Hipcall Integration
If you use Hipcall, you do not need to send calls yourself. Simply set the URL below as the webhook address in the Hipcall panel; when a call ends, Hipcall sends the notification directly to ThinkVoice.
Webhook URL
https://public-api.thinkvoice.ai/api/v1/webhooks/hipcall/calls?apiKey=<API_KEY>&apiSecret=<API_SECRET>Query Parameters
Because the Hipcall panel does not allow custom headers for webhooks, credentials are passed in the URL for this endpoint. Enter this URL only in the Hipcall panel; do not share it anywhere else.
Request Body
The body is Hipcall’s own call_hangup notification format; you do not need to build it. ThinkVoice needs the following fields: event, data.uuid, data.started_at, data.ended_at.
How It Works
| Case | Response | Description |
|---|---|---|
event is call_hangup | Processed | The call is saved and queued for analysis. |
event is anything else | 200, Event '...' ignored. | The notification is ignored. |
| Call received outside business hours | 200, Out of business hours call ignored. | The call is not saved. |
| Call never routed to a team or user | 200, Call never routed to an agent ignored. | The call is not saved. |
| Notification received again for the same call | 200, Already processed. | No duplicate record is created. |
200 is returned intentionally for ignored cases so that Hipcall does not keep resending the same notification.
Responses
| Message | HTTP | Description |
|---|---|---|
data.uuid is required. | 400 | The notification has no call ID. |
started_at and ended_at are required. | 400 | The start or end time is missing. |
ended_at cannot be earlier than started_at. | 400 | The end time is before the start time. |
Missing or invalid apiKey/apiSecret. | 401 | apiKey or apiSecret was not sent or is not in GUID format. |
Invalid apiKey/apiSecret. | 401 | The values are invalid or do not belong to a Hipcall integration. |
An error occurred while processing the call data. | 500 | Unexpected error. |
Last updated: