Profile

EDS SMS API
Contents
1.
About EDS API ........................................................................................................................... 3
2.
Pre-Requirements ..................................................................................................................... 3
3.
How to use EDS API ................................................................................................................... 3
4.
How to use EDS API in .Net 2.0 Application .............................................................................. 4
5.
EDS API Key ............................................................................................................................... 4
6.
EDS API result packet. ............................................................................................................... 4
7.
8.
6.1.
EDS API Packet................................................................................................................. 4
6.2.
EDS API Packet structure ................................................................................................ 5
EDS API Service methods. ......................................................................................................... 5

7.1
Get API Key ........................................................................................................................ 5
7.2
Get balance credits ........................................................................................................... 6
7.3
Credits expiry date time .................................................................................................... 7
7.4
Get Support SMS message types ....................................................................................... 7
7.5
Get user expiry date time .................................................................................................. 8
7.6
Read registered sender ids. ............................................................................................... 9
7.7
Send short messages (SMS)............................................................................................. 10
7.8
Calculate text SMS counts ............................................................................................... 12
7.9
Get Eligible countries ...................................................................................................... 13
7.10
Get error codes and description...................................................................................... 14
7.11
Send short messages on schedule time and with priority (SMS) ..................................... 14
7.12
Schedule short messages (SMS) ...................................................................................... 17
7.13
Send Prioritised SMS on Special Routing ......................................................................... 19
7.14
Get Submit messages Delivery Status ............................................................................. 21
Send SMS over HTTP/GET Method ......................................................................................... 22
EDS SMS API v1.0

9.
Time zone and date time format............................................................................................. 24
10.
Consume EDS SMS API in .Net 4.0 Application .................................................................... 24
11.
Error codes. ......................................................................................................................... 25
2 |EDS SMS Api v1.0
Express Digital Systems
Published Document
EDS SMS API v1.0
1. About EDS API

The EDS SMS API is an interface to interact with EDS ESME. It serves to do
various short message (sms) related activities including value added
services. It is an input source for EDS ESME to send short messages (sms)
for onward transmission short message to mobile recipients by its well
equipped backed operator base.
The API built on Simple Object Access Protocol (SOAP). The API enables to
send messages from different applications running on different types of
operating systems and using different technologies. It consists of various
functional components to handle various day to day activities of the end
user in the area of short messaging.
2.
Pre-Requirements
Must have API Key to utilize services. A basic knowledge on consuming
SOAP and its services.
3. How to use EDS API

An application intended to utilize the EDS API should reference and use
various services using its smsapi class library. The class library has got
various methods to support different tasks.
The EDS API access URL https://api.edsfze.com/smsapi.svc
3 |EDS SMS Api v1.0
Published Document
EDS SMS API v1.0
4. How to use EDS API in .Net 2.0 Application

Create a Microsoft .net application.
Right click on project or references in Solution explorer and select Add web
reference.
In the Add Web Reference window, type or paste EDS API URL
(https://api.edsfze.com/smsapi.svc) in URL textbox and click GO (Arrow
marked). Support methods will be retrieved and shown along with web
reference name (com.edsfze.sms).
Click on Add Reference button to link the EDS API to your application
Your application is ready to access EDS API services.
Declare object of smsapi and use various services.
5. EDS API Key

API Key is a security key to use EDS API services. You will be provided the
key by Express Digital Systems. It can also be acquired with the help of web
portal credentials (if any).
6. EDS API result packet.

EDS API methods always returns xml packets. The root element is EDS.
Packet header is API. The xml packet is called as EDS API packet. The EDS
API packet used as return packet of web methods.
6.1.
EDS API Packet
The common packet consists of Key, Value, Code, Desc elements. It is

return or result packet of web methods. It is a common packet for success
and failed. The Key element consists identity of the packet. The Value
element consists of return or result data of the respective method. The
4 |EDS SMS Api v1.0
Published Document
EDS SMS API v1.0

