Infopromo Communications

Welcome To Infopromo Communications – Bulk SMS Marketing docs

Get familiar with our APIs and technical resources in your favorite languages.

Alternatively view the documentation here

CONTACTS API

Infopromo Communications – Bulk SMS Marketing Contacts API helps you manage contacts that are identified by a unique random ID. Using this ID, you can create, view, update, or delete contacts. This API works as a collection of customer-specific contacts that allows you to group them and assign custom values that you can later use when sending SMS template messages.

The Contacts API uses HTTP verbs and a RESTful endpoint structure with an access key that is used as the API Authorization. Request and response payloads are formatted as JSON using UTF-8 encoding and URL encoded values.

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/contacts
Parameters
PARAMETERREQUIREDDESCRIPTION
Authorization
YES
When calling our API, send your api token with the authentication type set as Bearer (Example: Authorization: Bearer {api_token})
Accept
YES
Set to application/json
 
Create a contact

Creates a new contact object. Infopromo Communications – Bulk SMS Marketing returns the created contact object with each request.

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/contacts/{group_id}/store
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
PHONE
YES
numberThe phone number of the contact.
OTHER_FIELDS
NO
stringAll Contact’s other fields: FIRST_NAME (?), LAST_NAME (?),… (depending on the contact group fields configuration)
Example request
PHP
curl -X POST https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a/store \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"PHONE":"8801721970168",
"FIRST_NAME":"Jhon",
"LAST_NAME":"Doe",
}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "contacts data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
 
View a contact

Retrieves the information of an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation or receiving.

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/contacts/{group_id}/search/{uid}
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
uid
YES
stringContact uid
Example request
PHP
curl -X POST https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a/search/606732aec8705 \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "contacts data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
 
Update a contact

Updates an existing contact. You only need to supply the unique uid of contact and contact group uid that was returned upon creation.

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/contacts/{group_id}/update/{uid}
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
uid
YES
stringContact uid
PHONE
YES
numberThe phone number of the contact.
OTHER_FIELDS
NO
stringAll Contact’s other fields: FIRST_NAME (?), LAST_NAME (?),… (depending on the contact group fields configuration)
Example request
PHP
curl -X PATCH https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a/update/606732aec8705 \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"PHONE":"8801721970168",
"FIRST_NAME":"Jhon",
"LAST_NAME":"Doe",
}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "contacts data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
 
Delete a contact

Deletes an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation.

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/contacts/{group_id}/delete/{uid}
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
uid
YES
stringContact uid
Example request
PHP
curl -X DELETE https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a/delete/606732aec8705 \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "contacts data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
View all contacts in group

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/contacts/{group_id}/all
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
Example request
PHP
curl -X POST https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a/all \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "contacts data with pagination",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

CONTACT GROUPS API

Infopromo Communications – Bulk SMS Marketing Contact Groups API allows you to manage contact groups that are identified by a unique random ID. Use this ID to create, view, update or delete groups.

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/contacts
Parameters
PARAMETERREQUIREDDESCRIPTION
Authorization
YES
When calling our API, send your api token with the authentication type set as Bearer (Example: Authorization: Bearer {api_token})
Accept
YES
Set to application/json
Create a group

Creates a new group object. Infopromo Communications – Bulk SMS Marketing returns the created group object with each request.

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/contacts
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
name
YES
stringThe name of the group
Example request
PHP
curl -X POST https://sms.infopromo.digital/api/v3/contacts \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"name":"Codeglen"}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "group data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
View a group

Retrieves the information of an existing group. You only need to supply the unique group ID that was returned upon creation or receiving.

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/contacts/{group_id}/show/
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
Example request
PHP
curl -X POST https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a/show \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "group data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
 
Update a group

Updates an existing group. You only need to supply the unique ID that was returned upon creation.

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/contacts/{group_id}
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
name
YES
stringNew group name
Example request
PHP
curl -X PATCH https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"name":"Codeglen Update"}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "groups data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
 
Delete a group

Deletes an existing group. You only need to supply the unique id that was returned upon creation.

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/contacts/{group_id}
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
Example request
PHP
curl -X DELETE https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "null",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
 
View all groups

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/contacts/
Example request
PHP
curl -X GET https://sms.infopromo.digital/api/v3/contacts \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "group data with pagination",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

SMS API

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
Parameters
PARAMETERREQUIREDDESCRIPTION
Authorization
YES
When calling our API, send your api token with the authentication type set as Bearer (Example: Authorization: Bearer {api_token})
Accept
YES
Set to application/json
 
Send outbound SMS

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

Markup
https://sms.infopromo.digital/api/v3/sms/send
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
recipient
YES
stringNumber to send message. Use comma (,) to send multiple numbers. Ex. 31612345678,8801721970168
sender_id
YES
stringThe 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
stringThe type of the message. For text message you have to insert plain as sms type.
message
YES
stringThe body of the SMS message.
schedule_time
NO
datetimeThe scheduled date and time of the message in RFC3339 format (Y-m-d H:i)
dlt_template_id
NO
stringThe ID of your registered DLT (Distributed Ledger Technology) content template.
Example request for Single Number
PHP
curl -X POST https://sms.infopromo.digital/api/v3/sms/send \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"31612345678",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message"
}'
Example request for Multiple Numbers
PHP
curl -X POST https://sms.infopromo.digital/api/v3/sms/send \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-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

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "sms reports with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
 
Send Campaign Using Contact list

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

Markup
https://sms.infopromo.digital/api/v3/sms/campaign
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
contact_list_id
YES
stringContact list to send message. Use comma (,) to send multiple contact lists. Ex. 6415907d0d7a6,6415907d0d37a
sender_id
YES
stringThe 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
stringThe type of the message. For text message you have to insert plain as sms type.
message
YES
stringThe body of the SMS message.
schedule_time
NO
datetimeThe scheduled date and time of the message in RFC3339 format (Y-m-d H:i)
dlt_template_id
NO
stringThe ID of your registered DLT (Distributed Ledger Technology) content template.
Example request for Single Contact List
PHP
curl -X POST https://sms.infopromo.digital/api/v3/sms/campaign \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"6415907d0d37a",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message"
}'
Example request for Multiple Contact Lists
PHP
curl -X POST https://sms.infopromo.digital/api/v3/sms/campaign \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-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

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "campaign reports with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
 
View an SMS

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

Markup
https://sms.infopromo.digital/api/v3/sms/{uid}
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
uid
YES
stringA unique random uid which is created on the Infopromo Communications – Bulk SMS Marketing platform and is returned upon creation of the object.
Example request
PHP
curl -X GET https://sms.infopromo.digital/api/v3/sms/606812e63f78b \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "sms data with all details",}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
 
View all messages

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/sms/
Example request
PHP
curl -X GET https://sms.infopromo.digital/api/v3/sms \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "sms reports with pagination",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

PROFILE API

Infopromo Communications – Bulk SMS Marketing Profile API allows you to retrieve your total remaining sms unit, used sms unit, and your profile information.

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/me
Parameters
PARAMETERREQUIREDDESCRIPTION
Authorization
YES
When calling our API, send your api token with the authentication type set as Bearer (Example: Authorization: Bearer {api_token})
Accept
YES
Set to application/json
View sms unit

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/balance
Example request
PHP
curl -X GET https://sms.infopromo.digital/api/v3/balance \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "sms unit with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
View Profile

API Endpoint

Markup
https://sms.infopromo.digital/api/v3/me
Example request
PHP
curl -X GET https://sms.infopromo.digital/api/v3/me \
-H 'Authorization: Bearer (YOUR TOKEN STRING)' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "profile data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

CONTACTS API

Infopromo Communications – Bulk SMS Marketing Contacts API helps you manage contacts that are identified by a unique random ID. Using this ID, you can create, view, update, or delete contacts. This API works as a collection of customer-specific contacts that allows you to group them and assign custom values that you can later use when sending SMS template messages.

The Contacts API uses HTTP verbs and a RESTful endpoint structure with an access key that is used as the API Authorization. Request and response payloads are formatted as JSON using UTF-8 encoding and URL encoded values.

API Endpoint

Markup
https://sms.infopromo.digital/api/http/contacts
Parameters
PARAMETERREQUIREDDESCRIPTION
api_token
YES
API Token From Developers option. Get API Token
Accept
YES
Set to application/json
Content-Type
YES
Set to application/json
Create a contact

Creates a new contact object. Infopromo Communications – Bulk SMS Marketing returns the created contact object with each request.

