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:

For each method call, you must use your email and API_KEY.Authentication to the API is done via HTTP Basic Auth. Provide your email as the basic auth username and API_KEY as the password. You must authenticate for API requests. Even though we still support this type of authentication, we recommend using Oauth authentication.

When using API key to call the interface, you need to bring the parameter siteId. For Example: GET https://api11.comm100.io/v4/livechat/campaigns?siteId=10000

You can use OAuth2 to authenticate all your API requests to Comm100. OAuth provides a more secure way for your application to access your account data without requiring sensitive information like email and password to be sent with the requests. There are different OAuth flows for different types of API.

Note that while generating an access token, the API request should start with your platform domain, which is different from other API requests. For example:

Comm100 RESTful API returns data in JSON format.

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.

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