Skip to Content
Call IngestionHipcall Integration

Hipcall Integration

POST/api/v1/webhooks/hipcall/calls
Accepts the call_hangup notification that the Hipcall PBX sends when a call ends.

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

FieldTypeRequiredDescription
apiKeystring (GUID)YesAPI key provided by our team for your Hipcall integration.
apiSecretstring (GUID)YesAPI secret specific to your company.

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

CaseResponseDescription
event is call_hangupProcessedThe call is saved and queued for analysis.
event is anything else200, Event '...' ignored.The notification is ignored.
Call received outside business hours200, Out of business hours call ignored.The call is not saved.
Call never routed to a team or user200, Call never routed to an agent ignored.The call is not saved.
Notification received again for the same call200, 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

200Success
{ "success": true, "message": "019e925a-5f79-7778-b0be-a45a146cf828 successfully processed" }
401apiKey / apiSecret is missing or invalid
{ "success": false, "message": "Missing or invalid apiKey/apiSecret." }
MessageHTTPDescription
data.uuid is required.400The notification has no call ID.
started_at and ended_at are required.400The start or end time is missing.
ended_at cannot be earlier than started_at.400The end time is before the start time.
Missing or invalid apiKey/apiSecret.401apiKey or apiSecret was not sent or is not in GUID format.
Invalid apiKey/apiSecret.401The values are invalid or do not belong to a Hipcall integration.
An error occurred while processing the call data.500Unexpected error.
Last updated: