Call a customer

This endpoint allows you to start an outbound call to a customer, providing an AI persona ID to use as the instructions for the call.

post

Start an outbound call with the customer.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

customerIdstringRequired

The ID of the customer.

Body

application/json

personaIdstringRequired

voiceMailPersonaIdstringOptional

phoneNumberstringOptional

enginestring · enumOptionalPossible values:

Responses

200

The call was started succesfully.

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

post

/v1/agents/{agentId}/customers/{customerId}/call

HTTPcURLJavaScriptPython

POST /v1/agents/{agentId}/customers/{customerId}/call HTTP/1.1
Host: api.voxity.ai
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "personaId": "text",
  "voiceMailPersonaId": "text",
  "phoneNumber": "text",
  "engine": "v1"
}

{
  "code": "CALL_STARTED",
  "message": "Outbound call started.",
  "callSid": "text"
}