Calls
- GETGet Calls
- GETGet Call
- GETGet Transcript
- GETGet current page
- GETList Call tags
- GETReturn a pre-signed URL to the call recording
- GETReturn the logs for a call
- GETGets an organization's usage
- POSTStop Call
- POSTCancel Call
- POSTAdd a note to a call
- POSTTrigger async export of calls CSV to requester email
- PATCHUpdate a note on a call
- PATCHSet call as viewed by the user making the request
- PATCHSet call rating
- DELDelete a note from a call
- DELDelete a call
Dial
Orgs
Numbers
Usecases
Agents
Get Calls
Returns a list of calls.
curl --request GET \
--url https://app.happyrobot.ai/api/v1/calls \
--header 'authorization: <authorization>'
{
"calls": [
{
"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>"
]
}
],
"count": 12993,
"currentPage": 3
}
Headers
Your API key for authentication. Use Bearer format.
Query Parameters
Filter by call type
Inbound
, Outbound
"Inbound"
Limit the number of calls returned
Skip the first N calls
Filter by text in the call
Filter by date
Calculate current page if callId is provided
Response
Unique identifier for the call.
Organization ID.
Type of the call.
Inbound
, Outbound
Status of the call.
Dialing
, Connected
, Ended
, Completed
, Missed
, Abandoned
, Failed
Provider of the call.
Twilio
, Web
, Chat
Call metadata.
Tags associated with the call.
Call SID from the provider.
Auxiliary SID from the provider.
Phone number that initiated the call.
Phone number that received the call.
Recording SID from the provider.
ID of the pipeline that created the call.
Hooks to be executed after the call ends.
Dynamic parameters to inject into the templated assistant prompt.
Date the call was created.
User emails that have viewed the call in the Happyrobot App.
Sample IDs that are associated with the call.
Date the call was connected with the assistant.
Duration of the call in seconds.
Total number of calls
12993
Current page number
3
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": "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>"
]
}
],
"count": 12993,
"currentPage": 3
}