CEcequens

Sending SMS

Use messages endpoint to send Single or Bulk SMS. When you send SMS messages using this API, the API will return to you the sent messages’ ID to track them later using Cequens Get Message Details by ID API.

post/v1/messages

Request

  • Base URL
    https://apis.cequens.com/sms
  • URL
    https://apis.cequens.com/sms/v1/messages
  • Auth
    API key in header Authorization

Request body

messageTextstring required

The message content that you want to send.

senderNamestring required

The name of the message sender.

messageTypestring required

Message type either text or unicode Can be text or unicode

recipientsstring required

The intended recipients’ phone numbers.

clientMessageIdinteger

An integer used as an identifier for your request to track it.

deliveryTimestring

A string that includes the desired delivery time of the SMS.

dlrUrlstring

A string to define the URL to which you would like to send the delivery receipts (DLR).

dataCodingstring

A string to define the data coding scheme of the SMS.

shortURLboolean

set it to true, if the messageText contains URL and you want to shorten it

Response

200

replyCodeinteger
replyMessagestring
requestIdstring
clientRequestIdinteger
requestTimestring

Example response

{
  "replyMessage": "Request handled successfully",
  "requestId": "2fbc0560-6187-11e7-b60b-77c0e21cef84",
  "requestTime": "2017-07-05T15:38:10.742",
  "data": {
    "SentSMSIDs": [
      {
        "SMSId": "0461f8f4-4c4f-4dc0-b7ed-097f4f9f85f4"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.