Поделиться через

Web Pub Sub - Send To Group

  • Ссылка
Служба:
Azure Web PubSub Service
Версия API:
2024-01-01

Отправьте содержимое внутри текста запроса группе подключений.

POST {endpoint}/api/hubs/{hub}/groups/{group}/:send?api-version=2024-01-01
С использованием необязательных параметров: 
POST {endpoint}/api/hubs/{hub}/groups/{group}/:send?excluded={excluded}&api-version=2024-01-01&filter={filter}&messageTtlSeconds={messageTtlSeconds}

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string

url

Конечная точка HTTP или HTTPS для экземпляра службы Web PubSub.
group
 path True

string

Имя целевой группы, длина которой должна превышать 0 и меньше 1025.

Шаблон регулярного выражения: ^(?!\s+$).+$
hub
 path True

string

Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания.

Шаблон регулярного выражения: ^[A-Za-z][A-Za-z0-9_`,.[\]]{0,127}$
api-version
 query True

string

Версия REST API.
excluded
 query

string[]

Исключенные идентификаторы подключения
filter
 query

string

Следуя синтаксису фильтра OData, чтобы отфильтровать подписчиков, получающих сообщения.
messageTtlSeconds
 query

integer

int32

Значение времени в реальном времени (TTL) в секундах для сообщений, отправленных в службу. Значение 0 — это значение по умолчанию, которое означает, что сообщение никогда не истекает. 300 — максимальное значение. Если этот параметр не равен нулю, сообщения, которые не используются клиентом в указанном TTL, будут удалены службой. Этот параметр может помочь, если пропускная способность клиента ограничена.

Текст запроса

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

Имя Тип Описание
message

string

Текст полезных данных.

Ответы

Имя Тип Описание
202 Accepted

Принятый
Other Status Codes

ErrorDetail

Ответ на ошибку

Заголовки

x-ms-error-code: string

Примеры

WebPubSub_SendToGroup

Образец запроса

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

"Message to send"

Пример ответа

Код состояния:
202

Определения

Имя Описание
ErrorDetail

Объект ошибки.
InnerError

ErrorDetail

Объект ошибки.

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.
details

ErrorDetail[]

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
inner

InnerError

message

string

Читаемое пользователем представление ошибки.
target

string

Целевой объект ошибки.

InnerError

Имя Тип Описание
code

string

Более конкретный код ошибки, чем был предоставлен содержащей ошибкой.
inner

InnerError