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.
- `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.
- `to` DestinationRequest[], required — Array of destination addresses containing end users you want to send the message. - `to` 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.
- `params` string[] —Only applies if the content of the SMS message (´text´) contains personalized fields (placeholders).
Array of personalized fields (placeholders) values containing the SMS message.
Set placeholder/s values in order (position) of how each placeholder was defined in the SMS message.
For example, from the ´text´ parameter you entered the following message that includes 2 placeholders: Welcome to New York {0}, the temperature according to your location is {1} °C, enjoy the trip! Now you must enter the values of both placeholders in the order they were defined and be separated by commas -> {Elizabeth, 28}. The first placeholder value represents the name of the end user that will receive the message and the second placeholder value represents the degrees of temperature where the end user is located.
Optional. MT: Message sent from the mobile SMS provider system to the end user's mobile phone.
By default is ´MT´
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. This identifier will be sent back to you if you request callbacks containing status changes of the messages you send.
- `requestDR` boolean —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 ´false´
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, Messangi will provide you a list of connection names to use for your case.
- `callbacks` string[] —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.
- `email` string — Optional. Email associated with destination. - `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. ## Response `202` Posted batch messages - BatchMessageResponse - `meta` MetadataDTO - `timestamp` integer, 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` BatchMessageBaseResponse - `ids` Destination[], required — Array containing the destination address of each end user and the unique identifier (id) of each message sent. - `id` string — Unique identifier of the SMS message. - `mobile` string —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.
- `params` string[] —Only applies if the content of the SMS message (´text´) contains personalized fields (placeholders).
Array of personalized fields (placeholders) values containing the SMS message.
Set placeholder/s values in order (position) of how each placeholder was defined in the SMS message.
For example, from the ´text´ parameter you entered the following message that includes 2 placeholders: Welcome to New York {0}, the temperature according to your location is {1} °C, enjoy the trip! Now you must enter the values of both placeholders in the order they were defined and be separated by commas -> {Elizabeth, 28}. The first placeholder value represents the name of the end user that will receive the message and the second placeholder value represents the degrees of temperature where the end user is located.
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. 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.
- `requestDR` boolean —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 ´false´
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, Messangi will provide you a list of connection names to use for your case.
- `callbacks` string[] —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.
- `email` string — Optional. Email associated with destination. - `type` 'MT' | 'MO' — Type of message to be sent, default is 'MT' - `clientId` string — customer's identifier - `owner` string — Owner or creator of the SMS transaction. - `operator` string — User who is a member of the owner or creator of the SMS message. - `status` string —When the SMS message is sent, the system assigns one of the following possible status to an SMS message:
QUEUE: SMS message is queued. Acknowledged by internal delivery process but not yet sent.
DEQUEUED: The SMS message has been removed from the queue and is ready to be published on the mobile operator.
ERROR: An error occurred in the API logic and the message could not be delivered.
If the Error message is the following ´Text exceeds the limit of allowed segments´, it indicates that the number of permissible segments has been surpassed. This occurs when the message exceeds the 160-character limit per segment, therefore the the message cannot be sent. To resolve this issue, ensure that your SMS messages do not exceed 1600 characters to avoid reaching the segment limit.