Code consists of success code or error code. The success code is always 0
(zero) and error code is always negative value. The Desc tag consists of
either word Success or respective error description of the web method.
6.2.
EDS API Packet structure
<smsapi>
<Key>[Key Input Field]</Key>
<Value>[Result Value]</Value>
<Code>[Result code]</Code>
<Desc>[Result description]</Desc>
</smsapi>
7. EDS API Service methods.

Following are various tasks performed or supported by EDS API.
7.1
Get API Key
Objective
Service to obtain API key using account credentials (username

and password).
Method
GetApiKey
Parameters
Username
A valid user name of EDS SMS

account
Password
A valid user password of EDS

SMS account
5 |EDS SMS Api v1.0
Published Document
EDS SMS API v1.0

Return
EDS API Packet. The value key consists of API Key in case of
valid. Error code in case of invalid. The code tag contains 0 or
error code (zero for success). Desc tag consists of Success or
error description.
Return EDS API

Packet
<smsapi>
(Sample)
<Key>user1</Key>
<Value>e4h42889-ek40-4034-z587-6a5f33o6a29</Value>
<Code>0</Code>
<Desc>Success</Desc>
</smsapi>
7.2
Get balance credits
Objective
Service to get available or balance credits of the account.
Method
GetBalanceCredits
Parameter
Apikey as string
Return
EDS API Packet. The value tag contains balance credits in case
of valid API Key. Error code in case of invalid. The code tag
contains 0 or error code (zero for success). Desc tag consists
of Success or error description.
Return EDS API

Packet
<smsapi>
(Sample)
<Key>user1</Key>
<Value>27587</Value>
<Code>0</Code>
6 |EDS SMS Api v1.0
Published Document
EDS SMS API v1.0

</smsapi>
7.3
Credits expiry date time
Objective
Service to get credits expiry date and time of an account.
Method
GetCreditsExpiryTime
Parameter
Apikey as string
Return
EDS API Packet. The value tag consists of credits expiry date
and time in case of valid API Key. Error code in case of
invalid. The code tag contains 0 or error code (zero for
success). Desc tag consists of Success or error description.
Return EDS API

Packet (Sample) <smsapi>
<Key>user1</Key>
<Value>2013-02-10T09:32:57</Value>
<Code>0</Code>
</smsapi>
7.4
Get Support SMS message types
Objective
7 |EDS SMS Api v1.0
Service to get list of message types allowed to an account.
Published Document
EDS SMS API v1.0

Method
GetMesgTypes
Parameter
Apikey as string
Return
EDS API Packet. The packet may consists of multiple smsapi

nodes. The Key tag consists of Message type name. (This is
used while submit sms). The Value tag contains Message
Type code. The Code element consists 0 or error code. Desc
contains description.
Return EDS API

Packet (Sample)
7.5
<smsapi>
<Key>English</Key>
<Value>0</Value>
<Code>0</Code>
</smsapi>
<smsapi>
<Key>Arabic</Key>
<Value>8</Value>
<Code>0</Code>
</smsapi>
Get user expiry date time
Objective
Service to get user expiry date and time of an account.
Method
GetUserExpiryTime
Parameter
Apikey as string
8 |EDS SMS Api v1.0
Published Document
EDS SMS API v1.0

Return
Return EDS API

Packet (Sample)
7.6
Return EDS API Packet. The value tag contains user expiry
date and time in case of valid. Error code in case of invalid.
The code tag contains 0 or error code (zero for success).
Desc tag consists of Success or error description.
<smsapi>
<Key>user1</Key>
<Value>2015-12-31T22:40:50</Value>
<Code>0</Code>
</smsapi>
Read registered sender ids.
Objective
Service to get list of registered sender ids of an account.
Method
GetSenderIds
Parameter
Apikey as string
Return
Returns EDS API packet. The result may have multiple smsapi
nodes. The Value tag contains registered Sender ID in case of
valid. Error code in case of invalid. The code tag contains 0 or
error description.
Return EDS API

