* Before using the sample code, first initialize the credentials and api domain in theconfig/config.php file.
* content_type value options: English = 1 UNICODE = 3
* API Base Url : https://sms.tmssict.com/
A2P API Response Code Map
| STATUS CODE | MESSAGE | DESCRIPTION |
|---|---|---|
| 200 | success_message |
Success |
| 500 | INVALID_NUMBER | Number Must be 11 without 88 dont add special character(+,.) |
| 500 | INVALID_MESSAGE_LENGTH |
Maximum 1000 Character Acceptable |
| 300 | content_type_required |
The content type field is required. |
| 500 | api_key_message |
API Key Missing |
Check Balance API
Description :
To check the remaining balance status of your account (registered account),you can use this api
Request :
URL : POST /api/v001/balance
Headers :
[
* Accept : application/json,
* api_key(required) :2f2bc1f3c4a74897ea257481084e,
]Params : [ ]
Sample Success Response
{
"balance": {
"amount": 11034.25,
"api_response_code": 200,
"api_response_message": ""
}
}
Sample Failed Response
{
"campaign_uid": null,
"sms_uid": null,
"api_response_code": 500,
"api_response_message": "Api key Missing"
}
Campaign Status Check API
Description :
To check the individual campaign status, you can call this API.
Request :
URL : POST /api/v001/campaign-status
Headers :
[
* Accept : application/json,
* api_key(required) :2f2bc1f3c4a74897ea257481084e,
]Params :
[
* campaign_uid : CXXXXXXXXXXXXXXXX
* number : 0172588888
* date : 2024-02-11
Sample Success Response
{
"campaign": {
"campaign_uid": "CXXXXXXXXXXXXXXXX",
"campaign_title": "API_Single_SMS_2018-05-18",
"scheduled_time": "2018-05-18 17:51",
"summary": {
"pending": 0,
"success": 5,
"failed": 0
}
},
"api_response_code": 200,
"api_response_message": "SUCCESS"
}
Sample Failed Response
{
"campaign": {},
"api_response_code": 400,
"api_response_message": "FAILED",
"error": {
"error_code": 5004,
"error_message": "RECORD_NOT_FOUND"
}
}
SMS Status Check API
Description :
If you want to send SMS to a single/individual recipient (mobile number), you can use this API.
Request :
URL : POST /api/v001/status
Headers :
[
* Accept : application/json,
* api_key(required) :2f2bc1f3c4a74897ea257481084e,
]Params :
[
* request_type(required, value: SINGLE_SMS)
* message_type(required, value: TEXT | UNICODE)
* mobile(required)
* message_body(required)
Sample Success Response
{
"request_type": "single_sms",
"campaign_uid": "CXXXXXXXXXXXXXXXX",
"sms_uid": "SXXXXXXXXXXXXXXXX",
"invalid_numbers": [],
"api_response_code": 200,
"api_response_message": "SUCCESS"
}
Send SMS API (Bulk SMS)
Description :
If you want to send same SMS to multiple recipients (i.e. mobile numbers), you can use this API. Note: You can send maximum 1000 SMS via Bulk SMS API in a single request.
Note: multiple mobile numbers should be comma-separated.
Request :
URL : POST /api/v001/sent_sms
Headers :
[
* Accept : application/json,
* api_key(required) :2f2bc1f3c4a74897ea257481084e,
]Params :
[
* request_type(required, value: SINGLE_SMS)
* message_type(required, value: TEXT | UNICODE)
* mobile(required)
* message_body(required)
* isPromotional(value: 0 | 1)
* campaign_title(required)
Sample Success Response
{
"request_type": "GENERAL_CAMPAIGN",
"campaign_uid": "CXXXXXXXXXXXXXXXX",
"sms_uid": null,
"invalid_numbers": [
"0144511455445"
],
"api_response_code": 200,
"api_response_message": "SUCCESS"
}
SMS HISTORY API (Bulk SMS)
Description :
If you want to see sms history, you can use this API.
Request :
URL : POST /api/v001/history
Headers :
[
* Accept : application/json,
* api_key(required) :2f2bc1f3c4a74897ea257481084e,
]Params :[ ]
Sample Success Response
{
"status": 2000,
"result": {
"total_request": 158,
"total_success": 124,
"total_failed": 34,
"api_pending": 22
}
}