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 an SMS message from your application. | - You can send an SMSmessage to multiple recipients with the same message at the same time. - Currently, we do not support sending an SMS message to multiple recipients with multiple messages at the same time. |
| Post OTP SMS | This endpoint allows you to send OTP SMS from your application. | The pin format that we support: - Numeric - Alpha - Alphanumeric |
| Get Number List | This 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 Caller ID | This endpoint allows you to query details of Caller IDs, including: - Types - Expiry Date - Name of Caller IDs | |
| Get Staff Sender ID | This endpoint allows you to query details of the SMS sender IDs, including: - Virtual numbers used as the sender ID, - Countries from which the sender IDs originate - Name of the sender IDs. | |
| Get Event Hook List | This endpoint allows you to query the list of events you have subscribed to. | |
| Create/Edit/Delete the Call Event Subscription | This endpoint allows you to create a new webhook Call event and edit the subscribed event for an application. It also allows you to delete the webhook event of a call under your application account. | |
| Create/Edit/Delete the event subscription of the Inbound SMS Message | This endpoint allows you to create a new webhook event of the Inbound SMS Message and edit the subscribed event for an application. It also allows you to delete the subscribed event under your application account. | The event hook will return the following details: - ID (Record ID) - Event Description (Inbound SMS Message) - Sender Number - Recipient Number - Time of receiving the Inbound SMS Message - Content Type (Text) - Content of the SMS Message |
| Create/Edit/Delete the event subscription of the Outbound SMS Message | This endpoint allows you to create a new webhook event of the outbound SMS Message and edit the subscribed event for an application. It also allows you to delete the subscribed event under your application account. | The event hook will return the following details: - Serive ID of your CINNOX service - The SMS ID of the outbound SMS message - The SMS number of the recipient - The Country Code of the SMS recipient - The Response Code of the outbound SMS status - The Status of the outbound SMS message - The error message is when the SMS message sent or delivered failed. |
Important
In CINNOX, a single (1) SMS is limited to 160 chars for English text while 70 chars for non-English text (universal code), E.g., Chinese and Japanese scripts.
If the SMS text exceeds 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., an 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., an 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.
CINNOX Open API support up to 500 requests per min per service account.