Dials
Get Dial
API Documentation
Versioned Prompts
Phone Numbers
Models
Dials
Get Dial
Gets the details of a dial.
GET
/
dials
/
{id}
curl --request GET \
--url https://api.vogent.ai/api/dials/{id}
{
"id": "<string>",
"toNumber": "<string>",
"agent": {
"id": "<string>",
"name": "<string>",
"transcriberParams": {
"type": "deepgram",
"keywords": [
"<string>"
]
},
"metadata": {},
"utteranceDetectorConfig": {
"sensitivity": "ULTRA_FAST"
},
"language": "<string>"
},
"recordings": [
{
"url": "<string>"
}
],
"transcript": [
{
"text": "<string>",
"speaker": "<string>",
"detailType": "<string>"
}
],
"durationSeconds": 123,
"aiResult": {},
"inputs": {},
"status": "<string>",
"dialTaskId": "<string>",
"fromNumberId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z"
}
Path Parameters
ID of the dial.
Response
200
application/json
Successful operation
The language to use for the agent.
A URL that can be used to download the recording of the call. Be sure to include an API key in the header to access the recording.
Either HUMAN
or AI
, indicating the speaker type. If this is a function call result the speaker will be AI
, while the detailType
will be function
.
Will be function
if this is a function result, otherwise null
.
curl --request GET \
--url https://api.vogent.ai/api/dials/{id}
{
"id": "<string>",
"toNumber": "<string>",
"agent": {
"id": "<string>",
"name": "<string>",
"transcriberParams": {
"type": "deepgram",
"keywords": [
"<string>"
]
},
"metadata": {},
"utteranceDetectorConfig": {
"sensitivity": "ULTRA_FAST"
},
"language": "<string>"
},
"recordings": [
{
"url": "<string>"
}
],
"transcript": [
{
"text": "<string>",
"speaker": "<string>",
"detailType": "<string>"
}
],
"durationSeconds": 123,
"aiResult": {},
"inputs": {},
"status": "<string>",
"dialTaskId": "<string>",
"fromNumberId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z"
}