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>",
  "number_id": "<string>",
  "phone_number": "+1234567890",
  "model": "Fast",
  "params": "<any>",
  "questions": [
    "What is the location of the driver?"
  ]
}'
{
  "id": "<string>",
  "organization_id": "<string>",
  "type": "Inbound",
  "status": "Dialing",
  "provider": "Twilio",
  "metadata": {
    "call_sid": "<string>",
    "aux_sid": "<string>",
    "from": "<string>",
    "to": "<string>",
    "recording_sid": "<string>",
    "pipeline_id": "<string>",
    "tags": [
      "<string>"
    ]
  },
  "assistant": {
    "id": "<string>",
    "name": "<string>",
    "model": "<string>"
  },
  "hooks": [
    "<string>"
  ],
  "params": {},
  "questions": [
    {
      "question": "<string>",
      "answer": "<string>"
    }
  ],
  "created": "<string>",
  "started": "<string>",
  "duration": 123,
  "viewed_by": [
    "<string>"
  ],
  "samples": [
    "<string>"
  ]
}

Headers

​
authorization
string
required

Your API key for authentication. Use Bearer format.

Body

application/json
Body
​
assistant_id
string
required

ID of the assistant that should handle the call.

​
number_id
string
required

ID of the phone number that should trigger the call.

​
phone_number
string
required

Phone number to call.

Example:

"+1234567890"

​
model
string
required

Model to use for the call. Out of the box supported models are:

  • Fast: Our turbo model.
  • Balanced: The ideal model is you want to sacrifice a bit of speed for robustness.
  • Robust: Our smartest and robust model.
Example:

"Fast"

​
params
any | null

Dynamic parameters to inject into the templated assistant prompt.

​
questions
string[]

Questions that the AI assistant will try to answer once the call has finished.

Example:
["What is the location of the driver?"]

Response

200
application/json
200
​
id
string
required

Unique identifier for the call.

​
organization_id
string
required

Organization ID.

​
type
enum<string>
required

Type of the call.

Available options:
Inbound,
Outbound
​
status
enum<string>
required

Status of the call.

Available options:
Dialing,
Connected,
Ended,
Completed,
Missed,
Abandoned,
Failed
​
provider
enum<string>
required

Provider of the call.

Available options:
Twilio,
Web,
Chat
​
metadata
object
required

Call metadata.

​
assistant
object
required

Assistant that handled the call.

​
hooks
string[]
required

Hooks to be executed after the call ends.

​
params
object
required

Dynamic parameters to inject into the templated assistant prompt.

​
created
string
required

Date the call was created.

​
viewed_by
string[]
required

User emails that have viewed the call in the Happyrobot App.

​
samples
string[]
required

Sample IDs that are associated with the call.

​
questions
object[]

Questions that the AI assistant will try to answer once the call has finished.

​
started
string

Date the call was connected with the assistant.

​
duration
number

Duration of the call in seconds.

Was this page helpful?

Get Calls