API Document

API Document for CUSTOMIZE SMS

HTTP Customize API Specification

Add nearly any HTML within, even for linked list groups like the one below.

Sending Customize SMS

https://sms.cipherdigi.com/V2/http-customize-api.php?apikey=XXXXXXXXXXXXXXXX&senderid=XXXXXX &number=XXXXXXXXXXX,XXXXXXXXXXX,XXXXXXXXXXX&message=msg1^msg2^msg3&shortlink=1 &originalurl=XXXXXXXX&format=json

Sending An SMS Using Post method

post https://sms.cipherdigi.com/V2/http-customize-api-post.php

HTTP Customize API Specification

The API parameter specifications are described in the following sections

Mandatory Parameters

The mandatory parameters in the HTTP Customize API are tabulated below:

Name	Parameter	Description	Expected Values
API Key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Sender ID	senderid	Sender ID assigned to your account	Sender ID 6 Character only allow
Mobile number	number	Mobile number to which the SMS is to be sent.The destination mobile number can be with or without 91. Also provide multiple numbers in comma separated format.	Mobile number like 91XXXXXXXXX OR 98908XXXXX OR 91XXXXXXXXX,98908XXXXX
Message	message	Message to be sent	Message text which is URL encoded(Max 1000 char for normal, 500 for unicode).If message contains short link then add cpdg.in/xyz/xxxxxxx in message content.

Optional Parameters

The optional parameters in the HTTP Customize API are tabulated below:

Name	Parameter	Description	Expected Values
unicode	unicode	To specify that the message to be sent is in unicode format.	2
Schedule time	time	Date and time for scheduling an SMS	EX Format: YYYY-MM-DD HH:MM:SS OR YYYY-MM-DD HH:MM AM/PM Like : 2016-12-06 04:45pm
flash	flash	To specify that the message is to be sent in the flash format.	1
Short Link	shortlink	To specify that the message to be sent contain short link.	1
Original URL	originalurl	To specify that which url you want to redirect on click.	The url you want to hit Ex: www.example.com
Response Type	format	Output format should be as specified by this variable.	PHP/JSON. Default response will be in JSON

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
data	All the response is wrapped in side data
mobile	Mobile number the sms will be sent
status	status of the message
msgid	message id of the customize message

API Error Codes

The common error codes received while using the API to send an SMS is in the below format :

STATUS	MESSAGE
AZQ01	Kindly provide apikey
AZQ02	Invalid Api Key
AZQ03	Invalid user OR user is deactivated
AZQ04	Invalid route
AZQ05	Invalid senderid
AZQ06	No message found
AZQ07	Schedule Datetime can't less than current time
AZQ08	Invalid datetime format
AZQ09	No numbers found
AZQ10	You have insufficient credit
AZQ12	Message campaign failed
AZQ13	There is no numbers to send sms
AZQ14	You have not provided shortlink value
AZQ15	You have not provided Original Url
AZQ16	Invalid shortlink value

Example Post Data

If You are using post method to send message, then post only json data. if you want to add other parameter then add similarly.

{
    "apikey": "XXXXXXXXXXXXXXXX",
    "senderid": "XXXXXX",
    "format": "json",
    "data": [
        {
            "number": "91XXXXXXXXXX",
            "message": "This is test SMS1"
        },
        {
            "number": "91XXXXXXXXXX",
            "message": "This is test SMS2"
        }
    ]
}

Example Responses

Json

{
    "status": "OK",
    "data": [
        {
            "id": "32-1",
            "mobile": "91880085XXXX",
            "status": "SUBMITTED"
        },
        {
            "id": "32-2",
            "mobile": "91900467XXXX",
            "status": "SUBMITTED"
        },
        {
            "id": "32-3",
            "mobile": "91847101XXXX",
            "status": "SUBMITTED"
        }
    ],
    "msgid" => "9813100982"
    "message": "message Submitted successfully"
}

Error Response

{
    "status":"AZQ02",
    "message":"Invalid Api Key"
}

API Document for PULL DLR RESPONSE

HTTP API Specification

Add nearly any HTML within, even for linked list groups like the one below.

Get DLR Response

get https://sms.cipherdigi.com/V2/http-customize-api-post.php

HTTP API Specification

The API parameter specifications are described in the following sections

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
API Key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Message Id	id	Response id{"id":"XXXXXXXX-X"} to which you want to get DLR Response.	id like {"id":"XXXXXXXX-X"} give the status of a number like 98908XXXXX

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable.	PHP/JSON. Default response will be in JSON

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
data	All the response is wrapped in side data
mobile	Mobile number of which you get the response
status	status of the response
status-desc	status of the response by operator

