Benefit from Bulk SMS

Benefit from Bulk SMS

At Naikbeen.net we’ve seen first-hand the impact a Bulk SMS provider can have when used effectively, and witnessed it being used to grow revenue and drive results by companies ranging from large scale multinationals to smaller franchisees and soles traders. How can Bulk SMS messaging benefit your business? More »

Platform Integration

Platform Integration

Send messages in bulk directly from our custom built MXT platform, or via integration with your existing CRM using one of our flexible APIs. Choose the channel that best suits you. More »

Sales Competitions & Promotions

Sales Competitions & Promotions

Combine with 2-Way SMS, allowing you to create interactive and engaging marketing campaigns that can be sent, monitored and replied to, all via one platform More »

Real Time Information

Real Time Information

No delays or interruptions, have your inbound messages received in real time, allowing you to follow-up and respond instantly. More »

All In One Location

All In One Location

Don’t be daunted by the sheer volume of messages sent. Have all reply messages forwarded directly to your email inbox or CRM of choice. Here you will be able to reply to individual messages, re-send to larger groups or follow up with calls. More »

 

API

Version 2.1C

Introduction

With Naikbeen SMS API you can send SMS messages to 7+ billion subscribers of 1000+ Mobile Operators in 200+ countries.

The SMS API is based on REST. It uses built-in HTTP authentication and HTTP status codes. All data exchange is done in JSON format.

To test the SMS API, you will need a valid API account. If you don’t have one yet, click here to register for a FREE account.

Authentication

https://[HOST]/apis/auth

SMS

https://[HOST]/apis/sms/mt/v2/

[HOST]

Replace [HOST] with your API account domain name or IP.

Authentication

Each request must be accompanied by a valid access_token. access_token are generated upon successful authentication. To authenticate you must send an auth request.

https://[host]/apis/auth

This request accepts parameters type with value access_token , username and password.

access_token

If the request succeeded, an authentication object is returned, which includes an access_token and a refresh_token. Otherwise, an error is returned. access_token grants you access to make requests.

Setup the Authorization HTTP header with your access_token. Authorization: Bearer dcec4eb6-035c-41a4-9871-82c5bd3ef379

access_token is valid for 30 minutes, after which it expires. To preserve connection you must either refresh with refresh_token or reset connection and request a new access_token.

refresh_token

To refresh connection you must send an auth request.

https://[host]/apis/auth

This request accepts parameters type with value “refresh_token” , refresh_token with value the refresh token, provided by a previously successful auth request.

Authentication

POST https://[HOST]/apis/auth

POST https://[HOST]/apis/auth

Content-Type : application/json

{

“type” : “access_token”,

“username” : “myusername”,

“password” : “mypassword”

}

{

“status_code” : 200,

“status_message” : “OK”,

“payload” : {

“access_token” : “dcec4eb6-035c-41a4-9871-82c5bd3ef379”,

“validity_period” : 1800,

“refresh_token” : “d32dc41f-6545-4bdc-a980-79e376bbd641”

}

}

Refresh Connection

POST https://[HOST]/apis/auth

Content-Type : application/json

{

“type” : “refresh_token”,

“refresh_token” : “d32dc41f-6545-4bdc-a980-79e376bbd641”,

}

{

“status_code” : 200,

“status_message” : “OK”,

“payload” : {

“access_token” : “0e3f6ecb-7a7e-4d03-a004-d710db8978ab”,

“validity_period” : 1800,

“refresh_token” : “ecbb4d30-6da2-4b78-998e-d01025c648f2”

}

}

Send Single SMS

To send an sms you must send a send POST request.

https://[host]/apis/sms/mt/v2/send

Set parameters to with the the recipient mobile number phone in international E.164 format and from with your preferred sender.

Finally, setup parameter message with your message text.

Remember to setup the Authorization HTTP header with your access_token.

Congratulations! You just sent your first SMS using the SMS API.

If the request succeeded, an object is returned, which includes submission status, message id, type of message and the initial cost of the sms message. (Notice: the initial cost is calculated based on the prefix of the recipient’s number. Final cost is calculated when the SMS is sent by the platform, where more advanced identification processes are used ) Otherwise, an error is returned.

Send Single SMS

POST https://[host]/apis/sms/mt/v2/send

POST https://[host]/apis/sms/mt/v2/send

Content-Type : application/json

[

{

“to” : [“447945223343”],

“from” : “HelloWorld”,

“message” : “My first SMS message.”

}

]

{

“status_code” : 200,

“status_message” : “OK”,

“payload” : [

{

“status” : “submitted”,

“id” : 543521789981,

“to” : “447945223343”,

“from” : “HelloWorld”,

“message” : “My first SMS message.”,

“operator_id” : 765,

“cost” : “0.0400”

}

]

}

