Sign in
Phone Calls

Set Agent Incoming Call Action

put/api/v1/phone/incoming-call-action

Headers

Idempotency-Keystring nullable

Request body

incoming_call_action'auto_accept' | 'auto_reject' | 'webhook' | 'hosted_agent' | 'forward' required
agent_identity_idstring uuid nullable
client_websocket_urlstring nullable
incoming_call_webhook_urlstring nullable
forwarding_target_type'phone' | 'sip'
forwarding_phone_numberstring nullable

Phone number in E.164 format (e.g. '+15551234567').

forwarding_sip_uristring nullable

Complete SIP destination in sip:user@host format.

Example request

{
  "forwarding_phone_number": "+15551234567",
  "forwarding_sip_uri": "sip:line@voice.example.com"
}

Response

Successful Response

agent_identity_idstring uuid required
incoming_call_action'auto_accept' | 'auto_reject' | 'webhook' | 'hosted_agent' | 'forward' required
client_websocket_urlstring nullable required
incoming_call_webhook_urlstring nullable required
forwarding_target_type'phone' | 'sip'
forwarding_phone_numberstring nullable
forwarding_sip_uristring nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.