Telephony

Request call termination

Changed on

Idempotent stop for an integration call. Acknowledgment means the stop intent is durable; poll the call for confirmed completion. Requires telephony:manage.

post/v1/telephony/calls/{id}/hangup

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/telephony/calls/{id}/hangup
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required

Response

Stop accepted

versioninteger
project_idstring
client_referencestring nullable
agent_release_idstring nullable
stop_requestedboolean
objectstring
idstring
from_number_idstring
tostring
agent_idstring
use_case'transactional' | 'support' | 'sales' | 'collections' | 'survey'
routing_profile'quality_first' | 'balanced' | 'cost_optimized'
status'queued' | 'dispatching' | 'ringing' | 'in_progress' | 'completed' | 'failed' | 'canceled' | 'dispatch_unknown'
attempt_countinteger
max_attemptsinteger
failure_reason'network_unavailable' | 'congestion' | 'timeout' | 'no_answer' | 'busy' | 'rejected' | 'invalid_number' | 'identity_blocked' | 'compliance_blocked' | 'unknown' | 'null' nullable
created_atinteger

Unix ms.

updated_atinteger

Unix ms.

answered_atinteger nullable

Unix ms.

ended_atinteger nullable

Unix ms.

Example response

{
  "object": "telephony.call",
  "id": "tcall_...",
  "to": "+14155550123",
  "artifacts": {
    "ai_usage": {
      "meter": "agents.minutes"
    },
    "usage": {
      "meter": "telephony.minutes"
    }
  }
}

Changes