Sdílet prostřednictvím

Web Pub Sub - Send To Group

  • Reference
Služba:
Azure Web PubSub Service
Verze rozhraní API:
2024-01-01

Odeslání obsahu uvnitř textu požadavku skupině připojení

POST {endpoint}/api/hubs/{hub}/groups/{group}/:send?api-version=2024-01-01
S volitelnými parametry: 
POST {endpoint}/api/hubs/{hub}/groups/{group}/:send?excluded={excluded}&api-version=2024-01-01&filter={filter}&messageTtlSeconds={messageTtlSeconds}

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
endpoint
 path True

string

url

Koncový bod HTTP nebo HTTPS pro instanci služby Web PubSub.
group
 path True

string

Název cílové skupiny, která by měla být větší než 0 a menší než 1025.

Vzor regulárního výrazu: ^(?!\s+$).+$
hub
 path True

string

Název cílového centra, který by měl začínat abecedním znakem a obsahovat pouze alfanumerické znaky nebo podtržítko.

Vzor regulárního výrazu: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version
 query True

string

Verze rozhraní REST API.
excluded
 query

string[]

Vyloučené ID připojení
filter
 query

string

Podle syntaxe filtru OData vyfiltrujte odběratele přijímající zprávy.
messageTtlSeconds
 query

integer

int32

Hodnota TTL (Time to Live) v sekundách pro zprávy odeslané do služby. 0 je výchozí hodnota, což znamená, že zpráva nikdy nevyprší. Maximální hodnota je 300. Pokud je tento parametr nenulový, služba zahodí zprávy, které klient nespotřebovávají v zadané hodnotě TTL. Tento parametr může pomoct, když je šířka pásma klienta omezená.

Text požadavku

Media Types: "application/octet-stream", "text/plain", "application/json"

Name Typ Description
message

string

Tělo datové části.

Odpovědi

Name Typ Description
202 Accepted

Přijal
Other Status Codes

ErrorDetail

Chybová odpověď

Hlavičky

x-ms-error-code: string

Příklady

WebPubSub_SendToGroup

Ukázkový požadavek

POST {endpoint}/api/hubs/hub1/groups/group1/:send?api-version=2024-01-01&filter=startswith(userId, 'listener-')&messageTtlSeconds=15

"Message to send"

Ukázková odpověď

Stavový kód:
202

Definice

Name Description
ErrorDetail

Objekt chyby.
InnerError

ErrorDetail

Objekt chyby.

Name Typ Description
code

string

Jedna ze serverově definovaných kódů chyb.
details

ErrorDetail[]

Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
inner

InnerError

message

string

Čitelné znázornění chyby člověkem.
target

string

Cíl chyby.

InnerError

Name Typ Description
code

string

Konkrétnější kód chyby, než poskytla chyba obsahující chybu.
inner

InnerError