API Response Codes

The common error codes received while using the API to send an SMS is in the below format :

STATUS	MESSAGE
Delivered	Message has been delivered
Submitted	Message has been submitted
Failed	Message has failed
Other	Some unknown issue

API Error Codes

The common error codes received while using the API to send an SMS is in the below format :

STATUS	MESSAGE
AZQ01	Kindly provide apikey
AZQ02	Invalid Api Key
AZQ03	Invalid user OR user is deactivated
AZQ04	Kindly provide response id
AZQ05	At a time only 100 request can be sent

Json

{
    "status": "OK",  
    "data": [ 
        {
            "id": "32-1",
            "mobile": "847101XXXX",
            "status": "submitted"
            "status-desc": "delivered"
            "delivered_date": "2019-21-01 04:45 pm"
        },
        {
            "id": "32-2",
            "mobile": "847101XXXX",
            "status": "submitted"
            "status-desc": "delivered"
            "delivered_date": "2019-21-01 04:45 pm"
        },
        {
            "id": "32-3",
            "mobile": "847101XXXX",
            "status": "submitted"
            "status-desc": "delivered"
            "delivered_date": "2019-21-01 04:45 pm"
        }
    ],
    "message": "request Submitted successfully"
}

Error Response

{
    "status":"AZQ02",
    "message":"Invalid Api Key"
}

API Document for PUSH DLR RESPONSE

HTTP Push API Specification

The DLR Push API sends the DLR to the Client's URL , the method used for pushing delivery report onto the client's URL

Get your SMS status through DLR push API

https://sms.cipherdigi.com/V2/http-api.php?apikey=XXXXXXXXXXXXXXXX&senderid=XXXXXX&number=XXXXXXXXXXX, XXXXXXXXXXX,XXXXXXXXXXX&message=hello there&format=json&dlrurl=your dlr url

HTTP API Specification

The API parameter specifications are described in the following sections

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
API Key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Sender ID	senderid	Sender ID assigned to your account	Sender ID 6 Character only allow
Mobile number	number	Mobile number to which the SMS is to be sent.The destination mobile number can be with or without 91. Also provide multiple numbers in comma separated format.	Mobile number like 91XXXXXXXXX OR 98908XXXXX OR 91XXXXXXXXX,98908XXXXX
Message	message	Message to be sent	Message text which is URL encoded(Max 1000 char for normal, 500 for unicode)
Dlr URL	dlrurl	If you required delivery report at your end, set your dlr ulr at time of message push	URL Like : www.XXXXXX.com or http://XXXXXX.com

ULR response through get method :

get http://Your DLR URL?sender=XXXXXX&msgid=XXXXXXX&mobile=91XXXXXXXXXX&status=XXXXXXXXX&statusdesc=XXXXXXXXX &delivereddate=XXXXXXXXX

Response Dlr Push Paramerts Specification

Your DLR URL	your dlr ulr at time of message push
sender	Sender-id.
msgid	The unique identification for message given at the time of submission
mobile	Mobile number of which you get the response
status	Status of the message.( 'Delivered','Submitted', 'DNDFailed', 'Failed', 'Other')
statusdesc	Final dlr response by operator like : Delivered to handset, Absent Subscriber
delivereddate	Delivered date

API Document for ADD CREDIT API

HTTP API Specification

Add nearly any HTML within, even for linked list groups like the one below.

Add Credit

https://sms.cipherdigi.com/V2/http-add-credit.php?vendorapikey=XXXXXXXXXXXXXXXX&userapikey=XXXXXXXXXXXXXXXX&balance=XXXXXXXX&minbalance=XXXXXXXX&format=json

HTTP API Specification

The API parameter specifications are described in the following sections

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Vendor API Key	vendorapikey	Vendor API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
User API Key	userapikey	User API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Balance	balance	The balance You have to credit in user account.	Balance must be greater than 0. Exam: 1000XXX, 200XXXX

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Minimum Balance	minbalance	The minimum balance of user, below which credit should be added.	The credit will be added only if the user balance less than minimum balance.
Response Type	format	Output format should be as specified by this variable.	PHP/JSON. Default response will be in JSON

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
data	All the response is wrapped in side data

API Error Codes

The common error codes received while using the API to credit the balance is in the below format :

