Sign in

v1

latestOpenAPI 3.1.02026-07-24317911.4 MB
Messages

Send a message (MMS)

Note: # and anything after is NOT needed, its just to allow multiple examples for the same path/method.

post/domains/{domain}/users/{user}/messagesessions/{messagesession}/messages#5

Path parameters

domainstring required

This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.

Example:example.com
userstring required

This is the main user extension for the user account. ~ can be used to mean "my account" which will extract the user from the token/key used for authentication.

Example:1000
messagesessionstring required

ID of the message session to send in. Needs to be at least 32 characters long and random. Only alphanumeric chracters and underscore are allowed.

Request body

typestring required
messagestring required

This is the text that will be sent as the message

from-numberstring

This is used only for SMS. This is the user's number used to send outbound for SMS

datastring nullable

This is used only for media chat or MMS. This is the base64 data of the media file to be sent

mime-typestring
sizeinteger nullable

This is used only for media chat or MMS. This is the size in bytes of the media file being sent

Example request

{
  "type": "chat",
  "destination": "1123",
  "mime-type": "image/png"
}

Response

codeinteger required
messagestring required