CreateCallRequest

  • call_agent_id
    Type: string
    min length:  
    1
    max length:  
    512
    required

    The Call Agent that should handle this call.

  • to_phone_number
    Type: string
    required
  • additional_participants
    Type: Additional Participantsnullable

    Numbers for this call's additional participants, keyed by the names the Call Agent declares — for example {"pharmacy": "+16175550188"}. Every name must be on the agent's roster; a roster participant with a fixed number needs no entry. Omitted, and with no roster on the agent, the call is an ordinary two-party call.

  • call_ended_webhook_url
    Type: string
    min length:  
    1    Format: urinullable

    HTTPS URL Resia POSTs the call.ended event to for this call. A URL here overrides the Call Agent URL. Null or omitted uses the Call Agent URL. A retry that returns the same call keeps the URL saved by the first request. Treat the complete URL as a credential because delivery authenticity uses HTTPS plus URL secrecy.

  • client_reference
    Type: string
    min length:  
    1
    max length:  
    256    nullable

    Your own label for this call. Resia never interprets it: it is stored on the call, echoed on every read of it, and usable as a filter on GET /v1/calls. Use an opaque identifier from your own system — an order number, a CRM record id. Do not put names, phone numbers, or any personal or sensitive information in it: the label travels in URLs when used as a filter, and URLs appear in ordinary infrastructure request logs.

  • from_phone_number
    Type: stringnullable
  • inputs
    Type: Inputs
    Properties: 1
  • knowledge_base_id
    Type: string
    min length:  
    1
    max length:  
    512    nullable

    Names the knowledge base this call answers from. Null or omitted runs the call without one. The id must belong to a ready knowledge base in your organization; the call answers without a knowledge base when it does not.

Examples 
{
  "call_agent_id": "01K1S9V9Q0RS7X4T2N6BJ8ZDE5",
  "from_phone_number": "+16465550175",
  "inputs": {
    "medication": "metformin 500mg",
    "pharmacy_name": "Grove Street Pharmacy"
  },
  "to_phone_number": "+12125550142"
}