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 modules for Reports, Operations and Management that your developers can use in your apps.

Jump right into the API reference page to view the specification details.

Reports

Report Modules
Enquiry Details
Enquiry Conversation
Call Details
Conference Details
Conference Details
Recording Files
SMS Details
Overview Matrix
Channel Type List
Channel Type Details
Enquiry event

 

Operations

Operation Modules
Send SMS
Send OTP SMS
Get Number list
Get Event hook list
TDR event

 

Management

Management Modules
Get External contacts list
Get External contact activity
Get Staff list
Contact event subscription
Get Location
Get Language
Get Destination
Create/Update Destination
Delete Destination
Get Tag list
Create/Update Tag
Delete Tag
Get Label List
Delete Label
Label Enquiry Label
Unlabel 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 and 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.
938938

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.
10091009

Create an App on the API page

  • Click Save.
995995

Created App with generated App ID, App Toke 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 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.
10111011

Regenerate App Token

  • Click Regenerate located at the right of the App Token.
  • Click Save.
995995

Regenerate App Token

 

Edit an App Name

If necessary, you can change the App Name to have a better naming alignment with your team.

  • As a CINNOX admin staff, sign 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.
10111011

Change the App Name

  • Enter the new App Name.
  • Click Save.
995995

Change the App Name

989989

Change the App Name

 

Delete an App

You can delete an App when it is no longer used.

  • As a CINNOX admin staff, sign 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
10081008

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 be deleted as well. 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.

10241024

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.

Inside 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.

11701170

API Log

 

Help and Support

Please ensure that you are using the correct Base URL and you have created 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].