Skip to content

globelabs/gl-docs

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

93 Commits

README.md

README.md

 
 

Repository files navigation

Getting Started

Subscriber Consent Workflow

Access Tokens are required in order to transact (SMS, Voice or Charging API) with a subscriber. To get the access token, the subscribers need to grant the developer app in either two ways:

  • via SMS
  • via Web Form (OAuth 2.0)

Create An App

After successful registration and login, create an app at http://developer.globelabs.com.ph/apps/new or by clicking the Create App button.

In order to create an app, user must fill out a minimum of required fields which are the following:

  • Name - Application name, this will be included in the 'welcome message' sent to the subcriber.

  • Short Description - A short description that will also be included in the 'welcome message' sent to the subscriber.

  • Email Support - Valid Email address for contact that will also be included in the 'welcome message' sent to the subscriber.

  • Category - Select a category for this app.

  • Redirect URI - This link will receive the Code parameter if via web form, or Access Token if via SMS.

    Code parameter: required to get your subscriber's Access Token. This is sent to your Redirect URI, and access it via GET.

    Access Token: required to use the API.

  • API Type - Upon selection of the API type, there are certain API's that may require new fields:

    SMS

    • Notify URI - Everytime your short code receives a message, this link will receive the data in JSON format.

    Voice

    • Voice URI - Either in Scripting or WEB API; this contains your code/commands to be accessed.

After creation, your app will have its own Short Code.

Redirect and Notify URI

The following are the minimum expectations for your app's Redirect and Notify URI:

  1. Your URIs must be either a publicly accessible domain or web server i.e. no SSL certificate verification required
  2. Your URIs can perform basic HTTP Server functionalities. At the minimum, our platform expects an HTTP Status Code 200 response from your URIs for every HTTP request sent.

Opt-in via SMS

  1. Subscribers need to text INFO to your Short Code.

    Short Code provided to your app after creation, see your app's details.

  2. Upon receipt of the ‘welcome message’, the subscriber needs to reply YES.

    Welcome Message - welcome message mentioned in the Create App Section.

  3. After the subscriber replies (Yes), the Access Token and the Subscriber’s mobile number will be sent to your Redirect URI, you can get these parameters via GET method.

Sample GET to Redirect URI
GET /?access_token=E1enKbxfLBUH7b_1E500G_V16fM-Yxmm1VHAR15Re9I&subscriber_number=9179471234 HTTP/1.1

Opt-in via Webform

  1. Platform redirects your subscribers to this url:

    https://developer.globelabs.com.ph/dialog/oauth/<APP_ID_HERE>

  2. The page will ask to key-in the subscriber’s mobile number and subscriber clicks the Grant button.

  3. The page will be redirected, and an SMS with confirmation pin will be sent to the subscriber.

  4. The subscriber needs to key-in on the page the received confirmation pin and click the button Confirm to authorize the subscriber.

  5. The page will then be redirected to the redirect_uri of your application, and a Code parameter will be passed as a URL query parameter to it.

  6. To get the access token, you need to do a POST request via https://developer.globelabs.com.ph/oauth/access_token with your ‘app_id’, ‘app_secret’ and ‘code’ as URL query parameters. The parameters ‘access_token’ and ‘subscriber_number’ will then be returned to your Redirect URI as a response.

Code as URL Parameter
http://www.sample-redirect-url.com/?code=bLfXLEL9CM8nReI78kxAI7ra56hrBzrBsyonbkIzepngUdrKKyC5Mp5ahgKLAzF9z76RfA4rjrsaAdqeCBkGrMF4MA6MfK6bkGsB89onSL9ER6sbr5yGCzMa8RfA7TzAbqKTa6EfaE5BzCK7ErMsMK9LpSnobejsxrALxfE9GkzFGEdEaCj6rLXsL578RfdyL9rFkbp49hXxK7pCejpAgUyXnj7Ij4zdbsLpar9hKzkA8IEdneMIpjE45CaXjE7f
Sample POST to get Access Token
POST -x 'https://developer.globelabs.com.ph/oauth/access_token?app_id=<APP ID>&app_secret=<APP SECRET>&code=<CODE>'

