Bulk SMS
Interface Specification Document
V1.0
Page 1 of 6
Document control
Change history
Version Date Author Status Comments
0.1 2019-5-17 Mustafa M Beshr Draft Initial
Glossary
Term Description
Page 2 of 6
1 Introduction
1.1 Purpose
This document describes the detailed interface specifications which were provided by Yemen Mobile
Bulk SMS Gateway. Specification includes RESTful service content.
1.2 Scope
This document describes the parameters associated with RESTful service.
The RESTful interfaces will include (but not limit to) these parameters.
Note: On the premise of not affect function, some parameters name would be a little different between the
current document and the final RESTful interface.
1.3 Abbreviations
Abbreviation Description
Page 3 of 6
2 RESTful Service
2.1 Authentication :
Title The partner should authenticate before using any API to get an access token
which included in http header for upcoming requests.
URL /api/Auth/gettoken
Method POST
Content-type Content-Type: application/json
You must concatenate
Request Authorization: Basic username+':'+password
Authorization
<Base64(username:password)> , and then convert it to
Header Base64
ClientID: <partner identifier
ClientId
provided by Yemenmobile>
URL Params None
Data Params
None
(Body)
Code : 200 (OK)
Content :
Success {
Response access_token = [string],
username = [string],
expires = [number]
}
Page 4 of 6
2.2 Send SMS :
Title Use this API to send short message (SMS) to any Yemenmobile’s subscriber.
URL /api/SendSMS
Method POST
Request Content-type Content-Type: application/json
Header Authorization Authorization: <token-type> <access-token>
URL Params None
{
Id : [number],
Data Params client_id : [string],
mobile_no : [string],
(Body) message : [string],
language : [number]
}
{
Success
ResultCode = 1
Response , ResultMessage = Success
}
{ ResultCode = 300, ResultMessage = Client's balance did not enough}
Error { ResultCode = 301, ResultMessage = Client id does not correct}
{ ResultCode = 210, ResultMessage = Duplicated message at the last 15
Response minutes to the same mobile number}
Page 5 of 6
2.3 Change Password :
Title Use this API to change your password.
URL /api/changepassword
Method POST
Request Content-type Content-Type: application/json
Header Authorization Authorization: <token-type> <access-token>
URL Params None
{
Id : [number],
Data Params
client_id : [string],
(Body) oldpassword : [string],
newpassword : [string]
}
{
Success
ResultCode = 1
Response , ResultMessage = Success
}
Error { ResultCode = 301, ResultMessage = Client id does not correct}
{ ResultCode = 302, ResultMessage = old password does not correct}
Response { ResultCode = 303, ResultMessage = new password did not meet password
requirements policy}
Page 6 of 6
