APPs & API
The CINNOX Open Application Programming Interface (API) can send requests and receive responses to your CINNOX service features and data.
Below, we list all the available Reports, Operations and Management modules that your developers can use in your apps.
Jump right into the API reference page to view the specification details.
Reports
| Report Modules |
|---|
| Get Enquiry Details |
| Get Enquiry Chat Details |
| Get Call Details |
| Get Call Log Details |
| Get Conference Details |
| Get Recording Files |
| Get Transcription Files |
| Get SMS Details |
| Get Enquiry Overview |
| Get Channel Type List |
| Get Channel Type Details |
| Create/Edit/Delete Enquiry Event Subscription |
| Create/Edit/Delete Record File Event Subscription |
| Create/Edit/Delete Conference Call Event Subscription |
| Get Sent Campaign Summary |
| Get Sent Campaign Details |
Operations
| Operation Modules |
|---|
| Send SMS |
| Send OTP SMS |
| 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 |
Management
| Management Modules |
|---|
| 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 |
| Create/Edit/Delete Staff Contact Event Subscription |
| Get Staff Contact List |
| 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 |
What do you need to know before you begin
Your plan must be Omnichannel Contact Centre or above to use CINNOX Open API.
Refer to CINNOX Pricing for more details.
You must create an App ID in your CINNOX Web Dashboard to access the CINNOX Open API and use the generated App ID, App Token and the Base URL for the authorisation.
Creating an App
To create an App in the CINNOX Dashboard:
- As a CINNOX admin staff, sign in to your Web Dashboard.
- Navigate to Administration > Service Integration > API > API LIST
- Click Create App located in the middle part of the page.
Create an App on the API page
- On the Setup API Platform page, enter an App Name, which can be any name. The max chars are 50.
- Click Save.
Created an App with a generated App ID, App Token and Base URL
Once the App Name creation is done successfully, the following are generated.
- App ID
- App Token
- Base URL
Regenerate App Token
You can regenerate a new App Token for security purposes.
- As a CINNOX admin staff, sign in to your Web Dashboard.
- Navigate to Administration > Service Integration > API > API LIST.
- Find the App Name you want to edit.
- Click the 3-dot icon ... located on the right side of the App Name.
- Select View in the list to open the App details.
Regenerate App Token
- Click Regenerate located at the right of the App Token.
- Click Save.
Regenerate App Token
Edit an App Name
You can change the App Name to have a better naming alignment with your team if necessary.
- As a CINNOX admin staff, sign in to your Web Dashboard.
- Navigate to Administration > Service Integration > API > API LIST.
- Find the App Name you want to edit.
- Click the 3-dot icon ... located at the right side of the App Name.
- Select View in the list to open the App details.
Change the App Name
- Enter the new App Name.
- Click Save.
Change the App Name
Change the App Name
Delete an App
You can delete an App when it is no longer used.
- As a CINNOX admin staff, sign in to your Web Dashboard.
- Navigate to Administration > Service Integration > API > API LIST.
- Find the App Name that you want to delete.
- Click the 3-dot icon ... located at the right side of the App Name
- Select Delete in the list.
- A pop-up window will appear confirming the deletion of the App.
- Click Delete
Delete an App
Important
📘
Please Note
- Once an App is created successfully, the system will generate the App ID, App Token and Base URL for the created App.
- The maximum App to create in your CINNOX service is 10.
- The App ID, App Token and Base URL would remain the same when the App Name has been renamed.
- When you delete an App Name, its App ID and App Token will also be deleted. The API endpoint responds to an error when using an App ID and App Token for a deleted App.
CINNOX API Reference
Jump right into the API reference page to view the details.
CINNOX Open API Reference
API Log
The API Log located in the CINNOX Web Dashboard > Administration > API is a chronological record of all API activities made by your developer with the report data in your CINNOX service.
The API Log includes the Date, Method, Title, Status, IP Address, App ID and App Token details.
As a staff administrator, you can view the data in the API Log in real-time. You can filter by date range or search by App ID.
API Log
Help and Support
Please ensure you use the correct Base URL and create your App in your CINNOX Web Dashboard > Administration > API for the App ID and App Token use.
If you need further support, contact our CINNOX Support Team at [email protected].