Packet
<smsapi>
(Sample)
<Key>User1</Key>
<Value>edsuae</Value>
<Code>0</Code>
</smsapi>
9 |EDS SMS Api v1.0
Published Document
EDS SMS API v1.0

<smsapi>
<Key>user1</Key>
<Value>edsuae</Value>
<Code>0</Code>
</smsapi>
<smsapi>
7.7
Send short messages (SMS)
Objective
Service to send or post message(s) to one more mobile

recipients.
Method
SendTextSMS
Parameter
apikey
A valid API Key of an account.
msg
English, Arabic (Unicode) message to submit.
Msgtype
The valid mesg type matching to message

given for msg parameter. This is one of Value
tag data of getmesgtypes method.
Sid
A valid registered sender id of the account.

(This is one of the Sender_ID from
GetSenderIds web method).
Mobiles
Comma delimited mobile numbers prefixed

with country code. Mobile numbers must fall
under allowed countries of the account or
user.
10 |EDS SMS Api v1.0
Published Document
EDS SMS API v1.0

Dlr
Return
Return EDS
API Packet
(Sample)
Request for delivery report for the respective

message. Valid values are either 1 or 0. 1 for
enable request and 0 for disable request.
Returns EDS API packet. The packet may have multiple smsapi
nodes based on mobiles parameter. The key tag contains
mobile number. The Value tag consists of ESME response or
reference of the submit message in case of valid (Always
numeric string value of positive). In case of invalid the value
tag contains an error reference. The error reference is always
in negative numeric value. The code contains 0 for success or
respective error code in case of error. The Desc contains
success for code value 0 and in case of error it displays the
error description based on the code.
<smsapi>
<Key>971566721834</Key>
<Value>31325950273</Value>
<Code>0</Code>
</smsapi>
<smsapi>
<Key>971506514467</Key>
<Value>31325950274</Value>
<Code>0</Code>
</smsapi>
<smsapi>
<Key>97150</Key>
<Value>-204</Value>
<Code>-204</Code>
<Desc>Invalid mobile number</Desc>
</smsapi>
Published Document
EDS SMS API v1.0

On Error, EDS
API Packet
(Sample)
Points to
ponder
7.8
<smsapi>
<Key>user1</Key>
<Value>-116</Value>
<Code>-116</Code>
<Desc>Invalid SenderID </Desc>
</smsapi>
While sending text messages if message type does not match

for message given, system automatically convert to respective
type and send message(s). In this regard, credits consumption
will adjust accordingly.
Mobile must be valid mobile numbers prefixed with support
country prefix.
Calculate text SMS counts
Objective
A support service to get sms counts of text message.
Method
CalTextSmsCount
Parameter
Apikey
Valid API Key of the account.
msg
Text message to calculate sms count
Return
EDS API Packet. The value tag consists of sms count in case of
valid API Key and Error code in case of invalid. The code tag
contains 0 or error code (zero for success). Desc tag consists
of Success or error description.
Published Document
EDS SMS API v1.0

Return EDS API
<Key>Hello!! World</Key>
<Value>1</Value>
<Code>0</Value>
</smsapi>
7.9
Get Eligible countries
Objective
A service to know the user eligible countries or routes.
Method
GetUserAllowedPrefixes
Parameter
Apikey as string
Return
Returns EDS API Packet. In case of valid API Key, the Key tag
contains country Name and value tag consists of country
code. In case of invalid, both tags consists of Error code. The
code tag contains 0 or error code (zero for success). Desc tag
consists of Success or error description.
Return EDS API

<Key>United Arab Emirates</Key>
<Value>971</Value>
<Code>0</Code>
</smsapi>
<smsapi>
<Key>India</Key>
<Value>91</Value>
<Code>0</Code>
Published Document
EDS SMS API v1.0