STATUS	MESSAGE
AZQ01	Kindly provide vendor api key
AZQ02	Kindly provide user api key
AZQ03	Kindly provide balance
AZQ04	Invalid Vendor Api Key
AZQ05	Invalid vendor OR vendor is deactivated
AZQ06	Invalid User Api Key
AZQ07	Invalid user OR user is deactivated
AZQ08	Invalid user of vendor
AZQ09	Invalid vendor route
AZQ10	Vendor insufficient balance
AZQ11	Invalid user route
AZQ12	Something went wrong! Please contact to admin.
AZQ13	User has balance greater than minimum balance
AZQ14	Invalid vendor and user route

Json

{
    "status": "OK",
    "data": [
        {
            "credit": "10000",
            "balance": "25000",
            "route": "Transactional"
        }
    ],
    "message": "Credit added successfully",
    "statusType": "1"
}

Error Response

{
    "status":"AZQ04",
    "message":"Invalid Vendor Api Key",
    "statusType":"0"
}

API Document for BALANCE API

HTTP Balance API Specification

Add nearly any HTML within, even for linked list groups like the one below.

Get Your Balance Through API Key

get https://sms.cipherdigi.com/V2/http-balance-api.php?apikey=XXXXXXXXXXXXXXXX&format=json

HTTP Balance API Specification

The API parameter specifications are described in the following sections

Mandatory Parameters

The mandatory parameters in the HTTP Balance API are tabulated below:

Name	Parameter	Description	Expected Values
API Key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel

Optional Parameters

The optional parameters in the HTTP Balance API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable.	PHP/JSON. Default response will be in JSON

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
data	All the response is wrapped in side data

API Error Codes

The common error codes received while using the API to send an SMS is in the below format :

STATUS	MESSAGE
AZQ01	Kindly provide apikey
AZQ02	Invalid Api Key
AZQ03	Invalid user OR user is deactivated
AZQ04	Invalid route

Example Responses

Json

{
    "status": "OK",
    "data": [
        {
            "balance": "50000",
            "gateway": "Transactional"
        },
    ],
    "message": "Request Submitted Successfully"
}

Error Response

{
    "status":"AZQ02",
    "message":"Invalid Api Key"
}

API Document for DELETE SCHDULE API

HTTP Delete Schedule API Specification

Add nearly any HTML within, even for linked list groups like the one below.

Get Your Balance Through API Key

get https://sms.cipherdigi.com/V2/http-schedule-delete-api.php?apikey=XXXXXXXXXXXXXXXX&msgid=XXXXX&format=json

HTTP Delete Schedule API Specification

The API parameter specifications are described in the following sections

Mandatory Parameters

The mandatory parameters in the HTTP Delete Schedule API are tabulated below:

Name	Parameter	Description	Expected Values
API Key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Message Id	msgid	Schedule Message id of scheduled SMS	Message id EX: msgid=100

Optional Parameters

The optional parameters in the HTTP Balance API are tabulated below:

Name	Parameter	Description	Expected Values
Response Type	format	Output format should be as specified by this variable.	PHP/JSON. Default response will be in JSON

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
data	All the response is wrapped in side data

API Error Codes

The common error codes received while using the API to send an SMS is in the below format :

STATUS	MESSAGE
AZQ01	Kindly provide apikey
AZQ02	Invalid Api Key
AZQ03	Kindly provide scheduled message id
AZQ04	Invalid user OR user is deactivated
AZQ05	Invalid route
AZQ06	Sorry, We can not process this operations
AZQ07	This message is not scheduled by API
AZQ08	Invalid scheduled message id

Example Responses

Json

{
    "status": "OK",
    "data": [
       {
          "id": "100",
          "Schedule Date": "2018-08-10 04:45 pm"
       },
    ],
    "message": "Schedule message deleted successfully"
}

Error Response

{
    "status":"AZQ02",
    "message":"Invalid Api Key"
}

API Document for File SMS API

HTTP File API Specification

Add nearly any HTML within, even for linked list groups like the one below.

Sending SMS

https://sms.cipherdigi.com/http-file-msg-upload.php

Sending Customize SMS

http://localhost/http-file-cust-upload.php

HTTP API Specification

The API parameter specifications are described in the following sections

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
API Key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Sender ID	senderid	Sender ID assigned to your account	Sender ID 6 Character only allow
Mobile number	number	Mobile number to which the SMS is to be sent.The destination mobile number can be with or without 91.	File should have Heading name MOBILE and MESSAGE
Message	message	Message to be sent	Message text you have to send. For customize sms there should be "MESSAGE" Field in file

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
data	All the response is wrapped in side data
mobile	Mobile number the sms will be sent
status	status of the message
msgid	message id of the sent message

