Skip to main content

Workspace.Chats.Voice

Tags: chat, communication, messaging, voice

Endpoints​

Outbound Call​

POST /api/v2/w/{workspace_uuid}/chats/{chat_id}/outbound-call

Description:

Voice chat functionality

Initiate an outbound phone call for a chat.

Starts an outbound voice call from the assistant to the chat participant using Twilio. The call will be connected to the workspace's configured phone number and handled by the chat's assigned assistant with real-time audio streaming.

Path Parameters:

  • chat_id: Chat ID to initiate the call for

Request Body:

  • phoneNumberId: ID of the workspace phone number to use for the outbound call

Response: Returns a status object confirming the call was initiated successfully.

Permissions: Requires workspace management permissions and sufficient phone call budget.

Error Responses:

  • 400 Bad Request: Invalid phone number ID or chat configuration
  • 401 Unauthorized: Missing or invalid authentication
  • 403 Forbidden: Insufficient permissions or exceeded budget limits
  • 404 Not Found: Chat or phone number not found
  • 500 Internal Server Error: Failed to initiate call with Twilio

Related Endpoints:

  • GET /chats/{id} - Get chat details
  • POST /chats - Create a new chat for phone conversations

Authorization: Requires phones:write scope

Parameters:

Response: See OutboundDialResult

Phone Calls​

GET /api/v2/w/{workspace_uuid}/chats/{chat_id}/phone-calls

Description:

Voice chat functionality

Get phone calls associated with a chat.

Returns all phone calls linked to the given chat, ordered by most recent first. Used by the chat detail view to display call termination information.

Authorization: Requires chats:read scope

Parameters:

  • chat_id (Integer)

Response: List of PhoneCallResponse