CEcequens

Sending SMS To Groups

In case you want to send bulk SMS to predefined groups of recipients, use Cequens Send SMS to Groups API. The API will return to you the messages’ ID to track them later using Cequens Get Message Details by ID API.

Using Cequens Send SMS to Groups API is quite simple. First, submit an HTTP Request with the group’s name, the message text, and other important parameters, and then receive a Response that includes the SMS IDs.

post/v1/messages/groups

Request

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

Request body

messageTextstring

The message content that you want to send.

senderNamestring

The name of the message sender.

messageTypestring

Message type either text or unicode Can be text or unicode

groupsstring

The names of the groups to which you want to send the SMS separated by commas.

clientMessageIdinteger

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

deliveryTimestring

A string to specify 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.

Response

200

replyCodeinteger
replyMessagestring
requestIdstring
clientRequestIdinteger
requestTimestring

Example response

{
  "replyMessage": "Request handled successfully",
  "requestId": "6b8cab90-9997-11e4-9673-8d6d6ef9b02b",
  "clientRequestId": 123456789,
  "requestTime": "2016-01-22T11:04:02.648Z",
  "data": {
    "invalidRecipients": "string",
    "SentSMSIDs": [
      {
        "SMSID": "ddb122a1-4936-43ef-a09c-b6a24e2e511f, ddb122a1-4936-43ef-a09c-b6a24e2e722e"
      }
    ]
  }
}

Changes

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