HTTP
Account status is reflecting on this whether it is active or alive we can say in which particular mode the account is.
AppKey-AppSecret: Login authentication key (unique for every user)
GET /account-status?app_key=AppKey&app_secret=AppSecretHTTP/1.1 Host: https://www.oursms.in/api/v1 Content-Type: application/json
Response
{ "status": true, "data": true, "message": "Your account is activated.", "errors": [] }
Provide the vital information of current balance and basic information.
AppKey-AppSecret: Login authentication key (unique for every user)
GET /check-balance?app_key=AppKey&app_secret=AppSecretHTTP/1.1 Host: https://www.oursms.in/api/v1 Content-Type: application/json
Response
{ "status": true, "data": { "user_number": 111111, "name": "TESTING NAME", "email": "MAIL@MAIL>COM", "mobile": "XXXXXXXXXX", "status": "1", "transaction_balance": "5000", "promotional_balance": "5000", "otp_balance": "5000", "two_waysms_balance": 5000, "voice_sms_balance": 5000 }, "message": "Your account & balance information.", "errors": [] }
Reflection of all sender IDs list, which is approved by the system or allots by the system.
AppKey-AppSecret: Login authentication key (unique for every user)
GET /approved-senderids?app_key=AppKey&app_secret=AppSecretHTTP/1.1 Host: https://www.oursms.in/api/v1 Content-Type: application/json
Response
{ "status": true, "data": [ { "senderID": "ABCDEF" } ], "message": "Your approved sender ids list.", "errors": [] }
OTP will generate once the given instruction is finish with the command.
Use post method and pass parameters
AppKey-AppSecret: Login authentication key (unique for every user)
dlt_template_id: Approved DLT template id from TRAI.
mobile_number: Keep number in international format (with country code [91]) OR just use 10 digit mobile number.
Variables
v1, v2, v3, v4... Just pass the variables in the same order.
Example: If your template is [ {#var#} is your OTP for fund transfer for the amount {#var#} to {#var#} . OTP valid for 8 minutes. Do not share this OTP with anyone. ]
Suppose you pass these variables with value
v1 = 123456
v2 = Account one
v3 = Account Two
then the send template is
123456 is your OTP for fund transfer for the amount Account one to Account Two . OTP valid for 8 minutes. Do not share this OTP with anyone.
GET /generate-otp?app_key=AppKey&app_secret=AppSecret&dlt_template_id=XXXXXXXXXXXXXXXX&mobile_number=XXXXXXXXXX&v1=XXXXXX&v2=XXXXXX&v3=XXXXXX HTTP/1.1 Host: https://www.oursms.in/api/v1 Content-Type: application/json
Response
{ "status": true, "data": { "msg_length": 173, "msg_consumed_credit": 2, "token": "64faa610-abc7-11ee-a02b-75ac21154640" }, "message": "message successfully sent.", "errors": [] }
Here the option of verify OTP once the OTP generate.
Use post method and pass parameters
AppKey-AppSecret: Login authentication key (unique for every user)
otp_number: enter 4, 5, or 6 digit OTP.
GET /verify-otp?app_key=AppKey&app_secret=AppSecret&otp_number=XXXXXX HTTP/1.1 Host: https://www.oursms.in/api/v1 Content-Type: application/json
Response
{ "status": true, "data": "ffadb730-6c3d-11eb-bf21-81ef5a1693f6", "message": "Otp verified.", "errors": [] }
With this option, any kind form of SMS can be sent for communication direct or indirect.
Promotional and Transactional SMS
"dlt_template_id" : "XXXXXXXXXXXXXXXXXXX", //required, Approved DLT template id from TRAI.
"campaign" : "Test Campaign", //Fill or blank
"mobile_numbers" : "XXXXXXXXXX,XXXXXXXXXX", //numbers will be comma seprated
"message" : "Your message here...", //Fill or blank, if your DLT template has variable then fill this field otherwise no need to fill this.
"message_type" : "0", //0: English OR 1: Unicode || by default send as English message
"route_type" : "0", //0:Transactional, 1:Promotional || by default route is Promotional
"schedule_date": "", //if user want to send this SMS in a particular date and time format will be YYYY-MM-DD HH:MM (time 24Hrs format)
"is_flash" : "" // If user want to send the message as a flash message then Y: Yes / N: No or blank
GET /send-message?app_key=AppKey&app_secret=AppSecret&dlt_template_id=XXXXXXXXXXXXXXXXX&campaign=XXXXXXXXXX&mobile_numbers=XXXXXXXXXX,XXXXXXXXXX&message_type=0&route_type=0&schedule_date=&is_flash=0 HTTP/1.1 Host: https://www.oursms.in/api/v1 Content-Type: application/json
Response
{ "status": true, "data": { "msg_length": 173, "msg_consumed_credit": 2, "token": "64faa610-abc7-11ee-a02b-75ac21154640" }, "message": "message successfully sent.", "errors": [] }
Highlight the report of SMS which had been sent.
GET /send-report/SmsResponseToken?app_key=AppKey&app_secret=AppSecretHTTP/1.1 Host: {{smslocal}}v1 Content-Type: application/json
Response
{ "status": true, "data": { "id": 7413, "campaign_name": "API-SMS", "sender_id": "XXXX", "sms_type": "SMS", "message": "UNICODE MESSAGE SHOWN HERE", "message_type": "Unicode", "msg_length": 119, "msg_consumed_credit": 2, "is_flash": "N", "scheduled_date": null, "campaign_send_date_time": "2024-01-05", "scheduled_hour": null, "scheduled_minutes": null, "total_contacts": 1, "total_credit_use": 2, "total_block_invalid_number": 0, "currently_delivered": 0, "currently_failed": 1, "campaign_current_stage": "Completed", "send_numbers": [ { "id": 181233, "send_sms_id": 7413, "mobile": "919713753131", "used_credit": 2, "status_code": null, "submitDate": "2024-01-05 15:13:32", "doneDate": "2024-01-05 15:13:39", "status": "DELIVRD", "reason": null, "response_code": "000" } ] }, "message": "SMS Report.", "errors": [] }
The Templates list can be check from here.
GET /templates?app_key=AppKey&app_secret=AppSecretHTTP/1.1 Host: https://www.oursms.in/api/v1 Content-Type: application/json
Response
{ "status": true, "data": [ { "template_id": "0895ddc0-91fd-11eb-84bb-e7d749c95410", "template_name": "test", "entity_id": "XXXXXXXXXXXXXXXXXXX", "dlt_header_id": "XXXXXXXXXXXXXXXXXXX", "is_for_unicode": 0, "dlt_message_template": "testing messagew", "dlt_template_id": "XXXXXXXXXXXXXXXXXXX", "status": 0 }, { "template_id": "6e6765a0-91fd-11eb-a59f-873c5c1207d2", "template_name": "test ubu", "entity_id": "XXXXXXXXXXXXXXXXXXX", "dlt_header_id": "XXXXXXXXXXXXXXXXXXX", "is_for_unicode": 0, "dlt_message_template": "Your request for {#var#} sent to {#var#} for Approval. SMS/Mail will send if request is approved. Please note - Your mobile number {#var#} is your application number.", "dlt_template_id": "XXXXXXXXXXXXXXXXXXX", "status": 0 } ], "message": "Your template list.", "errors": [] }
All campaigns can be accessed by the user with this list from where the data is accessible.
GET /campaign-list-pagination?app_key=AppKey&app_secret=AppSecretHTTP/1.1 Host: https://www.oursms.in/api/v1 Content-Type: application/json
Response
{ "status": true, "data": { "current_page": 1, "data": [ { "campaign_name": "1", "sender_id": "ABCSEF", "sms_type": "TWOWAY", "message": "Hello, my name is Jhon Doe and Please rate my skills through below link {{2way-sms-link-1}}", "message_type": "English", "msg_length": 91, "msg_consumed_credit": 1, "is_flash": "N", "scheduled_date": null, "scheduled_hour": null, "scheduled_minutes": null, "total_contacts": 6, "total_credit_use": 6, "total_block_invalid_number": 0, "currently_delivered": 0, "currently_failed": 0, "campaign_current_stage": "In-process" }, { "campaign_name": "test", "sender_id": "NRTSMS", "sms_type": "TWOWAY", "message": "link1 {{2way-sms-link-3}} and link2{{2way-sms-link-2}}", "message_type": "English", "msg_length": 54, "msg_consumed_credit": 1, "is_flash": "N", "scheduled_date": null, "scheduled_hour": null, "scheduled_minutes": null, "total_contacts": 2, "total_credit_use": 2, "total_block_invalid_number": 0, "currently_delivered": 0, "currently_failed": 0, "campaign_current_stage": "In-process" }, { "campaign_name": "OTP", "sender_id": "NRTSMS", "sms_type": "SMS", "message": "{{OTP}} is your OTP for testing.", "message_type": "English", "msg_length": 31, "msg_consumed_credit": 1, "is_flash": "N", "scheduled_date": null, "scheduled_hour": null, "scheduled_minutes": null, "total_contacts": 1, "total_credit_use": 1, "total_block_invalid_number": 0, "currently_delivered": 0, "currently_failed": 0, "campaign_current_stage": "Pending" } ], "first_page_url": "https://www.oursms.in/api/campaign-list-pagination?page=1", "from": 1, "last_page": 1, "last_page_url": "https://www.oursms.in/api/campaign-list-pagination?page=1", "next_page_url": null, "path": "https://www.oursms.in/api/campaign-list-pagination", "per_page": 5, "prev_page_url": null, "to": 3, "total": 3 }, "message": "Your all types of campaign list with current stage.", "errors": [] }
Campaign list with specific data of particular campaign.
GET /all-campaign?AppKey=e3mKMg5hH601ByUnm5Qt6Yt01&app_secret=AppSecretHTTP/1.1 Host: https://www.oursms.in/api/v1 Content-Type: application/json
Response
{ "status": true, "data": [ { "campaign_name": "1", "sender_id": "ABCDEF", "sms_type": "TWOWAY", "message": "Hello, my name is Jhon Doe and Please rate my skills through below link {{2way-sms-link-1}}", "message_type": "English", "msg_length": 91, "msg_consumed_credit": 1, "is_flash": "N", "scheduled_date": null, "scheduled_hour": null, "scheduled_minutes": null, "total_contacts": 6, "total_credit_use": 6, "total_block_invalid_number": 0, "currently_delivered": 0, "currently_failed": 0, "campaign_current_stage": "In-process" }, { "campaign_name": "test", "sender_id": "ABCDEF", "sms_type": "TWOWAY", "message": "link1 {{2way-sms-link-3}} and link2{{2way-sms-link-2}}", "message_type": "English", "msg_length": 54, "msg_consumed_credit": 1, "is_flash": "N", "scheduled_date": null, "scheduled_hour": null, "scheduled_minutes": null, "total_contacts": 2, "total_credit_use": 2, "total_block_invalid_number": 0, "currently_delivered": 0, "currently_failed": 0, "campaign_current_stage": "In-process" }, { "campaign_name": "OTP", "sender_id": "ABCDEF", "sms_type": "SMS", "message": "{{OTP}} is your OTP for testing.", "message_type": "English", "msg_length": 31, "msg_consumed_credit": 1, "is_flash": "N", "scheduled_date": null, "scheduled_hour": null, "scheduled_minutes": null, "total_contacts": 1, "total_credit_use": 1, "total_block_invalid_number": 0, "currently_delivered": 0, "currently_failed": 0, "campaign_current_stage": "Pending" } ], "message": "Your last 500 campaigns list showing with current stage.", "errors": [] }
dlt_template_name : "Any name | required",
sender_id: "Registered SENDER ID | 6 CHAR | required",
dlt_message: "This is your dummy template with {#var#} | required",
dlt_template_id: "DLT Template | required",
is_unicode: "n OR y" // n for No, Y for Yes | Default : n
GET /api/v1/add-template?app_key=AppKey&app_secret=AppSecret&dlt_template_name=testing&sender_id=XXXXXX&dlt_message=This is ypor dummy template with{#var#}&dlt_template_id=3424234234&is_unicode=1 HTTP/1.1 Host: https://www.oursms.in Content-Type: application/json
Response
{ "status": true, "data": { "dlt_template_name": "testing", "entity_id": "xxxxxxxxxxxxxxx", "sender_id": "XXXXXX", "header_id": "xxxxxxxxxxxxxxxxxx", "is_unicode": 1, "dlt_message": "This is your dummy template with {#var#}", "dlt_template_id": "xxxxxxxx", "status": 1, "uuid": "xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx", "created_at": "2023-11-28T08:28:55.000000Z" }, "message": "DLT Template successfully added.", "errors": [] }
Please pass mobile number and campaign response token to get report
your url like:
/api/v1/send-number-report/9713753131/e2d8be10-abae-11ee-81ab-a9a9b9436819?app_key=XXXXXXXXX&app_secret=XXXXXXXXX
GET /api/v1/send-number-report/mobileNumber/campaignResponseToken?app_key=XXXXXXXXXXXXX&app_secret=XXXXXXXXXXXXXX HTTP/1.1 Host: oursms.in Content-Type: application/json Accept: application/json
Response
{ "status": true, "data": [ { "mobile": "919713753131", "used_credit": 2, "status_code": null, "submitDate": "2024-01-05 15:13:32", "doneDate": "2024-01-05 15:13:39", "status": "REJECTD", "reason": null, "response_code": "632" } ], "message": "SMS Report by mobile number.", "errors": [] }