Gts cloud mmp http api-sept2017
0 likes40 views
The document describes the HTTP API for connecting a third party application to the GTS-Cloud Mobile Messaging Platform. It allows applications to: 1. Send SMS messages (SMS-MT) to mobile phones by making HTTP requests with message details. 2. Receive SMS messages (SMS-MO) sent from mobile phones through HTTP requests to the application's server. 3. Get delivery reports for sent messages through HTTP requests with message IDs. 4. Check the account balance and details by making HTTP requests with login credentials. Detailed explanations and samples are provided for making HTTP requests to submit, receive, and get status of SMS messages and accounts.
![GTS-Cloud Mobile Messaging Platform HTTP API – Ver Juillet 2017
5/6
Other parameters can also be added to the HTTP request. Find below a complete list of
parameters available on the GTS-SMS Studio Server platform via HTTP API:
(* = Mandatory parameter)
Keyword Description
from * This specifies the sender mobile number
to * The destination number where the message is sent to.
id * The external ID of the message assigned by the external SME. This ID
was received with the incoming message for which this delivery report
is being sent.
Result is an array which contain SMS status value, from, to and id of the message.
Array ([sms_status] => delivered [from] => SenderID [to] =>
671234567 [id] => 472115F56173)
3.4 HTTP Request for Account Profile
To get your account profile information to the GTS-Cloud Mobile Messaging Platform:
Constructs a URL.
Makes the HTTP request based on the constructed URL, to the VASP platform.
To retrieve account profile information value, use the following http request:
http://mobilemarketing.gts-
infotel.com/gts/get_account?version=2&phone=UserPhoneNumber&pa
ssword=UserPassword
(* = Mandatory parameter)
Keyword Description
phone * Customer user account phone number. This
parameter is defined by customer
administrator/user when creating a user
account/user sub-account.
Phone = 6*******7
password * Customer user account password. This
parameter is defined by customer
administrator/user when creating a user
account/user sub-account.
Password = m*******s](https://image.slidesharecdn.com/gts-cloudmmphttpapisept2017-181020012402/85/Gts-cloud-mmp-http-api-sept2017-5-320.jpg)
Gts cloud mmp http api-sept2017
- 1. www.gts-infotel.com Email: support@gts-infotel.com Juillet 2017 TABLE OF CONTENTS 1 INTRODUCTION.................................................................................................. 2 2 FEATURES OF THE HTTP API OF GTS-Cloud Mobile Messaging P................................ 2 3 SUBMITTING SMS-MT MESSAGES FROM THE VASP APPLICATION ............................. 2 3.1 HTTP Request for Sending MT Messages........................................................... 3 3.2 HTTP Response for Sending MT Messages......................................................... 4 3.3 HTTP Request for Delivery Report.................................................................... 4 3.4 HTTP Request for Account Profile..................................................................... 5 4 RECEIVING SMS-MO MESSAGES TO THE VASP APPLICATION ................................... 6 4.1 HTTP Request for Receiving MO Messages ........................................................ 6 GTS-Cloud Mobile Messaging Platform: HTTP API SPECIFICATION
- 2. GTS-Cloud Mobile Messaging Platform HTTP API – Ver Juillet 2017 2/6 1 INTRODUCTION This document is addressed to third party SMS Service Providers (VAS Providers), who wish to connect their SMS Application platform to GTS-Cloud Mobile Messaging Platform via HTTP API for: Sending SMS Mobile Terminated (SMS-MT) messages to mobile phones & collecting delivery report. Receiving SMS Mobile Originated (SMS-MO) messages sent from mobile phones. This HTTP interface requires VAS Providers to develop an HTTP client to send SMS-MT messages to GTS-Cloud Mobile Messaging Platform, and also a HTTP server to receive SMS- MO messages and delivery report. Detailed explanations and samples will be given throughout the document; however, additional information and support on this HTTP interface can be obtained from GTS Support team at: support@gts-infotel.com. 2 FEATURES OF THE HTTP API OF GTS-Cloud Mobile Messaging P. The GTS-Cloud Mobile Messaging platform supports the following features: Direct connectivity to Operators SMSC over public Internet via GTS-SMS Studio server platform for the reception with powerful routing of SMS-MO via shortcodes/keywords & longcodes as well as for the sending of SMS-MT. Reception of text SMS-MO messages & routing to HTTP server develop by VAS Provider. Sending of various SMS message types: normal, long, based on SMS credit allocated the each application account: o Each SMS-MT decrement the SMS credit by 1 or more units, depending on the message type and the destination. SMS throughput: More than 20 SMS per sec. 3 SUBMITTING SMS-MT MESSAGES FROM THE VASP APPLICATION The HTTP Interface allows VASP platform to send SMS-MT message to GTS-Cloud MMP for onward delivery to the recipient using a specified route over public Internet via GTS-SMS Studio server platform. The GTS-Cloud Mobile Messaging Platform performs the following tasks after receiving the SMS-MT via a HTTP request: Checks the message parameters to ensure authentication and the SMS credit required to send the message, and if validated, attempts delivery to the GTS-SMS Studio server platform. Confirms the receipt of the HTTP request and message parameters to the VASP Application platform, using the HTTP response.
- 3. GTS-Cloud Mobile Messaging Platform HTTP API – Ver Juillet 2017 3/6 For a VASP platform to send SMS-MT to the GTS-Cloud MMP via the HTTP API, it must have the following: A HTTP user Account: to be created in the GTS-Cloud MMP by VASP. This account consists of UserPhoneNumber, password and other relevant details. The URL format supported by the GTS-Cloud MMP: as specified in this document. SMS credit on its account. 3.1 HTTP Request for Sending MT Messages The VASP application can send a text SMS-MT messages or other messages types to the GTS-Cloud MMP using the HTTP Request (GET) by simply calling an URL using the following format: http://mobilemarketing.gts- infotel.com/gts/sendsms?version=2&phone=UserPHONENumber&password=U serPASSWORD&from=SenderID&to=TO&text=YourMessageDATA&id=ID "phone" should be replaced by the phone number that identifies customer user SMS account. "password" should be replaced by the password that identifies customer user SMS account. "from" should be replaced with the shortcode/senderID that is assigned to your user account. "to" should be replaced by the mobile phone number that the application wishes to send the SMS message to. "text" should be replaced by the message data. The message data should be using UTF- 8 characters and should be urlencoded. Other parameters can also be added to the HTTP request. Find below a complete list of parameters available on the GTS-Cloud MMP via HTTP API: (* = mandatory parameter) Parameter Description Example phone* Customer user account phone number. This parameter is defined by customer administrator/user when creating a user account/user sub-account. login=671234567 password* Customer user account password. This parameter is defined by customer administrator/user when creating a user account/user sub-account. password=abc@123
- 4. GTS-Cloud Mobile Messaging Platform HTTP API – Ver Juillet 2017 4/6 from* Specifies the sender id. This information will be displayed on the mobile phone that receives the message. This can be a mobile number, a short code or an alphanumeric value. from=gtsinfotel to* The recipient mobile number, Which the message will be sent. More than one recipient addresses can be separated by a semicolon to=+237671234567 or (234805123456, +234803022222) text* Specifies the text or the data of the SMS message. text=Hello+World id The unique ID of the message assigned by the external SME. GTS-Cloud MMP can use this parameter to avoid receiving duplicate messages id= 2657867 3.2 HTTP Response for Sending MT Messages If the incoming request type has been recognized and all its text parameters (used in specifiers) are present, the message or delivery report will be received and the response will be sent back with HTTP status code 200. Otherwise, an appropriate HTTP error status code will be returned. For more information about HTTP errors, kindly visit the following link: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes code Description 200 Successful send 10 Your Account provider does not have enough credit to send SMS 11 The Account provider have some problem...contact him! 12 You do not have enough credit to send this SMS 13 Your account have been deactivated ... 14 Wrong password ... 15 Wrong phone number ... 3.3 HTTP Request for Delivery Report When the message is handed to the recipient, the mobile operator sends the delivery report to the GTS-Cloud Mobile Messaging Platform, which then: Constructs a URL. Makes the HTTP request based on the constructed URL, to the VASP platform. To retrieve the delivery report of previously sent message, use the following http request: http://mobilemarketing.gts- infotel.com/gts/get_dlr?from=SenderID&to=Recipient&id=MessageId
- 5. GTS-Cloud Mobile Messaging Platform HTTP API – Ver Juillet 2017 5/6 Other parameters can also be added to the HTTP request. Find below a complete list of parameters available on the GTS-SMS Studio Server platform via HTTP API: (* = Mandatory parameter) Keyword Description from * This specifies the sender mobile number to * The destination number where the message is sent to. id * The external ID of the message assigned by the external SME. This ID was received with the incoming message for which this delivery report is being sent. Result is an array which contain SMS status value, from, to and id of the message. Array ([sms_status] => delivered [from] => SenderID [to] => 671234567 [id] => 472115F56173) 3.4 HTTP Request for Account Profile To get your account profile information to the GTS-Cloud Mobile Messaging Platform: Constructs a URL. Makes the HTTP request based on the constructed URL, to the VASP platform. To retrieve account profile information value, use the following http request: http://mobilemarketing.gts- infotel.com/gts/get_account?version=2&phone=UserPhoneNumber&pa ssword=UserPassword (* = Mandatory parameter) Keyword Description phone * Customer user account phone number. This parameter is defined by customer administrator/user when creating a user account/user sub-account. Phone = 6*******7 password * Customer user account password. This parameter is defined by customer administrator/user when creating a user account/user sub-account. Password = m*******s
- 6. GTS-Cloud Mobile Messaging Platform HTTP API – Ver Juillet 2017 6/6 Result is a Json which contain Account profile information values. { "first_name" : "Rhesus", "last_name" : "Montoya", "email" : "rhesus.montoya@yahoo.fr", "phone" : "6*******7", "company_name" : "GTS-Infotel Cameroon", "sms_balance" : "447", "created" : "2016-04-22 07:54:00" } If an error occurred, an appropriate HTTP error status code will be returned. code Description 14 Wrong password ... 15 Wrong phone number ... 4 RECEIVING SMS-MO MESSAGES TO THE VASP APPLICATION The HTTP Interface allows VASP platform to receive SMS-MO message from the GTS- SMS Studio Server platform for processing, as depicted in the below figure: The mobile subscriber sends an SMS-MO to a specific shortcode/longcode. The mobile operator transmits this message to the GTS SMS Studio Server Gateway, which then: Constructs a URL. Makes the HTTP request based on the constructed URL, to the VASP platform. The GTS-SMS Studio Server platform expects VASPs to implement a HTTP server or Web service to receive SMS-MO messages via HTTP API. Please note that the VASP HTTP server’s firewall must be open to the GTS-SMS Studio Server platform IP before receiving any MO message. 4.1 HTTP Request for Receiving MO Messages Configured as an HTTP Client user, the GTS-SMS Studio Server platform takes incoming SMS-MO messages and initiates a HTTP GET request to a VASP’s server URL using the following format: <base_url>? from=originator&to=shortcode/longcode&text=msgdata
- 7. GTS-Cloud Mobile Messaging Platform HTTP API – Ver Juillet 2017 7/6 Other parameters can also be added to the HTTP request. Find below a complete list of parameters available on the GTS-SMS Studio Server platform via HTTP API: (* = Mandatory parameter) Keyword Description <base_url>? * The path to the URL where the customer’s HTTP application is hosted. from * This specifies the sender mobile number to * This is the short Code that is assigned to the service / the destination number the message is sent to. Text * This contains the message content. -END OF DOCUMENT-