Send a message (MMS)

post https://{server}/ns-api/v2/domains/{domain}/users/{user}/messagesessions/{messagesession}/messages#5

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

Path Params

domain

string

required

length ≤ 64

Defaults to ~

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.

user

string

required

length between 0 and 16

Defaults to ~

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.

messagesession

string

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.

Body Params

type

string

required

Type of message to send. Examples: chat, chat-media, sms, mms, chat-name-change, chat-video-invite, chat-participant-add, chat-participant-remove, chat-participant-leave

message

string

required

This is the text that will be sent as the message

destination

required

This is a single user or phonenumber for chat and SMS respectively. If sending to multiple recipients, then should be an array of users or phonenumbers

from-number

string

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

data

string | null

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

mime-type

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

size

integer | null

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

Responses

Language

Credentials

Bearer

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://ns-api.com/ns-api/v2/domains/~/users/~/messagesessions/messagesession/messages#5' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Accepted

400Bad Request

401Authentication Required

404Record not found