Stop Subscription

If ever a subscriber chooses to opt-out or unsubscribe to your application. They will need to text in STOP to your shortcode ('STOPSVC' for cross-telco). After stopping the subscription, a json data will be passed to your redirect_uri (POST) informing you that a subscriber had just unsubscribed to your service.

json format:

{
   "unsubscribed":{
          "subscriber_number":"9171234567",                                                                                                      "access_token":"abcdefghijklmnopqrstuvwxyz",
          "time_stamp": "2014-10-19T12:00:00"
   }
}

SMS

Overview

Short Message Service (SMS) enables your application or service to send and receive secure, targeted text messages and alerts to your Globe / TM and other telco subscribers.

Note: All API calls must include the access_token as one of the Universal Resource Identifier (URI) parameters.

Sending SMS (SMS-MT)

Send an SMS message to one or more mobile terminals:

(Mobile Terminating - Application to Subscriber)

Use POST method on this URI:

https://devapi.globelabs.com.ph/smsmessaging/v1/outbound/{senderAddress}/requests?access_token={access_token}
Representation Formats

For the Globe Labs API SMS, it is implemented using application/json.

Resource Parameters
Parameter Usage
string senderAddress refers to the application short code suffix (last 4 digits) Required
string access_token which contains security information for transacting with a subscriber. Subscriber needs to grant an app first via SMS or Web Form Subscriber Consent Workflow. Required
Request Body or Payload Parameters
Parameter Usage
string address is the subscriber MSISDN (mobile number), including the ‘tel:’ identifier. Parameter format can include the ‘+’ followed by country code +639xxxxxxxxx or 09xxxxxxxxx Required
string message must be provided within the outboundSMSTextMessage element. Currently, the API implementation is limited a maximum of 160 characters. Also make sure that your language or framework's editor is encoding the HTTP parameters as UTF-8 Required
string clientCorrelator uniquely identifies this create SMS request. If there is a communication failure during the request, using the same clientCorrelator when retrying the request allows the operator to avoid sending the same SMS twice. Optional
Sample POST Request
curl -X POST
"https://devapi.globelabs.com.ph/smsmessaging/v1/outbound/1234/requests?access_token=3YM8xurK_IPdhvX4OUWXQljcHTIPgQDdTESLXDIes4g" -H "Content-Type: application/json" -d
{"outboundSMSMessageRequest": {
   "clientCorrelator": "123456",
   "senderAddress": "1234",
   "outboundSMSTextMessage": {"message": "Hello World"},
   "address": "9171234567"
 }
}
Sample Successful POST Response
{
 "outboundSMSMessageRequest": {
   "address": "tel:+639175595283",
   "deliveryInfoList": {
     "deliveryInfo": [],
     "resourceURL": "https://devapi.globelabs.com.ph/smsmessaging/v1/outbound/8011/requests?access_token=3YM8xurK_IPdhvX4OUWXQljcHTIPgQDdTESLXDIes4g"
   },
   "senderAddress": "8011",
   "outboundSMSTextMessage": {
     "message": "Hello World"
   },
   "receiptRequest": {
     "notifyURL": "http://test-sms1.herokuapp.com/callback",
     "callbackData": null,
     "senderName": null,
     "resourceURL": "https://devapi.globelabs.com.ph/smsmessaging/v1/outbound/8011/requests?access_token=3YM8xurK_IPdhvX4OUWXQljcHTIPgQDdTESLXDIes4g"
   }
 }
}
Response Parameters
Parameter Usage
outboundSMSResponse Specifies the body of the response. Required
address Subscriber MSISDN (mobile number) whom the SMS was sent to.
senderAddress Refers to the application short code suffix (last 4 digits).
outboundSMSTextMessage The string message sent to the subscriber’s number (address).
resourceURL Specifies the URI that provides network delivery status of the sent message. The API Endpoint. Required
notifyURL App call back URL defined at the App Info. Optional

Note: Response parameters deliveryInfo, callbackData, senderName are optional parameters that are not currently supported by the Globe Labs SMS API. Error response with 400 series will deduct 0.50 from your wallet balance.

