S M S

Sending SMS To Groups

POST
/sms/v1/messages/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.

Authorization

bearerAuth
AuthorizationBearer <token>

JWT access token returned by Signing In (POST /auth/v1/tokens/).

In: header

Request Body

application/json

messageText?string

The message content that you want to send.

senderName?string

The name of the message sender.

messageType?string

Message type either text or unicode Can be text or unicode

groups?string

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

clientMessageId?integer

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

Formatint32
Default0
deliveryTime?string

A string to specify the desired delivery time of the SMS.

dlrUrl?string

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

dataCoding?string

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

Response Body

application/json

application/json

curl -X POST "https://example.com/sms/v1/messages/groups" \  -H "Content-Type: application/json" \  -d '{}'
"{\n\"replyCode\": 0,\n\"replyMessage\": \"Request handled successfully\",\n\"requestId\": \"6b8cab90-9997-11e4-9673-8d6d6ef9b02b\",\n\"clientRequestId\": 123456789,\n\"requestTime\": \"2016-01-22T11:04:02.648Z\",\n\"data\": {\n\"invalidRecipients\": \"string\",\n\"SentSMSIDs\": [\n{\n\"SMSID\": \"ddb122a1-4936-43ef-a09c-b6a24e2e511f, ddb122a1-4936-43ef-a09c-b6a24e2e722e\"\n}\n]\n}\n}"