INinkbox
Phone Calls

Place Call

Changed on
post/api/v1/phone/place-call

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/place-call
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Query parameters

async_commandboolean

Headers

Idempotency-Keystring nullable

Request body

origination'dedicated_number' | 'shared_imessage_number' | 'dedicated_imessage_number'
from_numberstring nullable

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

to_numberstring required

Destination phone number to dial, in E.164 format.

agent_identity_idstring uuid nullable

Agent identity placing the call (required for shared_imessage_number under admin/JWT).

client_websocket_urlstring nullable

WebSocket URL (wss://) for audio bridging. Falls back to phone number's client_websocket_url.

mode'client_websocket' | 'hosted_agent'
hosted_agent_authority_mode'contact_scoped' | 'yolo'
on_voicemail'hang_up' | 'leave_message' | 'ignore'
voicemail_messagestring nullable

What the hosted agent should say when leaving a voicemail. Only valid with on_voicemail=leave_message; when omitted, the agent composes a short message from reason.

voicemail_detection'enabled' | 'disabled'
reasonstring nullable

Task brief for the hosted agent, e.g. what to accomplish on the call. Required with mode=hosted_agent; invalid otherwise.

Example request

{
  "from_number": "+15551234567",
  "to_number": "+15551234567"
}

Response

Successful Response

OR

Changes

  • f89b69e22318Revision changes
    • info

      added the optional property / to the response with the status

  • 4e8dd191442eRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status