Text.lk – SMS Gateway Sri Lanka’s Programmable SMS API enables you to send campaigns programmatically from your web application. First, you need to create a new message object. Text.lk -SMS Gateway Sri Lanka returns the created message object with each request.
Send your first Campaign Using the Contact List with this example request.
API Endpoint #
https://app.text.lk/api/v3/sms/campaignParameters #
| Parameter | Required | Type | Description |
|---|---|---|---|
| contact_list_id | Yes | string | Contact list to send message. Use comma (,) to send multiple contact lists. Eg: 6415907d0d7a6,6415907d0d37a |
| sender_id | Yes | string | The sender of the message. This can be a telephone number (including country code) or an alphanumeric string. In case of an alphanumeric string, the maximum length is 11 characters. |
| type | Yes | string | The type of the message. For text message you have to insert plain as sms type. |
| message | Yes | string | The body of the SMS message. |
| schedule_time | No | datetime | The scheduled date and time of the message in RFC3339 format (Y-m-d H:i) |
| dlt_template_id | No | string | The ID of your registered DLT (Distributed Ledger Technology) content template. |
Example request for Single Contact List #
curl -X POST https://app.text.lk/api/v3/sms/campaign \
-H 'Authorization: Bearer API_KEY' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"6415907d0d7a6",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message"
}'Example request for Multiple Contact Lists #
curl -X POST https://app.text.lk/api/v3/sms/campaign \
-H 'Authorization: Bearer API_KEY' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"6415907d0d37a,6415907d0d7a6",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message",
"schedule_time=2021-12-20 07:00"
}'Example Response #
Returns a contact object if the request is successful.
{
"status": "success",
"data": "campaign reports with all details",
}If the request fails, an error object will be returned.
{
"status": "error",
"message" : "A human-readable description of the error."
}
