Navigation

Call (v2)

Create Phone Call

Create a new outbound phone call

Post

Authorizations

  • Authorizations
  • string
  • header
  • required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Body

  • from_number
  • string
  • required

The number you own in E.164 format. Must be a Retell managed number.

  • to_number
  • string
  • required

The number you want to call, in E.164 format. Right now only US numbers are officially supported.

  • override_agent_id
  • string

For this particular call, override the agent used with this agent id. This does not bind the agent to this number, this is for one time override.

  • metadata
  • object

An arbitrary object for storage purpose only. You can put anything here like your internal customer id associated with the call. Not used for processing. You can later get this field from the call object.

  • retell_llm_dynamic_variables
  • object

Add optional dynamic variables in key value pairs of string that injects into your Retell LLM prompt and tool description. Only applicable for Retell LLM.

Response

  • call_type
  • enum</string>
  • required

The number you own in E.164 format. Must be a Retell managed number.

  • Available options:
  • phone_call
  • from_number
  • string
  • required

The caller number.

  • to_number
  • string
  • required

The caller number.

  • direction
  • enum</string>
  • required

Direction of the phone call.

  • Available options:
  • inbound
  • ,
  • outbound

Response

  • call_type
  • enum</string>
  • required
  • Available options:
  • phone_call
  • from_number
  • string
  • required

The number you want to call, in E.164 format. Right now only US numbers are officially supported.

  • override_agent_id
  • string

For this particular call, override the agent used with this agent id. This does not bind the agent to this number, this is for one time override.

  • direction
  • object

An arbitrary object for storage purpose only. You can put anything here like your internal customer id associated with the call. Not used for processing. You can later get this field from the call object.

  • retell_llm_dynamic_variables
  • object

Add optional dynamic variables in key value pairs of string that injects into your Retell LLM prompt and tool description. Only applicable for Retell LLM.

Was this page helpful?
Yes
No
Create a web call
Powered by imash

Start building your call operation agents

Create Seamless multi-channel customer experiences in seconds, Welcome new contacts, recover abandoned carts, and notify customers about back-in-stocks