API Endpoint

Markup
https://sms.infopromo.digital/api/http/contacts/{group_id}/store
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
PHONE
YES
numberThe phone number of the contact.
OTHER_FIELDS
NO
stringAll Contact’s other fields: FIRST_NAME (?), LAST_NAME (?),… (depending on the contact group fields configuration)
Example request
PHP
curl -X POST https://sms.infopromo.digital/api/http/contacts/6065ecdc9184a/store \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"(YOUR TOKEN STRING)",
"PHONE":"8801721970168",
"FIRST_NAME":"Jhon",
"LAST_NAME":"Doe",
}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "contacts data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
View a contact

Retrieves the information of an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation or receiving.

API Endpoint

Markup
https://sms.infopromo.digital/api/http/contacts/{group_id}/search/{uid}
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
uid
YES
stringContact uid
Example request
PHP
curl -X POST https://sms.infopromo.digital/api/http/contacts/6065ecdc9184a/search/606732aec8705 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"(YOUR TOKEN STRING)"}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "contacts data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
Update a contact

Updates an existing contact. You only need to supply the unique uid of contact and contact group uid that was returned upon creation.

API Endpoint

Markup
https://sms.infopromo.digital/api/http/contacts/{group_id}/update/{uid}
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
uid
YES
stringContact uid
PHONE
YES
numberThe phone number of the contact.
OTHER_FIELDS
NO
stringAll Contact’s other fields: FIRST_NAME (?), LAST_NAME (?),… (depending on the contact group fields configuration)
Example request
PHP
curl -X PATCH https://sms.infopromo.digital/api/http/contacts/6065ecdc9184a/update/606732aec8705 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"(YOUR TOKEN STRING)",
"PHONE":"8801721970168",
"FIRST_NAME":"Jhon",
"LAST_NAME":"Doe",
}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "contacts data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
Delete a contact

Deletes an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation.

API Endpoint

Markup
https://sms.infopromo.digital/api/http/contacts/{group_id}/delete/{uid}
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
uid
YES
stringContact uid
Example request
PHP
curl -X DELETE https://sms.infopromo.digital/api/http/contacts/6065ecdc9184a/delete/606732aec8705 \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"(YOUR TOKEN STRING)"}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "contacts data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
View all contacts in group

API Endpoint

Markup
https://sms.infopromo.digital/api/http/contacts/{group_id}/all
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
Example request
PHP
curl -X POST https://sms.infopromo.digital/api/http/contacts/6065ecdc9184a/all \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"(YOUR TOKEN STRING)"}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "contacts data with pagination",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

CONTACT GROUPS API

Infopromo Communications – Bulk SMS Marketing Contact Groups API allows you to manage contact groups that are identified by a unique random ID. Use this ID to create, view, update or delete groups.

API Endpoint

Markup
https://sms.infopromo.digital/api/http/contacts
Parameters
PARAMETERREQUIREDDESCRIPTION
api_token
YES
API Token From Developers option. Get API Token
Accept
YES
Set to application/json
Content-Type
YES
Set to application/json

Create a group

Creates a new group object. Infopromo Communications – Bulk SMS Marketing returns the created group object with each request.

API Endpoint

Markup
https://sms.infopromo.digital/api/http/contacts
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
name
YES
stringThe name of the group
Example request
PHP
curl -X POST https://sms.infopromo.digital/api/http/contacts \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"name":"Codeglen","api_token":"(YOUR TOKEN STRING)"}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "group data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
View a group

Retrieves the information of an existing group. You only need to supply the unique group ID that was returned upon creation or receiving.

API Endpoint

Markup
https://sms.infopromo.digital/api/http/contacts/{group_id}/show/
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
Example request
PHP
curl -X POST https://sms.infopromo.digital/api/http/contacts/6065ecdc9184a/show \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"(YOUR TOKEN STRING)"}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "group data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
Update a group

Updates an existing group. You only need to supply the unique ID that was returned upon creation.

API Endpoint

Markup
https://sms.infopromo.digital/api/http/contacts/{group_id}
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
name
YES
stringNew group name
Example request
PHP
curl -X PATCH https://sms.infopromo.digital/api/http/contacts/6065ecdc9184a \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"name":"Codeglen Update","api_token":"(YOUR TOKEN STRING)"}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "groups data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
Delete a group

