KEMBAR78
SMS API Technical Document V1.3 | PDF | Web Service | Json
0% found this document useful (0 votes)
184 views31 pages

SMS API Technical Document V1.3

This document outlines the methods and APIs provided by 'Community' for sending SMS messages, including features such as delivery reports and message validity. It details the request parameters, sample requests and responses in both XML and JSON formats, and includes a glossary of terms. The document serves as a guide for clients to utilize these services effectively within their accounts.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
184 views31 pages

SMS API Technical Document V1.3

This document outlines the methods and APIs provided by 'Community' for sending SMS messages, including features such as delivery reports and message validity. It details the request parameters, sample requests and responses in both XML and JSON formats, and includes a glossary of terms. The document serves as a guide for clients to utilize these services effectively within their accounts.
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 31

pg.

1
Table of Contents
I. Revision History..................................................................................................................... 3
II. Purpose of this document ...................................................................................................... 4
III. Glossary of Terms & Abbreviations......................................................................................... 4
IV. Methods provided by “Community” :...................................................................................... 5
1. SendSMS: .......................................................................................................................... 5
2. SendSMSWithDLR: ............................................................................................................ 8
3. SendSMSWithValidity: ..................................................................................................... 11
4. SendToMany: (API only) .................................................................................................. 14
5. SendOfflineSMS: ............................................................................................................. 16
6. SendSMSWithTemplate: (Web service only) .................................................................... 19
7. CheckCredit: .................................................................................................................... 21
8. CheckDLRStatus: (API only) .............................................................................................. 23
V. Methods to be provided by Client: ....................................................................................... 25
1. ReceiveDLR: (API) ........................................................................................................... 25
VI. All Code Values: ................................................................................................................... 27

pg. 2
I. Revision History

Date Version Author Description

01/08/2024 V1.0 Sandra Nashed • Initial document

pg. 3
II. Purpose of this document
• This document demonstrates how to use web services and APIs that provided by
“Community” to send SMSs by client from his purchased quota and check his
credit.
• “Community” provides the following list of web services:
o SendSMS
o SendSMSWithDLR
o SendSMSWithValidity
o SendOfflineSMS
o SendSMSWithTemplate
o CheckCredit
• “Community” provides the following list of APIs:
o SendSMS
o SendSMSWithDLR
o CheckDLRStatus
o SendSMSWithValidity
o SendToMany
o SendOfflineSMS
o CheckCredit
o GetDLRResponseStatus
• The provided web services use SOAP protocol, and the client can request and respond
the data through it using XML format.
• Provided APIs use REST protocol, and client can request and respond data through it
using JSON format.
• The URLs of the Web services accepts POST and GET methods, but the URLs of the APIs
use POST method only.
• Client can define list of IPs as White Listed IPs for their account, and SMSs will be sent
by that account through the defined White List IPs only.
• Client can define list of dials as Black Listed Dials for their account, and that account
will be eligible to send SMSs to any dial except the defined Black List Dials.
III. Glossary of Terms & Abbreviations
Term Definition

Client Refers to The entity which has account at “Community” SMS platform

An alphanumeric text appears to the SMS receivers as the message sender


Fake Sender
name (Instead of the mobile number)

SMS Quota The SMS count which available for the client to send using his account

DLR Delivery reporting is a feature that reports back SMS message delivery status

pg. 4
IV. Methods provided by “Community” :
1. SendSMS:
This method used to send SMSs only (without DLR – Without validity).
Request Parameters:
Parameter Description Data Type
• User name provided by “Community”
UserName* String
for the sender account
• Password provided by “Community”
Password* String
for the sender account
SMSText* • The text of the message String
• SMS language
o “E” for English
SMSLang* String
o “A” for Arabic
SMSSender* • The SMS fake sender String

SMSReceiver* • The dial that SMS will be sent to String


• The SMS global unified ID that
SMSID* GUID
generated by client.
• The ID of SMS’s campaign, that
CampaignID String
identified by the client (Optional)

