API Overview
An outline of what out ITON.mobi API which shows a step by step flow and also explains the wide variety of operations on the available resources.
Requests
he typical request body will be JSON with mime type application. Some endpoints may also support other types of content encoding like Media API that uses multipart/form-data for media uploads.
Authentication
All Web API requests must be authenticated using an API token. API tokens are unique per project, and. The API token must be included in the Authorization header for all API requests
Authorization: ITON < Your API Token >
Example
Authorization: ITON 532073f7e4b05199d2c3d812
Credentials API Overview
The Credentials API is used to store the GCM keys and APNS certificates that are required to send push notifications using Google and Apple push services. Credentials are limited use with the apps within a single project and need to be linked with a channel using the Channels API before they can be used.
How to create push credentials
APNS Credentials The APNS credential data consists of the SSL push certificate for your application, downloaded from Apple’s provisioning portal. To get this, you will need an iOS Developer Account, an App ID (Apple’s App ID, not to be confused with the system appchannel_id), a provisioning profile and provider certificate.
HTTPS API COMMANDS
You can test all the commands manually by entering their URLs into the address bar of your internet browser. provides the following API commands:
| Command | Description |
| sendSMS | send SMS command |
| account | check account balance command |
| message_status | retrieve SMS delivery notification |
| Check_DNDnumber | check phone number whether the gibven number is present in DND Number list or not. |
All these commands can be executed only if you provide a valid username and API password in your requests. All API commands (on a per-need basis) use the following key parameters:
| Parameter name | Example |
| username | xxxx |
| password | yyyy |
| phone_number | 9999999999 |
NOTE: You must enter your own username, password, and command name for each command to be executed. The phone number 9999999999 is only an example, and you must replace it with a valid phone number
SEND SMS
The send command is used to send an SMS message to a mobile phone. You can include up to 100 mobile phone numbers to a single send command, so if you need to send 2000 messages you need to complete 20 send commands.
Request
Response
Success Your MessageId is 532073f7e4b05199d2c3d812
Notes:
-
You must use a valid API username and password.
-
Each SMS is assigned a unique identifier that is necessary for checking that message delivery status. API users should take care to store message identifiers send command returns in order to be able to check those messages’ delivery status later on. The only means of obtaining message identifiers is by getting them from responses to send commands.
REQUEST PARAMETERS
| Parameter | Description |
| username | Your username |
| password | Your API password |
| to | Your recipient phone number or recipients’ phone numbers. You can enter multiple phone numbers, each separated by a comma (,) without a space, and can include up to 100 phones in a single send request |
| uniCode | You should set it to 2 if the message contains Unicode characters; otherwise you should set it to 0 |
| sender | Custom Sender ID |
RESPONSE
| Parameter | Description |
| message_id | This is a hash map of phone numbers, indexed by message identifiers which the gateway assigns to each sent message. You must save these identifiers if you want to retrieve your messages’ final delivery status. |
ACCOUNT
You can use this command to check the current SMS credit balance on your account.
Request
https://sms.iton.in/ItonSMSAPI/smsService/api/?username=XXXX&password=XXXX&cmd=account
Response
Remaining_Credits: 417
REQUEST PARAMETERS
| Parameter | Description |
| username | Your username. |
| password | Your API password (get it here) |
RESPONSE
| Parameter | Description |
| Remaining_Credits | The amount of available SMS credits on your account. |
message_status
This command allows you to retrieve the delivery status of any SMS you have already sent. When you give the message identifier the gateway generated and returned by send, this command returns any message details along with its current status.. Delivery Codes explained.
Request
Response
{
"5320729be4b05199d2c3d80f":{
"phoneNumberWithRespectiveStatus":{
"91XXXXXXXXXX":"DELIVIRED"
},
"message":"Hello",
"sender_Id":"itonXXXX",
"user_Id":"XXXXXX",
"sending_Date":"Mar 12, 2013 8:13:39 PM"
}
}
REQUEST PARAMETERS
| Parameter | Description |
| username | Your username. |
| password | Your API password (get it here). |
| ids | The identifier of any message returned by send command for which you want to check the status. If you want to check the status of several messages at once, enter their IDs with a comma without spaces separating each; for example, 8624389,8624390,8624391. allows up to 100 IDs for each message_status request. |
RESPONSE
The response is a hash map with your message details indexed by message identifiers. The message details object has the following fields:
| Parameter | Description |
| phoneNumberWithRespectiveStatus | Phone Number with its DeliveryStatus . |
| message | The message Sent. |
| sending_Date | The time sent the message, as the gateway recorded it upon receiving your send request. |
| sender_Id | The Id of the sender by which the message was sent. |
| user_Id | The user id of the message sender. |
check_DNDnumber
This command helps you to know a phone number is an DND Number or not.
Request
https://sms.iton.in/ItonSMSAPI/smsService/api/?username=XXX&password=XXXXX&cmd=check_DNDnumber&phoneNumbers=XXXXXXXXXX
Response
{
"9032728149":true
}
REQUEST PARAMETERS
| Parameter | Description |
| username | Your username. |
| password | Your API password (get it here). |
| phoneNumbers | Phone number to be checked. You can enter multiple phone numbers by separating each with a comma (,) without a space after it. |
RESPONSE
The response contains a hash map of phone-number details indexed by the phone numbers. The objects of phone-number details have the following fields:
| Parameter | Description |
| key | The given number. |
| value | The boolean value where the number exists in DND list or not. true: It exists in DND Number List. false: It doesn’t exists in DND Number List. |