Sign in

v1

latestOpenAPI 3.0.12026-07-2471135326.0 KB
Messages

Send Batch SMS Message

This endpoint allows you to send multiple outbound SMS messages.

post/v3/messages/batch

Request body

fromstring required
<p>Source address of the message.</p> <p>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.</p> <p><i>If you don't have one assigned yet please contact our support team to request one.</i></p>
textstring required
<p>Content of the SMS message that will be sent to the end user.</p> <p>The maximum length of a short message text is <b>160 characters</b> 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 <b>segments</b> 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.</p> <p>You will be charged per segment, not per message.</p>
type'MT' | 'MO' required
<p><i>Optional.</i> <code>MT</code>: Message sent from the mobile SMS provider system to the end user's mobile phone.</p> <p>By default is <code>´MT´</code></p>
externalIdstring
<p><i>Optional.</i> 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.</p> <p>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.</p>
requestDRboolean
<p><i>Optional.</i> Request a Delivery Receipt to the carrier.</p> <p><code>´true´</code>: Operator notifies the state of a message while it is in transit to its destination. <i>We recommend you use this option.</i></p> <p><code>´false´</code>: Operator won't notify the state of a message while it is in transit to its destination.</p> <p>By default is <code>´false´</code></p>
connectionstring
<p><i>Optional.</i> 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.</p> <p><i>If you need to indicate this parameter, Messangi will provide you a list of connection names to use for your case.</i></p>
callbacksstring[]
<p><i>Optional.</i> To know the possible SMS status that will be registered on your callback URL once the message is sent, refer to the <a href='https://docs.messangi.com/docs/sms-status'>SMS Status</a> section.</p> <p>To know the parameters that will be registered and sent to your callback URL in JSON format go to the <a href='https://docs.messangi.com/docs/url-callback-mt'>Callback URL (MT)</a> section.</p>
emailstring

<i>Optional.</i> Email associated with destination.

clientIdstring

<i>Optional.</i> 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.

Example request

{
  "from": "12345",
  "text": "Hi {0}, your balance is ${1}",
  "type": "MT",
  "externalId": "test_1",
  "connection": "CONNECTION_TEST",
  "callbacks": [
    "http://www.mycallback.com?id=123"
  ],
  "email": "root@demo.com",
  "clientId": "client1"
}

Response

Posted batch messages

Example response

{
  "meta": {
    "timestamp": 1597166699457,
    "transactionId": "70169d77-c165-4795-9932-35b8a3af96fb",
    "explain": "a descriptive text"
  },
  "data": {
    "ids": [
      {
        "id": "507f1f77bcf86cd799439011",
        "mobile": "+580000000001"
      },
      {
        "id": "507f191e810c19729de860ea",
        "mobile": "+580000000002"
      }
    ],
    "invalidNumber": [
      "+580000000001"
    ],
    "from": "12345",
    "externalId": "test_1",
    "text": "text demo",
    "connection": "CONNECTION_TEST",
    "callbacks": [
      "http://www.mycallback.com?id=123"
    ],
    "email": "root@demo.com",
    "clientId": "555555",
    "owner": "owner",
    "operator": "operator",
    "status": "SENT",
    "date": "2020-06-22T15:06:37.909584Z"
  }
}