Receiving SMS (SMS-MO)

In receiving SMS, globe will send a data(POST) to your Notify URL (that you provided when you created your app) when the subscriber sends an SMS or replied to your short code number.

(Mobile Originating - Subscriber to Application)

{
  "inboundSMSMessageList":{
      "inboundSMSMessage":[
         {
            "dateTime":"Fri Nov 22 2013 12:12:13 GMT+0000 (UTC)",
            "destinationAddress":"tel:21581234",
            "messageId":null,
            "message":"Hello",
            "resourceURL":null,
            "senderAddress":"tel:+639171234567"
         }
       ],
       "numberOfMessagesInThisBatch":1,
       "resourceURL":null,
       "totalNumberOfPendingMessages":null
   }
}

In your Notify URL, create a script that will catch and save these data to a file or to the database.

###Multi-Part SMS

Sending Multi-Part SMS

You can send multi-part sms like you would in sending a normal sms, just keep in mind that you will be charged per 160 characters.

Sample POST Request
curl -X POST
"https://devapi.globelabs.com.ph/smsmessaging/v1/outbound/1234/requests?access_token=3YM8xurK_IPdhvX4OUWXQljcHTIPgQDdTESLXDIes4g" -H "Content-Type: application/json" -d
{"outboundSMSMessageRequest": {
   "clientCorrelator": "123456",
   "senderAddress": "1234",
   "outboundSMSTextMessage": {"message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis commodo posuere dui vitae feugiat. Cras vehicula, elit eget commodo tristique, mi magna placerat turpis, quis ultrices massa odio vitae sapien. Proin elit diam, malesuada sit amet blandit id, fermentum eu orci."},
   "address": "9171234567"]
 }
}

Receiving Multi-Part SMS

There will be additional parameters whenever you receive an sms content exceeding 160 characters, this would be:

Parameter Description
multipartRefId ID of multi-part message
multipartSeqNum Sequence of multi-part message

sample of expected format of multi-part content below:

{
   "inboundSMSMessageList":{
      "inboundSMSMessage":[
         {
            "dateTime":"Fri Nov 22 2013 12:12:13 GMT+0000 (UTC)",
            "destinationAddress":"tel:21581234",
            "messageId":"57cd07d61a28d80100a26bc7",
            "message":"AlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrigh",
            "resourceURL":null,
            "senderAddress":"tel:+639171234567",
            "multipartRefId":"5476ddbba4e7d20c527c0f83422bf938",
            "multipartSeqNum":"1"
         }
      ],
      "numberOfMessagesInThisBatch":"2",
      "resourceURL":null,
      "totalNumberOfPendingMessages":0
   }
}

{
   "inboundSMSMessageList":{
      "inboundSMSMessage":[
         {
            "dateTime":"Fri Nov 22 2013 12:12:13 GMT+0000 (UTC)",
            "destinationAddress":"tel:21581234",
            "messageId":"57cd07dab9d3660100cee8d2",
            "message":"tAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightAlrightu",
            "resourceURL":null,
            "senderAddress":"tel:+639171234567",
            "multipartRefId":"5476ddbba4e7d20c527c0f83422bf938",
            "multipartSeqNum":"2"
         }
      ],
      "numberOfMessagesInThisBatch":"2",
      "resourceURL":null,
      "totalNumberOfPendingMessages":0
   }
}

Batch of messages could be identified if they have the same multipartRefId.

###Binary SMS

Binary Short Messaging interface allows an application to send any generic binary object attachments to the network using SMS.

Use POST method on this URI:

https://devapi.globelabs.com.ph/binarymessaging/v1/outbound/{senderAddress}/requests?access_token={access_token}

Parameters

