Skip to main content
POST
Hang up the live call (the agent speaks a goodbye message, then ends)

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
message
string

Optional goodbye message. If omitted, the agent's configured end-of-call message is used; if none is set, defaults to 'Good Bye'.

Maximum string length: 2000
Example:

"Thank you for calling, goodbye."

Response

Hangup 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:

"Hangup dispatched"

data
object