Multilingual Support

POST https://[host]/apis/sms/mt/v2/send

Content-Type : application/json

[

{

“to” : [“8613054782931”],

“from” : “HELLO”,

“message” : “早上好我的朋友”

}

]

{

“status_code” : 200,

“status_message” : “OK”,

“payload” : [

{

“status” : “submitted”,

“id” : 543521789982,

“to” : “8613054782931”,

“from” : “HELLO”,

“message” : “早上好我的朋友”,

“operator_id” : 765,

“cost” : “0.0400”

}

]

}

Send Multiple SMS

To send multiple sms you must send a send POST request.

https://[host]/apis/sms/mt/v2/send

Set parameters message with your message text and from with your preferred sender.

Now, set parameter to with an array of the recipient mobile numbers in international E.164 format.

In this request, body is enclosed in an array. Repeat adding objects to send SMS with different messages and/or senders to multiple recipients.

Remember to setup the Authorization HTTP header with your access_token.

Congratulations! You just sent multiple SMS using one request.

If the request succeeded, a response object is returned, which includes id, broadcast_date, expiration_date and the cost of the sms. Otherwise, an error is returned.

Send Multiple SMS

POST https://[host]/apis/sms/mt/v2/send

Content-Type : application/json

[

{

“to” : [“447945223343”],

“from” : “OTP PIN”,

“message” : “Your one time pin is: 875529”

},

{

“to” : [“447945223342″,”447945223341”],

“from” : “Alert”,

“message” : “A product in your watchlist is on discount. For more

information click here: http://bit.ly/1jL3YEw”

}

]

{

“status_code” : 200,

“status_message” : “OK”,

“payload” : [

{

“status” : “submitted”,

“id” : 543521789995,

“to” : “447945223343”,

“from” : “OTP PIN”,

“message” : “Your one time pin is: 875529”,

“operator_id” : 765,

“cost” : “0.0400”

},

{

“status” : “submitted”,

“id” : 543521789996,

“to” : “447945223342”,

“from” : “Alert”,

“message” : “A product in your watchlist is on discount. For

more information click here: http://bit.ly/1jL3YEw”,

“operator_id” : 765,

“cost” : “0.0400”

},

{

“status” : “submitted”,

“id” : 543521789997,

“to” : “447945223341”,

“from” : “Alert”,

“message” : “A product in your watchlist is on discount. For

more information click here: http://bit.ly/1jL3YEw”,

“operator_id” : 765,

“cost” : “0.0400”

}

]

}

Send WAP Push

To send a WAP Push you must send a send POST request.

https://[host]/apis/sms/mt/v2/send

Set parameters to with the the recipient mobile number phone in international E.164 format and from with your preferred sender.

Setup parameter wap_title with your preferred title.

Setup parameter wap_url to your resource URI (image / document /video etc) location.

Finally, setup message_type with value “wap_push”.

Remember to setup the Authorization HTTP header with your access_token.

Congratulations! You just sent a WAP Push using the SMS API.

If the request succeeded, an object is returned, which includes submission status, message id, type of message and the initial cost of the sms message. (Notice: the initial cost is calculated based on the prefix of the recipient’s number. Final cost is calculated when the SMS is sent by the platform, where more advanced identification processes are used ) Otherwise, an error is returned.

Send WAP Push

POST https://[host]/apis/sms/mt/v2/send

POST https://[host]/apis/sms/mt/v2/send

Content-Type : application/json

[

{

“to” : [“447945223343”],

“from” : “Purchase”,

“wap_title” : “Your purchase link”,

“wap_url” : “http://bit.ly/1Rmmw1b”,

“message_type” : “wap_push”

}

]

{

“status_code” : 200,

“status_message” : “OK”,

“payload” : [

{

“status” : “submitted”,

“id” : 543521790030,

“to” : “447945223343”,

“from” : “Purchase”,

“wap_title” : “Your purchase link”,

“wap_url” : “http://bit.ly/1Rmmw1b”,

“operator_id” : 765,

“cost” : “0.0400”

}

]

}

Send Flash SMS

To send a flash you must send a send POST request.

https://[host]/apis/sms/mt/v2/send

Set parameters to with the the recipient mobile number phone in international E.164 format and from with your preferred sender.

Setup parameter message with your message text.

Finally, setup message_type with value “flash”.

Remember to setup the Authorization HTTP header with your access_token.

Congratulations! You just sent a flash SMS using the SMS API.

If the request succeeded, an object is returned, which includes submission status, message id, type of message and the initial cost of the sms message. (Notice: the initial cost is calculated based on the prefix of the recipient’s number. Final cost is calculated when the SMS is sent by the platform, where more advanced identification processes are used ) Otherwise, an error is