v1

latestSwagger 2.02026-07-1324555.3 KB
webpubsub

Broadcast content inside request body to all the connected client connections.

post/api/hubs/{hub}/:send

Path parameters

hubstring required

Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore.

Query parameters

excludedstring[]

Excluded connection Ids.

api-versionstring required

The version of the REST APIs.

filterstring

Following OData filter syntax to filter out the subscribers receiving the messages.

messageTtlSecondsinteger

The time-to-live (TTL) value in seconds for messages sent to the service. 0 is the default value, which means the message never expires. 300 is the maximum value. If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service. This parameter can help when the client's bandwidth is limited.

Request body

string binary required

Response

The message is accepted. The service follows fire-and-forget pattern when sending messages.