Documentation
Ginota API Request
The following sections describe the request URL to Ginota SMS API and all of its associated input parameters and their corresponding values.
Endpoint URL
All the requests to Ginota must be submitted to following Endpoint URL:
https://www.ginota.com/gemp/sms/json
Content Type
Since Ginota SMS API supports both HTTP GET and HTTP POST method, please specify the input type of application/x-www-form-urlencoded for HTTP POST request. Note that all inputs should be fully URL encoded with Unicode UTF-8 encoding.
Authentication
All requests to Ginota APIs are authenticated with your Ginota account's API Key and Secret, which you can find under Dashboard > Messaging after login to Ginota Portal.
Input Parameters
The following table lists each parameter that can be submitted together with the Endpoint URL given above. Note that the first 5 parameters are mandatory while remaining is optional. All parameters are case sensitive.
| Parameter | Description | Example Values |
|---|---|---|
| apiKey | Ginota account API Key. | 3zJU%2Ft7DX6g%3D |
| apiSecret | Ginota account API Secret. | %21ABCDE |
| srcAddr | Sender ID of the message. Up to 21 alphanumeric characters. | MyCompany |
| dstAddr | Destination mobile number in international format (prefixed with country code but without the '+' sign). Restricted to ONE recipient only. |
6593274037 (Singapore) |
| content | The SMS text to send encoded in Unicode UTF-8. Limited to 1500 characters. For binary message, hex-encoded binary data. | Hello+World |
| type | Indicates the type of message to be sent:
|
text |
| dlr | By default, delivery receipt (DLR) is returned for all messages. There is no need to configure this parameter on API level. However, DLR Callback URL should be configured under Profile > API Settings to enable delivery receipt to be returned to the right destination. | N/A |
| txnRef | Unique internal transaction reference supplied by user to aid with matching delivery receipts. Limited to 20 alphanumeric characters. | REF987654321 |
| ttl | The number of milliseconds to attempt delivery before message expires. | 6000 |
| at | Scheduled message delivery date/time in ISO8601 date time with time zone format: YYYY-MM-DDThh:mm:ss±hh:mm Defaults to Immediate delivery. |
2014-01-02T12:15:00+08:00 |
| flash | Indicates whether a text message is sent as Flash SMS where:
|
0 |
| channel | Indicates the preferred channel to deliver the message:
|
0 |
| Mandatory Parameters for Binary Message | ||
| udh | Hex-encoded UDH (User Data Header) to be used with binary messages. | 06050415811581 |
| Mandatory Parameters for Wap Push Message | ||
| url | Wap URL to be pushed. | http%3a%2f%2fwww.ginota.com |
Ginota API Bulk Request
The following sections describe the bulk request URL to Ginota SMS API and all of its associated input parameters and their corresponding values.
Endpoint URL
All the bulk requests to Ginota must be submitted to following Endpoint URL:
https://www.ginota.com/gemp/bulk/sms/json
Content Type
Since Ginota SMS API supports both HTTP GET and HTTP POST method, please specify the input type of application/x-www-form-urlencoded for HTTP POST request. Note that all inputs should be fully URL encoded with Unicode UTF-8 encoding.
Authentication
All bulk requests to Ginota APIs are authenticated with your Ginota account's API Key and Secret, which you can find under Dashboard > Messaging after login to Ginota Portal.
Input Parameters
The following table lists each parameter that can be submitted together with the Endpoint URL given above. Note that the first 5 parameters are mandatory while remaining is optional. All parameters are case sensitive.
| Parameter | Description | Example Values |
|---|---|---|
| apiKey | Ginota account API Key.*HTTP URL friendly. Do not require further encoding | 3zJU%2Ft7DX6g%3D |
| apiSecret | Ginota account API Secret.*required to be URL encoded | %21ABCDE |
| srcAddr | Sender ID of the message. Up to 21 alphanumeric characters. | MyCompany |
| dstAddrs | Destination mobile number in international format (prefixed with country code but without the '+' sign). *required to be UTF-8 and URL encoded For multiple MSISDNs, each destination numbers must be separated with commas (,) |
6593274037%2C6593274038 (Singapore) |
| content | The SMS text to send encoded in Unicode UTF-8. Limited to 1500 characters. For binary message, hex-encoded binary data. | Hello+World |
| type | Indicates the type of message to be sent:
|
text |
| dlr | By default, delivery receipt (DLR) is returned for all messages. There is no need to configure this parameter on API level. However, DLR Callback URL should be configured under Profile > API Settings to enable delivery receipt to be returned to the right destination. | N/A |
| txnRef | Unique internal transaction reference supplied by user to aid with matching delivery receipts. Limited to 20 alphanumeric characters. | REF987654321 |
| ttl | The number of milliseconds to attempt delivery before message expires. | 6000 |
| at | Scheduled message delivery date/time in ISO8601 date time with time zone format: YYYY-MM-DDThh:mm:ss±hh:mm Defaults to Immediate delivery. |
2014-01-02T12:15:00+08:00 |
| udh | Hex-encoded UDH (User Data Header) to be used with binary messages. | 06050415811581 |
| url | Wap URL to be pushed. | http%3a%2f%2fwww.ginota.com |
| flash | Indicates whether a text message is sent as Flash SMS where:
|
0 |
| channel | Indicates the preferred channel to deliver the message:
|
0 |