</smsapi>
</EDS>
7.10
Get error codes and description.
Objective
Service to obtain list of error code and their descriptions
Method
GetErrorCodes
Parameter
Apikey as string
Return
Returns EDS API Packet. The Key tag contains error code,
Value tag contains error description in case of valid API Key.
Error code in case of invalid. The code tag contains 0 or error
code (zero for success). Desc tag consists of Success or error
description.
7.11
Send short messages on schedule time and with priority (SMS)
Objective

recipients with additional inputs for schedule time and special
routing priority(Configured by service provider)
Method
PushTextSMS
Parameter
apikey
msg
Msgtype

Published Document
EDS SMS API v1.0
Return
Return EDS
API Packet
(Sample)
Sid

Mobiles

user.
Dlr

schedule
Schedule time in minutes with relative to

current time. It is a positive integer value to
schedule message after given number of
minutes from current date time.
priority
Preconfigured priority for special routing of

message for better performance. It is an
integer value provided by provider. If not
configured it will be ignored. Please contact
account manager for further information.
<smsapi>
<Key>971566721834</Key>
Published Document
EDS SMS API v1.0

<Value>31325950273</Value>
<Code>0</Code>
</smsapi>
<smsapi>
<Key>971506514467</Key>
<Value>31325950274</Value>
<Code>0</Code>
</smsapi>
<smsapi>
<Key>97150</Key>
<Value>-204</Value>
<Code>-204</Code>
</smsapi>
On Error, EDS
API Packet
(Sample)
Points to
ponder
<smsapi>
<Key>user1</Key>
<Value>-116</Value>
<Code>-116</Code>
</smsapi>

country prefix.
Published Document
EDS SMS API v1.0
7.12
Schedule short messages (SMS)
Objective
Method
Service to schedule short message(s) to one more mobile

recipients to transmit.
ScheduleSMS
Parameter
apikey
msg
Msgtype

Sid

Mobiles

user.
Dlr

schedule
Schedule time in minutes with relative to

current time. It is a positive integer value to
schedule message after given number of
minutes from current date time.
Return
Published Document
EDS SMS API v1.0

Return EDS
API Packet
(Sample)
On Error, EDS
API Packet
(Sample)
<smsapi>
<Key>971566721834</Key>
<Value>31325950273</Value>
<Code>0</Code>
</smsapi>
<smsapi>
<Key>971506514467</Key>
<Value>31325950274</Value>
<Code>0</Code>
</smsapi>
<smsapi>
<Key>97150</Key>
<Value>-204</Value>
<Code>-204</Code>
</smsapi>
<smsapi>
<Key>user1</Key>
<Value>-116</Value>
<Code>-116</Code>
</smsapi>
Published Document
EDS SMS API v1.0

Points to
ponder
7.13

country prefix.
Send Prioritised SMS on Special Routing
Objective
Method

recipients with special priority. This facilitates to handle
high/dedicated routing for high priority short messages. The
priority values are configured on special request by service
provider. (For further information contact service provider).
SendPrioritySMS
Parameter
apikey
msg
Msgtype

Sid