pg. 5
• Web service complete URL
https://app.community-ads.com/SendSMSService/SMSSender.asmx?op=SendSMS
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendSMSxmlns="http://tempuri.org/">
<UserName>username</UserName>
<Password>123456</Password>
<SMSText>Test</SMSText>
<SMSLang>e</SMSLang>
<SMSSender>SMS Sender</SMSSender>
<SMSReceiver>01142220154</SMSReceiver>
<SMSID>0f6103e8-fd9a-4b53-00a3-f8fda400aa3a</SMSID>
</SendSMS>
</soap12:Body>
</soap12:Envelope>

• Request Values Sample (XML)Return Values Sample(XML)

<?xml version="1.0" encoding="utf-8"?>


<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendSMSResponse xmlns="http://tempuri.org/">
<SendSMSResult>0</SendSMSResult>
</SendSMSResponse>
</soap12:Body>
</soap12:Envelope>

Status code Integer represents the service response code


• API complete URL
https://app.community-ads.com/SendSMSAPI/api/SMSSender/SendSMS

pg. 6
• Request Values Sample (JSON)
{
"UserName": "username",
"Password": "123456",
"SMSText": "Test",
"SMSLang": "e",
"SMSSender": "SMS Sender",
"SMSReceiver": "201542220154",
"SMSID": "b0a3a0de-3748-4308-1f93-b6ce1a3a8108"
}

• Return Values Sample(JSON)


0

Status code Integer represents the service response code

pg. 7
2. SendSMSWithDLR:
This method used to send SMSs with the DLR report.
Request Parameters:

Parameter Description Data Type

UserName* • User name provided by “Community” for the


String
sender account
Password* • Password provided by “Community” for the sender
String
account
SMSText* • The text of the message String
• SMS language
SMSLang* o “E” for English String
o “A” for Arabic
SMSSender* • The SMS fake sender String

SMSReceiver* • The dial that SMS will be sent to String


• The SMS global unified ID that generated by client.
SMSID* GUID
• The ID of SMS’s campaign, that identified by the
CampaignID String
client (Optional)
• The URL where the client receives the DLR status
(Optional)
DLRURL • If client didn’t enter it, the system will use the URL String
that provided by the client with his account on
“Community” SMS platform.
• Web service complete URL
https://app.community-ads.com/SendSMSService/SMSSender.asmx?op=SendSMSWithDLR

