Create Outbound Call

POST

dial

outbound

curl --request POST \
  --url https://app.happyrobot.ai/api/v1/dial/outbound \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "assistant_id": "<string>",
  "voice_id": "<string>",
  "model": "Fast",
  "number_id": "<string>",
  "prompt_id": "<string>",
  "use_case_id": "<string>",
  "agent_id": "<string>",
  "model_id": "<string>",
  "phone_number": "+1234567890",
  "language": "en-US",
  "params": "<any>",
  "metadata": {},
  "campaign_id": "<string>",
  "scheduled_for": "2024-01-01T01:01:01Z",
  "max_duration_mins": 123
}'

{
  "id": "<string>",
  "organization_id": "<string>",
  "metadata": {
    "call_sid": "<string>",
    "from": "+1234567890",
    "to": "+1234567890",
    "recording_sid": "<string>",
    "tags": [
      "<string>"
    ],
    "custom": {
      "clientId": "123",
      "orderId": "456"
    }
  },
  "use_case": {
    "id": "<string>",
    "organization_id": "<string>",
    "name": "Kate",
    "transfer_number": "<string>",
    "extract_with_ai": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "string",
        "example": "<string>",
        "required": true
      }
    ],
    "classification_tags": [
      {
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "language": "en-US",
    "detailed_work_hours": {},
    "work_start": "<string>",
    "work_end": "<string>",
    "timezone": "<string>",
    "generic_after_hours_message": "<string>",
    "enable_detailed_work_hours": true,
    "keywords": [
      "<string>"
    ],
    "hooks": [
      {
        "url": "<string>",
        "headers": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "params": {},
    "amd": true,
    "amd_behavior": "Hangup",
    "amd_messages": {},
    "sample_labels": [
      {
        "name": "<string>",
        "color": "slate"
      }
    ],
    "hidden": true,
    "evaluation_models": [
      "<string>"
    ],
    "max_duration_mins": 123,
    "recorded_message_inbound": true,
    "recorded_message_outbound": true,
    "show_original_caller_id": true,
    "disable_end_call_after_n_reminders": true,
    "model": "<string>"
  },
  "params": {},
  "created": "2024-01-01T01:01:01Z"
}

Headers

authorization

string

required

Your API key for authentication. Use Bearer format.

Example:

"Bearer API_KEY"

Body

application/json

Body

number_id

string

required

ID of the phone number that should trigger the call.

Required string length: 24

phone_number

string

required

Phone number to call.

Example:

"+1234567890"

assistant_id

string

deprecated

DEPRECATED: Use the use_case_id instead.

voice_id

string

deprecated

DEPRECATED: ID of the voice that the agent will use.

model

string

deprecated

DEPRECATED: Model to use for the call

Example:

"Fast"

prompt_id

string

ID of the prompt to use for the call. If empty, default outbound prompt will be used.

use_case_id

string

ID of the use case that should handle the call.

Required string length: 24

agent_id

string

ID of the agent that should handle the call.

Required string length: 24

model_id

string

ID of the model that should handle the call.

Required string length: 24

language

enum<string>

Language of the call. It will default to use case's default language.

Available options:

en-US,

en-GB,

es-MX,

es-ES,

es-CO,

pt-PT,

de-DE,

fr-FR,

pl-PL,

ro-RO,

it-IT,

zh-CN,

hi-IN,

ja-JP,

sv-SE

params

any | null

Dynamic parameters to inject into the templated use case prompt.

metadata

object

Custom metadata associated with the call.

campaign_id

string

ID of the campaign that triggered the call.

scheduled_for

string

ISO 8601 UTC datetime the call is scheduled for. If not specified, the call will the executed immediately.

Example:

"2024-01-01T01:01:01Z"

max_duration_mins

integer

Specifies the maximum duration of the call in minutes. This value takes precedence over the maximum duration specified in the use-case model. If neither is provided, the default duration is 10 minutes.

Response

200

application/json

200

string

required

Unique identifier for the call.

organization_id

string

required

Organization ID.

metadata

object

required

Call metadata.

metadata.call_sid

string

Call SID from the provider.

metadata.from

string

Phone number that initiated the call.

Example:

"+1234567890"

metadata.to

string

Phone number that received the call.

Example:

"+1234567890"

metadata.recording_sid

string

Recording SID from the provider.

metadata.tags

string[]

Tags associated with the call.

metadata.custom

object

Custom metadata associated with the call.

Example:

{ "clientId": "123", "orderId": "456" }

use_case

object

required

Use case that handled the call.

use_case.id

string

required

ID of the use case.

use_case.organization_id

string

required

ID of the organization that owns the use case.

use_case.model

string

required

Model name.

use_case.name

string

Name of the use case.

Example:

"Kate"

use_case.transfer_number

string

Fallback phone number to transfer the call to if something breaks.

use_case.extract_with_ai

object[]

Parameters to extract with AI.

use_case.classification_tags

object[]

Classification tags for the use case.

use_case.language

enum<string>

default:en-US

Preferred language for the use case.

Available options:

en-US,

en-GB,

es-MX,

es-ES,

es-CO,

pt-PT,

de-DE,

fr-FR,

pl-PL,

ro-RO,

it-IT,

zh-CN,

hi-IN,

ja-JP,

sv-SE

use_case.detailed_work_hours

object

Detailed work hours for each day of the week.

use_case.work_start

string

Start of the work hours.

use_case.work_end

string

End of the work hours.

use_case.timezone

string

Timezone of the use case.

use_case.generic_after_hours_message

string

Generic message to play if the call is after hours.

use_case.enable_detailed_work_hours

boolean

Enable detailed work hours in the UI.

use_case.keywords

string[]

Keywords you want the transcriber to know about.

use_case.hooks

object[] | null

Webhooks to call when the use case is executed.

use_case.params

object

Parameters to pass to the use case.

use_case.amd

boolean

Enable automatic machine detection. This is a prerequisite to end calls on machines or for Phone Tree Navigation.

use_case.amd_behavior

enum<string>

AI assistant behavior when AMD is enabled. Continue is used for Phone Tree Navigation, Hangup to end the call and Message to leave a message. If amd is set, this field is required.

Available options:

Hangup,

Continue,

Message

use_case.amd_messages

object

Record of messages to leave on voicemail if amd_behavior is set to Message. You may use parameters as you do in the prompt for templating. The key is the language of the message and the value is the message.

use_case.sample_labels

object[]

Available labels for the samples.

use_case.hidden

boolean

Hide the use case from the UI.

use_case.evaluation_models

string[]

Models the use case is evaluated on.

use_case.max_duration_mins

integer

Specifies the maximum duration in minutes for this use-case. This value is overridden by the maximum duration specified for individual calls. If neither is provided, the default duration is 10 minutes.

use_case.recorded_message_inbound

boolean

Play 'This call is being recorded' message for inbound calls.

use_case.recorded_message_outbound

boolean

Play 'This call is being recorded' message for outbound calls.

use_case.show_original_caller_id

boolean

Show the original caller ID on the call screen.

use_case.disable_end_call_after_n_reminders

boolean

Disable end call after N reminders.

created

string

required

Date the call was created.

Example:

"2024-01-01T01:01:01Z"

params

object

Dynamic parameters to inject into the templated use case prompt.

Was this page helpful?

Get Calls

curl --request POST \
  --url https://app.happyrobot.ai/api/v1/dial/outbound \
  --header 'Content-Type: application/json' \
  --header 'authorization: <authorization>' \
  --data '{
  "assistant_id": "<string>",
  "voice_id": "<string>",
  "model": "Fast",
  "number_id": "<string>",
  "prompt_id": "<string>",
  "use_case_id": "<string>",
  "agent_id": "<string>",
  "model_id": "<string>",
  "phone_number": "+1234567890",
  "language": "en-US",
  "params": "<any>",
  "metadata": {},
  "campaign_id": "<string>",
  "scheduled_for": "2024-01-01T01:01:01Z",
  "max_duration_mins": 123
}'

{
  "id": "<string>",
  "organization_id": "<string>",
  "metadata": {
    "call_sid": "<string>",
    "from": "+1234567890",
    "to": "+1234567890",
    "recording_sid": "<string>",
    "tags": [
      "<string>"
    ],
    "custom": {
      "clientId": "123",
      "orderId": "456"
    }
  },
  "use_case": {
    "id": "<string>",
    "organization_id": "<string>",
    "name": "Kate",
    "transfer_number": "<string>",
    "extract_with_ai": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "string",
        "example": "<string>",
        "required": true
      }
    ],
    "classification_tags": [
      {
        "name": "<string>",
        "description": "<string>"
      }
    ],
    "language": "en-US",
    "detailed_work_hours": {},
    "work_start": "<string>",
    "work_end": "<string>",
    "timezone": "<string>",
    "generic_after_hours_message": "<string>",
    "enable_detailed_work_hours": true,
    "keywords": [
      "<string>"
    ],
    "hooks": [
      {
        "url": "<string>",
        "headers": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ]
      }
    ],
    "params": {},
    "amd": true,
    "amd_behavior": "Hangup",
    "amd_messages": {},
    "sample_labels": [
      {
        "name": "<string>",
        "color": "slate"
      }
    ],
    "hidden": true,
    "evaluation_models": [
      "<string>"
    ],
    "max_duration_mins": 123,
    "recorded_message_inbound": true,
    "recorded_message_outbound": true,
    "show_original_caller_id": true,
    "disable_end_call_after_n_reminders": true,
    "model": "<string>"
  },
  "params": {},
  "created": "2024-01-01T01:01:01Z"
}

Basic

Calls

Tools

Dial

Orgs

Numbers

Voices

Models

Usecases

Agents

Analytics

Create Outbound Call

Headers

Body

Response