Reports API

Introduction

The CINNOX Open API Reports provides endpoints to retrieve detailed records from the CINNOX database related to your CINNOX service account.

Such as:

API Endpoint	Description	Remark
Get Enquiry detail	This endpoint allows you to query all enquiry details such as the enquiry ID, status, visitor records, and others.	The current version supports the following enquiry channels: Tag / Directory Web link Campaign Virtual Number Facebook Messenger WhatsApp WeChat LINE Third Party Channel Email
Get Enquiry chat	This endpoint allows you to query closed enquiry - chat history between the staff and the visitor or customer.	You can only query one closed enquiry - chat history at one time.
Get Call detail	This endpoint allows you to query all 1-on-1 call details such as the caller, called party, call duration and others.
Get Conference detail	This endpoint allows you to query all conference call details such as the host, participants, call duration and others.
Get Recording file	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 detail	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 includes 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 for an application. And also allow 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 (Status: Open, Handling, Missed and Closed)

❗️
Please be noted that the recording file download URL does not have any permission control. Please do not share it with any unauthorised third party.

Error Codes and Rate Limit

Error Code	Error Message	Description
6451001	Bad response from the service	Response from internal service error
6451000	Unknown data type Bad query EnquiryID is required CallID or conferenceID is required only one of callID or conferenceID is allowed Missing one of startAt, endAt endAt is prior than startAt negative offset negative limit exceed maximum limit invalid enquiryID invalid query: (query1), (query2) invalid channel type empty time range (missing startAt and endAt)	General error code for wrong parameter of request
6451010	Too many requests	Reach request rate limit
6451011	No records found	Query success is correct but no records found
6451013	Requested chat logs over the limit	Request item over the limit (500 requests per min per service)
6451014	App name is conflict	Duplicate app name conflict
6452000	Invalid token	Invalid app token
6452001	Invalid appID	Invalid app id
6450001	Method cannot be found, method: {method} uri: {uri}	Resource not found / incorrect path

📘
CINNOX Open API support up to 500 requests per min per service account.