Introduction

Introduction

Welcome to Comm100 Restful API help guide. Our APIs make it possible for you to integrate your applications with Comm100LiveChat to achieve seamless data sharing. Our goal tohelp businesses automate their service and enhance the customer support capability withinnovation projects that you can create using Comm100 API.

The Basics

Comm100 RESTful API must use https protocol. What the API requests should start with depends on your platform domain, which can be accessed from both your Control Panel and web version Agent Console after successful login. For example:

• If your Control Panel domain is dash11.comm100.io, all API requests (except for the request to generate the access token) should start with https://api11.comm100.io/v4/.
• If your Control Panel domain is dash12.comm100.io, all API requests (except for the request to generate the access token) should start with https://api12.comm100.io/v4/.
• If your Control Panel domain is dash13.comm100.io, all API requests (except for the request to generate the access token) should start with https://api13.comm100.io/v4/.
• If your Control Panel domain is dash15.comm100.io, all API requests (except for the request to generate the access token) should start with https://api15.comm100.io/v4/.
• If your Control Panel domain is dash17.comm100.io, all API requests (except for the request to generate the access token) should start with https://api17.comm100.io/v4/.
  Note: Each IP can call the APIs maximum 300 times every 5 minutes.

Data Format

Comm100 RESTful API returns data in JSON format.

Error handling

Errors are returned using standard HTTP error code syntax. Generally, codes in the 2xx range indicate success; codes in the 4xx range indicate an error (bad or missing parameters, not authenticated, etc.); codes in the 5xx range indicate an error with Comm100 Live Chat servers.

• 400 - Bad Request. The request cannot be fulfilled due to bad syntax. You need to make sure that passed arguments are matching format in the method's documentation.
• 401 - Unauthorized. The username or API key you provide is invalid. Please make sure that you authenticate with the correct username or API key.
• 403 - Forbidden. Your permission to access the requested resource has been denied or the number of your API requests has exceeded the limit of the day.
• 404 - Not Found. The requested resource could not be found but may be available at a later time.
• 500 - Internal Server Error. The request was incorrect. You need to make sure that the passed arguments match the formats in the method's documentation.

Pagination & Sorting

The majority of list resources in the API allow paging and sorting.

Pagination

You can specify how many items per page you want to fetch.
Params:

Response:

Sorting

You can specify the order of list resources.
Params:

Time Zone Options