Introduction
The CINNOX Open API Reports provides endpoints for retrieving detailed records from the CINNOX database related to your CINNOX service account.
| API Endpoint | Description | Remark |
|---|---|---|
| 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 - LINE - WOZTELL - ThirdParty Channel |
| 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 - LINE - Third Party Channel |
| 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. |
Please be noticed that the recording file download URL does not have any permission control. Please do not share it with any unauthorised third party.
CINNOX Open API support up to 500 requests per min per service account.