API Error Codes

The common error codes received while using the API to send an SMS is in the below format :

STATUS	MESSAGE
AZQ01	Kindly provide apikey
AZQ02	Invalid Api Key
AZQ03	Invalid user OR user is deactivated
AZQ04	Invalid route
AZQ05	Invalid senderid
AZQ06	No message found
AZQ07	Schedule Datetime can't less than current time
AZQ08	Invalid datetime format
AZQ09	No numbers found
AZQ10	You have insufficient credit
AZQ12	Message campaign failed
AZQ13	There is no numbers to send sms
AZQ14	You have not provided shortlink value
AZQ15	You have not provided Original Url
AZQ16	You have not added tracking URL in messages content
AZQ17	Invalid shortlink value

Example Responses

Json

{
    "status": "OK",
    "data": [
       {
          "id": "32-1",
          "mobile": "91880085XXXX",
          "status": "SUBMITTED"
       },
       {
          "id": "32-2",
          "mobile": "91900467XXXX",
          "status": "SUBMITTED"
       },
       {
          "id": "32-3",
          "mobile": "91847101XXXX",
          "status": "SUBMITTED"
       }
    ],
    "msgid" => "981310XXXX"
    "message": "message Submitted successfully"
}

API Document for SENDING SMS

HTTP API Specification

Add nearly any HTML within, even for linked list groups like the one below.

Sending SMS

https://sms.cipherdigi.com/V2/http-api.php?apikey=XXXXXXXXXXXXXXXX&senderid=XXXXXX&number=XXXXXXXXXXX, XXXXXXXXXXX,XXXXXXXXXXX&message=hello there&format=json

Sending An SMS Using Post method

https://sms.cipherdigi.com/V2/http-api-post.php

HTTP API Specification

The API parameter specifications are described in the following sections

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
API Key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel
Sender ID	senderid	Sender ID assigned to your account	Sender ID 6 Character only allow
Mobile number	number	Mobile number to which the SMS is to be sent.The destination mobile number can be with or without 91. Also provide multiple numbers in comma separated format.	Mobile number like 91XXXXXXXXX OR 98908XXXXX OR 91XXXXXXXXX,98908XXXXX
Message	message	Message to be sent	Message text which is URL encoded(Max 1000 char for normal, 500 for unicode).If message contains short link then add cpdg.in/xyz/xxxxxxx in message content.

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
unicode	unicode	To specify that the message to be sent is in unicode format.	2
PE ID	pe_id	To specify DLT register pe_id.	12345XXXXXXX789
Template ID	template_id	Template Id must be against pe_id.	12345XXXXXXX789
Schedule time	time	Date and time for scheduling an SMS	EX Format: YYYY-MM-DD HH:MM:SS OR YYYY-MM-DD HH:MM AM/PM Like : 2016-12-06 04:45pm
flash	flash	To specify that the message is to be sent in the flash format.	1
Short Link	shortLink	To specify that the message to be sent contain short link and message body must be contain short link "cpdg.in/xyz/xxxxxxx".	1
Original URL	originalurl	To specify that which url you want to redirect on click.	The url you want to hit Ex: www.example.com
Is Encrypted	is_encrypted	This parameter can be use for encrypt the message content and number	1
Response Type	format	Output format should be as specified by this variable.	PHP/JSON. Default response will be in JSON

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
data	All the response is wrapped in side data
mobile	Mobile number the sms will be sent
status	status of the message
msgid	message id of the sent message

API Error Codes

The common error codes received while using the API to send an SMS is in the below format :

STATUS	MESSAGE
AZQ01	Kindly provide apikey
AZQ02	Invalid Api Key
AZQ03	Invalid user OR user is deactivated
AZQ04	Invalid route
AZQ05	Invalid senderid
AZQ06	No message found
AZQ07	Schedule Datetime can't less than current time
AZQ08	Invalid datetime format
AZQ09	No numbers found
AZQ10	No numbers found
AZQ12	Message campaign failed
AZQ13	There is no numbers to send sms
AZQ14	You have not provided shortlink value
AZQ15	You have not provided Original Url
AZQ16	You have not added tracking URL in messages content
AZQ17	Invalid shortlink value

Example Post Data

If You are using post method to send message, then post only json data. if you want to add other parameter then add similarly.

{
    "apikey": "xxxxxxxxxxxxxxxx",
    "senderid": "XXXXXX",
    "number": "99XXXXXXXX,99XXXXXXXX",
    "message": "Message to be send",
    "format": "json"
}