Deletes an existing group. You only need to supply the unique id that was returned upon creation.

API Endpoint

Markup
https://sms.infopromo.digital/api/http/contacts/{group_id}
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
group_id
YES
stringContact Groups uid
Example request
PHP
curl -X DELETE https://sms.infopromo.digital/api/http/contacts/6065ecdc9184a \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"(YOUR TOKEN STRING)"}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "null",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
 
View all groups

API Endpoint

Markup
https://sms.infopromo.digital/api/http/contacts/
Example request
PHP
curl -X GET https://sms.infopromo.digital/api/http/contacts \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"(YOUR TOKEN STRING)"}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "group data with pagination",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

SMS API

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/http/sms/send
Parameters
PARAMETERREQUIREDDESCRIPTION
api_token
YES
API Token From Developers option. Get API Token
Accept
YES
Set to application/json
Content-Type
YES

Set to application/json

 
Send outbound SMS

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

Markup
https://sms.infopromo.digital/api/http/sms/send
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
recipient
YES
stringNumber to send message. Use comma (,) to send multiple numbers. Ex. 31612345678,8801721970168
sender_id
YES
stringThe 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
stringThe type of the message. For text message you have to insert plain as sms type.
message
YES
stringThe body of the SMS message.
schedule_time
NO
datetimeThe scheduled date and time of the message in RFC3339 format (Y-m-d H:i)
dlt_template_id
NO
stringThe ID of your registered DLT (Distributed Ledger Technology) content template.
Example request for Single Number
PHP
curl -X POST https://sms.infopromo.digital/api/http/sms/send \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"api_token":"(YOUR TOKEN STRING)",
"recipient":"31612345678",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message"
}'
Example request for GET method
PHP
https://sms.infopromo.digital/api/http/sms/send?recipient=31612345678&sender_id=YourName&message=test&api_token=(YOUR TOKEN STRING)
Example request for Multiple Numbers
PHP
curl -X POST https://sms.infopromo.digital/api/http/sms/send \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"api_token":"(YOUR TOKEN STRING)",
"recipient":"31612345678,880172145789",
"sender_id":"YourName",
"type":"plain",
"message":"This is a test message",
"schedule_time=2021-12-20 07:00"
}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "sms reports with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
 
View an SMS

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

Markup
https://sms.infopromo.digital/api/http/sms/{uid}
Parameters
PARAMETERREQUIREDTYPEDESCRIPTION
uid
YES
stringA unique random uid which is created on the Infopromo Communications – Bulk SMS Marketing platform and is returned upon creation of the object.
Example request
PHP
curl -X GET https://sms.infopromo.digital/api/http/sms/606812e63f78b \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"(YOUR TOKEN STRING)"}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "sms data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
 
View all messages

API Endpoint

Markup
https://sms.infopromo.digital/api/http/sms/
Example request
PHP
curl -X GET https://sms.infopromo.digital/api/http/sms \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"(YOUR TOKEN STRING)"}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "sms reports with pagination",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

PROFILE API

Infopromo Communications – Bulk SMS Marketing Profile API allows you to retrieve your total remaining sms unit, used sms unit, and your profile information.

API Endpoint

Markup
https://sms.infopromo.digital/api/http/me
Parameters
PARAMETERREQUIREDDESCRIPTION
api_token
YES
API Token From Developers option. Get API Token
Accept
YES
Set to application/json
Content-Type
YES

Set to application/json

View sms unit

API Endpoint

Markup
https://sms.infopromo.digital/api/http/balance
Example request
PHP
curl -X GET https://sms.infopromo.digital/api/http/balance \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"(YOUR TOKEN STRING)"}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "sms unit with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}
 
View Profile

API Endpoint

Markup
https://sms.infopromo.digital/api/http/me
Example request
PHP
curl -X GET https://sms.infopromo.digital/api/http/me \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{"api_token":"(YOUR TOKEN STRING)"}'
Returns

Returns a contact object if the request was successful.

JSON
{
    "status": "success",
    "data": "profile data with all details",
}

If the request failed, an error object will be returned.

JSON
{
    "status": "error",
    "message" : "A human-readable description of the error."
}

API docs

https://email.infopromo.digital/frontend/docs/api/v1 link

API Endpoint

https://email.infopromo.digital/api/v1

Your API token

Click to register/ login to access YOUR_API_TOKEN

You need to add parameter api_token=YOUR_API_TOKEN to each request to the API system
Example: https://email.infopromo.digital/api/v1/lists?api_token=YOUR_API_TOKEN

AUTHENTICATION

HTTP methodEndpointFunction
POST/api/v1/login-tokenGenerate one time login token
 

Returns

Token string

Example:

curl -X POST -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/login-token \
-d api_token=(YOUR API TOKEN)

User can login by visiting the following URL:
https://email.infopromo.digital/login/token/*|token_string|*

 

LISTS

HTTP methodEndpointFunction
POST/api/v1/listsNew list
 

Parameters

$name
List’s name
$from_email
Default From email address
$from_name
Default From name
divider
Contact information
$contact[company]
Name
$contact[state]
State / Province / Region
$contact[address_1]
Address 1
$contact[address_2]
Address 2
$contact[city]
City
$contact[zip]
Zip / Postal code
$contact[phone]
Phone
$contact[country_id]
Country id
$contact[email]
Email
$contact[url]   optional
Home page
$subscribe_confirmation
Send subscription confirmation email (Double Opt-In)
$send_welcome_email
Send a final welcome email
$unsubscribe_notification
Send unsubscribe notification to subscribers
$send_welcome_email
Send a final welcome email

Returns

Creation messages in json

Example:

curl -X POST -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/lists \
-d api_token=(YOUR API TOKEN) \
-d name=List+1 \
-d from_email=admin@abccorp.org \
-d from_name=ABC+Corp. \
-d contact[company]=ABC+Corp. \
-d contact[state]=Armagh \
-d contact[address_1]=14+Tottenham+Court+Road+London+England \
-d contact[address_2]=44-46+Morningside+Road+Edinburgh+Scotland+EH10+4BF \
-d contact[city]=Noname \
-d contact[zip]=80000 \
-d contact[phone]=123+456+889 \
-d contact[country_id]=1 \
-d contact[email]=info@abccorp.org \
-d contact[url]=http://www.abccorp.org \
-d subscribe_confirmation=1 \
-d send_welcome_email=1 \
-d unsubscribe_notification=1
GET/api/v1/listsGet information about all lists
 

Returns

List of all user’s mail lists in json

Example:

curl -X GET -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/lists \
-d api_token=(YOUR API TOKEN)
GET/api/v1/lists/{uid}Get information about a specific list
 

Returns

All list informations in json

Example:

curl -X GET -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/lists/{uid} \
-d api_token=(YOUR API TOKEN)
POST/api/v1/lists/{uid}/add-fieldAdd custom field to list
 

Parameters

$type
Choose one of these types: text, number, datetime.
$label
Field’ label
$tag
The tag name may have alpha-numeric characters, as well as dashes and underscores.
$default_value   optional
Default value of the field

Returns

Creation messages in json

Example:

curl -X POST -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/lists/{uid}/add-field \
-d api_token=(YOUR API TOKEN) \
-d type=text \
-d label=Custom \
-d tag=CUSTOM_FIELD_1 \
-d default_value=test
DELETE/api/v1/lists/{uid}Delete a list
 

Parameters

$uid
List’s uid

Returns

Result messages in json

Example:

curl -X DELETE -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/lists/{uid} \
-d api_token=(YOUR API TOKEN)
 

CAMPAIGNS

HTTP methodEndpointFunction
GET/api/v1/campaignsGet information about all campaigns
 

Returns

List of all user’s campaigns in json

Example:

curl -X GET -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/campaigns \
-d api_token=(YOUR API TOKEN)
POST/api/v1/campaignsAdd new campaign
 

Parameters

$list_uid
List’s uid
$name
New campaign name
$subject
Email subject
$from_email
From email
$from_name
From name
$reply_to
Reply-to email
$track_open   optional – default: true
Track open (true|false)
$track_click   optional – default: true
Track click (true|false)
$sign_dkim   optional – default: true
Sign dkim (true|false)
$skip_failed_messages   optional – default: false
Track open (true|false)

Returns

New campaign’s information in json

Example:

curl -X POST -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/campaigns \
-d api_token=(YOUR API TOKEN) \
-d mail_list_uid={list_uid} \
-d name=MyCampaign \
-d subject=HelloWorld \
-d from_email=noreply@gmail.com \
-d from_name=NoReply \
-d reply_to=noreply@gmail.com \
-d track_open=true \
-d track_click=true \
-d sign_dkim=false \
-d skip_failed_messages=false
GET/api/v1/campaigns/{uid}Get information about a specific campaign
 

Returns

Campaign’s information in json

Example:

curl -X GET -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/campaigns/{uid} \
-d api_token=(YOUR API TOKEN)
PATCH/api/v1/campaigns/{uid}Update campaign
 

Parameters

$list_uid
List’s uid
$name
Campaign name
$subject
Email subject
$from_email
From email
$from_name
From name
$reply_to
Reply-to email
$track_open   optional – default: true
Track open (true|false)
$track_click   optional – default: true
Track click (true|false)
$sign_dkim   optional – default: true
Sign dkim (true|false)
$skip_failed_messages   optional – default: false
Track open (true|false)

Returns

New campaign’s information in json

Example:

curl -X PATCH -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/campaigns/{uid} \
-d api_token=(YOUR API TOKEN) \
-d name=MyCampaign2 \
-d subject=HelloWorld2 \
-d sign_dkim=true
POST/api/v1/campaigns/{uid}/runRun a specific campaign
 

Returns

Action messages in json

Example:

curl -X POST -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/campaigns/{uid}/run \
-d api_token=(YOUR API TOKEN)
POST/api/v1/campaigns/{uid}/pausePause a specific campaign
 

Returns

Action messages in json

Example:

curl -X POST -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/campaigns/{uid}/pause \
-d api_token=(YOUR API TOKEN)
POST/api/v1/campaigns/{uid}/resumeResume a specific campaign
 

Returns

Action messages in json

Example:

curl -X POST -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/campaigns/{uid}/resume \
-d api_token=(YOUR API TOKEN)
DELETE/api/v1/campaigns/{uid}Delete a campaign
 

Parameters

$uid
Campaign’s uid

Returns

Result messages in json

Example:

curl -X DELETE -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/campaigns/{uid} \
-d api_token=(YOUR API TOKEN)
 

SUBSCRIBERS

HTTP methodEndpointFunction
GET/api/v1/subscribersDisplay list’s subscribers
 

Parameters

$list_uid
List’s uid
$open   optional – default: all
yes – opened some campaigns
no – not opened any campaign
$click   optional – default: all
yes – clicked some campaigns
no – not clicked any campaign
$per_page   optional – default: 25
Number of subscribers per page
$page
Page number

Returns

List of all list’s subscribers in json

Example:

curl -X GET -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/subscribers \
-d api_token=(YOUR API TOKEN) \
-d list_uid={list_uid} \
-d per_page=20 \
-d page=1
POST/api/v1/subscribersCreate subscriber for a mail list
 

Parameters

$list_uid
List’s uid
$EMAIL
Subscriber’s email
$tag   optional
Subscriber’s tags, seperated by a comma (,).
$status   optional
Subscriber’s status: subscribed | unsubscribed | unconfirmed
$[OTHER_FIELDS…]   optional
All subscriber’s other fields: FIRST_NAME (?), LAST_NAME (?),… (depending on the list fields configuration)

Returns

Creation messages in json

Example:

curl -X POST -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/subscribers \
-d api_token=(YOUR API TOKEN) \
-d list_uid={list_uid} \
-d EMAIL=test@gmail.com \
-d tag=foo,bar,tag+with+space, \
-d FIRST_NAME=Marine \
-d LAST_NAME=Joze \
-d status=subscribed
GET/api/v1/subscribers/{uid}Get information about a specific subscriber
 

Parameters

$uid
Subsciber’s uid or email

Returns

All subscriber information in json

Example:

curl -X GET -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/subscribers/{uid} \
-d api_token=(YOUR API TOKEN)
PATCH/api/v1/subscribers/{uid}Update subscriber for a mail list
 

Parameters

$uid
Subscriber’s uid
$EMAIL
Subscriber’s email
$tag   optional
Subscriber’s tags, seperated by a comma (,).
$[OTHER_FIELDS…]   optional
All subscriber’s other fields: FIRST_NAME (?), LAST_NAME (?),… (depending on the list fields configuration)

Returns

Update messages in json

Example:

curl -X PATCH -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/subscribers/{uid} \
-d api_token=(YOUR API TOKEN) \
-d EMAIL=test@gmail.com \
-d tag=foo,bar,tag+with+space, \
-d FIRST_NAME=Marine \
-d LAST_NAME=Joze \
-d status=unsubscribed
POST/api/v1/subscribers/{uid}/add-tagAdd tag(s) to subscriber
 

Parameters

$tag   optional
Subscriber’s tags, seperated by a comma (,).

Returns

Creation messages in json

Example:

curl -X POST -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/subscribers/{uid}/add-tag \
-d api_token=(YOUR API TOKEN) \
-d tag=foo,bar,tag+with+space
GET/api/v1/subscribers/email/{email}Find subscribers with email
 

Parameters

$email
Subsciber’s email

Returns

All subscribers with the email

Example:

curl -X GET -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/subscribers/email/{email} \
-d api_token=(YOUR API TOKEN)
PATCH/api/v1/lists/{list_uid}/subscribers/{uid}/subscribeSubscribe a subscriber
 

Parameters

$list_uid
List’s uid
$uid
Subsciber’s uid

Returns

Result messages in json

Example:

curl -X PATCH -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/lists/{list_uid}/subscribers/{uid}/subscribe \
-d api_token=(YOUR API TOKEN)
PATCH/api/v1/lists/{list_uid}/subscribers/{uid}/unsubscribeUnsubscribe a subscriber
 

Parameters

$list_uid
List’s uid
$uid
Subsciber’s uid

Returns

Result messages in json

Example:

curl -X PATCH -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/lists/{list_uid}/subscribers/{uid}/unsubscribe \
-d api_token=(YOUR API TOKEN)
PATCH/api/v1/lists/{list_uid}/subscribers/email/{email}/unsubscribeUnsubscribe a subscriber by email
 

Parameters

$list_uid
List’s uid
$email
Subsciber’s email

Returns

Result messages in json

Example:

curl -X PATCH -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/lists/{list_uid}/subscribers/email/{email}/unsubscribe \
-d api_token=(YOUR API TOKEN)
DELETE/api/v1/subscribers/{uid}Delete a subscriber
 

Parameters

$list_uid
List’s uid
$uid
Subsciber’s uid

Returns

Result messages in json

Example:

curl -X DELETE -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/subscribers/{uid} \
-d api_token=(YOUR API TOKEN)
 

NOTIFICATION

HTTP methodEndpointFunction
POST/api/v1/notificationSend a delivery or abuse report to the application. It could be a success / bounce / feedback or abuse report
 

Parameters

$message_id
Message’s id
$type
One of 4 types: sent | bounced | reported | failed
$bounce_type
Required if type is bounced
$report_type
Required if type is reported
$description
Notification message

Returns

Action messages in json

Example:

curl -X POST -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/notification \
-d api_token=(YOUR API TOKEN)  \
-d message_id=201637442604422402.6199642caf7f3@example.com  \
-d type=sent
curl -X POST -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/notification \
-d api_token=(YOUR API TOKEN)  \
-d message_id=201637442604422402.6199642caf7f3@example.com  \
-d type=bounced \
-d bounce_type=hard \
-d description=Email+address+does+not+exist
curl -X POST -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/notification \
-d api_token=(YOUR API TOKEN)  \
-d message_id=201637442604422402.6199642caf7f3@example.com  \
-d type=abuse \
-d report_type=hard \
-d description=Email+address+does+not+exist
curl -X POST -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/notification \
-d api_token=(YOUR API TOKEN)  \
-d message_id=201637442604422402.6199642caf7f3@example.com  \
-d type=spam \
-d report_type=hard \
-d description=Email+address+does+not+exist
curl -X POST -H "accept:application/json" -G \
https://email.infopromo.digital/api/v1/notification \
-d api_token=(YOUR API TOKEN)  \
-d message_id=201637442604422402.6199642caf7f3@example.com  \
-d type=failed \
-d description=Email+address+does+not+exist
 

FILE

HTTP methodEndpointFunction
POST/api/v1/file/uploadUpload file(s) to customer’s storage
 

Parameters

$file_url
File url
$subdirectory   optional – default: user root directory
Custom subdirectory

Returns

Upload result message
 

In its beta stage, coming soon!!!

Be the first to be informed