- Dashboard
- Community
- GETReturn the logs for a call
- PATCHSet call as viewed by the user making the request
- GETGets an organization's usage
- GETList Call tags
- PATCHUpdate a note on a call
- GETGet Call
- POSTAdd a note to a call
- GETList Calls
- GETGet Transcript
- PATCHSet call rating
- GETGet Calls
- POSTStop Call
- DELDelete a call
- GETReturn a pre-signed URL to the call recording
- DELDelete a note from a call
- POSTCreate Assistant
- PATCHUpdate Assistant
- DELDelete Assistant
- GETList Assistants
- GETGet Assistant
- PATCHUpdate an existing tool
- GETReturns a list of tools for a use case id
- DELDelete a tool
- POSTCreate a new tool
- GETReturns a list of tools for a use case id
- GETReturns a list of tools for a use case id
- GETGet Campaigns
- POSTCreate batched Outbound Calls
- POSTCreate Outbound Call
- POSTCreate Outbound Call
- GETGet all users for an organization
- POSTCreate a new member for an organization
- GETGet an organization
- DELDelete a member from an organization
- PATCHUpdate a user
- PATCHUpdate an organization
- DELDelete a list of numbers
- GETReturns a list of phone numbers
- DELDelete a phone number
- PATCHUpdate a phone number routes
- POSTBuy a new phone number
- GETReturns a single number
- POSTCreate a new hook
- PATCHUpdate an existing hook
- GETReturns a list of hooks for an assistant id
- DELDelete a hook
- DELDelete a message
- GETReturns a list of samples for an assistant id
- POSTGenerate a list of samples in jsonl format
- GETReturns a sample by id
- POSTAdd a new message
- DELDelete a list of samples
- PATCHUpdate an existing example
- PATCHUpdate an existing message
- POSTCreate a new sample
- POSTDownload a backup of a list of samples
- GETGet Use Case
- POSTCreate a Use Case
- DELDelete Use Case
- GETList Use Cases
- PATCHUpdate Use Case
- POSTCreate a label for Use Case
- DELDelete Use Case's label
- POSTCreate a new agent
- GETReturns a list of agents
- DELDelete an agent
- GETReturns a single agent
- PATCHUpdate an existing agent
- GETReturn the logs for a call
- PATCHSet call as viewed by the user making the request
- GETGets an organization's usage
- GETList Call tags
- PATCHUpdate a note on a call
- GETGet Call
- POSTAdd a note to a call
- POSTCancel Call
- GETGet Transcript
- PATCHSet call rating
- GETList Calls
- POSTStop Call
- DELDelete a call
- GETReturn a pre-signed URL to the call recording
- DELDelete a note from a call
Calls
Assistants
Tools
Dial
Orgs
Numbers
Hooks
Samples
Usecases
Agents
Analytics
Create batched Outbound Calls
Create multiple outbound calls at once and have AI answers questions for you.
Your API key for authentication. Use Bearer format.
Array of outbound calls to create.
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>",
"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
Your API key for authentication. Use Bearer format.
Body
DEPRECATED: Use the use_case_id instead.
DEPRECATED: ID of the voice that the agent will use.
DEPRECATED: Model to use for the call
ID of the phone number that should trigger the call.
ID of the use case that should handle the call.
ID of the agent that should handle the call.
ID of the model that should handle the call.
Phone number to call.
Language of the call. It will default to use case's default language.
en-US
, es-MX
, es-ES
, in-IN
Dynamic parameters to inject into the templated use case prompt.
Custom metadata associated with the call.
ID of the campaign that triggered the call.
UTC datetime to schedule the call.
Response
Unique identifier for the call.
Organization ID.
Call metadata.
Call SID from the provider.
Phone number that initiated the call.
Phone number that received the call.
Recording SID from the provider.
Tags associated with the call.
Custom metadata associated with the call.
Use case that handled the call.
ID of the use case.
ID of the organization that owns the use case.
Name of the use case.
Fallback phone number to transfer the call to if something breaks.
Parameters to extract with AI.
string
, number
, boolean
, array
Classification tags for the use case.
Name of the classification tag.
Description of the classification tag.
Preferred language for the use case.
en-US
, es-MX
, es-ES
, in-IN
Start of the work hours.
End of the work hours.
Timezone of the use case.
Keywords you want the transcriber to know about.
Webhook to call when the use case is executed.
URL of the webhook.
Headers of the webhook.
Key of the header.
Value of the header.
Parameters to pass to the use case.
Enable automatic machine detection. This is a prerequisite to end calls on machines or for Phone Tree Navigation.
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.
Hangup
, Continue
, Message
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.
Available labels for the samples.
Name of the label.
Color of the label.
slate
, gray
, zinc
, neutral
, stone
, red
, orange
, amber
, yellow
, lime
, green
, teal
, cyan
, sky
, blue
, indigo
, violet
, purple
, fuchsia
, pink
, rose
Hide the use case from the UI.
Models the use case is evaluated on.
Model name.
Dynamic parameters to inject into the templated use case prompt.
Date the call was created.
Was this page helpful?
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>",
"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"
}
]