Example Responses

Json

{
    "status": "OK",
    "data": [
       {
          "id": "32-1",
          "mobile": "91880085XXXX",
          "status": "SUBMITTED"
       },
       {
          "id": "32-2",
          "mobile": "91900467XXXX",
          "status": "SUBMITTED"
       },
       {
          "id": "32-3",
          "mobile": "91847101XXXX",
          "status": "SUBMITTED"
       }
    ],
    "msgid" => "981310XXXX"
    "message": "message Submitted successfully"
 }

Error Response

{
    "status":"AZQ02",
    "message":"Invalid Api Key"
}

API Document for TEMPLATE API

HTTP Template API Specification

Getting Template Details

https://sms.cipherdigi.com/V2/http-template-api.php?apikey=XXXXXXXXXXXXXXXX

HTTP API Specification

The API parameter specifications are described in the following sections

Mandatory Parameters

The mandatory parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
API Key	apikey	API/Working key generated from your SMS Account	Alphanumeric working key generated from web panel

Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name	Parameter	Description	Expected Values
Template id	templateid	Template id associated with template.	Specify template id to get details

Response Data

status	It indicates the success or failure of your request.
message	It indicates the success or failure message.
data	All the response is wrapped in side data

API Error Codes

The common error codes received while using the API to send an SMS is in the below format :

STATUS	MESSAGE
AZQ01	Kindly provide apikey
AZQ02	Invalid Api Key
AZQ03	Invalid user OR user is deactivated

Example Responses

Json

{
    "status": 'ok',
    "data": [
       {
          "templateName":"Test Template1",
          "peId":"110235XXXXXXXXXXXX",
          "templateId":"1107159XXXXXXXXXXX",
          "senderid":["SENDER"],
          "contentType":"Transactional",
          "categoryType":"Banking/Insurance/Financial products/ credit cards",
          "unicodeType":"normal",
          "templateData":"Dear {#var#} thanks1.",
       },
      {
          "templateName":"Test Template2",
          "peId":"110235XXXXXXXXXXXX",
          "templateId":"1107159XXXXXXXXXXX",
          "senderid":["312976","SENDER","schdps"],
          "contentType":"Service Explicit",
          "categoryType":"Real Estate",
          "unicodeType":"normal",
          "templateData":"Dear {#var#} thanks2.",
       }
    ],
    "message": "Success"
 }

Error Response

{
    "status":"AZQ01",
    "message":"Kindly provide apikey"
}

API Document for XML API

Send SMS using XML API :

https://sms.cipherdigi.com/V2/xml-api.php?xml=&format=XML;

Below is the sample xml data before url encoding. You have to send below xml in post method.

Parameter Specifications :

Mandatory Parameters :

Name	Parameter	Description	Expected Values
API Key	apikey	API/Working key generated from your SMS Account.	Alphanumeric working key generated from web panel
SENDERId	senderid	Sender ID 6 Character only allow.	Sender id EX: AZMARQ
NUMBER	number	Enter multiple number SMS Node(can repeat.(Required)	to : Mobile number in sms node.(Required)
MESSAGE	message	Message to be sent. In case of any special characters in your message, enclose it within CDATA a s in the example.	:

Optional Parameters

The optional parameters in the HTTP Balance API are tabulated below:

Name	Parameter	Description	Expected Values
Date and Time	datetime	for schedule sms.
Unicode	Unicode	2 (if you want to send regional language msg then use otherwise not required to use this parameter).

Sample XML Data :

<?xml version="1.0" encoding="UTF-8"?>
<api>
    <apikey>XXXXXXXXXXXXXXX</apikey>
    <senderid>XXXXX</senderid>
    <time></time>
    <unicode></unicode>
    <message><![CDATA[Testing XML API by support ]]></message>
    <sms>
    <to>XXXXXXXX</to>
    </sms>
    <sms>
    <to>XXXXXXXXX</to>
    </sms>
</api>

Error Response

Error status

<?xml version='1.0' encoding='UTF-8'?>
<api>
    <status>Error</status>
    <message>Please provide username and password.</message>
</api>

Success status

<?xml version='1.0' encoding='UTF-8'?>
<api>
    <status>OK</status>
    <data>
    <id>2763392-1</id>
    <mobile>918800852106</mobile>
    <status>SUBMITTED</status>
    </data>
    <data>
    <id>2763392-2</id>
    <918744022180</mobile>
    <status>SUBMITTED</status>
    </data>
    <message>message Submitted successfully</message>
</api>