Web Pub Sub - Send To Connection
Send content inside request body to the specific connection.
POST {endpoint}/api/hubs/{hub}/connections/{connectionId}/:send?api-version=2024-01-01
POST {endpoint}/api/hubs/{hub}/connections/{connectionId}/:send?api-version=2024-01-01&messageTtlSeconds={messageTtlSeconds}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
connection
|
path | True |
string |
The connection Id. |
endpoint
|
path | True |
string url |
HTTP or HTTPS endpoint for the Web PubSub service instance. |
hub
|
path | True |
string |
Target hub name, which should start with alphabetic characters and only contain alpha-numeric characters or underscore. Regex pattern: |
api-version
|
query | True |
string |
The version of the REST APIs. |
message
|
query |
integer int32 |
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
Media Types: "application/octet-stream", "text/plain", "application/json"
Name | Type | Description |
---|---|---|
message |
string |
The payload body. |
Responses
Name | Type | Description |
---|---|---|
202 Accepted |
Accepted |
|
Other Status Codes |
Error response Headers x-ms-error-code: string |
Examples
WebPubSub_SendToConnection
Sample request
POST {endpoint}/api/hubs/hub1/connections/connection1/:send?api-version=2024-01-01&messageTtlSeconds=15
"Message to send"
Sample response
Definitions
Name | Description |
---|---|
Error |
The error object. |
Inner |
ErrorDetail
The error object.
Name | Type | Description |
---|---|---|
code |
string |
One of a server-defined set of error codes. |
details |
An array of details about specific errors that led to this reported error. |
|
inner | ||
message |
string |
A human-readable representation of the error. |
target |
string |
The target of the error. |
InnerError
Name | Type | Description |
---|---|---|
code |
string |
A more specific error code than was provided by the containing error. |
inner |