Parameter Description Required
userDataHeader UDH of the message true
dataCodingScheme data coding of the message true
address MSISDN of the recipient true
outboundBinaryMessage.message message to be sent true
senderAddress shortcode of the app true
access_token access token of the subscriber true
Data Coding Value Description
0 SMSC Default
1 IA5/ASCII
3 Latin 1 (ISO-8859-1)
4 Binary (8-bit)
8 UCS2 (Unicode) 
{
  "outboundBinaryMessageRequest": {
    "address": "9171234567",
    "deliveryInfoList": {
      "deliveryInfo": [],
      "resourceURL": "https://devapi.globelabs.com.ph/binarymessaging/v1/outbound/{senderAddress}/requests?access_token={access_token}",
    "senderAddress": "21581234",
    "userDataHeader": "06050423F423F4",
    "dataCodingScheme": 1,
    "outboundBinaryMessage": {
      "message": "samplebinarymessage"
    },
    "receiptRequest": {
      "notifyURL": "http://example.com/notify",
      "callbackData": null,
      "senderName": null
    },
  "resourceURL": "https://devapi.globelabs.com.ph/binarymessaging/v1/outbound/{senderAddress}/requests?access_token={access_token}",
  }
}

###SMS API HTTP Response

Code Description
201 Request has been successful
400/401 Request failed. Wrong or missing parameters, invalid subscriber_number format, wrong access_token.
502/503 Platform Error. API Service is busy or down

API requests with a response code of 201, 400 or 401 will be chargeable against your developer wallet. Standard SMS API rates apply, unless otherwise stated.

Location Based Services

Overview

This API allows a web application to query the location of one or more mobile devices that are connected to a mobile operator network. The Globe Labs LBS is a RESTful interface.

Note: All API calls must include the access_token as one of the Universal Resource Identifier (URI) parameters. This can be requested beforehand via the Subscriber Consent Workflow.

Read more about the Subscriber Consent Workflow (http://goo.gl/EEEBO8)

LBS Query

Locate a subscriber’s location:

Use GET method on this URI:

https://devapi.globelabs.com.ph/location/v1/queries/location?access_token={access_token}&address={address}&requestedAccuracy={metres}
Representation Formats

For the Globe Labs API LBS, it is implemented using application/json.

Resource Parameters
Parameter Usage
string access_token (string) which contains security information for transacting with a subscriber.This can be requested beforehand via the Subscriber Consent Workflow. Read more about the Subscriber Consent Workflow (http://goo.gl/EEEBO8). Required
Request Body or Payload Parameters
Parameter Usage
int address is the subscriber MSISDN (mobile number), including the ‘tel:’ identifier. Parameter format can include the ‘+’ followed by country code +639xxxxxxxxx or 09xxxxxxxxx Required
int requestedAccuracy The preferred accuracy of the result, in metres. Typically, when you request an accurate location it will take longer to retrieve than a coarse location. So requestedAccuracy=10 will take longer than requestedAccuracy=100 . Required
Sample GET Request
curl "https://devapi.globelabs.com.ph/location/v1/queries/location?access_token=ux5MvYjg7V_9aNljXBewrLVHHo70kOyKF7Vbgupm5IY&address=09171234567&requestedAccuracy=100" -H "Content-Type: application/json"
Sample Successful POST Response
{
  "terminalLocationList": {
    "terminalLocation": {
      "address": "tel:9171234567",
      "currentLocation": {
        "accuracy": 100,
        "latitude": "14.5609722",
        "longitude": "121.0193394",
        "map_url": "http://maps.google.com/maps?z=17&t=m&q=loc:14.5609722+121.0193394",
        "timestamp": "Fri Jun 06 2014 09:25:15 GMT+0000 (UTC)"
      },
      "locationRetrievalStatus": "Retrieved"
    }
  }
}
Response Parameters
Parameter Usage
terminalLocationList Specifies the body of the response.
address Subscriber MSISDN (mobile number) whom the SMS was sent to.
accuracy The preferred accuracy of the result, in metres.
outboundSMSTextMessage The string message sent to the subscriber’s number (address).
latitude geographic coordinate of the subscriber that specifies the north-south.
longitude geographic coordinate of the subscriber that specifies the north-south.
timestamp time of event response.
locationRetrievalStatus status of location request.

###LBS API HTTP Response

Code Description
201 Request has been successful
400/401 Request failed. Wrong or missing parameters.
502/503 Platform Error. API Service is busy or down

API requests with a response code of 201, 400 or 401 will be chargeable against your developer wallet. Standard LBS API rates apply, unless otherwise stated.

Charging

Overview

The Charging API allows developers to directly charge for digital services to the prepaid balance of a Globe or TM subscriber.

Note: The Charging API is not readily available upon app creation. To avail, please email your app's use case and company name to api@globe.com.ph

Charging Opt-in via Webform

  1. Platform redirects your subscribers to this url: 
    https://developer.globelabs.com.ph/dialog/oauth/<APP ID>/?amount=<CHARGE AMOUNT>

NOTE: Amount must be in decimal format e.g 1.00, 2.00, 3.00

  1. The page will ask to key-in the subscriber’s mobile number and subscriber clicks the Grant button.

  2. The page will be redirected and an SMS with confirmation PIN will be sent to the subscriber.

  3. The subscriber needs to enter the received confirmation PIN and click the Confirm button to authorize the transaction.

  4. The page will then be redirected to the Redirect URI of your application. The code and amount parameters will be sent to your Notify URI.

  5. To get the access token, you need to do a POST request via https://developer.globelabs.com.ph/oauth/access_token with your ‘app_id’, ‘app_secret’ and ‘code’ as URL query parameters. The parameters ‘access_token’ and ‘subscriber_number’ will then be returned as a response.

Charging Opt-in via SMS

  1. Use POST method on this URI:
https://devapi.globelabs.com.ph/payment/v1/smsoptin?app_id=<APP ID>&app_secret=<APP SECRET>&subscriber_number=<SUBSCRIBER NUMBER>&duration=<PROMO DURATION IN DAYS>&amount=<CHARGE AMOUNT>

Alternatively, the subscriber can receive an opt-in message by sending INFO to the shortcode.

  1. Upon receipt of the opt-in message, the subscriber needs to reply YES keyword (e.g. YES GLABS1). Special keywords are defined and provisioned for each application.
  • If the opt-in is developer-triggered, the keyword is provided in the opt-in message based on the amount parameter.
  • If the subscriber sends INFO, a list of available keywords with equivalent amounts are provided in the opt-in message

  1. After the subscriber replies, the amount and the code will be sent to your Notify URI as URL parameters via the GET method.

  2. To get the access token, you need to do a POST request via https://developer.globelabs.com.ph/oauth/access_token with your ‘app_id’, ‘app_secret’ and ‘code’ as URL query parameters. The parameters ‘access_token’ and ‘subscriber_number’ will then be returned as a response.

Code as URL Parameter
http://www.sample-redirect-url.com/?code=bLfXLEL9CM8nReI78kxAI7ra56hrBzrBsyonbkIzepngUdrKKyC5Mp5ahgKLAzF9z76RfA4rjrsaAdqeCBkGrMF4MA6MfK6bkGsB89onSL9ER6sbr5yGCzMa8RfA7TzAbqKTa6EfaE5BzCK7ErMsMK9LpSnobejsxrALxfE9GkzFGEdEaCj6rLXsL578RfdyL9rFkbp49hXxK7pCejpAgUyXnj7Ij4zdbsLpar9hKzkA8IEdneMIpjE45CaXjE7f&amount=0.00
Sample POST to get Access Token
POST -x 'https://developer.globelabs.com.ph/oauth/access_token?app_id=<APP ID>&app_secret=<APP SECRET>&code=<CODE>'

Charge Subscriber

Charge/bill a subscriber:

Use POST method on this URI:

https://devapi.globelabs.com.ph/payment/v1/transactions/amount?access_token={access_token}
Sample POST Request
curl -X POST "https://devapi.globelabs.com.ph/payment/v1/transactions/amount?access_token=3YM8xurK_IPdhvX4OUWXQljcHTIPcQDdTESLUDI4s4g" \
 -F "amount=0.00" \
 -F "description=my application" \
 -F "endUserId=9171234567" \
 -F "referenceCode=12341000022" \
 -F "transactionOperationStatus=Charged"
 -F "duration=0"
Request Parameters
Parameter Usage
string amount amount to be charged. Must be in decimal format. eg. 1.00, 2.50, 10.00 Required
string description is the human-readable text to appear on the bill, so the user can easily see what they bought Required
string endUserId URL-escaped end user ID; in this case their MSISDN including the ‘tel:’ protocol identifier and the country code preceded by ‘+’. i.e., tel:+16309700001. The API also supports the Anonymous Customer Reference (ACR) if provided by the operator. Required
string referenceCode is a unique alphanumeric code for records matching. The operator should include it in reports so that you can match their view of what has been sold with yours by matching the referenceCodes. Required format: Suffix of your shortcode (last 4 digits) + Unique combination of 7 alphanumeric string, but we recommend that you do Increments of 1 from 1000000 for faster tracking. e.g. [1234]1,000,001 to [1234]9,999,999] Required
string transactionOperationStatus a mandatory parameter that should always be set to 'Charged' Required
int duration this defines how many days the subscriber will be subscribed to the promo(duration=0 for one-time charging). Required
Sample Response
{
 "amountTransaction":
 {
   "endUserId": "9171234567",
   "paymentAmount": 
   {
     "chargingInformation": 
     {
       "amount": "0.00",
       "currency": "PHP",
       "description": "my application"
     },
     "totalAmountCharged": "0.00"
   },
   "referenceCode": "12341000023",
   "serverReferenceCode": "528f5369b390e16a62000006",
   "resourceURL": null
  }
}
Error Codes:
Code Description
201 Charging Successful.
400 Authentication Error/Missing parameters in request body.
401 App Is deactivated (due to inactivity).
402 Subscriber Not found (invalid number).
405 Failure to update the TM subscriber’s balance or failure to check the TM subscriber’s balance.
407 Failure since postpaid charging is not permitted.
411 GHP Subscriber has insufficient balance.
412 TM Subscriber has insufficient balance.
416 Failure to check the subscriber's balance.
503 System is busy, please try again later.
701 Charging is disallowed for the subscriber. Do not retry. Inform the subscriber to call the hotline for activation.
702 System is busy. Please try again later and contact api@globe.com.ph

Get Last Reference Code

In case you lost of track of your reference code, you can make a GET request to this uri below:

https://devapi.globelabs.com.ph/payment/v1/transactions/getLastRefCode
Sample Response
{
  "referenceCode": "12341000005",
  "status": "SUCCESS",
  "shortcode": "21581234"
}

Note: Non 200 and 500 series will deduct 0.50 from your wallet balance

Load

Overview

The Load API enables your application to send prepaid load, postpaid credits or call, text and surfing promos to your subscribers.

Note: The Load API is not readily available upon app creation. To avail, please email your app's use case and company name to api@globe.com.ph

Sending Load

Use POST method on this URI:

https://devapi.globelabs.com.ph/rewards/v1/transactions/send
Representation Format

For the Globe Labs Load API, the expected format is application/json

Sample POST Request
curl -X POST
"https://devapi.globelabs.com.ph/rewards/v1/transactions/send" -H "Content-Type: application/json" -d
{
    "outboundRewardRequest" : {
        "app_id" : "B54z9Ug55zLh5rTGRT5g6hq64pGUq6ap",
        "app_secret" : "f6554137d08f5607a696cd40741993758c411af3bb5f6c230270ec26e8d54126",
        "rewards_token" : "I7SkxKYid_F_p-JSgTejow",
        "address" : "9271051129",
        "promo" : "LOAD 50"
    }
}
Request Body or Payload Parameters
Parameter Usage
string app_id This is the unique identifier of your app Required
string app_secret This is the security code of your app Required
string rewards_token This is used as a key to allow your app to send rewards Required
string address This is the subscriber MSISDN (mobile number), including the ‘tel:’ identifier. Parameter format can include the ‘+’ followed by country code 09xxxxxxxxx or 9xxxxxxxxx Required
string promo This is the promo to be sent Required
Sample Successful POST Response
{
  "outboundRewardRequest": {
    "transaction_id": 1805759,
    "status": "Please check your Rewards Callback URI for status",
    "address": "9271051129",
    "promo": "LOAD 50",
    "timestamp": "Wed, Jun 06 2018 03:19:11 GMT+0000 (UTC)"
  }
}
Parameter Usage
int transaction_id This is the unique identifier of the transaction
string status This is the status of the transaction. Please note that the actual status is sent to your Callback URI
string address This is the subscriber MSISDN (mobile number), including the ‘tel:’ identifier. Parameter format can include the ‘+’ followed by country code 09xxxxxxxxx or 9xxxxxxxxx
string promo This is the promo code to be sent
datetime timestamp This is the time the transaction was made
Sample Callback

The Load API Callback is sent via POST request to your Callback URI.

{
  "outboundRewardRequest": {
    "status": "SUCCESS",
    "promo": "LOAD 50",
    "timestamp": "Wed, Jun 06 2018 03:19:11 GMT+0000 (UTC)"
    "transaction_id": 1805759,
    "address": "9271051129"
  }
}

Error Codes

Status Code Error Message
200 N/A
401 Invalid App Secret
401 App is not provisioned for Rewards
401 Invalid Rewards Token
401 App is not provisioned for this promo
403 Insufficient Wallet Balance
403 Your account is currently blocked. Please contact api@globe.com.ph for reactivation
403 The subscriber is blacklisted
404 App not found
404 Invalid promo
500 Something went wrong. Please try again in a while

USSD

Overview

The USSD API allows users to access your products or services free of charge by accessing the dial menu through a dedicated number.

Note: The USSD API is not readily available upon app creation. To avail, please email your app's use case and company name to api@globe.com.ph

Sending Network Initiated USSD Message (USSD-NI)

Use POST method on this URI:

https://devapi.globelabs.com.ph/ussd/v1/outbound/{shortcode}/send/requests?access_token={access_token}
Resource Parameters
Parameter Usage
string shortcode This is the last 4 digits of the app's shortcode Required
string access_token This contains security information for transacting with a subscriber. The subscriber needs to grant an app first via SMS or Web Form Subscriber Consent Workflow Required
Representation Format

For the Globe Labs USSD API, the expected format is application/json

Sample Post Request (USSD-NI)
curl -X POST
"https://devapi.globelabs.com.ph/ussd/v1/outbound/9996/send/requests?access_token=LsQwuHog3n_OwlYSjj4QFujb451HeqCPyaAdkKgRAkM" -H "Content-type: application/json" -d
{
    "outboundUSSDMessageRequest": {
        "outboundUSSDMessage": {
            "message": "Simple USSD Message\nOption - 1\nOption - 2"
        },
        "address": "639171111111",
        "senderAddress": "21589996",
        "flash": false
    }
}
Request Body or Payload Parameters
Parameter Usage
string outboundUSSDMessage.message This is the message to be sent and displayed on the subscriber's mobile phone Required
string address This is the subscriber's mobile number Required
string senderAddress This is the shortcode of the app Required
boolean flash This indicates whether this is the final message or not Required
Sample Successful POST Response (USSD-NI)
{
  "outboundUSSDMessageRequest": {
    "address": "639171111111",
    "deliveryInfoList": {
      "deliveryInfo": [],
      "resourceURL": "https://devapi.globelabs.com.ph/ussd/v1/outbound/21589996/reply/requests?access_token=access_token"
    },
    "senderAddress": "21589996",
    "outboundUSSDMessage": {
      "message": "Simple USSD Message\nOption - 1\nOption - 2"
    },
    "receiptRequest": {
      "ussdNotifyURL": "http://example.com/notify",
      "sessionID": "012345678912"
    },
    "resourceURL": "https://devapi.globelabs.com.ph/ussd/v1/outbound/21589996/reply/requests?access_token=access_token"
  }
}
Response Parameters
Parameter Usage
string address This is the subscriber's mobile number
string resourceURL This is the API endpoint. This specifies the URI that provides network delivery status of the sent message.
string senderAddress This is the shortcode of the app
string outboundUSSDMessage.message This is the message to be sent and displayed on the subscriber's mobile phone
string ussdNotifyURL This is the URI where the USSD responses will be sent
string sessionID This is the unique identifier for the ongoing USSD session

Sending USSD Reply Message (USSD-MT)

Use POST method on this URI:

https://devapi.globelabs.com.ph/ussd/v1/outbound/{shortcode}/reply/requests?access_token={access_token}
Resource Parameters
Parameter Usage
string shortcode This is the last 4 digits of the app's shortcode Required
string access_token This contains security information for transacting with a subscriber. The subscriber needs to grant an app first via SMS or Web Form Subscriber Consent Workflow Required
Sample POST Request (USSD-MT)
curl -X POST
'https://devapi.globelabs.com.ph/ussd/v1/outbound/9996/reply/requests?access_token=LsQwuHog3n_OwlYSjj4QFujb451HeqCPyaAdkKgRAkM' -H "Content-type: application/json" -d
{
    "outboundUSSDMessageRequest": {
        "outboundUSSDMessage": {
            "message": "Simple USSD Message\nOption - 1\nOption - 2"
        },
        "address": "639171111111",
        "senderAddress": "21589996",
        "sessionID": "012345678912",
        "flash": false
    }
}
Parameter Usage
string outboundUSSDMessage.message This is the message to be sent and displayed on the subscriber's mobile phone Required
string address This is the subscriber's mobile number Required
string senderAddress This is the shortcode of the app Required
string sessionID This is the unique identifier for the ongoing USSD session Required
boolean flash This indicates whether this is the final message or not Required
Successful POST Response (USSD-MT)
{
  "outboundUSSDMessageRequest": {
    "address": "639171111111",
    "deliveryInfoList": {
      "deliveryInfo": [],
      "resourceURL": "https://devapi.globelabs.com.ph/ussd/v1/outbound/21589996/reply/requests?access_token=access_token"
    },
    "senderAddress": "21589996",
    "outboundUSSDMessage": {
      "message": "Simple USSD Message\nOption - 1\nOption - 2"
    },
    "receiptRequest": {
      "ussdNotifyURL": "http://example.com/notify",
      "sessionID": "012345678912",
      "referenceID": "f7b61b82054e4b5e"
    },
    "resourceURL": "https://devapi.globelabs.com.ph/ussd/v1/outbound/21589996/reply/requests?access_token=access_token"
  }
}
Parameter Usage
string address This is the subscriber's mobile number
string resourceURL This is the API endpoint. This specifies the URI that provides network delivery status of the sent message.
string outboundUSSDMessage.message This is the message to be sent and displayed on the subscriber's mobile phone
string senderAddress This is the shortcode of the app
string ussdNotifyURL This is the URI where the USSD responses will be sent
string sessionID This is the unique identifier for the ongoing USSD session
Sample USSD Callback

This data will be sent to your USSD Notify URL.

{
  "inboundUSSDMessageList": {
    "inboundUSSDMessage":[
    {
      "datetime":"Tue May 17 2016 11:10:32 GMT+0000 (UTC)",
      "destinationAddress":"21589996",
      "message":"*120*9996*3#",
      "senderAddress":"639171111111",
      "sessionID": "012345678912"
    }
  ]
  }
}

User Inititated USSD Message

Dial *120*{shortcode} and press CALL on your mobile phone. This will start the USSD session and send {"message":`null`, sessionStart: true} to your USSD Notify URL.

Alternatively, you can send a sequence of inputs upon starting the USSD session by dialing *120*{shortcode}*{input 1}*{input 2}*{input 3}#. For example, dialing *120*9996*1*2*3# and pressing CALL will start the USSD session and automatically send {"message":`['1', '2', '3']`, sessionStart: true} to your USSD Notify URL

Error Codes

Status Code Error Message
200 N/A
400 Missing parameters
400 Excess parameters
400 Invalid subscriber number
401 Invalid access token
401 App is not provisioned for USSD
403 Your account is currently blocked. Please contact api@globe.com.ph for reactivation.
403 The subscriber is blacklisted
403 Insufficient Wallet Balance
404 App not found

About

Globe Labs API Documentation

Resources

Readme
Activity
Custom properties

Stars

5 stars

Watchers

8 watching

Forks

13 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •