Send Call

Your API key for authentication.

A special key for using a BYOT (Bring Your Own Twilio) account. Only required for sending calls from your own Twilio account.

The phone number to call. Country code defaults to +1 (US) if not specified.

For best results, use the E.164 format.

Provide instructions, relevant information, and examples of the ideal conversation flow.

This is your prompt where you are telling the agent what to do.

Recommendations:

• Include context and a background/persona for the agent like "You are {name}, a customer service agent at {company} calling {name} about {reason}.
• Phrase instructions like you are speaking to the agent before the call.
• Any time you tell the agent not to do something, provide an example of what they should do instead.
• Keep the prompt under 2,000 characters where possible.
• Want to easily test out exactly how your agent will behave? Try out Agent Testing!

This is the pathway ID for the pathway you have created on our dev portal. You can access the ID of your pathways by clicking the ‘Copy ID’ button of your pathway here

Note: Certain parameters do not apply when using pathways.

Example Simple Request body:

"phone_number": "+1975934749",
"pathway_id": "a0f0d4ed-f5f5-4f16-b3f9-22166594d7a7"

The voice of the AI agent to use. Accepts any form of voice ID, including custom voice clones and voice presets.

Default voices can be referenced directly by their name instead of an id.

Usage example: voice: "maya"

Bland Curated voices:

• maya
• mason
• ryan
• adriana
• tina
• matt
• evelyn

Use the GET /v1/voices endpoint to see a full list of your available voices.

Makes your agent say a specific phrase or sentence for it’s first response.

By default, the agent starts talking as soon as the call connects.

When wait_for_greeting is set to true, the agent will wait for the call recipient to speak first before responding.

Adjusts how patient the AI is when waiting for the user to finish speaking.

Lower values mean the AI will respond more quickly, while higher values mean the AI will wait longer before responding.

Recommended range: 50-200

• 50: Extremely quick, back and forth conversation
• 100: Balanced to respond at a natural pace
• 200: Very patient, allows for long pauses and interruptions. Ideal for collecting detailed information.

Try to start with 100 and make small adjustments in increments of ~10 as needed for your use case.

Select a model to use for your call.

Options: gpt4, base, turbo and enhanced.

In nearly all cases, enhanced is the best choice.

A value between 0 and 1 that controls the randomness of the LLM. 0 will cause more deterministic outputs while 1 will cause more random.

Example Values: "0.9", "0.3", "0.5"

These words will be boosted in the transcription engine - recommended for proper nouns or words that are frequently mis-transcribed.

For example, if the word “Reece” is frequently transcribed as a homonym like “Reese” you could do this:

{
  "keywords": ["Reece"]
}

For stronger keyword boosts, you can place a colon then a boost factor after the word. The default boost factor is 2.

{
  "keywords": ["Reece:3"]
}

The pronunciation guide is an array of objects that guides the agent on how to say specific words. This is great for situations with complicated terms or names.

  [
    {
      "word": "example",
      "pronunciation": "ex-am-ple",
      "case_sensitive": "false",
      "spaced": "false"
    },
    {
      "word": "API",
      "pronunciation": "A P I",
      "case_sensitive": "true",
      "spaced": "true"
    }
  ]

A phone number that the agent can transfer to under specific conditions - such as being asked to speak to a human or supervisor.

Give your agent the ability to transfer calls to a set of phone numbers.

Overrides transfer_phone_number if a transfer_list.default is specified.

Will default to transfer_list.default, or the chosen phone number.

Example usage to route calls to different departments:

"transfer_list": {
    "default": "+12223334444",
    "sales": "+12223334444",
    "support": "+12223334444",
    "billing": "+12223334444"
}

Select a supported language of your choice. Optimizes every part of our API for that language - transcription, speech, and other inner workings.

Supported Languages and their codes:

• English: ENG
• Spanish: ESP
• French: FRE
• Polish: POL
• German: GER
• Italian: ITA
• Brazilian Portuguese: PBR
• Portuguese: POR

Set the timezone for the call. Handled automatically for calls in the US.

This helps significantly with use cases that rely on appointment setting, scheduling, or behaving differently based on the time of day.

Timezone options are here in the TZ identifier column.

Any JSON you put in here will be visible to the AI agent during the call - and can also be referenced with Prompt Variables.

For example, let’s say in your app you want to programmatically set the name of the person you’re calling. You could set request_data to:

{
  "phone_number": "+1...",
  "task": "...",
  "first_sentence": "Hello {{name}}! How are you doing today?", // also works in the prompt, tools, etc.
  "request_data": {
    "name": "John Doe",
  }
}

