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

Web Pub Sub - Send To User

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

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

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

Параметры URI

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

string

url

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

string

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

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

string

Идентификатор пользователя.
api-version
 query True

string

Версия REST API.
filter
 query

string

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

integer

int32

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

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

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

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

string

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

Ответы

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

Принято
Other Status Codes

ErrorDetail

Сообщение об ошибке

Заголовки

x-ms-error-code: string

Примеры

WebPubSub_SendToUser

Sample request

POST {endpoint}/api/hubs/hub1/users/user1/:send?api-version=2023-07-01&filter=startswith(userId, 'listener-')&messageTtlSeconds=15

"Message to send"

Sample response

Status code:
202

Определения

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

Объект error.
InnerError

ErrorDetail

Объект error.

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

string

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

ErrorDetail[]

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

InnerError

message

string

Удобочитаемое представление ошибки.
target

string

Цель ошибки.

InnerError

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

string

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

InnerError