Starts a message session by sending its first message, and answers 202. Every scope reaches its own user. Office Manager reaches every user in its domain, Reseller the domains in its territory, and Super User every domain. You send as the user in the path.The body is the one POST /domains/{domain}/users/{user}/messages takes, with the same type values and fields. The session is found from who takes part, so the same sender and recipients continue an existing session. To get the stored message and its messagesession-id in the answer, use POST /domains/{domain}/users/{user}/messages instead. For later messages, use POST /domains/{domain}/users/{user}/messagesessions/{messagesession}/messages.A number that texted STOP to from-number does not get the message. When every recipient has opted out, the request answers 409.A 202 means the change is accepted and applied shortly after, so a read made right away can still show the old values.
Request
Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params
Body Params application/jsonRequired
Examples
Responses
🟢202Accepted
application/json
The message is accepted and delivered shortly after this response.
Bodyapplication/json
🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
🟠409Conflict
🟠415Unsupported Media Type
🔴500Internal Server Error
🟠420Rate Limit Exceeded
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl--location'https://awqacore01.crexendocloud.com/ns-api/v2/domains//users//messagesessions' \
--header'Authorization: Bearer <token>' \
--header'Content-Type: application/json' \
--data'{
"type": "chat",
"message": "Can you cover the front desk at 3?",
"destination": "1002"
}'