Phone Calls

Get Agent Incoming Call Action

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

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/phone/incoming-call-action
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Query parameters

agent_identity_idstring uuid nullable

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 operation across all 38 revisions of this API.