HTTP API - Introduction

From Ultiroam User Docs
Jump to navigation Jump to search

The API enables an a server to communicate with gateways and supports SMS, USSD and Data services.

The key features supported are:

  • Sending/receiving of SMS, also support delivery status
  • Sending/receiving of MMS
  • Sending/receiving of USSD
  • Managing Data services
  • Port information

The API is based on HTTP and JSON.

So please check how to send HTTP request and how to encode/decode JSON data before you write an application with this API.

This document takes cURL as an example to illustrate using the API.

In order to use the API, the Basic configuration screen of the Gateway should be set to 'New Version' as illustrated above.

About SMS configuration:

The gateway supports 2 types of encoding, namely GSM 7 bit and UCS2.

  • GSM 7bit is suitable for sending messages that contain ASCII and some Latin alphabets, while UCS2 is suitable for sending anything, including Chinese, Korean, Japanese and even emoji .
  • For GSM 7bit, it is possible to send up to 160 characters (packed in up to 140 octets) in one SMS message. But for UCS2, one SMS message could only contain 70 characters at maximum.

The gateway supports Concatenated_SMS, which means the gateway will split your long messages into smaller SMS.

The maximum size is limited to 670 Characters.