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.
| API Endpoint | Description | Remark |
|---|---|---|
| Send Message. | This endpoint allows you to send an instant message from your application to a room in CINNOX. | |
| Send SMS. | This endpoint allows you to send an SMS message from your application. | * 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. |
| 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: * 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. |
| Get Enquiry Details | This endpoint allows you to query all enquiry details such as the enquiry ID, status, visitor name, label ID, enquiry duration, deep link and others. | The current version supports the following enquiry channels: * Tag / Directory * Web link * Campaign * Virtual Number * Facebook Messenger * WhatsApp * WeChat * LINE * WOZTELL * ThirdParty Channel * Email |
| Get Enquiry Chat Details | This endpoint allows you to query closed enquiry - chat history between the staff and the visitor. | You can only query one closed enquiry - chat history at one time. |
| Get Call Details | This endpoint lets you query all 1-on-1 call details such as the caller, called party, call duration, etc. | |
| Get Call Log Details | This endpoint allows you to query all call log details, such as the call duration, the caller info and receiver info. | |
| Get Conference Details | This endpoint allows you to query all conference call details, such as the call date and participant details. | |
| Get Recording File Details | This endpoint allows you to query the recording files of the recorded 1-on-1 calls or conference calls. | You can query one or more call recording files at one time. |
| Get SMS Details | This endpoint allows you to query SMS details such as the staff sender, sender address, recipient and others. | |
| Get Enquiry Overview Matrix | This endpoint allows you to query the enquiry overview matrix details. These include the total number of received inquiries, the total number of ongoing enquiries, the total number of missed enquiries, and others. | You can query up to 90 days of the overview matrix data. |
| Get Channel Type List | This endpoint allows you to query the list of supported channel types. | |
| Get Channel Type Details | This endpoint allows you to query the list of supported channel type details. | The current version supports the following channels: * Directory * Web link (*Coming soon) * Campaign * Virtual Number * Facebook Messenger * WhatsApp * WeChat * LINE * Third Party Channel * Email |
| Create/Edit/Delete Enquiry Event Subscription | This endpoint allows you to create a new webhook event or edit the subscribed event of enquiries. It also allows you to delete the enquiry event under your application account. | The event hook will return the enquiry information when it triggers the events below: * When there is a new incoming enquiry. * When the enquiry status changed (Open, Handling, Missed and Closed). |
| Create/Edit/Delete Recording File Event Subscription | This endpoint allows you to create a new webhook event or edit the subscribed event of recording files. It also allows you to delete the subscribed event under your application account. | The event hook will return the recording file information when it triggers the events below: * When recording a file succeeds. * When recording a file fails. |
| Create/Edit/Delete Conference Call Event Subscription | This endpoint allows you to create a new webhook event or edit the subscribed event of conference calls. It also allows you to delete the subscribed event under your application account. | The event hook will return the conference call information when the conference ends. |
| Get Sent Campaigns Summary | This endpoint allows you to retrieve the Sent Campaigns Summary. | |
| Get Sent Campaigns Details | This endpoint allows you to retrieve the Sent Campaigns Details for a particular Campaign. |
‼️ 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.
📘 Remark
CINNOX Open API support up to 500 requests per min per service account.
Article
Operations API
Send Message
Send SMS
Send SMS OTP
Send WhatsApp OTP
Get Number List
Get Caller ID
Get Staff Sender ID
Get Event Hook List
Create/Edit/Delete Call Event Subscription
Create/Edit/Delete Inbound SMS Event Subscription
Create/Edit/Delete Outbound SMS Event Subscription
Share this Article
Previous
Get Sent Campaign Details
Next
Operations API
Last modified: 2026-05-22
- Chatroom
- Serving Chat Enquiries
- Sending and Receiving Chats
- Canned Responses
- Chat Translation
- AI Enquiry Summary
- AI Enquiry Summary Custom Format Best Practices
- Add Staff to an Enquiry Room
- Monitor Enquiry and Take Action
- Private Message
- Get your Azure OpenAI Account
- Integrate your Azure OpenAI Account with CINNOX
- Labelling an Enquiry
- Sharing Files
- Space (Group Chat)
- Customer Public Space (Private Chat)
- Manage Tag Directory
- Creating a Tag
- Managing Social Channels
- Connecting (FB) Messenger
- Connecting Wechat
- Connecting Whatsapp
- 360dialog (WhatsApp BSP)
- Restart the Enquiry Conversation (360dialog WhatsApp)
- Connecting Line
- Connecting Woztell
- Get a Woztell Account and Create Channels
- Connecting Email
- Connecting Gmail/Google Workspace Email
- Connecting Outlook/Microsoft 360 Email
- Email Enquiry Handling
- Connecting Third-Party Channel
- Channel Source
- Email Engagement
- Pin/Unpin Messages & Hide/Unhide Chat Rooms
- Sending SMS
- SMS Inbox
- SMS Keyword Auto-Reply
- SMS and Call Known Limitations
- Campaigns
- Creating SMS Standard Campaign
- Create SMS Dynamic Campaign
- Campaign Templates
- SMS Templates
- WhatsApp Engagement
- Creating WhatsApp Campaign
- Whatsapp Templates
- Sent Campaigns (SMS and WhatsApp)
- CINNOX Markdown Guide
- Connecting WeChat Sandbox
- SMS Registration Template
- Managing Destinations
- Managing Service Group
- Adding Chatbot
- CINNOX Q&A Bot
- Chatbot Data Source
- Chatbot Custom Prompts Best Practices
- General Integration for Chatbot (with Streaming Message Support)
- IVR (Interactive Voice Response)
- Alternative, Percentage, Time and Sticky Routing Rules
- Queue Settings
- CINNOX Distribution Method (ACD)
- Advanced Enquiry Routing Flow
- Enquiries in CINNOX
- Enquiry Centre
- Transferring Enquiry
- Transferring Chat
- Follow Up on Missed Enquiries
- Closing an Enquiry
- Monitoring
- Enquiries Monitoring (aka Enquiry Overview)
- Queue Monitoring
- Contacts
- Managing External Contacts
- Labelling an External Contact
- Custom Field for External Contacts
- Merging Contacts
- Integrating Salesforce
- Salesforce Contacts in Dashboard
- Engagement in CINNOX
- Developer Guide
- Prerequisites
- Installing the Web Widget
- Configure the Widget UI Language
- Passing data to agent via Weblink and Widget
- Tag Conditional Trigger
- Installing Internet Information Services (Microsoft IIS)
- Installing Apache Server
- Installing Nginx Server
- Wordpress
- Wix
- Drupal
- Joomla
- Squarespace
- BigCommerce
- Shopify
- Weebly (eCommerce by Square)
- Webflow
- HubSpot CMS Hub
- Jimdo
- Leadpages
- SHOPLINE
- Thinkific
- APPs & API
- Zapier
- CINNOX Chrome Extension
- Mobile SDK (Visitor Live Chat & Call)
- My Sites
- Configure CINNOX Web Widget
- Customising Your Widget
- Managing Widget's Smart Greeting
- Managing Visitor Forms
- Managing Staff
- Custom Staff Status
- Enhanced Navigation Bar and Roles and Permissions
- Managing Roles and Permissions
- Managing Teams
- Managing Call Recording an Transcript
- Managing Labels
- Keyword Masking
- AI Suggested Label and Topic
- Managing Contact & Enquiry Settings
- Managing Call Prompts
- Managing Storage
- My Plan
- Cancelling CINNOX Account
- Workflows
- Getting Started with the App
- App Sign In and Sign Out
- Navigating the App
- Enquiry Monitoring (aka Enquiry Overview)
- Chat Room
- Private Message
- Serving Chat Enquiries
- Serving Call Enquiries
- Monitor Chat Enquiry & Take Action
- Add Staff to an Enquiry Room
- Closing Enquiries
- Labelling an Enquiry
- Labelling External Contacts
- Sending and Receiving Chats
- Sharing Files
- Making Calls
- Answering Calls
- Sending SMS
- WhatsApp Engagement
- Email Engagement
- Instant Conference Call
- Scheduling Conference Call
- 1-to-1 to Conference
- Ongoing Conference Call
- Video Calling
- Recording and Transcript
- Following Up on Missed Enquiries
- Transferring Enquiry
- Transferring Call
- Transferring Chat
- Space (Group Chat)
- Restart the Enquiry Conversation (360dialog WhatsApp)
- Pin/Unpin Messages & Hide/Unhide Chat Rooms
- Contacts
- Merging Contacts
- Salesforce Contacts in CINNOX App
- Sync Device Contacts
- Setting Up Your Availability Status
- Unread Panel
- Mention Preference
- Conference Preference
- My Account - Staff Profile
- Changing Password
- Passcode and Biometrics
- Two-Factor Authentication
- Third-Party Authentication (Staff App Login)
- Service Numbers
- Personal Numbers
- Call Forwarding
- Managing Devices
- Simulation and Help Centre
- Sending Feedback
- Reports API
- Get Enquiry Details
- Get Enquiry Chat Details
- Get Call Details
- Get Conference Details
- Get Call Log Details
- Get Recording File Details
- Get Transcription File
- Get SMS Details
- Get Enquiry Overview Matrix
- Get Channel Type list
- Get Channel Type details
- Create/Edit/Delete Enquiry Event Subscription
- Create/Edit/Delete Recording File Event Subscription
- Create/Edit/Delete Conference Call Event Subscription
- Get Sent Campaigns Summary
- Get Sent Campaign Details
- Management API
- Create/Edit/Delete External Contact Event Subscription
- Get External Contact List
- Get External Contact Activity
- Create External Contact
- Update External Contact
- Create/Edit/Delete Contact Event Subscription
- Get Staff Contact List
- Create/Edit/Delete Staff Contact Event Subscription
- Get Supported Language List
- Get Supported Location List
- Create Destination-Service Group
- Update Destination-Service Group
- Get Destination List
- Delete Destination-Service Group
- Create Tag
- Get Tag List
- Update Tag
- Delete Tag
- Get Label List
- Delete Label
- Label an Enquiry
- Unlabel an Enquiry
- Create/Edit/Delete Label Event Subscription
- Create/Edit/Delete Enquiry Label Event Subscription
- Get External Contact Note List
Outline