KAkaleyra
Bulk SMS APIs

Send MKT/TXN/OTP SMS using POST method to multiple numbers

To send marketing messages use "type" value as "MKT". To send transactional messages use "type" value as "TXN". To send otp messages use "type" value as "OTP". To send SMS to multiple numbers use Comma separated values in "to"

post/v1/{sid}/messages

Request

  • Base URL
    api.in.kaleyra.io (relative, and the document’s source URL is not known)
  • URL
    api.in.kaleyra.io/v1/{sid}/messages
  • Auth
    none declared. Required headers: api-key, Content-Type

Path parameters

sidstring required

Headers

api-keystring required

API Key generated by kaleyra.io. Example - Ac4XXXXX21f

Content-Typestring required

The format in which the data is sent.

Request body application/x-www-form-urlencoded

tostring required

It contains a phone number, Numbers Separated by “,“ comma OR It can have a list of numbers in an Array. For example - 9188XXXXXXXX.

senderstring required

Sender ID used for sending SMS. The sender must be in the form of a tag when used in template-based sending. For example - "KLRHXA"

typestring

Type of the SMS (for example, transactional). type must exist as a tag if using template-based sending.

template_idstring

[Conditional] Template ID for pre-registered templates. Required if the body is not provided. template_id must be 12 to 30 digits and exist as a tag.

bodystring

[Conditional] Body of the SMS. It is required if template_id is not provided.

callback_profile_idstring

URL for callbacks. Callback must exist as a tag if using template-based sending.

campaign_namestring

Name of the campaign. Must match regex pattern ^[\w-]*$.

refstring

Custom reference fields for the message, up to 150 characters each.

ref1string

Custom reference fields for the message, up to 150 characters each.

ref2string

Custom reference fields for the message, up to 150 characters each.

Example request

{
  "to": "{{to_commas}}",
  "sender": "{{sender_id}}",
  "type": "MKT",
  "template_id": "{{template_id}}",
  "body": "{{body}}",
  "callback_profile_id": "{{callback_profile_id}}",
  "campaign_name": "Campaign",
  "ref": "Reference Data",
  "ref1": "Reference Data 2",
  "ref2": "Reference Data 3"
}

Response

Successful response

Changes

No recorded changes to this operation across all 2 revisions of this API.