Parameters
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 |
Send outbound SMS
SMS NOC’s Programmable SMS API enables you to programmatically send SMS messages from your web application. First, you need to create a new message object. SMS NOC returns the created message object with each request.
Send your first SMS message with this example request.
Parameters
Parameter | Required | Type | Description | |
---|---|---|---|---|
recipient | YES | string | Number to send message. Use comma (,) to send multiple numbers. Ex. 31612345678,8801744977947 | |
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 | YES | datetime | The scheduled date and time of the message in RFC3339 format (Y-m-d H:i) |
Example request for Single Number
PHP
curl -X POST https://app.smsnoc.com/api/v3/sms/send \
-H 'Authorization: Bearer 1586|eoe2hsdhbuyg2unewkjfewry743741bb8qe' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"8801744977947",
"sender_id":"YourName/Number",
"type":"plain",
"message":"This is a test message"
}'
Example request for Multiple Numbers
PHP
curl -X POST https://app.smsnoc.com/api/v3/sms/send \
-H 'Authorization: Bearer 1586|eoe2hsdhbuyg2unewkjfewry743741bb8qe' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"recipient":"8801744977947,8801754228383",
"sender_id":"YourName/Number",
"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."
}
Show SMS Balance
View Your SMS Balance with this example request.
Returns
Returns a contact object if the request was successful.
JSON
{
"status": "success",
"data": "sms Balance 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
SMS NOC's Programmable SMS API enables you to programmatically send Campaigns from your web application. First, you need to create a new message object. SMS NOC returns the created message object with each request.
Send your first Campaign Using Contact List with this example request.
Parameters
Parameter | Required | Type | Description | |
---|---|---|---|---|
contact_list_id | YES | string | Contact list to send message. Use comma (,) to send multiple contact lists. Ex. 641159070d0d7a6,64159007d0d347a | |
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 | YES | datetime | The scheduled date and time of the message in RFC3339 format (Y-m-d H:i) |
Example request for Single Contact List
PHP
curl -X POST https://app.smsnoc.com/api/v3/sms/campaign \
-H 'Authorization: Bearer 1586|eoe2hsdhbuyg2unewkjfewry743741bb8qe' \
-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://app.smsnoc.com/api/v3/sms/campaign \
-H 'Authorization: Bearer 1586|eoe2hsdhbuyg2unewkjfewry743741bb8qe' \
-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."
}
Example request for Show/View SMS Balance
PHP
curl -X GET https://app.smsnoc.com/api/v3/balance \
-H 'Authorization: Bearer 1586|eoe2hsdhbuyg2unewkjfewry743741bb8qe' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
View an SMS
You can use SMS NOC’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://app.smsnoc.com/api/v3/sms/{uid}
Parameters
Parameter | Required | Type | Description |
---|---|---|---|
uid | YES | string | A unique random uid which is created on the SMS NOC platform and is returned upon creation of the object. |
Example request
PHP
curl -X GET https://app.smsnoc.com/api/v3/sms/609681630f78b \
-H 'Authorization: Bearer 1586|eoe2hsdhbuyg2unewkjfewry743741bb8qe' \
-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."
}
Example request
API Endpoint
PHP
curl -X GET https://app.smsnoc.com/api/v3/sms \
-H 'Authorization: Bearer 1586|eoe2hsdhbuyg2unewkjfewry743741bb8qe' \
-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."
}
HTTP API Documets
Example request for GET method
https://app.smsnoc.com/api/http/sms/send?recipient=88017000000&sender_id=YourSenderIDNameOrYourSenderNumber&message=test&api_token=1|xgUwTcsdsfd6sfYYGX9JafdQ903h87808
আমাদের সাপোর্ট টিম 24 ঘন্টা এবং সপ্তাহে ৭ দিন আপনাকে সেবা দিতে প্রস্তুত আছে।
- Department: support
- Contact: 01754228383
- Email: support@smsnoc.com
- Website: www.smsnoc.com