pg. 8
• Request Values Sample (XML
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendSMSWithDLR xmlns="http://tempuri.org/">
<UserName>username</UserName>
<Password>123456</Password>
<SMSText>Test</SMSText>
<SMSLang>e</SMSLang>
<SMSSender>SMS Sender</SMSSender>
<SMSReceiver>01142220154</SMSReceiver>
<SMSID>0f6103e8-fd9a-4b53-00a3-f8fda400aa3a</SMSID>
<DLRURL>http://hostname/applicationname/receiveDLR/DLRStatus</DLRURL>
</SendSMSWithDLR>
</soap12:Body>
</soap12:Envelope>

pg. 9
Return Values Sample (XML)

<?xml version="1.0" encoding="utf-8"?>


<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendSMSWithDLRResponse xmlns="http://tempuri.org/">
<SendSMSWithDLRResult>0</SendSMSWithDLRResult>
</SendSMSWithDLRResponse>
</soap12:Body>

Status code Integer represents the service response code


• API complete URL
https://app.community-ads.com/SendSMSAPI/api/SMSSender/SendSMSWithDLR
• Request Values Sample (JSON)

{
"UserName":"username",
"Password":"123456",
"SMSText":"Test",
"SMSLang":"a",
"SMSSender":"SMS Sender",
"SMSReceiver":"201542220154",
"SMSID":"b0a3a0de-3748-4308-1f93-b6ce1a3a8108",
"DLRURL":"http://hostname/applicationname/receiveDLR/DLRStatus"
}

• Return Values Sample(JSON)

Status code Integer represents the service response code

pg. 10
3. SendSMSWithValidity:
This method used to send SMS with the feature of sending schedule/on spot, and
retrying to send the failed messages.

Request Parameters:

Parameter Description Data Type

UserName* • User name provided by “Community”


String
for the sender account
Password* • Password provided by “Community” for
String
the sender account
SMSText* • The text of the message String
• SMS language
SMSLang* o “E” for English String
o “A” for Arabic
SMSSender* • The SMS fake sender String

SMSReceiver* • The dial that SMS will be sent to String


• The SMS global unified ID that generated
SMSID* GUID
by client.
• The ID of SMS’s campaign, that identified
CampaignID String
by the client (Optional)
Validity • The period in minutes which the system String
keeps retrying to send the failed
messages (Optional)

pg. 11
• In case of the defined time ended
without sending the message, the
message sending status will be “Failed”.
• If the client didn’t enter the validity value,
the system will use the value that set
before in his account information on
“Community” SMS platform
o If the system didn’t find it, it will use
the default value which is 3 minutes
In while StartTime • Time to start sending SMS (Optional) String
• If the client didn’t enter it, the system will
send the SMS on spot
• Web service complete URL:
https://app.community-ads.com/SendSMSService/SMSSender.asmx?op=SendSMSWithValidity
• Request Values Sample (XML)

<?xml version="1.0" encoding="utf-8"?>


<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendSMSWithValidity xmlns="http://tempuri.org/">
<UserName>username</UserName>
<Password>123456</Password>
<SMSText>Test</SMSText>
<SMSLang>e</SMSLang>
<SMSSender>SMS Sender</SMSSender>
<SMSReceiver>01142220154</SMSReceiver>
<SMSID>0f6103e8-fd9a-4b53-00a3-f8fda400aa3a</SMSID>
<Validity>5</Validity>
<StartTime>25/08/2019 16:48:00</StartTime>
</SendSMSWithValidity>
</soap12:Body>
</soap12:Envelope>

pg. 12
• Return Values Sample (XML)

<?xml version="1.0" encoding="utf-8"?>


<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendSMSWithValidityResponse xmlns="http://tempuri.org/">
<SendSMSWithValidityResult>0</SendSMSWithValidityResult>
</SendSMSWithValidityResponse>
</soap12:Body>

Status code Integer represents the service response code


• API complete URL
https://app.community-ads.com/SendSMSAPI/api/SMSSender/SendSMSWithUserSMSIdAndValidity
• Request Values Sample (JSON)

{
"UserName":"username",
"Password":"123456",
"SMSText":"Test",
"SMSLang" :"e",
"SMSSender":"SMS Sender",
"SMSReceiver":"201542220154",
"SMSID":"b0a3a0de-3748-4308-1f93-b6ce1a3a8108",
"Validity":"4",
"StartTime": "15/09/2019 16:48:00"
}
• Return Values Sample(JSON)
0

Status code Integer represents the service response code

pg. 13
4. SendToMany: (API only)
This method used to send SMSs to several dials.

Request Parameters:

Parameter Description Data Type

UserName* • User name provided by “Community” for


String
the sender account
Password* • Password provided by “Community” for
String
the sender account
SMSText* • The text of the message String
• SMS language
SMSLang* o “E” for English String
o “A” for Arabic
SMSSender* • The SMS fake sender String
• Dials that message are sent to, following by String
Anis* the SMSs’ GUIDs which created by the
client
• The ID of SMSs’ campaign, that identified
CampaignID String
by the client (Optional)
• Determine whether client will receive DLR String
for sent SMSs or not:
WithDLR
o “true” for sending with DLR
o “false” for sending without DLR

pg. 14
Validity • The period in minutes which the system String
keeps retrying to send the failed messages
(Optional)
• In case of the defined time ended without
sending the message, the message sending
status will be “Failed”.
• If the client didn’t enter the validity value,
the system will use the value that set
before in his account information on
“Community” SMS platform
o If the system didn’t find it, it will use the
default value which is 3 minutes
• API complete URL
https://app.community-ads.com/SendSMSAPI/api/SMSSender/SendToMany
• Request Values Sample (JSON)

{
"UserName":"username",
"Password":"123456789",
"SMSText":"Test",
"SMSLang" :"e",
"SMSSender":"SMS Sender",
"Anis": ["01024875436,5f50f470-3295-4e35-9005-
2f54a0fd7449","01024875437,5f50f470-3295-4e35-9005-
2f54a0fd7459","01024875438,5f50f470-3295-4e35-9005-2f54a0fd7849"],
"Validity":"4",
"WithDLR":"true"
}

• Return Values Sample (JSON)

0
Status code Integer represents the service response code

pg. 15
5. SendOfflineSMS:
This method used to receive SMS from the client and send it offline by “Community”
for better sending performance.

Request Parameters:

Parameter Description Data Type

UserName* • User name provided by “Comminity”for


String
the sender account
Password* • Password provided by “Comminity”for
String
the sender account
SMSText* • The text of the message String
• SMS language
SMSLang* o “E” for English String
o “A” for Arabic
SMSSender* • The SMS fake sender String

SMSReceiver* • The dial that SMS will be sent to String


• The SMS global unified ID that generated by
SMSID* GUID
client.
• The ID of SMS’s campaign, that identified by the
CampaignID String
client (Optional)
WithDLR • Determine whether client will receive DLR for sent
SMSs or not:
String
o “true” for sending with DLR
o “false” for sending without DLR

pg. 16
Validity • The period in minutes which the system keeps
retrying to send the failed messages (Optional)
• In case of the defined time ended without
sending the message, the message sending
status will be “Failed”.
String
• If the client didn’t enter the validity value, the
system will use the value that set before in his
account information on “COMMUNITY” SMS
platform
o If the system didn’t find it, it will use the
default value which is 3 minutes
• Web service complete URL:
https://app.community-ads.com/SendSMSService/SMSSender.asmx?op=SendOfflineSMS
• Request Values Sample (XML)

<?xml version="1.0" encoding="utf-8"?>


<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendOfflineSMS xmlns="http://tempuri.org/">
<UserName>username</UserName>
<Password>123456</Password>
<SMSText>Test</SMSText>
<SMSLang>e</SMSLang>
<SMSSender>SMS Sender</SMSSender>
<SMSReceiver>01142220154</SMSReceiver>
<SMSID>0f6103e8-fd9a-4b53-00a3-f8fda400aa3a</SMSID>
<CampaignID>6</CampaignID>
<WithDLR>true </WithDLR>
<Validity>3</Validity>
</SendOfflineSMS >
</soap12:Body>
</soap12:Envelope>

pg. 17
• Return Values Sample (XML)

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendOfflineSMSResponse xmlns="http://tempuri.org/">
<SendOfflineSMSResult>0</SendOfflineSMSResult>
</SendOfflineSMSResponse>
</soap12:Body>

Status code Integer represents the service response code


• API complete URL
https://app.community-ads.com/SendSMSAPI/api/SMSSender/SendOfflineSMS
• Request Values Sample (JSON)

{
"UserName":"username",
"Password":"123456",
"SMSText":"Test",
"SMSLang":"e",
"SMSSender":"SMS Sender",
"SMSReceiver":"01234626128",
"SMSId":"0f6103e8-fd9a-4b53-00a3-f8fda400aa3a",
"CampaignID": "1213af",
"WithDLR": "True",
"Validity":"4"
}

• Return Values Sample(JSON)

Status code Integer represents the service response code


pg. 18
6. SendSMSWithTemplate: (Web service only)
• This method used to send customized SMSs with placeholders.

Request Parameters:

Parameter Description Data Type

UserName* • User name provided by “Community” for the


String
sender account
Password* • Password provided by “Community” for the
String
sender account
• SMS language
SMSLang* o “E” for English String
o “A” for Arabic
SMSSender* • The SMS fake sender String

SMSReceiver* • The dial that SMS will be sent to String


• The SMS global unified ID that generated by
SMSID* GUID
client.
• The ID of SMS’s campaign, that identified by the
CampaignID String
client (Optional)
Template* • The SMS’s text with the possibility of adding String
place holders
• The place holders replaced with the values which
mentioned in the “Items” parameter
• The place holder key added between two
percentage signs ➔ % %

pg. 19
• In case of the client enters a key not
included in the “Items” parameter, the
SMS will be rejected
Items* • The place holder’s value aligned with its String
key which used in the text of the
parameter “template”
• It could be one place holder or more
• Web service complete URL :
https://app.community-ads.com/SendSMSService/SMSSender.asmx?op=SendSMSWithTemplate
Request Values Sample (XML)

<?xml version="1.0" encoding="utf-8"?>


<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendSMSWithTemplate xmlns="http://tempuri.org/">
<UserName>username</UserName>
<Password>123456</Password>
<SMSLang>e</SMSLang>
<SMSSender>SMS Sender</SMSSender>
<SMSReceiver>01062612890</SMSReceiver>
<SMSID>0f6103e8-fd9a-4b58-00a3-f8fda400aa3a</SMSID>
<Template>MR %Fname% we are pleased to inform you that your card that
ended by %LastFourDigitsOfCardNo% won our big prize for more
information call 99999</Template>
<Data>
<Item value="Ahmed" key="Fname" />
<Item value="6789" key="LastFourDigitsOfCardNo" />
</Data>
</SendSMSWithTemplate>
</soap12:Body>
</soap12:Envelope>

pg. 20
• Return Values Sample (XML)

<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<SendSMSWithTemplateResponse xmlns="http://tempuri.org/">
<SendSMSWithTemplateResult>0</SendSMSResult>
</SendSMSWithTemplateResponse>
</soap12:Body>

Status code Integer represents the service response code

7. CheckCredit:
This method used to check client’s SMS quota on the system.
Request Parameters:

Parameter Description Data Type

UserName* • User name provided by “Community” for


String
the sender account
Password* • Password provided by “Community” for
String
the sender account

pg. 21
• Web service complete URL
https://app.community-ads.com/CheckCreditService/CheckCreditService.asmx
• Request Values Sample (XML)

<?xml version="1.0" encoding="utf-8"?>


<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<CheckCredit xmlns="http://tempuri.org/">
<userName>username</userName>
<password>123456</password>
</CheckCredit>
</soap12:Body>
</soap12:Envelope>

• Return Values Sample (XML)

<?xml version="1.0" encoding="utf-8"?>


<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<CheckCreditResponse xmlns="http://tempuri.org/">
<CheckCreditResult>-1</CheckCreditResult>
</CheckCreditResponse>
</soap:Body>
</soap:Envelope>

Status code Integer represents the service response code

pg. 22
• API complete URL:
https://app.community-ads.com/CheckCreditApi/api/CheckCredit
• Request Values Sample (JSON)

{
"UserName":"username",
"Password":"123456"
}

• Return Values Sample(JSON)

-1

Status code Integer represents the service response code

8. CheckDLRStatus: (API only)


This method used to return DLR status for sent messages with DLR.
Request Parameters:

Parameter Description Data Type

UserName* • User name provided by “Community” for


String
the sender account
Password* • Password provided by “Community” for
String
the sender account
UserSMSId* • The text of the message String

• API complete URL:


https://app.community-ads.com/CheckDLRStatus/api/CheckDLRStatus
• Request Values Sample (JSON)

pg. 23
{
"UserName":"username",
"Password":"123456",
"UserSMSId":"00000000-0000-0000-0000-000000000000"
}

• Return Values Sample(JSON)

Status code Integer represents the service response code

pg. 24
V. Methods to be provided by Client:
1. ReceiveDLR: (API)
• This method must be created by the client to receive the DLR status in case
of using the SendSMSWithDLR method and the account has the privilege to
receive DLR.
• The client provides “Community” with URL to receive the DLR status
parameters values (This URL may be the URL that added when the client’s
account created on “Community” SMS platform, or the system will use the
URL which added by client while using SendSMSWithDLR method)

pg. 25
• The RecieveDLR will be called with the following format with Get verb over
HTTP(s): [Client Receive DLR Status
URL]?userSMSId={0}&dlrResponseStatus={1}
• In case of the client needs to add more parameters to the mentioned
parameters of this API, he shall provide “Community” with it.
• Client can get the DLR full report through his account on the reseller
reporting tool.

Request Parameters:

Parameter Description Data Type

• The SMS global unified ID which generated


userSMSId* by the client and sent through methods GUID
that have the DLR option
• SMS delivery report status:
o DeliveredToPhone (SMS delivered
successfully)
o NonDeliveredToPhone RecieveDLR
(SMS not delivered)
dlrResponseStatus* String
o Queued RecieveDLR (SMS still in the
queue)
o SentWithoutReceivingDLR (SMS has
sent without receiving DLR option)
o Failed (SMS failed to send)

pg. 26
• Request Values Sample

{
"userSMSId"= "5f50f470-3295-4e35-9005-2f54a0fd7459",
"dlrResponseStatus" = "1"
}

VI. All Code Values:


The following table shows the code values of the different statuses, and the API/Web service
which use it (Common means that the code value used in all APIs/Web services):

Code Description Method Scenario

0 Success Common SMS sent successfully, and in


case of “CheckCredit”
method, it means client
quota is unlimited

-1 Invalid Credentials Common Invalid username or


password

-2 Invalid Account IP Common SMS has been sent by an


account through not white
listed IPs of the sender’s
account

-3 Invalid ANI Black List Common SMS sent to black listed dial
of the sender’s account

-5 Out Of Credit Common Account’s quota has ended

-6 Database Down Common SMS platform database down

-7 Inactive Account Common The sending account isn’t


active

-8 No DLR received GetDLRResponseStatus In case of SMS submitted and


sent but no delivery report
received from operator yet
pg. 27
-11 Account Is Expired Common The account exceeded the
expire date

-12 SMS Is Empty Common There is no text

-13 Invalid Sender With Common There is a problem with the


Connection connection

-14 SMS Sending Failed Try Common While sending SMS an error
Again occurs and SMS not sent

-100 Other Error Common Internal server error

-16 User Can Not Send With DLR SendSMSWithDLR, This account doesn’t have the
SendOfflineSMS send with DLR option.

-18 Invalid ANI Common ANI is wrong

-19 SMS Id Is Exist Common Repeated SMS Id, and SMS ID


must be unique

-21 Invalid Account Common The sending account is not


exist in the system

-22 SMSNotValidate Common SMS not validate yet because


the database is down, it will
be validated later and send to
kannel

-23 Invalid Account Operator Common The connection is wrong


Connection

-26 Invalid User SMS Id Common SMS ID not a GUID

-29 Empty User Name Or Common User name or password fields


Password has no data

-30 Invalid Sender Common Invalid SMS fake sender

-31 InvalidStartTime SendSMSWithValidity The start time is invalid

pg. 28
-32 InvalidSMSTemplateOrItems SendSMSWithTemplate In case of the client enters a
key not included in the
“Items” parameter

pg. 29
1 DeliveredToPhone GetDLRResponseStatus, • In case
CheckCredit “GetDLRResponseStatus”
methods, it means SMS
delivered successfully
• In case of “CheckCredit”
method, it means client
quota is 1 SMS

2 NonDeliveredToPhone GetDLRResponseStatus, • In case of


CheckCredit “GetDLRResponseStatus”
methods, it means SMS
not delivered
• In case of “CheckCredit”
method, it means client
quota is 2 SMS

3 Queued GetDLRResponseStatus, • In case of


CheckCredit “GetDLRResponseStatus”
methods, it means SMS
still in the queue
• In case of “CheckCredit”
method, it means client
quota is 3 SMS

4 SentWithoutReceivingDLR GetDLRResponseStatus, • In case of


CheckCredit “GetDLRResponseStatus”
methods, it means SMS
has sent without receiving
DLR option
• In case of “CheckCredit”
method, it means client
quota is 4 SMS

5 Failed GetDLRResponseStatus, • In case of


CheckCredit “GetDLRResponseStatus”
methods, it means SMS
failed to send
• In case of “CheckCredit”
method, it means client
quota is 5 SMS

pg. 30
N Client Quota CheckCredit Positive number describe
number of available SMS
credit for client to send

pg. 31

You might also like