POST
/
dial
/
outbound-batched
curl --request POST \
  --url https://app.happyrobot.ai/api/v1/dial/outbound-batched \
  --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 · object[]

Body

Array of outbound calls to create.

Response

200
application/json

200

Array of outbound calls created.