API Document

1. Get Account Balance

This is the one of the functions you should try at first. It helps you get your remaining balance

URL Request:

http://rest.simosms.com/MainService.svc/xml/GetBalance/{ApiKey}/{SecretKey}

Request is consists of:
– Base Url
– Parameters

Base Url

You can use one of the following formats. It depends on your expected response format.

JSONXML
http://rest.simosms.com/MainService.svc/json/http://rest.simosms.com/MainService.svc/xml/

Parameters

The following table shows the parameters using for the request.

ParameterDescriptionRequired
ApikeyThe pair of key is use for authenticating the requestYes
Secretkey

Response:

It’s based on the base url. The following table shows the response for both Json and Xml format.

JSONXML

{
"Balance": 7527430,
"CodeResponse": "100",
"UserID": 0001
}
<MemberModel xmlns="http://schemas.datacontract.org/2004/07/AdvertisingAPI.Model"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Balance>7527430</Balance>
<CodeResponse>100</CodeResponse>
<UserID>0001</UserID>
</MemberModel>

Reference Codes:

CodeDescription
100:Success
99:Unknown error
101:Authorized failed
102:Account is blocked
103:Balance is insufficient

2. Send message functionality

The function is use for sending the message to single or multiple phone number(s).
SimoSMS supports many type of sender id such as long code, short code, alpha sender,etc,…
Therefore, to send the message using alpha sender, you need to register the sender before using to send the message.
Contact our business department for your reference at: +(855) 10 679 222.

Request:

Get Request:

http://rest.simosms.com/MainService.svc/xml/SendMultipleMessage_V4?Phone={PHONE}&Content={CONTENT}&ApiKey={APIKEY}&SecretKey={SECRETKEY}&IsUnicode={ISUNICODE}&Brandname={BRANDNAME}&SmsType={SMSTYPE}OriginalSender={ORIGINALSENDER}

Samples:
Type 2: Send with registered sender id (direct route)Type 8: Send with sim or dynamic sender (ss7 route)
http://rest.simosms.com/MainService.svc/xml/Send
MultipleMessage_V4Phone=85510679222&
Content=test&ApiKey=APIKEY&ampSecretKey=SECRECTKEY&
IsUnicode=0&Brandname=Verify&SmsType=2
&OriginalSender=Verify		http://rest.simosms.com/MainService.svc/xml/SendMultipleMessage_V4?Phone=85510679222&Content=test&ApiKey=APIKEY&
SecretKey=SECRECTKEY&IsUnicode=0&SmsType=8&
OriginalSender=Facebook

Post Request:

http://rest.simosms.com/MainService.svc/xml/SendMultipleMessage_V4_post/

Json Body :
Type 2: Send with registered sender id (direct route)Type 8: Send with sim or dynamic sender (ss7 route)

{
"apiKey":"{Your API key}",
"secretKey":"{Your Secrect key}",
"phone":"84968501615",
"content":"this is message test",
"isUnicode":"0",
"smsType":"2",
"brandname":"TEST"
}

{
"apiKey":"{Your API key}",
"secretKey":"{Your Secrect key}",
"phone":"84968501615",
"content":"this is message test",
"isUnicode":"0",
"smsType":"8",
"originalSender":"Facebook"
}

Request is consists of:
– Base Url
– Parameters

Base Url

You can use one of the following formats. It depends on your expected response format.

JSONXML
http://rest.simosms.com/MainService.svc/json/http://rest.simosms.com/MainService.svc/xml/

Parameters

The following table shows the parameters using for the request.

ParameterDescriptionRequired
PhoneDestination number
Format: [NationalCode]xxxxxx
Sample: 8496850166		Yes
ContentMessage textYes
APIKeyAPI key uses for authentication.
It is located in API management menu		Yes
SecretKeySecret key uses for authentication.
It is located in API management menu.		Yes
SmsType

Type of message you would like to send

ValueMeaning
2Direct
8Longcode, shortcode, dynamic sender
 
IsUnicode
CodeMeaning
1Sending with the unicode content
0Sending with non-unicode content
[Optional, default: 0]
BrandnameSender name. It is only available once sending over direct route (type 2).
Note: If you use type 8, remove this parameter from the request.		Required if use type 2
OriginalSenderSource sender. It is only available once sending over short code, long code, dynamic sender route (type 8)Required if use type 8

Response:

It’s based on the base url. The following table shows the response for both Json and Xml format.

JSONXML

{
"CodeResult": "100",
“CountRegenerate”:”0”,
"SMSID": "24342680"
}
<SmsResultModel xmlns="http://schemas.datacontract.org/2004/07/AdvertisingAPI.Model"
xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<CodeResult>100</CodeResult>
<CountRegenerate>0</CountRegenerate>
<SMSID>24342676</SMSID>
</SmsResultModel>

Response Format:

PropertyDescription
CodeResult

Reference Codes:

CodeDescription
100:Success
101:Authorized failed
103:Balance is insufficient
104:Sender name is not existed
118:Invalid message type
119:Sender name character must not exceed 21 characters
99:Unknown error
SMSIDMessage Id stored at SimoSms
ErrorMessageMessage response once the request is getting failed

3. SMPP

  • SMPP Version: 3.4
  • SMPP Host: 125.212.248.242
  • SMPP Port: 7889
  • SMPP System ID: provide in technical form
  • SMPP Password: provide in technical form
  • SMPP Service Type: leave it blank
  • SMPP Connection time out: 60 seconds
  • SMPP Enquire link: 20 seconds
  • SMPP Message State: DELIVRD, UNDELIV, REJECTD, EXPIRD
Call Now