SMS-BUS Service API Documentation
API is a protocol between your software and our server. The API is needed in order to automate the process of receiving SMS messages on your side To work with the API, you must use your API key, you can get it by going to the profile page.
Our software is fully compatible with competitor sites
Protocol Description
All requests should go to https://sms-bus.com/api/control
All requests must have an API Key as a parameter "token"
Search for country and service id
List service id
List country id
Affiliate Programs for Developers
You can get a commission on every spend when users use your program, all you need to do is sign up for an account and put you referral code on every request. Check out for more details.
Your software must be public so that everyone can buy or rent it.
Query balance
GET - https://sms-bus.com/api/control/get/balance?token=$token
Parameters
Field | Location | Type | Required | Description |
---|---|---|---|---|
token | query | String | Yes | Your API KEY |
Result
Success
{
"code": 200,
"message": "Operation Success",
"data": {
"frozen": 0,
"balance": 2.52
}
}
Possible Errors
{
"code": 401,
"message": "Wrong token!"
}
Get all countries
GET - https://sms-bus.com/api/control/list/countries?token=$token
Parameters
Field | Location | Type | Required | Description |
---|---|---|---|---|
token | query | String | Yes | Your API KEY |
Result
Success
{
"code": 200,
"message": "Operation Success",
"data": {
"1": {
"id": 1,
"title": "Unite State of America",
"code": "us"
},
"2": {
"id": 2,
"title": "Russia",
"code": "ru"
}
}
}
Possible Errors
{
"code": 401,
"message": "Wrong token!"
}
Get all projects
GET - https://sms-bus.com/api/control/list/projects?token=$token
Parameters
Field | Location | Type | Required | Description |
---|---|---|---|---|
token | query | String | Yes | Your API KEY |
Result
Success
{
"code": 200,
"message": "Operation Success",
"data": {
"1": {
"id": 1,
"title": "Telegram",
"code": "tg"
},
"2": {
"id": 2,
"title": "Paypal",
"code": "pp"
}
}
}
Possible Errors
{
"code": 401,
"message": "Wrong token!"
}
Check project prices and available numbers
GET - https://sms-bus.com/api/control/list/prices?token=$token&country_id=$country_id
Parameters
Field | Location | Type | Required | Description |
---|---|---|---|---|
token | query | String | Yes | Your API KEY |
country_id | query | Integer | Yes | Country |
Result
Success
{
"code": 200,
"message": "Operation Success",
"data": {
"5": {
"country_id": 5,
"project_id": 2,
"cost": 0.9,
"total_count": 1023,
"title": "United States of America",
"code": "us"
}
}
}
Possible Errors
{
"code": 401,
"message": "Wrong token!"
}
{
"code": 50001,
"message": "No service available"
}
Get a number
GET - https://sms-bus.com/api/control/get/number?token=$token&country_id=$country_id&project_id=$project_id
Parameters
Field | Location | Type | Required | Description |
---|---|---|---|---|
token | query | String | Yes | Your API KEY |
country_id | query | Integer | Yes | Country |
project_id | query | Integer | Yes | Service |
refer_id | query | String | No | Pass Referral ID |
Result
Success
{
"code": 200,
"message": "Operation Success",
"data": {
"request_id": 124,
"number": "17548003793"
}
}
Possible Errors
{
"code": 401,
"message": "Wrong token!"
}
{
"code": 50002,
"message": "No number available"
}
{
"code": 50104,
"message": "The number of waiting requests exceeds the limit, please complete or cancel it and try again."
}
{
"code": 50201,
"message": "Balance not enough"
}
{
"code": 50208,
"message": "This account is not activated, please click the activation link in the mailbox to activate"
}
Get sms
GET - https://sms-bus.com/api/control/get/sms?token=$token&request_id=$request_id
Parameters
Field | Location | Type | Required | Description |
---|---|---|---|---|
token | query | String | Yes | Your API KEY |
request_id | query | String | Yes | Request Id |
Result
Success
{
"code": 200,
"message": "Operation Success",
"data": "429916"
}
Possible Errors
{
"code": 401,
"message": "Wrong token!"
}
{
"code": 50101,
"message": "Not received sms yet"
}
{
"code": 50102,
"message": "Number has been released or timeout, please reacquire"
}
Cancel a request
GET - https://sms-bus.com/api/control/cancel?token=$token&request_id=$request_id
Parameters
Field | Location | Type | Required | Description |
---|---|---|---|---|
token | query | String | Yes | Your API KEY |
request_id | query | String | Yes | Request Id |
Result
Success
{
"code": 200,
"message": "Operation Success"
}
Possible Errors
{
"code": 401,
"message": "Wrong token!"
}
{
"code": 50103,
"message": "Can't change request status because the request has already closed."
}
Reuse number for certain project
Not every number can be reused. And this feature is only available if you have previously used the number to receive SMS from this service.
GET - https://sms-bus.com/api/control/reuse?token=$token&country_id=$country_id&project_id=$project_id&mobile_number=$mobile_number
Parameters
Field | Location | Type | Required | Description |
---|---|---|---|---|
token | query | String | Yes | Your API KEY |
country_id | query | Integer | Yes | Country |
project_id | query | Integer | Yes | Service |
mobile_number | query | String | Yes | Number without the + sign |
refer_id | query | String | No | Pass Referral ID |
Result
Success
{
"code": 200,
"message": "Operation Success",
"data": {
"request_id": 124,
"number": "17548003793"
}
}
Possible Errors
{
"code": 400,
"message": "Wrong token!"
}
{
"code": 50001,
"message": "No service available."
}
{
"code": 50007,
"message": "The number doesn't exist."
}
{
"code": 50107,
"message": "The number cannot be reused."
}
{
"code": 50108,
"message": "The number cannot be reused."
}
{
"code": 50109,
"message": "The number is expired."
}
{
"code": 50201,
"message": "Balance not enough"
}
{
"code": 50208,
"message": "This account is not activated, please click the activation link in the mailbox to activate"
}