Skip to main content
POST
Forward (warm-transfer) the live call to another phone number

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Path Parameters

uuid
string<uuid>
required

Conversation UUID returned by POST /api/v1/call as conversation_uuid.

Body

application/json
phone_number
string
required

E.164 phone number to forward the call to.

Maximum string length: 32
Example:

"+1234567890"

Response

Forward dispatched

success
boolean

Indicates whether the request completed successfully. True for successful responses; false for documented error responses.

Example:

true

message
string

Human-readable response message. Safe to display in logs or simple client notifications; use structured fields for program logic.

Example:

"Forward dispatched"

data
object