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 Endpoint | Description | Remark |
---|---|---|
Post SMS | This endpoint allows you to send SMS from your application |
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.
When an SMS is combined with English and non-English chars, 1 non-English char is regarded as non-English text. |
Post OTP SMS | This endpoint allows you to send OTP SMS from your application | The pin format that we support:
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.
When an SMS is combined with English and non-English chars, 1 non-English char is regarded as non-English text. |
Get Number List | This endpoint allows you to query all numbers used in your CINNOX service, including:
|
|
Get Event Hook List | This endpoint allows you to query the list of events that you have subscribed. | |
Create/Edit/Delete TDR Event Subscription | This 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 account | The event hook will return the following delivery receipts status: M800 server status:
Carrier server status :
|
Error Codes and Rate Limit
Error Code | Error Message | Description |
---|---|---|
6451001 | Bad response from the service | Response from internal service error |
6451000 |
| General error code for wrong parameter of request |
6451010 | Too many requests | Reach request rate limit |
6451011 | No records found | Query success is correct but no records found |
6451013 | Requested chat logs over the limit | Request item over the limit |
6451014 | App name is conflict | Duplicate app name conflict |
6452000 | Invalid token | Invalid app token |
6452001 | Invalid appID | Invalid app id |
6450001 | Method cannot be found, method: {method} uri: {uri} | Resource not found / incorrect path |
7210101 | bad request | Send sms error |
7210102 | anonymous user invalid | Anonymous user |
7210103 | senderNumber Invalid format | Invalid sender number format |
7210104 | RecipientNumber Invalid format | Invalid recipient number format |
CINNOX Open API support up to 500 requests per min per service account.