This HTTP API reference guide will help you to use our push platform to send SMS message through query string over HTTP. This document provides the necessary information related to the interface
Assumptions
Single SMS with Template ID
Response
Success | {"code":201,"status":"Success","message":"Message sent successfully","job_id":"631200030"} |
Error | {"code":404,"status":"Failed","message":"User not found."} |
Multiple SMS
Response
Success | {"code":201,"status":"Success","message":"Message sent successfully","job_id":"631200030"} |
Error | {"code":404,"status":"Failed","message":"User not found."} |
Job ID Details
Response
Success | {"code":201,"status":"Success","message":"Job id details found.","submitted":0,"delivered":1,"failed":0,"job_id_details":[{"job_id":136301149,"Sender":"MOBSFT","count":1,"message":"helo+vedant","mobile":"918108004545","status":"DELIVERED"}]} |
Error | {"code":404,"status":"Failed","message":"job id details not found."} |
SMS Balance Details
Response
Success | {"code":201,"status":"Success","message":"User balance details found.","available_balance":{"transactional_balance":999,"promotional_balance":0}} |
Error | {"code":404,"status":"Failed","message":"Balance details not found."} |
Sent Message Report
Response
Success | {"code":201,"status":"Success","message":"Sent sms details found.","submitted":0,"delivered":14,"failed":4,"report_details":[{"job_id":82013252,"Sender":"MOBSFT","count":1,"message":"Test","mobile":"918108004545","status":"DELIVERED"}]} |
Error | {"code":404,"status":"Failed","message":"Sent SMS not found."} |
SMS Parameters Details
Parameter | Details | Example |
---|---|---|
username | Unique username assigned to user at the time of account creation. Username can only contain alphabets or numbers, with no blank spaces or special characters. | Abcd, abcd2 |
password | User’s password | ******* |
sender | User’s approved sender ID * Must be registered in DLT Portal. Like - smartping, Jio Trueconnect, BSNL DLT |
ABCDEF, QWERTY |
mobile | Mobile numbers to which you want to send SMS.You can add mobile number with or without country code (91). Do not add ‘+’ sign in front of country code. Add multiple mobile numbers separated by comma (,). | 1234567890, 911234567890 |
type | Type parameter indicates type of message i.e. text or Unicode. 1 - Plain text 2 - Unicode |
type=1 |
product | Product parameter indicates type of product i.e. transactional or promotional. 1 – Transactional 2 - Promotional |
1234567890, 911234567890 |
template | Registered and approved template id. * Must be registered in DLT Portal. Like - smartping, Jio Trueconnect, BSNL DLT |
12547896587458963 |
message | SMS content, which may be text or unicode. * Must be registered in DLT Portal. Like - smartping, Jio Trueconnect, BSNL DLT |
Welcome David. Your OTP is 2018132. Thanks. |
job_id | This parameter indicates job id number of which you want to get information. | job_id=784512639 |
date | Date parameter indicates date of which you want to get sent SMS report. Date parameter should always in yyyy-mm-dd format. | Date=2017-11-12 |