SMS API
OAuth 2.0 API Endpoint
https://sms.infopromo.digital/api/v3/
HTTP API Endpoint
https://sms.infopromo.digital/api/http/
Your API Token
{Obtain it from your SMS portal}
Alternatively, you can find all the FREE APIs in the developer section of our various portals after a FREE account opening.
Infopromo Communications – Bulk SMS Marketing SMS API allows you to send and receive SMS messages to and from any country in the world through a REST API. Each message is identified by a unique random ID so that users can always check the status of a message using the given endpoint.
API Endpoint
Markup
https://sms.infopromo.digital/api/v3/sms/send| Parameter | Required | Description |
|---|---|---|
| Authorization | Yes | When calling our API, send your api token with the authentication type set as Bearer (Example: Authorization: Bearer {your api_token}) |
| Accept | Yes | Set to application/json |
Infopromo Communications – Bulk SMS Marketing’s Programmable SMS API enables you to programmatically send SMS messages from your web application. First, you need to create a new message object. Infopromo Communications – Bulk SMS Marketing returns the created message object with each request.
Send your first SMS message with this example request.
API Endpoint
https://sms.infopromo.digital/api/v3/sms/send| Parameter | Required | Type | Description |
|---|---|---|---|
| recipient | Yes | string | Number to send message. Use comma (,) to send multiple numbers. Ex. 31612345678,8801721970168 |
| 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. |
curl -X POST https://sms.infopromo.digital/api/v3/sms/send \ -H 'Authorization: Bearer {your api_token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"31612345678",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message"
}'
curl -X POST https://sms.infopromo.digital/api/v3/sms/send \ -H 'Authorization: Bearer {your api_token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"31612345678,880172145789",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message",
"schedule_time=2021-12-20 07:00"
}'
Returns a contact object if the request was successful.
{ "status": "success", "data": "sms reports with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
Infopromo Communications – Bulk SMS Marketing’s Programmable SMS API enables you to programmatically send Campaigns from your web application. First, you need to create a new message object. Infopromo Communications – Bulk SMS Marketing returns the created message object with each request.
Send your first Campaign Using Contact List with this example request.
API Endpoint
https://sms.infopromo.digital/api/v3/sms/campaign| Parameter | Required | Type | Description |
|---|---|---|---|
| contact_list_id | Yes | string | Contact list to send message. Use comma (,) to send multiple contact lists. Ex. 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. |
curl -X POST https://sms.infopromo.digital/api/v3/sms/campaign \ -H 'Authorization: Bearer {your api_token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"6415907d0d37a",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message"
}'
curl -X POST https://sms.infopromo.digital/api/v3/sms/campaign \ -H 'Authorization: Bearer {your api_token}' \
-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"
}'
Returns a contact object if the request was successful.
{ "status": "success", "data": "campaign reports with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
You can use Infopromo Communications – Bulk SMS Marketing’s SMS API to retrieve information of an existing inbound or outbound SMS message.
You only need to supply the unique message id that was returned upon creation or receiving.
API Endpoint
https://sms.infopromo.digital/api/v3/sms/{uid}
| Parameter | Required | Type | Description |
|---|---|---|---|
| uid | Yes | string | A unique random uid which is created on the Infopromo Communications – Bulk SMS Marketing platform and is returned upon creation of the object. |
curl -X GET https://sms.infopromo.digital/api/v3/sms/606812e63f78b \ -H 'Authorization: Bearer {your api_token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Returns a contact object if the request was successful.
{ "status": "success", "data": "sms data with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
API Endpoint
https://sms.infopromo.digital/api/v3/sms/curl -X GET https://sms.infopromo.digital/api/v3/sms \ -H 'Authorization: Bearer {your api_token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Returns a contact object if the request was successful.
{ "status": "success", "data": "sms reports with pagination", }
If the request failed, an error object will be returned.
{
"status": "error",
"message" : "A human-readable description of the error."
} You can use Infopromo Communications – Bulk SMS Marketing’s Campaign API to retrieve information of an existing Campaigns.
You only need to supply the unique campaign id that was returned upon creation or receiving.
API Endpoint
https://sms.infopromo.digital/api/v3/campaign/{uid}
| Parameter | Required | Type | Description |
|---|---|---|---|
| uid | Yes | string | A unique random uid which is created on the Infopromo Communications – Bulk SMS Marketing platform and is returned upon creation of the object. |
curl -X GET https://sms.infopromo.digital/api/v3/campaign/606812e63f78b/view \ -H 'Authorization: Bearer {your api_token}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Returns a contact object if the request was successful.
{ "status": "success", "data": "campaign data with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
Infopromo Communications – Bulk SMS Marketing SMS API allows you to send and receive SMS messages to and from any country in the world through a REST API. Each message is identified by a unique random ID so that users can always check the status of a message using the given endpoint.
API Endpoint
https://sms.infopromo.digital/api/http/sms/send| Parameter | Required | Description |
|---|---|---|
| api_token | Yes | API Token From Developers option. Get API Token |
| Accept | Yes | Set to application/json |
| Content-Type | Yes | Set to application/json |
Infopromo Communications – Bulk SMS Marketing’s Programmable SMS API enables you to programmatically send SMS messages from your web application. First, you need to create a new message object. Infopromo Communications – Bulk SMS Marketing returns the created message object with each request.
Send your first SMS message with this example request.
API Endpoint
https://sms.infopromo.digital/api/http/sms/send| Parameter | Required | Type | Description |
|---|---|---|---|
| recipient | Yes | string | Number to send message. Use comma (,) to send multiple numbers. Ex. 31612345678,8801721970168 |
| 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. |
curl -X POST https://sms.infopromo.digital/api/http/sms/send \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -d '{ "api_token":"{your api_token}",
"recipient":"31612345678",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message"
}'
https://sms.infopromo.digital/api/http/sms/send?recipient=31612345678&sender_id=YourName&message=test&api_token={your api_token}curl -X POST https://sms.infopromo.digital/api/http/sms/send \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -d '{ "api_token":"{your api_token}",
"recipient":"31612345678,880172145789",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message",
"schedule_time=2021-12-20 07:00"
}'
Returns a contact object if the request was successful.
{ "status": "success", "data": "sms reports with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
You can use Infopromo Communications – Bulk SMS Marketing’s SMS API to retrieve information of an existing inbound or outbound SMS message.
You only need to supply the unique message id that was returned upon creation or receiving.
API Endpoint
https://sms.infopromo.digital/api/http/sms/{uid}
| Parameter | Required | Type | Description |
|---|---|---|---|
| uid | Yes | string | A unique random uid which is created on the Infopromo Communications – Bulk SMS Marketing platform and is returned upon creation of the object. |
curl -X GET https://sms.infopromo.digital/api/http/sms/606812e63f78b \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -d '{"api_token":"{your api_token}"}'
Returns a contact object if the request was successful.
{ "status": "success", "data": "sms data with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
API Endpoint
https://sms.infopromo.digital/api/http/sms/curl -X GET https://sms.infopromo.digital/api/http/sms \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -d '{"api_token":"{your api_token}"}'
Returns a contact object if the request is successful.
{ "status": "success", "data": "sms reports with pagination", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
