Send SMS Message

post https://elastic.messangi.me/raven/v2/messages

time	status	user agent
Retrieving recent requests…

Loading…

Body Params

from

string

required

Source address of the message.

Specifies the Shortcode (from 1 to 6 digits), Longcode (from 7 digits on), an alphanumeric shortcode (ex. COMPANY) or a virtual number that will be used to originate and send the SMS message. Any of these codes will appear in the handset as the source of the text message. Virtual numbers will translate to a local shortcode depending on the destination carrier.

If you don't have one assigned yet please contact our support team to request one.

externalId

string

Optional. Alphanumeric identifier that can be used for reporting purposes. For instance, you could set the name or ID of the action that originated this SMS message so you can then identify where this API call is coming from.

This is an identifier you can use to identify your messages uniquely. Typical applications are to assign a different identifier per message or per group of messages, like a campaign identifier. This identifier will be sent back to you if you request callbacks containing status changes of the messages you send.

text

string

required

Content of the SMS message that will be sent to the end user.

The maximum length of a short message text is 160 characters using the default GSM 03.38 alphabet. If you use any character that is not in the default alphabet, the message will be encoded in Unicode and will be divided in segments of a maximum of 70 characters each. For example, if you include an emoji in your message and the message is 150 characters long, it will be divided into three segments: the first one with 70 characters, the second one with 70 characters and the third one with just 10 characters.

You will be charged per segment, not per message.

string

required

Destination address of the message. This is the cell phone number where you want to send your message to.

The destination address must be specified in E.164 format → (‘+’ and a country code). The plus sign prefix of the format is optional.

requestDR

boolean

Defaults to true

Optional. Request a Delivery Receipt to the carrier.

true: Operator notifies the state of a message while it is in transit to its destination. We recommend you use this option.

false : Operator won't notify the state of a message while it is in transit to its destination.

By default is true

connection

string

Optional. Name of the connection to indicate which carrier to send the message to. This is only used in cases where there are ambiguities between the destination carriers you are allowed to send to.

If you need to indicate this parameter, we will provide you a list of connection names to use for your case.

callbacks

array of strings

Optional. To know the possible SMS status that will be registered on your callback URL once the message is sent, refer to the SMS Status section.

To know the parameters that will be registered and sent to your callback URL in JSON format go to the Callback URL (MT) section

callbacks

string

Optional. Email associated with destination.

type

string

Defaults to MT

Optional. MT: Message sent from the mobile SMS provider system to the end user's mobile phone.

By default is MT

clientId

string

Optional. Unique user identifier that can be used for reporting purposes. This is an identifier you can use to uniquely identify the destination address in your systems. This is similar to the externalId and will be sent back to you if you are requesting callbacks that contain status changes of the messages you send.

Responses

Response body

object

meta

object

timestamp

int64

required

Transaction's date in timestamp

transactionId

string

required

Id for the current transaction (Endpoint's call)

explain

string

Explain string in case of failure

data

object

string

The process id

from

string

required

Source address of the message.

If you don't have one assigned yet please contact our support team to request one.

externalId

string

text

string

required

Content of the SMS message that will be sent to the end user.

You will be charged per segment, not per message.

string

required

Destination address of the message. This is the cell phone number where you want to send your message to.

The destination address must be specified in E.164 format → (‘+’ and a country code). The plus sign prefix of the format is optional.

requestDR

boolean

Defaults to true

Optional. Request a Delivery Receipt to the carrier.

true: Operator notifies the state of a message while it is in transit to its destination. We recommend you use this option.

false : Operator won't notify the state of a message while it is in transit to its destination.

By default is true

connection

string

If you need to indicate this parameter, we will provide you a list of connection names to use for your case.

callbacks

array of strings

Optional. To know the possible SMS status that will be registered on your callback URL once the message is sent, refer to the SMS Status section.

To know the parameters that will be registered and sent to your callback URL in JSON format go to the Callback URL (MT) section

callbacks

string

Optional. Email associated with destination.

type

string

Defaults to MT

Optional. MT: Message sent from the mobile SMS provider system to the end user's mobile phone.

By default is MT

MT MO

clientId

string

owner

string

The owner of these process

operator

string

The operator of these groups

status

string

Message’s status

date

date-time

Message sent date

Language

Credentials

Bearer

JWT


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://elastic.messangi.me/raven/v2/messages \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "requestDR": true,
8
  "type": "MT"
9
}
10
'

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

application/json

202Posted message

400Bad Request

403Forbidden

404Not Found

500Internal Server Error