Mtalkz

SMS API
Documentation

Date : 27/01/2022 www.mtalkz.com

+91-98686 29924, [email protected]

TABLE OF CONTENT

SENDING SMS PAGE 3

XML API PAGE 8

CUSTOMIZE SMS PAGE 10

PULL DLR RESPONSE PAGE 15

PUSH DLR RESPONSE PAGE 19

BALANCE API PAGE 21

DELETE SCHEDULE API PAGE 23

INTERNATIONAL SMS API PAGE 26

WHATSAPP SMS API PAGE 30

TEMPLATE API PAGE 34

SENDER ID API PAGE 36

Page 2
 1. Sending SMS

HTTP API Specification

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

Sending An SMS
http://msg.mtalkz.com/V2/http-api.php?
apikey=XXXXXXXXXXXXXXXX&senderid=XXXXXX&number=XXXXXXXXXXX,a
XXXXXXXXXXX,XXXXXXXXXXX&message=hello there&format=json

Sending An SMS Using Post method

http://msg.mtalkz.com/V2/http-api-post.php

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"
}

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/Working key generated Alphanumeric working key

API Key apikey
from your SMS Account generated from web panel

Sender ID assigned to your Sender ID 6 Character only

Sender ID senderid
account allow

Page 3
 Mobile number to which the SMS is
to be sent.The destination mobile Mobile number like 91XXXXXXXXX OR
Mobile number number number can be with or without 91. 98908XXXXX OR
Also provide multiple numbers in 91XXXXXXXXX,98908XXXXX
comma separated format.

Message text which is URL

encoded(Max 1000 char for normal,
Message message Message to be sent 500 for unicode).If message
contains short link then add
tx5.in/xyz/xxxxxxx in message content.

Optional Parameters
The optional parameters in the HTTP API are tabulated below:

Name Parameter Description Expected Values

To specify that the message to be

unicode unicode 2
sent is in unicode format.

To specify that the message to be

Template ID tempid Example : 1, 2, 101
sent with template data.

EX Format: YYYY-MM-DD
HH:MM:SS OR YYYY-MM-DD
Schedule time time Date and time for scheduling an SMS
HH:MM AM/PM
Like : 2016-12-06 04:45pm

To specify that the message is to be

flash flash 1
sent in the flash format.

To specify that the message to be

sent contain short link and message
Short Link shortlink 1
body must be contain short link
"tx5.in/xyz/xxxxxxx".

To specify that which url you want to The url you want to hit
Original URL originalurl
redirect on click. Ex: www.example.com

Output format should be as Output format should be as specified by

Response Type format
specified by this variable this variable

If you required delivery report at your

URL Like : www.XXXXXX.com or
Dlr URL dlrurl end, set your dlr ulr at time of
http://XXXXXX.com
message push

Principle Entity Specify the principle entity id to send

pe_id Ex: pe_id=120346821103XXXX
Id message

Specify the template id to send

Template Id template_id Ex: template_id=290346821103XXXX
message

Page 4
Example Responses
JSON

{
"status": "OK",
"data": [
{
"id": "32-1",
"mobile": "918800852106",
"status": "SUBMITTED"
},
{
"id": "32-2",
"mobile": "919004674356",
"status": "SUBMITTED"
},
{
"id": "32-3",
"mobile": "918471015383",
"status": "SUBMITTED"
}
],
"msgid" => "9813100982"
"message": "message Submitted successfully"
}

PHP
Array
(
[status] => OK
[data] => Array
(
[0] => Array
(
[id] => 34-1
[mobile] => 918800852106
[status] => SUBMITTED
)

[1] => Array

(
[id] => 34-2
[mobile] => 919004674356
[status] => SUBMITTED
)

[2] => Array

(
[id] => 34-3
[mobile] => 918471015383
[status] => SUBMITTED
)

Page 5
 )
[msgid] => 9813100982
[message] => message Submitted successfully
)

Error Response

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

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

Page 6
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

Page 7
 2. XML API

Send SMS using XML API :

