API for SMS Notification
Mitracomm
Version 1.3
SMS Notification API SMS Notification Version 1.3
MitraComm Ekasarana
DOCUMENT HISTORY
Release Date Modification Author
Version 1.0 28/01/2010 Fix flow for ping & status Yudi Wijaya
Reffno rules for send SMS
Version 1.1 01/02/2010 Change fieldname user_id to Yudi Wijaya
userid
Version 1.2 06/09/2013 Add optional field ‘masking’ Yudi Wijaya
Version 1.3 19/05/2016 Add message Status Delivery Yudi Wijaya
Page 2 of 8
SMS Notification API SMS Notification Version 1.3
MitraComm Ekasarana
Transaction Flow
Partner use HTTP Post Protocol, and MitraComm will send SMS Notification
Request to Telco using Telco Specification.
The reply from MitraComm to Partner is transaction status.
1. SMS Notification response
Request Send SMS
SMS
Center
Partner Mitracomm Telco
SMS Status SMS Status
Using :
HTTP POST protocol
Address: http(s)://URL
POST DATA:
userid=USER_ID&password=PASSWORD&msisdn=MOBILE_NO&message=MESSAGE&refno=
REF_NO&masking=MASKING_ID
2. SMS Status Delivery
SMS Status
SMS
Center
Acknowledment
Partner Mitracomm Telco
SMS Status
Acknowledment
Using :
HTTP GET protocol
Address:
http(s)://URL/status?userid=USER_ID&password=PASSWORD&msisdn=MOBILE_NO&r
efno=REF_NO& status=SMS_STATUS
Page 3 of 8
SMS Notification API SMS Notification Version 1.3
MitraComm Ekasarana
3. SMS Ping / Heartbeat
Request
Mitracomm Partner
Response
4. SMS Status
Request
Mitracomm Partner
Response
Page 4 of 8
SMS Notification API SMS Notification Version 1.3
MitraComm Ekasarana
Send SMS
SMS Request from Partner to Mitracomm
Example :
https://1.2.3.4/sendsms
POST DATA:
userid=test&password=test123&msisdn=628123456789&message=test+message+us
ing+mitracomm+sms+push+service&refno=11111&masking=MITRACOMM
Field Name Description
URL URL for SMS API including server name, path, and page name.
userid will be given by Mitracomm (Alphanumeric 16)
password will be given by Mitracomm (Alphanumeric 16)
msisdn Mobile number include country code. Eq: 6281234567890
message Message to be sent to customer. Need to be URL-encoded
since it was sent as Query String. Limited to 160 character
only.
refno* Unique ID as Reference Number from Partner
(Alphanumeric 32)
masking ID assigned by Mitracomm to identify what that number will
be displayed on the recipient's phone (optional)
(Alphanumeric 11)
SMS Response from Mitracomm to Partner
Example :
refno=11111&status=0
Note:
- reply will be given in plain text in this format:
Field Name Description
refno* Reference Number from Partner
status Request acknowledge status
-1 = failed
0 = success (request ok)
3 = wrong user id or password or masking
*) If Partner provide the reference number on the SMS request, then on the SMS
response the reference number will be provide from Partner. But if Partner
doesn’t provide the reference number on the SMS request then for the SMS
response MitraComm will provide the reference number.
Page 5 of 8
SMS Notification API SMS Notification Version 1.3
MitraComm Ekasarana
SMS Status Delivery
SMS Status Delivery Info Mitracomm to Partner
Example :
https://1.2.3.4/status?userid=test&password=test123&msisdn=MOBILE_NO&ref
no=11111& status=SMS_STATUS
Field Name Description
URL URL for SMS API including server name, path, and page name.
userid will be given by Partner(Alphanumeric 16)
password will be given by Partner (Alphanumeric 16)
msisdn Mobile number include country code. (Numeric 15)
Eq: 6281234567890
refno ID as Reference Number from Partner (Alphanumeric 32)
status Status Delivery (Numeric 2)
10 = Sent
00 = Delivered
20 = Not enough balance
27 = Invalid phone number
29 = Telco Internal Error
Acknowledge from Partner to Mitracomm
Example :
status=0
SMS Ping (test connection)
SMS Request from Partner to Mitracomm
Example :
https://1.2.3.4/ping
POST DATA: -
Field Name Description
URL URL for SMS API including server name, path, and page name.
SMS Response from Mitracomm to Partner
Example :
status=0&responsedate=31-12-2008+23%3A59%3A59
Note:
- reply will be given in plain text in this format:
Field Name Description
status Request acknowledge status
0 = success
responsedate Response date time (dd-mm-yyyy HH:MM:SS)
Page 6 of 8
SMS Notification API SMS Notification Version 1.3
MitraComm Ekasarana
SMS Status (check transaction status)
SMS Request from Partner to Mitracomm
Example :
https://1.2.3.4/status
POST DATA: userid=test&password=test123&refno=11111
Field Name Description
URL URL for SMS API including server name, path, and page name.
userid will be given by Mitracomm
password will be given by Mitracomm
refno ID as Reference Number from Partner
SMS Response from Mitracomm to Partner
Example :
refno=11111&status=0
Note:
- reply will be given in plain text in this format:
Field Name Description
refno Reference Number from Partner
status SMS Status
0 = SMS sent
-1 = SMS not sent
Page 7 of 8
SMS Notification API SMS Notification Version 1.3
MitraComm Ekasarana
Appendix A
Notes :
• Maximum message displayed on Mobile phone screen are 160
characters
• Currently this API can send SMS for Indosat, XL, Telkomsel, Three
(HCPT), and SmartFren
• Supported characters = :><?;!@#$%^&*()`~/_+-,.'"= 0123456789
ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz (SmartFren
doesn’t support char &-ampersand and \-backslash)
Page 8 of 8
