- 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
List Calls
Returns a list of calls.
Your API key for authentication. Use Bearer format.
Filter by call type
Limit the number of calls returned
Skip the first N calls
Calculate current page if callId is provided
Filter by call statuses, comma separated
Filter by tags, comma separated
Filter by models names, comma separated
Filter by ratings, comma separated
Filter by use case ids, comma separated
Filter by start date
Filter by end date
Search by extraction or phone number
Filter by campaign ids, comma separated
curl --request GET \
--url https://app.happyrobot.ai/api/v1/calls \
--header 'authorization: <authorization>'{
"calls": [
{
"id": "<string>",
"organization_id": "<string>",
"type": "Inbound",
"status": "Scheduled",
"provider": "Twilio",
"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>"
},
"agent": {
"id": "<string>",
"name": "<string>"
},
"language": "en-US",
"params": {},
"extraction": {},
"classification": {
"tag": "<string>",
"reasoning": "<string>"
},
"created": "2024-01-01T01:01:01Z",
"duration": 123,
"viewed_by": [
"<string>"
],
"notes": [
{
"id": "<string>",
"user_id": "<string>",
"content": "<string>",
"flagged": true,
"created_at": "2024-01-01T01:01:01Z"
}
],
"samples": [
"<string>"
],
"ratings": [
{
"emoji": "✅",
"email": "jsmith@example.com",
"created": "2024-01-01T01:01:01Z"
}
],
"scheduled_for": "<string>",
"campaign_id": "<string>"
}
],
"count": 12993,
"currentPage": 3
}Headers
Your API key for authentication. Use Bearer format.
Query Parameters
Filter by call type
Inbound, Outbound Limit the number of calls returned
Skip the first N calls
Calculate current page if callId is provided
Filter by call statuses, comma separated
Filter by tags, comma separated
Filter by models names, comma separated
Filter by ratings, comma separated
Filter by use case ids, comma separated
Filter by start date
Filter by end date
Search by extraction or phone number
Filter by campaign ids, comma separated
Response
Unique identifier for the call.
Organization ID.
Type of the call.
Inbound, Outbound Status of the call.
Scheduled, Queued, Initiated, Ringing, In progress, Transferred, Completed, AMD Terminated, Busy, No answer, Canceled, Failed Provider of the call.
Twilio, Web, Chat 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.
Agent that handled the call.
Agent ID.
Agent name.
Language of the call.
en-US, es-MX, es-ES, in-IN Dynamic parameters to inject into the templated use case prompt.
AI extracted data from the call.
Tag classification of the call.
Tag classification. These tags are defined at the Use Case level.
Reasoning for the classification.
Date the call was created.
Duration of the call in seconds.
User emails that have viewed the call in the Happyrobot App.
Notes associated with the call.
Unique identifier for the note.
User ID that created the note.
Content of the note.
Whether the note is flaged or not.
Date the note was created.
Sample IDs that are associated with the call.
Ratings emojis associated with the call.
Emoji rating.
✅, 👎, 🚨 The users's email.
Date the rating was created.
UTC datetime the call is scheduled for.
Campaign ID.
Total number of calls
Current page number
Was this page helpful?
curl --request GET \
--url https://app.happyrobot.ai/api/v1/calls \
--header 'authorization: <authorization>'{
"calls": [
{
"id": "<string>",
"organization_id": "<string>",
"type": "Inbound",
"status": "Scheduled",
"provider": "Twilio",
"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>"
},
"agent": {
"id": "<string>",
"name": "<string>"
},
"language": "en-US",
"params": {},
"extraction": {},
"classification": {
"tag": "<string>",
"reasoning": "<string>"
},
"created": "2024-01-01T01:01:01Z",
"duration": 123,
"viewed_by": [
"<string>"
],
"notes": [
{
"id": "<string>",
"user_id": "<string>",
"content": "<string>",
"flagged": true,
"created_at": "2024-01-01T01:01:01Z"
}
],
"samples": [
"<string>"
],
"ratings": [
{
"emoji": "✅",
"email": "jsmith@example.com",
"created": "2024-01-01T01:01:01Z"
}
],
"scheduled_for": "<string>",
"campaign_id": "<string>"
}
],
"count": 12993,
"currentPage": 3
}