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"
},
"idleMessageConfig": {
"enabled": true,
"messages": [
"<string>"
],
"idleDurationMilliseconds": 5001,
"maxIdleMessages": 2
},
"language": "<string>",
"maxDurationSeconds": 10800,
"defaultVoiceId": "<string>",
"defaultVersionedPromptId": "<string>",
"defaultExtractorId": "<string>",
"linkedFunctionDefinitions": [
{
"functionDefinitionId": "<string>",
"lifecycleMessagesOverride": {
"started": [
"<string>"
]
}
}
]
},
"recordings": [
{
"url": "<string>"
}
],
"transcript": [
{
"text": "<string>",
"speaker": "<string>",
"detailType": "<string>",
"startTimeMs": 123,
"endTimeMs": 123,
"functionCalls": [
{
"name": "<string>",
"args": "<string>"
}
],
"nodeTransition": {
"toNodeId": "<string>",
"transitionData": {}
}
}
],
"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 response is of type object
.
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"
},
"idleMessageConfig": {
"enabled": true,
"messages": [
"<string>"
],
"idleDurationMilliseconds": 5001,
"maxIdleMessages": 2
},
"language": "<string>",
"maxDurationSeconds": 10800,
"defaultVoiceId": "<string>",
"defaultVersionedPromptId": "<string>",
"defaultExtractorId": "<string>",
"linkedFunctionDefinitions": [
{
"functionDefinitionId": "<string>",
"lifecycleMessagesOverride": {
"started": [
"<string>"
]
}
}
]
},
"recordings": [
{
"url": "<string>"
}
],
"transcript": [
{
"text": "<string>",
"speaker": "<string>",
"detailType": "<string>",
"startTimeMs": 123,
"endTimeMs": 123,
"functionCalls": [
{
"name": "<string>",
"args": "<string>"
}
],
"nodeTransition": {
"toNodeId": "<string>",
"transitionData": {}
}
}
],
"durationSeconds": 123,
"aiResult": {},
"inputs": {},
"status": "<string>",
"dialTaskId": "<string>",
"fromNumberId": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z"
}
Assistant
Responses are generated using AI and may contain mistakes.