Send Bulk Chat Messages Asynchronously

post

https://{hostname}/api/talk/chat/v1/messages/async

This operation sends a chat message to one or more recipients asynchronously and returns a request ID, which allows you to check the status of the asynchronous request.

Service limit

A service limit constrains the number of recipients per batch and the message length that can be processed in a single request.

The Number of Users per Batch cannot exceed 100.
The Message Length cannot exceed 1000 characters.

Authorization and Permissions

An OpenAM or Auth0 token is required to send a chat message.
The user must have content creation permission, which can be granted by a Talk administrator.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

202Successfully accepted the bulk chat request for processing.

400The HTTP status code 400 Bad Request error, thrown when required parameters are not passed.

401The HTTP status code 401 Unauthorized error, thrown when the user is not authorized to access the resource.

403The HTTP status code 403 Forbidden error, thrown when the user is not authorized to access the resource.

405The HTTP status code 405 Method Not Allowed error, thrown when you attempt to call a URI with an unsupported HTTP method.

406The HTTP status code 406 Not Acceptable Content error, thrown when you send a request with accept header other than application/json.

413The HTTP status code 413 Payload Too Large error, thrown when you attempt to pass a request payload that exceeds the limit.

429The HTTP status code 429 Too Many Requests error, thrown when the user exceeds the allowed rate limit for the API.

500The HTTP status code 500 Internal Server error, thrown when the server is not able to process the request.