Menu

Operations API

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.

Copy 
  <th style={{ textAlign: "left" }}>
    Description
  </th>

  <th style={{ textAlign: "left" }}>
    Remark
  </th>
</tr>
Copy 
  <td style={{ textAlign: "left" }}>
    This endpoint allows you to send an SMS message from your application.
  </td>

  <td style={{ textAlign: "left" }}>
    * You can send an SMS message 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.
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    Post OTP SMS
  </td>

  <td style={{ textAlign: "left" }}>
    This endpoint allows you to send OTP SMS from your application.
  </td>

  <td style={{ textAlign: "left" }}>
    The pin format that we support:  

    * Numeric  
    * Alpha  
    * Alphanumeric
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    Get Number List
  </td>

  <td style={{ textAlign: "left" }}>
    This endpoint allows you to query all numbers used in your CINNOX service, including:  

    * Virtual Numbers  
    * Service Numbers  
    * Alphanumeric Sender IDs
  </td>

  <td style={{ textAlign: "left" }}>
    * Max data limit per request: 500 batch limit
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    Get Caller ID
  </td>

  <td style={{ textAlign: "left" }}>
    This endpoint allows you to query details of Caller IDs, including:  

    * Types  
    * Expiry Date  
    * Name of Caller IDs
  </td>

  <td style={{ textAlign: "left" }}>

  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    Get Staff Sender ID
  </td>

  <td style={{ textAlign: "left" }}>
    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.
  </td>

  <td style={{ textAlign: "left" }}>

  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    Get Event Hook List
  </td>

  <td style={{ textAlign: "left" }}>
    This endpoint allows you to query the list of events you have subscribed to.
  </td>

  <td style={{ textAlign: "left" }}>

  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    Create/Edit/Delete the Call Event Subscription
  </td>

  <td style={{ textAlign: "left" }}>
    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.
  </td>

  <td style={{ textAlign: "left" }}>

  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    Create/Edit/Delete the event subscription of the Inbound SMS Message
  </td>

  <td style={{ textAlign: "left" }}>
    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.
  </td>

  <td style={{ textAlign: "left" }}>
    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
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    Create/Edit/Delete  the event subscription of the Outbound SMS Message
  </td>

  <td style={{ textAlign: "left" }}>
    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.
  </td>

  <td style={{ textAlign: "left" }}>
    The event hook will return the following details:  

    * Service 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.
  </td>
</tr>
API Endpoint
Post SMS

Important

In CINNOX, a single (1) SMS is limited to 160 characters 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 is split 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 characters, 1 non-English character is regarded as non-English text.

Pre-registration of a template to the carrier as a regulation when sending SMS to a Mainland China number (+86)is required.

** CINNOX Open API supports up to 500 requests per minute per service account.**

Previous
Operations API
Next
Send Message
Last modified: 2025-12-11