(This is one of the Sender ID from
Mobiles

user.
Published Document
EDS SMS API v1.0
Return
Return EDS
API Packet
(Sample)
Dlr

priority
Preconfigured priority for special routing of

message for better performance. It is an
integer value provided by provider. If not
configured it will be ignored. Please contact
account manager for further information.
<smsapi>
<Key>971566721834</Key>
<Value>31325950273</Value>
<Code>0</Code>
</smsapi>
<smsapi>
<Key>971506514467</Key>
<Value>31325950274</Value>
<Code>0</Code>
</smsapi>
<smsapi>
<Key>97150</Key>
<Value>-204</Value>
Published Document
EDS SMS API v1.0

<Code>-204</Code>
</smsapi>
On Error, EDS
API Packet
(Sample)
Points to
ponder
7.14
<smsapi>
<Key>user1</Key>
<Value>-116</Value>
<Code>-116</Code>
</smsapi>

country prefix.
Get Submit messages Delivery Status
Objective
Method
Service to acquire delivery status details of submitted

messages of an account with interval of 60 Minutes. This
applies short messages which submitted over API.
GetMessagesStatus
Parameter
Apikey as string
Return
Return Custom API Packet. The Key tag contains Submit

Reference, Status tag contains Delivery Status and Time tag
contains delivery time. This may contain multiple packets.
Published Document
EDS SMS API v1.0

Error code in case of invalid. The code tag contains 0 or
error description.
Return Custom
API Packet
(Sample)
Return EDS SMS

API Packet
(Sample)
<smsapi>
<Key>32011403364458</key>
<Status>DELIVRD</Status>
<Time>2014-01-19T05:22:33:560</Time>
<Code>0</Code>
</smsapi>
<smsapi>
<Key>user1</Key>
<Value>-146</Value>
<Code>-146</Code>
<Desc>No Pending Delivery Reports Found</Desc>
</smsapi>
8. Send SMS over HTTP/GET Method
Objective
HTTP/GET to send messages to one more mobile recipients.
Method
http://api.edsfze.com/http/sendsms.aspx
Parameter
apikey
msg
Published Document
EDS SMS API v1.0

Msgtype

Sid

Mobiles

user.
Dlr

Return
Returns EDS SMS API packet. The packet may have multiple
smsapi nodes based on mobiles parameter. The key tag
contains mobile number. The Value tag consists of ESME
response or reference of the submit message in case of valid
(Always numeric string value of positive). In case of invalid the
value tag contains an error reference. The error reference is
always in negative numeric value. The code contains 0 for
success or respective error code in case of error. The Desc
contains success for code value 0 and in case of error it
displays the error description based on the code.
Return EDS
SMS API
Packet
(Sample)
Like: mobilenumber-responseid-status
On Error, EDS
SMS API
Packet
(Sample)
Invalid Api Key
Ex: 971xxxxxxxxx-62111001101855-Success
Published Document
EDS SMS API v1.0

Points to
ponder

country prefix.
9. Time zone and date time format

All date and times are in UTC by default. The time zone can be configured to an
account. The date time format is ISO8601. It will be like [YYYY-MMDD]T[HH:MM:SS] (Example : 1900-10-10T00:00:00).
10. Consume EDS SMS API in .Net 4.0 Application

Create a Microsoft .net application.
Right click on project or references in Solution explorer and select Add
service reference.
In the Add Web Reference window, type or paste EDS SMS API URL
(http://api.edsfze.com/smsapi.svc) in URL textbox and click GO (Arrow
marked). Support methods will be retrieved and shown along with web
reference name (com.edsfze.sms).
Click on Add Reference button to link the EDS SMS API to your application
Your application is ready to access EDS SMS API services.
Declare object of ismsapiClient and use various services.
Published Document
EDS SMS API v1.0
11. Error codes.
Result Code
Result Description
-101
Invalid API Key
-102
General failure to get API Key
-103
General failure Invalid API Key.
-104
No registered sender ids.
-105
General failure to read sender ids
-106
No Message Types allowed.
-107
General failure to read Message Types
-108
General failure to get balance credits
-109
General failure to get Credits expiry date and time
-110
General failure to get user expiry date and time
-111
Insufficient Inputs to send SMS(s)
-112
Mismatch message type, could not send SMS(s).
-113
Invalid delivery request code, could not send SMS(s).
-114
Invalid length of mobiles parameter, could not SMS(s).
-115
General failure to send short message.
-116
Invalid sender id
-117
No Error codes found.
-118
General failure to read Error Codes.
-119
General failure Could not Could not calculate SMS credits.
Published Document
EDS SMS API v1.0

-120
No Routes Found
-121
General failure to read user routes
-122
No Day Report Found
-123
General failure to read user day report
-124
- No Day Route Report Found
-125
General failure to read user day route report
-126
No Day sender id Report Found
-127
General failure to read user day sender id report
-128
No Day sender id Route Report Found
-129
General failure to read user day sender id route report
-130
No Month Report Found
-131
General failure to read user month report
-132
No Month Route Report Found
-133
General failure to read user month route report
-134
No Month Sender id Report Found
-135
General failure to read user month sender Id report
-136
No Month Sender id Route Report Found
-137
General failure to read user month sender id route report
-138
No User Year Report Found
-139
General failure to read user year report
-140
No Year Route Report Found
-141
General failure to read user route report
-142
No Year Sender id Report Found
Published Document
EDS SMS API v1.0

-143
General failure to read user sender id report
-144
No Year Sender id Route Report Found
-145
General failure to read user year sender id route report
-146
No Pending Delivery Reports Found
-147
General failure to get delivery reports
-148
General Failure to Submit Schedule SMS
-149
General Failure to Submit Priority SMS
-150
Waiting time of 60 mins applicable.
-201
Spam message.
-202
Invalid schedule time.
-203
Invalid country prefix or code.
-204
Invalid mobile number.
-205
Invalid user/login timeout.
-206
Package expired.
-207
Country or Route not allowed.
-208
Credits expired.
-209
Message Type not allowed.
-210
Message submit fail.
-211
General failure - submit fail.
-212
Blocked Recipient
-213
Reject Recipient
-301
Insufficient Credits
Published Document
EDS SMS API v1.0

-302
Rejected Mobile
-303
Submit fail
End of Document
Published Document

Profile

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Profile

Uploaded by

Copyright:

Available Formats

EDS SMS API

About EDS API ........................................................................................................................... 3

How to use EDS API ................................................................................................................... 3

How to use EDS API in .Net 2.0 Application .............................................................................. 4

EDS API Key ............................................................................................................................... 4

EDS API result packet. ............................................................................................................... 4

EDS API Packet................................................................................................................. 4

EDS API Packet structure ................................................................................................ 5

EDS API Service methods. ......................................................................................................... 5

Get API Key ........................................................................................................................ 5

Get balance credits ........................................................................................................... 6

Credits expiry date time .................................................................................................... 7

Get Support SMS message types ....................................................................................... 7

Get user expiry date time .................................................................................................. 8

Read registered sender ids. ............................................................................................... 9

Send short messages (SMS)............................................................................................. 10

Calculate text SMS counts ............................................................................................... 12

Get Eligible countries ...................................................................................................... 13

Get error codes and description...................................................................................... 14

Schedule short messages (SMS) ...................................................................................... 17

Send Prioritised SMS on Special Routing ......................................................................... 19

Get Submit messages Delivery Status ............................................................................. 21

Send SMS over HTTP/GET Method ......................................................................................... 22

EDS SMS API v1.0

Time zone and date time format............................................................................................. 24

Consume EDS SMS API in .Net 4.0 Application .................................................................... 24

Error codes. ......................................................................................................................... 25

2 |EDS SMS Api v1.0

Express Digital Systems

EDS SMS API v1.0

1. About EDS API

3. How to use EDS API

The EDS API access URL https://api.edsfze.com/smsapi.svc

3 |EDS SMS Api v1.0

Express Digital Systems

EDS SMS API v1.0

4. How to use EDS API in .Net 2.0 Application

5. EDS API Key

6. EDS API result packet.

EDS API Packet

The common packet consists of Key, Value, Code, Desc elements. It is

4 |EDS SMS Api v1.0

Express Digital Systems

EDS SMS API v1.0

EDS API Packet structure

7. EDS API Service methods.

Get API Key

Service to obtain API key using account credentials (username

A valid user name of EDS SMS

A valid user password of EDS

5 |EDS SMS Api v1.0

Express Digital Systems

EDS SMS API v1.0

Return EDS API

Get balance credits

Service to get available or balance credits of the account.

Return EDS API

6 |EDS SMS Api v1.0

Express Digital Systems

EDS SMS API v1.0

Credits expiry date time

Service to get credits expiry date and time of an account.

Return EDS API