Start a new Message Session

post

https://{server}/ns-api/v2/domains/{domain}/users/{user}/messages

This is a good place to start with messaging if you do not already have a message session ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

domain

string

required

length ≤ 64

^[A-Za-z0-9._-]*|~|\*+

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.

Body Params

type

string

required

message

string

required

This is the text that will be sent as the message

destination

string | array

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

MimeTypes | null

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

Response

200