Introduction

The CINNOX Open API Operations provides endpoints to send SMS, OTP SMS, Get Number list, Get Push Notification and Patch TDR Event to your CINNOX service account.

API EndpointDescriptionRemark
Post SMSThis endpoint allows you to send SMS from your application- You can send SMS to multiple recipients with the same message at the same time.
- Currently, we do not support sending SMS to multiple recipients with multiple message at the same time.
Post OTP SMSThis endpoint allows you to send OTP SMS from your applicationThe pin format that we support:
- Numeric
- Alpha
- Alphanumeric
Get Number ListThis endpoint allows you to query all numbers used in your CINNOX service, including:
- Virtual Numbers
- Service Numbers
- Alphanumeric Sender IDs
- Max data limit per request: 500 batch limit
Get Event Hook ListThis endpoint allows you to query the list of events that you have subscribed.
Create/Edit/Delete TDR Event SubscriptionThis endpoint allows you to create a new webhook event / edit the subscribed event for an application. And also allow you to delete the TDR event under your application accountThe event hook will return the following delivery receipts status:

M800 server status:
- Submitted
- Rejected
- Timeout

Carrier server status :
- Deliver status
- Success
- Fail
- Timeout

📘

Important

In CINNOX, a single (1) SMS is limited to 160 chars for English text while 70 chars for the non-English text (universal code), E.g., Chinese and Japanese scripts.

If the SMS text is over the single SMS limit, it splits into smaller messages for transmission.

  • A. SMS with English chars > 160 splits into 153-char per sent.
    E.g., SMS with 161 chars - will be sent as 2 SMS, first with 153 chars and the second with 8 chars.

  • B. SMS with non-English chars > 70 splits into 67-char per sent.
    E.g., SMS with 71 chars - will be sent as 2 SMS, first with 67 chars and the second with 4 chars.

When an SMS is combined with English and non-English chars, 1 non-English char is regarded as non-English text.

Note it requires pre-registration of a template to the carrier as a regulation when sending SMS to mainland China number (+86).

📘

CINNOX Open API support up to 500 requests per min per service account.