Contacts, Contact Group & Profile 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 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
https://sms.infopromo.digital/api/v3/contacts| Parameter | Required | Description |
|---|---|---|
| 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 |
Creates a new contact object. Infopromo Communications – Bulk SMS Marketing returns the created contact object with each request.
API Endpoint
https://sms.infopromo.digital/api/v3/contacts/{group_id}/store
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
| PHONE | Yes | number | The phone number of the contact. |
| OTHER_FIELDS | No | string | All Contact’s other fields: FIRST_NAME (?), LAST_NAME (?),… (depending on the contact group fields configuration) |
curl -X POST https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a/store \ -H 'Authorization: Bearer {your api_token}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -d '{ "PHONE":"8801721970168", "FIRST_NAME":"Jhon", "LAST_NAME":"Doe", }'
Returns a contact object if the request is successful.
{ "status": "success", "data": "contacts data with all details", }
If the request fails, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
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
https://sms.infopromo.digital/api/v3/contacts/{group_id}/search/{uid}
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
| uid | Yes | string | Contact uid |
curl -X POST https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a/search/606732aec8705 \ -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": "contacts data with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
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
https://sms.infopromo.digital/api/v3/contacts/{group_id}/update/{uid}
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
| uid | Yes | string | Contact uid |
| PHONE | Yes | number | The phone number of the contact. |
| OTHER_FIELDS | No | string | All Contact’s other fields: FIRST_NAME (?), LAST_NAME (?),… (depending on the contact group fields configuration) |
curl -X PATCH https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a/update/606732aec8705 \ -H 'Authorization: Bearer {your api_token}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -d '{ "PHONE":"8801721970168", "FIRST_NAME":"Jhon", "LAST_NAME":"Doe", }'
Returns a contact object if the request was successful.
{ "status": "success", "data": "contacts data with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
Deletes an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation.
API Endpoint
https://sms.infopromo.digital/api/v3/contacts/{group_id}/delete/{uid}
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
| uid | Yes | string | Contact uid |
curl -X DELETE https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a/delete/606732aec8705 \ -H 'Authorization: Bearer {your api_token}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \
Returns a contact object if the request is successful.
{ "status": "success", "data": "contacts data with all details", }
If the request fails, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
API Endpoint
https://sms.infopromo.digital/api/v3/contacts/{group_id}/all
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
curl -X POST https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a/all \ -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": "contacts data with pagination", }
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 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
https://sms.infopromo.digital/api/http/contacts| 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 |
Creates a new contact object. Infopromo Communications – Bulk SMS Marketing returns the created contact object with each request.
API Endpoint
https://sms.infopromo.digital/api/http/contacts/{group_id}/store
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
| PHONE | Yes | number | The phone number of the contact. |
| OTHER_FIELDS | No | string | All Contact’s other fields: FIRST_NAME (?), LAST_NAME (?),… (depending on the contact group fields configuration) |
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 api_token}", "PHONE":"8801721970168", "FIRST_NAME":"Jhon", "LAST_NAME":"Doe", }'
Returns a contact object if the request is successful.
{ "status": "success", "data": "contacts data with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
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
https://sms.infopromo.digital/api/http/contacts/{group_id}/search/{uid}
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
| uid | Yes | string | Contact uid |
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 api_token}"}'
Returns a contact object if the request was successful.
{ "status": "success", "data": "contacts data with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
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
https://sms.infopromo.digital/api/http/contacts/{group_id}/update/{uid}
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
| uid | Yes | string | Contact uid |
| PHONE | Yes | number | The phone number of the contact. |
| OTHER_FIELDS | No | string | All Contact’s other fields: FIRST_NAME (?), LAST_NAME (?),… (depending on the contact group fields configuration) |
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 api_token}", "PHONE":"8801721970168", "FIRST_NAME":"Jhon", "LAST_NAME":"Doe", }'
Returns a contact object if the request is successful.
{ "status": "success", "data": "contacts data with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
Deletes an existing contact. You only need to supply the unique contact uid and group uid that was returned upon creation.
API Endpoint
https://sms.infopromo.digital/api/http/contacts/{group_id}/delete/{uid}
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
| uid | Yes | string | Contact uid |
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 api_token}"
}'
Returns a contact object if the request was successful.
{ "status": "success", "data": "contacts 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/contacts/{group_id}/all
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
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 api_token}"
}'
Returns a contact object if the request was successful.
{ "status": "success", "data": "contacts data with pagination", }
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 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
https://sms.infopromo.digital/api/v3/contacts| 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 |
Creates a new group object. Infopromo Communications – Bulk SMS Marketing returns the created group object with each request.
API Endpoint
https://sms.infopromo.digital/api/v3/contacts| Parameter | Required | Type | Description |
|---|---|---|---|
| name | Yes | string | The name of the group |
curl -X POST https://sms.infopromo.digital/api/v3/contacts \ -H 'Authorization: Bearer {your api_token}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -d '{"name":"Codeglen"}'
Returns a contact object if the request was successful.
{ "status": "success", "data": "group data with all details",
}
If the request fails, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
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
https://sms.infopromo.digital/api/v3/contacts/{group_id}/show/
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
curl -X POST https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a/show \ -H 'Authorization: Bearer {your api_token}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \
Returns a contact object if the request is successful.
{ "status": "success", "data": "group data with all details", }
If the request fails, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
Updates an existing group. You only need to supply the unique ID that was returned upon creation.
API Endpoint
https://sms.infopromo.digital/api/v3/contacts/{group_id}
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
| name | Yes | string | New group name |
curl -X PATCH https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a \ -H 'Authorization: Bearer {your api_token}' \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -d '{"name":"Codeglen Update"}'
Returns a contact object if the request is successful.
{ "status": "success", "data": "groups data with all details", }
If the request fails, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
Deletes an existing group. You only need to supply the unique id that was returned upon creation.
API Endpoint
https://sms.infopromo.digital/api/v3/contacts/{group_id}
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
curl -X DELETE https://sms.infopromo.digital/api/v3/contacts/6065ecdc9184a \ -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": "null", }
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/contacts/curl -X GET https://sms.infopromo.digital/api/v3/contacts \ -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": "group data with pagination", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
#HTTP_DocsAPInav
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
https://sms.infopromo.digital/api/http/contacts| 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 |
Creates a new group object. Infopromo Communications – Bulk SMS Marketing returns the created group object with each request.
API Endpoint
https://sms.infopromo.digital/api/http/contacts| Parameter | Required | Type | Description |
|---|---|---|---|
| name | Yes | string | The name of the group |
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 api_token}"
}'
Returns a contact object if the request was successful.
{ "status": "success", "data": "group data with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
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
https://sms.infopromo.digital/api/http/contacts/{group_id}/show/| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
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 api_token}"}'
Returns a contact object if the request was successful.
{ "status": "success", "data": "group data with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
Updates an existing group. You only need to supply the unique ID that was returned upon creation.
API Endpoint
https://sms.infopromo.digital/api/http/contacts/{group_id}
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
| name | Yes | string | New group name |
curl -X PATCH https://sms.infopromo.digital/api/http/contacts/6065ecdc9184a \ -H 'Content-Type: application/json' \ -H 'Accept: application/json' \ -d '{"name":"Infopromo Group","api_token":"{your api_token}"}'
Returns a contact object if the request was successful.
{ "status": "success", "data": "groups data with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
Deletes an existing group. You only need to supply the unique id that was returned upon creation.
API Endpoint
https://sms.infopromo.digital/api/http/contacts/{group_id}
| Parameter | Required | Type | Description |
|---|---|---|---|
| group_id | Yes | string | Contact Groups uid |
curl -X DELETE https://sms.infopromo.digital/api/http/contacts/6065ecdc9184a \ -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": "null", }
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/contacts/curl -X GET https://sms.infopromo.digital/api/http/contacts \ -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": "group data with pagination", }
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 Profile API allows you to retrieve your total remaining sms unit, used sms unit, and your profile information.
API Endpoint
https://sms.infopromo.digital/api/v3/me| 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 |
API Endpoint
https://sms.infopromo.digital/api/v3/balancecurl -X GET https://sms.infopromo.digital/api/v3/balance \ -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 unit 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/mecurl -X GET https://sms.infopromo.digital/api/v3/me \ -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": "profile 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 Profile API allows you to retrieve your total remaining sms unit, used sms unit, and your profile information.
API Endpoint
https://sms.infopromo.digital/api/http/me| 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 |
API Endpoint
https://sms.infopromo.digital/api/http/balancecurl -X GET https://sms.infopromo.digital/api/http/balance \ -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 unit 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/mecurl -X GET https://sms.infopromo.digital/api/http/me \ -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": "profile data with all details", }
If the request failed, an error object will be returned.
{ "status": "error", "message" : "A human-readable description of the error." }
