Skip to main content

CreateRetellCallRequest

toNumberstringrequired

Destination: E.164, 10/11-digit US, PBX extension, queue name, or SIP URI.

Possible values: non-empty and <= 512 characters

overrideAgentIdstring

Retell agent ID for this call. Overrides the phone number's default outbound agent. The tenant dashboard Agent dropdown sends this field.

overrideAgentVersioninteger | string

Retell agent version for this one call. Accepts a non-negative integer, latest, or latest_published. Omit to use the agent's default published version.

retellLlmDynamicVariables object

String key/value pairs sent to Retell as retell_llm_dynamic_variables. The agent can read them in prompts and tools as {{key}}. Do not put sipsandwich identifiers only on Retell metadata; metadata is storage-only and is not actionable. sipsandwich always adds and owns these keys: callGroup, sipsandwich_call_group, routingMode, tenantId, trunkId, phoneNumberId, originatedFrom, and sipsandwich_request_id.

property name*string
customSipHeaders object

X-* SIP headers to include; platform correlation headers are added automatically.

property name*string
tags object[]

Any Retell create-phone-call override as a dotted-path tag.

Possible values: <= 100

  • Array [
    • keystringrequired

    Dotted path into the Retell create-phone-call payload (for example agent_override.agent.voice_id).

    valuestringrequired

    Raw value or JSON text parsed as booleans, numbers, arrays, or objects.

  • ]
    • pAssertedIdentityboolean

    When true, the selected From number (or originalCallerId if supplied) is sent as X-Sip-Sandwich-DID and rewritten to P-Asserted-Identity toward the carrier. Defaults to true.

    Default value: true
    originalCallerIdstring

    Optional presented DID. Defaults to the phone number's E.164. Used for X-Original_Caller_ID and, when pAssertedIdentity is true, X-Sip-Sandwich-DID. The portal sends the selected From number automatically.

    fromUserstring

    Optional SIP From-user rewrite via X-sipsandwich_from_user. Not required when calling from a selected imported or alternate number; the trunk fromUserMode already maps Retell's identity to the provider SIP username.

    CreateRetellCallRequest
    {
      "toNumber": "string",
      "overrideAgentId": "string",
      "overrideAgentVersion": 0,
      "retellLlmDynamicVariables": {},
      "customSipHeaders": {},
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "pAssertedIdentity": true,
      "originalCallerId": "string",
      "fromUser": "string"
    }