Scribd
Upload
103 views

Simberry API

The SIMBERRY API specification outlines three endpoints: 1. sendSms to send SMS messages with parameters like user/password, to/from numbers, and message text. It returns a status and ID. 2. checkSmsStatus to check SMS delivery status by ID, returning status and delivery status. 3. checkBalance to check the account balance, returning status and current balance.

Uploaded by

Rohit Tank
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
103 views

Simberry API

The SIMBERRY API specification outlines three endpoints: 1. sendSms to send SMS messages with parameters like user/password, to/from numbers, and message text. It returns a status and ID. 2. checkSmsStatus to check SMS delivery status by ID, returning status and delivery status. 3. checkBalance to check the account balance, returning status and current balance.

Uploaded by

Rohit Tank
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

SIMBERRY API specification

sendSms
Request structure:

Parameter Data type Mandatory Description


userName string Yes User name of related account
password string Yes password
action string Yes Action type, must be sendSms for sendSms request
to string
from string
delivery integer Request delivery receipt
message string Text sms
Response structure:

Parameter Data type Description


1 - Request successful
statusCode numeric
0 - Request failed

statusText string Description response


id integer Sms id
Example of command:
https://<ROUTER_IP>:8443/sms.php?action=sendSms&userName=<USER>&password=<PASSWORD>&to=
<DAD>&from=<OAD>&delivery=1&message=<MESSAGE>

Example of response in JSON format:


{"success":1,"description":"OK","id":64}

checkSmsStatus
Request structure:

Parameter Data type Mandatory Description


userName string Yes User name of related account
password string Yes password
action string Yes Action type, must be checkSmsStatus for checkSmsStatus request
sms_id integer Yes Sms id
wait integer Waiting status 'Delivered' (in seconds)
Response structure:

Parameter Data type Description


1 - Request successful
statusCode numeric
0 - Request failed

statusText string Description response


delivery_status integer Status
Example of command:

https://smsapi.simberry.com/sms.php?sms.php?
action=checkSmsStatus&sms_id=number&wait=3&userName=user&password=pass

Example of response in JSON format:

{"success":1,"description":"Delivered","delivery_status":3}

checkBalance
Request structure:

Parameter Data type Mandatory Description


userName string Yes User name of related account
password string Yes password
action string Yes Action type, must be checkBalance for checkBalance request
Response structure:

Parameter Data type Description


1 - Request successful
statusCode numeric
0 - Request failed

statusText string Description response


balance integer Current balance
Example of command:
https://smsapi.simberry.com/sms.php?action=checkBalance&userName=user&password=pass

Example of response in JSON format:

{"success":1,"description":"OK","balance":999.1908}

You might also like