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.
Your API key for authentication. Use Bearer format.
Filter by call type
Limit the number of calls returned
Skip the first N calls
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
Sort direction
Search by extraction or phone number
Filter by campaign ids, comma separated
Filter by transfer contact email
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
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
Sort direction
asc, desc Search by extraction or phone number
Filter by campaign ids, comma separated
Filter by transfer contact email
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.
Use case that handled the call.
ID of the use case.
ID of the organization that owns the use case.
Model name.
Name of the use case.
Fallback phone number to transfer the call to if something breaks.
Parameters to extract with AI.
2 - 5510 - 2000string, number, boolean, array Preferred language for the use case.
en-US, en-GB, es-MX, es-ES, pt-PT, de-DE, fr-FR, pl-PL, ro-RO, it-IT Detailed work hours for each day of the week.
Start of the work hours.
End of the work hours.
Bypass happyrobot and transfer calls directly to the transfer number.
Phone number to transfer the call to if bypass is true.
Message to play if the call is after hours.
Start of the work hours.
End of the work hours.
Timezone of the use case.
Generic message to play if the call is after hours.
Enable detailed work hours in the UI.
Keywords you want the transcriber to know about.
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.
Message to leave on voicemail if amd_behavior is set to Message. You may use parameters as you do in the prompt for templating.
1Available labels for the samples.
Name of the label.
1Color 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.
Specifies the maximum duration in minutes for this use-case. This value is overridden by the maximum duration specified for individual calls. If neither is provided, the default duration is 10 minutes.
Play 'This call is being recorded' message for inbound calls.
Play 'This call is being recorded' message for outbound calls.
Show the original caller ID on the call screen.
Prompt ID.
Language of the call.
en-US, en-GB, es-MX, es-ES, pt-PT, de-DE, fr-FR, pl-PL, ro-RO, it-IT Dynamic parameters to inject into the templated use case prompt.
Date the call was created.
Duration of the call in seconds.
User emails that have viewed the call in the Happyrobot App.
Parent call ID in the case of repeated calls.
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.
ISO 8601 UTC datetime the call is scheduled for.
Whether the backup model was used.
Whether the call should wait until the model is awake.
Campaign ID.
Specifies the maximum duration of the call in minutes. This value takes precedence over the maximum duration specified in the use-case. If neither is provided, the default duration is 10 minutes.
Email of the transfer contact.
Costs associated with the call.
Total number of calls
Limit of calls returned, defined by limit query parameter
0 < x < 2000Offset of the first call in the list, determined by skip query parameter
Was this page helpful?