API authentication required
Need API Access?

Please use ‘Create Account’ to quickly register and start exploring our APIs

POST

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/sms-campaigns

Parameter
Name
Value
Description
* Body
Jsonbody

Replace <your_api_key> and <your_api_token> with the API key and token created by you.
Replace <your_sid> with your “Account sid”
Replace <subdomain> with the region of your account
<subdomain> of Singapore cluster is @api.exotel.com
<subdomain> of Mumbai cluster is @api.in.exotel.com

<your_api_key> , <your_api_token> and <your_sid> are available in the API settings page of your Exotel Dashboard

Response Content Type

GET

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/sms-campaigns/<id>

To get the details of a specific campaign in your account, make an HTTP GET request

Parameter
Name
Value
Description
* id
path
Response Content Type

PUT

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/sms-campaigns/<id>

While you can update all the parameters of a campaign that has not started

Parameter
Name
Value
Description
* ID
path
* Body
Jsonbody

string; Control a campaign. The below values can be passed:

pause – Stop calling more numbers as part of the campaign that is in progress.
resume -Resume calling numbers that were not called.

Response Content Type

GET

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/sms-campaigns

To get the details of bulk campaign details in your account, make an HTTP GET request.

This API allows you to fetch bulk campaign details with sorting and searching capabilities. 
 

Parameter
Name
Value
Description
* offset
query

offset (optional)-  By specifying offset, you retrieve a subset of records starting with the offset value. Offset is zero-based i.e. the 10th record is at offset 9

* limit
query

limit(optional)- number of records on single page default:20 maximum=50

* name
query

name (optional)-Search by campaign name. Min 3 letters. (like %xxx%)

* sort_by
query

sort_by (optional)- This indicates in what order the campaign records are sorted in the API response. By default records are sorted by ScheduledTime in ascending order. However, you can override the same in following way for ascending order: Eg: schedule.start_time:asc, schedule.start_time:desc, name:asc (alphabetical order A-z, Z-A)

 

* status
query

status (Optional)- Filter on status. Possible values- “scheduled”, “in-progress”,”completed”,”archived”,”paused” 

Response Content Type

GET

https://<your_api_key>:<your_api_token><subdomain>/v2/accounts/<your_sid>/sms-campaign/ <campaign_id>/sms-details

To get the sms details of a specific campaign in your account, make an HTTP GET request

Parameter
Name
Value
Description
* id
path
Response Content Type