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>",
  "use_case_id": "<string>",
  "agent_id": "<string>",
  "model_id": "<string>",
  "phone_number": "+1234567890",
  "language": "en-US",
  "params": "<any>",
  "metadata": {},
  "campaign_id": "<string>",
  "scheduled_for": "<string>"
}'
{
  "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",
    "work_start": "<string>",
    "work_end": "<string>",
    "timezone": "<string>",
    "keywords": [
      "<string>"
    ],
    "hook": {
      "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>"
    ],
    "model": "<string>"
  },
  "params": {},
  "created": "2024-01-01T01:01:01Z"
}

Headers

authorization
string
required

Your API key for authentication. Use Bearer format.

Body

application/json
assistant_id
string

DEPRECATED: Use the use_case_id instead.

voice_id
string
default: 661ca46d4cea0f21e12c850f

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

model
string

DEPRECATED: Model to use for the call

number_id
string
required

ID of the phone number that should trigger the call.

use_case_id
string

ID of the use case that should handle the call.

agent_id
string

ID of the agent that should handle the call.

model_id
string

ID of the model that should handle the call.

phone_number
string
required

Phone number to call.

language
enum<string>

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

Available options:
en-US,
es-MX,
es-ES,
in-IN
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

UTC datetime to schedule the call.

Response

200 - application/json
id
string
required

Unique identifier for the call.

organization_id
string
required

Organization ID.

metadata
object
required

Call metadata.

use_case
object
required

Use case that handled the call.

params
object

Dynamic parameters to inject into the templated use case prompt.

created
string
required

Date the call was created.

Was this page helpful?

Return the logs for a call