v1

latestOpenAPI 3.0.02026-07-1313126.3 KB

contact

Call a contact

This endpoint allows you to initiate a call with a Contact using a specific Agent. The Agent will handle the conversation during the call.

post/contact/call

Request body

contact_idstring required

The ID of the Contact that will be called. You cannot call a phone number until you have created a Contact. By creating a contact, you acknowledge that you have the necessary permissions to call the phone number.

interview_idstring required

The ID of the Agent that will be used to make the call. This can be found in the URL of the Agent page.

Response

Successful response

errorobject nullable

An object containing error details, if any. This field will be populated if the API request fails or encounters an error. If the request is successful, this field will be null or omitted.

dataobject required

Contains the response data for the successful request. This field will vary based on the specific API endpoint being called and contains the main data returned from the API. For example, it may include information about a created contact, agent, or webhook subscription.