http://msg.mtalkz.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.

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>

Parameter Specifications :
Mandatory Parameters :

Name Parameter Description Expected Values

API/Working key generated from your Alphanumeric working key

API Key apikey
SMS Account. generated from web panel

SENDERId senderid Sender ID 6 Character only allow. Sender id EX: AZMARQ

Enter multiple number SMS Node(can to : Mobile number in sms node.

NUMBER number
repeat.(Required) (Required)

Message to be sent. In case of any

special characters in your message,
MESSAGE message
enclose it within CDATA a s in the
example.

Page 8
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.

2 (if you want to send

regional language msg then
Unicode Unicode
use otherwise not required to
use this parameter).

Specify the principle entity id

Principle Entity Id pe_id Ex: pe_id=120346821103XXXX
to send message

Ex:
Specify the template id to
Template Id template_id template_id=290346821103XX
send message
XX

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>

Page 9
 3. Customize SMS

HTTP Customize API Specification

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

Sending Customize SMS

http://msg.mtalkz.com/V2/http-customize-api.php?
apikey=XXXXXXXXXXXXXXXX&senderid=XXXXXX&number=XXXXXXXXXXX,XXXXXX
XXXXX,XXXXXXXXXXX&message=msg1^msg2^msg3&shortlink=1&originalurl=XX
XXXXXX&format=json

Sending An SMS Using Post method

http://msg.mtalkz.com/V2/http-customize-api-post.php

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"
}
]
}

HTTP Customize API Specification

The API parameter specifications are described in the following sections

Page 10
Mandatory Parameters

The mandatory parameters in the HTTP Customize API are tabulated below

Name Parameter Description Expected Values

API/Working key generated Alphanumeric working key

API Key apikey
from your SMS Account generated from web panel

Sender ID assigned to your Sender ID 6 Character only

Sender ID senderid
account allow

Mobile number to which the

SMS is to be sent.The
Mobile number like
Mobile destination mobile number can
number 91XXXXXXXXX OR 98908XXXXX
number be with or without 91. Also
OR 91XXXXXXXXX,98908XXXXX
provide multiple numbers in
comma separated format.

Message text which is URL

encoded(Max 1000 char for
normal, 500 for unicode).If
Message message Message to be sent
message contains short link
then add tx5.in/xyz/xxxxxxx in
message content.

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

Name Parameter Description Expected Values

To specify that the message to be

unicode unicode 2
sent is in unicode format.

To specify that the message to be

Template ID tempid Example : 1, 2, 101
sent with template data.

EX Format: YYYY-MM-DD
Date and time for scheduling an HH:MM:SS OR YYYY-MM-DD
Schedule time time
SMS HH:MM AM/PM
Like : 2016-12-06 04:45pm

To specify that the message is to be

flash flash 1
sent in the flash format.

Page 11
 Name Parameter Description Expected Values

To specify that the message to be

Short Link shortlink 1
sent contain short link.

To specify that which url you want The url you want to hit
Original URL originalurl
to redirect on click. Ex: www.example.com

If you required delivery report at

URL Like : www.XXXXXX.com or
Response Type dlrurl your end, set your dlr ulr at time of
http://XXXXXX.com
message push

Specify the principle entity id to

Dlr URL pe_id Ex: pe_id=120346821103XXXX
send message

Specify the template id to send Ex:

Template Id template_id
message template_id=290346821103XXXX

Example Responses

JSON

{
"status": "OK",
"data": [
{
"id": "32-1",
"mobile": "918800852106",
"status": "SUBMITTED"
},
{
"id": "32-2",
"mobile": "919004674356",
"status": "SUBMITTED"
},
{
"id": "32-3",
"mobile": "918471015383",
"status": "SUBMITTED"
}
],
"msgid" => "9813100982"
"message": "message Submitted successfully"
}

Page 12
PHP

Array
(
[status] => OK
[data] => Array
(
[0] => Array
(
[id] => 34-1
[mobile] => 918800852106
[status] => SUBMITTED
)

[1] => Array

(
[id] => 34-2
[mobile] => 919004674356
[status] => SUBMITTED
)

[2] => Array

(
[id] => 34-3
[mobile] => 918471015383
[status] => SUBMITTED
)
)
[msgid] => 9813100982
[message] => message Submitted successfully
)

Error Response

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

Page 13
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

Page 14
 4. Pull DLR Response

HTTP API Specification

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

Get DLR Response

http://msg.mtalkz.com/V2/http-dlr.php?apikey=XXXXXXXXXXXXXXXX&id=xxxxxxxx-
x,xxxxxxxx-x,xxxxxxxx-x&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

API/Working key generated Alphanumeric working key generated

API Key apikey
from your SMS Account from web panel

Response id{"id":"xxxxxxxx-x"}
id like {"id":"xxxxxxxx-x"} give the status of
Id id to which you want to get
a number like 98908XXXXX
DLR Response.

Optional Parameters
The optional parameters in the HTTP API are tabulated below:

Name Parameter Description Expected Values

Response Output format should be as PHP/JSON. Default response will be in

format
Type specified by this variable. JSON

Page 15
Example Responses

JSON

{
"status": "OK",
"data": [
{
"id": "32-1",
"mobile": "8471015383",
"status": "submitted"
"status-desc": "delivered"
},
{
"id": "32-2",
"mobile": "8471015383",
"status": "submitted"
"status-desc": "delivered"
},
{
"id": "32-3",
"mobile": "8471015383",
"status": "submitted"
"status-desc": "delivered"
}
],
"message": "request Submitted successfully"
}

PHP

Array
(
[status] => OK
[data] => Array
(
[0] => Array
(
[id] => 34-1
[mobile] => 918800852106
[status] => submitted
[status-desc] => delivered
)

[1] => Array

(
[id] => 34-2
[mobile] => 919004674356
[status] => submitted
[status-desc] => delivered
)

Page 16
 [2] => Array
(
[id] => 34-3
[mobile] => 918471015383
[status] => submitted
[status-desc] => delivered
)

[message] => request Submitted successfully

)

Error Response

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

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

Page 17
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

Page 18
5. 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

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

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/Working key generated from Alphanumeric working key

API Key apikey
your SMS Account generated from web panel

Sender ID senderid Sender ID assigned to your account Sender ID 6 Character only allow

Mobile number to which the SMS is

to be sent.The destination mobile Mobile number like 91XXXXXXXXX
Mobile number number number can be with or without 91. OR 98908XXXXX OR
Also provide multiple numbers in 91XXXXXXXXX,98908XXXXX
comma separated format.

Message text which is URL

Message message Message to be sent encoded(Max 1000 char for
normal, 500 for unicode)

If you required delivery report at

URL Like : www.XXXXXX.com or
Dlr URL dlrurl your end, set your dlr ulr at time of
http://XXXXXX.com
message push

reqmethod used for, in which

menthod you want response POST
Request Method reqmethod or GET. If you not passing "post" for POST and "get" for GET
reqmethod parameter value default
will be post menthod

Page 19
Delivery Report Push Format using post method :

ULR response through post method :

[ { "msgid": "xxxxxxxxxxxxxx", "errorCode": "xxxx", "dlrTime": "xxxxxxxxxx", "mobile": "xxxxxxxxxxx",

"status": "Delivered" }, { "msgid": "xxxxxxxxxxxxxx", "errorCode": "xxxx", "dlrTime": "xxxxxxxxxx",
"mobile": "xxxxxxxxxxx", "status": "Delivered" }, { "msgid": "xxxxxxxxxxxxxx", "errorCode": "xxxx",
"dlrTime": "xxxxxxxxxx", "mobile": "xxxxxxxxxxx", "status": "Delivered" } ]

ULR response through GET method :

Your dlr URL?

msgid=xxxxxxxxxxxxxx&errorCode=xxx&dlrTime=xxxxxxxxxx&mobile=xxxxxxxxxx&senderid
=xxxxxx&status=xxxxxxxxxx

Response Dlr Push Paramerts Specification

Your DLR URL your dlr ulr at time of message push

sender Sender-id.

The unique identification for message given at the time of

msgid
submission

mobile Mobile number of which you get the response

Status of the message.( 'Delivered','Submitted', 'DNDFailed',

status
'Failed', 'Other')

Final dlr response by operator like : Delivered to handset, Absent

statusdesc
Subscriber

delivereddate Delivered date

Page 20
 6. 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

http://msg.mtalkz.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/Working key generated Alphanumeric working key

API Key apikey
from your SMS Account generated from web panel

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

Name Parameter Description Expected Values

Output format should be as PHP/JSON. Default response

Response Type format
specified by this variable. will be in JSON

Page 21
JSON

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

PHP

Array
(
[status] => OK
[data] => Array
(
[balance] => 50000
[status] => Transactional
)
[message] => Request Submitted successfully
)

Error Response

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

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

Page 22
7. Delete Schedule 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

http://msg.mtalkz.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/Working key generated Alphanumeric working key

API Key apikey
from your SMS Account generated from web panel

Message Schedule Message id of

msgid Message id EX: msgid=100
Id scheduled SMS

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

Name Parameter Description Expected Values

Response Output format should be as PHP/JSON. Default response will

format
Type specified by this variable. be in JSON

Page 23
Example Responses

JSON

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

PHP

Array
(
[status] => OK
[data] => Array
(
[balance] => 100
[status] => 2018-08-10 04:45 pm
)
[message] => Schedule message deleted successfully
)

Error Response

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

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

Page 24
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

Page 25
8. International SMS API

HTTP API Specification

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

Sending An SMS

http://msg.mtalkz.com/V2/http-api-int.php?
apikey=XXXXXXXXXXXXXXXX&senderid=XXXXXX&number=XXXXXXXXXXX,
XXXXXXXXXXX,XXXXXXXXXXX&message=hello there&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

API/Working key generated Alphanumeric working key

API Key apikey
from your SMS Account generated from web panel

Sender ID assigned to your

Sender ID senderid Sender ID you have
account

Mobile number to which the

SMS is to be sent.The
Mobile number like 91XXXXXXXXX
destination mobile number can
Mobile number number OR 98908XXXXX OR
be with or without 91. Also
91XXXXXXXXX,98908XXXXX
provide multiple numbers in
comma separated format.

Message text which is URL

encoded(Max 1000 char for
normal, 500 for unicode).If
Message message Message to be sent
message contains short link then
add tx5.in/xyz/xxxxxxx in message
content.

Page 26
Optional Parameters

The optional parameters in the HTTP API are tabulated below:

Name Parameter Description Expected Values

To specify that the message to be sent is in

unicode unicode 2
unicode format.

To specify that the message to be sent

Template ID tempid Example : 1, 2, 101
with template data.

EX Format: YYYY-MM-DD
Schedule HH:MM:SS OR YYYY-MM-DD
time Date and time for scheduling an SMS
time HH:MM AM/PM
Like : 2016-12-06 04:45pm

To specify that the message is to be sent in

flash flash 1
the flash format.

To specify that the message to be sent

Short Link shortlink contain short link and message body must 1
be contain short link "tx5.in/xyz/xxxxxxx".

To specify that which url you want to The url you want to hit
Original URL originalurl
redirect on click. Ex: www.example.com

Output format should be

Response Output format should be as specified by
format as specified by this
Type this variable
variable

Example Responses

JSON

{
"status": "OK",
"data": [
{
"id": "32-1",
"mobile": "918800852106",
"status": "SUBMITTED"
},
{
"id": "32-2",
"mobile": "919004674356",
"status": "SUBMITTED"
},
{
"id": "32-3",
"mobile": "918471015383",
"status": "SUBMITTED"
}
],
"msgid" => "9813100982"
"message": "message Submitted successfully"
}

Page 27
PHP

{
"status": "OK",
"data": [
{
"id": "32-1",
"mobile": "918800852106",
"status": "SUBMITTED"
},
{
"id": "32-2",
"mobile": "919004674356",
"status": "SUBMITTED"
},
{
"id": "32-3",
"mobile": "918471015383",
"status": "SUBMITTED"
}
],
"msgid" => "9813100982"
"message": "message Submitted successfully"
}

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

Page 28
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

Page 29
9. WhatsApp SMS API

HTTP API Specification

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

Sending An SMS

http://msg.mtalkz.com/V2/http-waapi.php?
apikey=XXXXXXXXXXXXXXXX&source=XXXXXX&number=XXXXXXXXXXX,
XXXXXXXXXXX,XXXXXXXXXXX&message=hello there&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

API/Working key generated from Alphanumeric working key

API Key apikey
your SMS Account generated from web panel

Source source Source assigned to your account Source you have

Mobile number to which the SMS is

Mobile number like XXXXXXXXX
to be sent. Also provide multiple
Mobile number number OR 98908XXXXX OR
numbers in comma separated
XXXXXXXXX,98908XXXXX
format.

Message text which is URL

Message message Message to be sent
encoded.

Page 30
Optional Parameters
The optional parameters in the HTTP API are tabulated below:

Name Parameter Description Expected Values

EX Format: YYYY-MM-DD
Date and time for scheduling an HH:MM:SS OR YYYY-MM-DD
Schedule time time
SMS HH:MM AM/PM
Like : 2020-12-06 04:45pm

Output format should be as PHP/JSON. Default response will

Response Type format
specified by this variable. be in JSON

Example Responses

JSON

{
"status": "OK",
"data": [
{
"id": "32-1",
"mobile": "880XXXXXXX",
"status": "SUBMITTED"
},
{
"id": "32-2",
"mobile": "900XXXXXXX",
"status": "SUBMITTED"
},
{
"id": "32-3",
"mobile": "847XXXXXXX",
"status": "SUBMITTED"
}
],
"msgid" => "9813100982"
"message": "message Submitted successfully"
}

Page 31
PHP

Array
(
[status] => OK
[data] => Array
(
[0] => Array
(
[id] => 34-1
[mobile] => 880XXXXXXX
[status] => SUBMITTED
)

[1] => Array

(
[id] => 34-2
[mobile] => 900XXXXXXX
[status] => SUBMITTED
)

[2] => Array

(
[id] => 34-3
[mobile] => 847XXXXXXX
[status] => SUBMITTED
)

)
[msgid] => 981XXXXXXX
[message] => message Submitted successfully
)

Error Response

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

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

Page 32
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 source

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

Page 33
10. Template API

HTTP Template API Specification

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

Getting Template Details

http://msg.mtalkz.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/Working key generated Alphanumeric working key

API Key apikey
from your SMS Account generated from web panel

Optional Parameters
The optional parameters in the HTTP API are tabulated below

Name Parameter Description Expected Values

Template id associated Specify template id to get

Template id templateid
with template. details

Page 34
Example Responses

JSON

{
"status": true,
"data": [
{
"templateName":"Test Template1",
"peId":"110235XXXXXXXXXXXX",
"templateId":"1107159XXXXXXXXXXX",
"unicodeType":"normal",
"templateData":"Dear {#var#} thanks1.",
"status":"Active"
},
{
"templateName":"Test Template2",
"peId":"110235XXXXXXXXXXXX",
"templateId":"1107159XXXXXXXXXXX",
"unicodeType":"normal",
"templateData":"Dear {#var#} thanks2.",
"status":"Active"
}
],
"message": "Success"
}

Error Response

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

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

Page 35
11. Sender ID API

HTTP Senderid API Specification

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

Getting Senderid
http://msg.mtalkz.com/V2/http-senderid-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/Working key generated Alphanumeric working key

API Key apikey
from your SMS Account generated from web panel

Example Responses

JSON

{
"status": true,
"data": [
{
"senderid":"XXXXXX",
"status":"Active"
},
{
"senderid":"XXXXXX",
"status":"Active"
}
],
"message": "Success"
}

Error Response

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

Page 36
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

Page 37