ClearIP offers an API that can be used to manage all policies that can accessed through the user interface and pull call analytics and usage data.
Response Codes
| Status Code | Reason |
|---|---|
| 200 OK | The request was successful |
| 201 Created | The request was successful. A new record was created. |
| 400 Bad Request | The request was invalid due to a missing required field, invalid value format, etc. |
| 403 Forbidden | The request is missing a valid access token. |
| 409 Conflict | The request failed due to an existing duplicate record that conflicts with the request. |
Reference Records by ID
The ClearIP API references each record by its unique ID defined within ClearIP. The ID for the object can be viewed within the user interface or using the API.
To view the IDs in the user interface, go to the relevant page in ClearIP that shows the list of records, select Columns, and click ID. It shows the ID values to use when referencing each record using the API.