For further information about how Prompt Variables work, check out the Custom Tools tutorial.

Interact with the real world through API calls.

Detailed tutorial here: Custom Tools

Make dynamic requests to external APIs and use the data in your AI’s responses.

    "dynamic_data": [
        {
            "url": "https://api.coindesk.com/v1/bpi/currentprice.json",
            "response_data": [
                {
                    "name": "BTC Price USD",
                    "data": "bpi.USD.rate",
                    "context": "Current BTC Price: ${{BTC Price USD}} USD"
                },
                {
                    "name": "BTC Price EUR",
                    "data": "bpi.EUR.rate",
                    "context": "In Euros: {{BTC Price USD}} EUR"
                }
            ]
        }
    ]

The time you want the call to start. If you don’t specify a time (or the time is in the past), the call will send immediately.

Set your time in the format YYYY-MM-DD HH:MM:SS -HH:MM (ex. 2021-01-01 12:00:00 -05:00).

The timezone is optional, and defaults to UTC if not specified.

Note: Scheduled calls can be cancelled with the POST /v1/calls/:call_id/stop endpoint.

When the AI encounters a voicemail, it will leave this message after the beep and then immediately end the call.

Warning: If amd is set to true or voicemail_action is set to ignore, then this will still work for voicemails, but it will not hang up for IVR systems.

This is processed separately from the AI’s decision making, and overrides it.

Options:

• hangup
• leave_message
• ignore

Examples:

• Call is answered by a voicemail (specifically with a beep or tone):

  • If voicemail_message is set, that message will be left and then the call will end.
  • Otherwise, the call immediately ends (regardless of amd)

• Call is answered by an IVR system or phone tree:

  • If amd is set to true, the AI will navigate the system and continue as normal.
  • If voicemail_action is set to ignore, the AI will ignore the IVR and continue as normal.
  • Otherwise, if voicemail_message is set then it’ll leave that message and end the call.
  • Finally, if none of those conditions are met, the call will end immediately.

Note: If voicemail_message is set, then the AI will leave the message regardless of the voicemail_action.

When the call starts, a timer is set for the max_duration minutes. At the end of that timer, if the call is still active it will be automatically ended.

Example Values: 20, 2

To record your phone call, set record to true. When your call completes, you can access through the recording_url field in the call details or your webhook.

Specify a phone number to call from that you own or have uploaded from your Twilio account. Country code is required, spaces or parentheses must be excluded.

By default, calls are initiated from a separate pool of numbers owned by Bland.

When the call ends, we’ll send the call details in a POST request to the URL you specify here.

The request body will match the response from the GET /v1/calls/:call_id endpoint.

Add any additional information you want to associate with the call. This can be useful for tracking or categorizing calls.

Anything that you put here will be returned in your webhook or in the call details under metadata.

Example:

"metadata": {
  "campaign_id": "1234",
  "source": "web"
}

When the call ends, the transcript and call details will be analyzed by the AI.

Define a JSON schema for how you want to get information about the call - information like email addresses, names, appointment times or any other type of custom data.

In the webhook response or whenever you retrieve call data later, you’ll get the data you defined back under analysis.

For example, if you wanted to retrieve this information from the call:

"analysis_schema": {
  "email_address": "email",
  "first_name": "string",
  "last_name": "string",
  "wants_to_book_appointment": "boolean",
  "appointment_time": "YYYY-MM-DD HH:MM:SS"
}

You would get it filled out like this in your webhook once the call completes:

"analysis": {
  "email_address": "johndoe@gmail.com",
  "first_name": "John",
  "last_name": "Doe",
  "wants_to_book_appointment": true,
  "appointment_time": "2024-01-01 12:00:00"
}

If this is set to true, we process the audio from the start of the call to determine if it was answered by a human or a voicemail.

In the call details or webhook response, you’ll see the answered_by field with the value human, unknown or voicemail.

Notes for accuracy:

• When answered_by is voicemail or human, that is nearly 100% accurate.
• When it is unknown, try using text analysis by adding answered_by to your analysis_schema.

Can be success or error.

A unique identifier for the call (present only if status is success).

The batch ID of the call (present only if status is success).

A message explaining the status of the call.

For validation errors, a detailed list of each field with an error and it’s error message.

Example:

{
  "status": "error",
  "message": "Invalid parameters",
  "errors": [
      "Missing required parameter: phone_number.",
      "Missing required parameter: task.",
      "Phone number must be a string or number.",
      "Task must be a string."
  ]
}