curl --request GET \
--url https://api.vogent.ai/api/dials/{id} \
--header 'Authorization: Bearer <token>'{
"id": "<string>",
"toNumber": "<string>",
"agent": {
"id": "<string>",
"name": "<string>",
"language": "<string>",
"transcriberParams": {
"type": "deepgram",
"keywords": [
"<string>"
]
},
"metadata": {},
"utteranceDetectorConfig": {
"sensitivity": "ULTRA_FAST",
"interruptionPlayTimeMs": 123
},
"endpointDetectorConfig": {
"type": "SIMPLE",
"mode": "CONSERVATIVE"
},
"ivrConfiguration": {
"detectionType": "NONE",
"versionedPromptId": "<string>",
"aiVoiceId": "<string>",
"taggingText": "<string>"
},
"idleMessageConfig": {
"enabled": true,
"messages": [
"<string>"
],
"idleDurationMilliseconds": 5001,
"maxIdleMessages": 2
},
"maxDurationSeconds": 10800,
"defaultVoiceId": "<string>",
"defaultVersionedPromptId": "<string>",
"defaultExtractorId": "<string>",
"linkedFunctionDefinitions": [
{
"functionDefinitionId": "<string>",
"lifecycleMessagesOverride": {
"started": [
"<string>"
]
}
}
],
"fillEmptyStringVariables": true,
"silenceHangupConfiguration": {
"type": "DISABLED",
"silenceDurationSeconds": 123
},
"voiceOptionValues": [
{
"optionId": "<string>",
"value": "<string>"
}
]
},
"recordings": [
{
"url": "<string>"
}
],
"transcript": [
{
"text": "<string>",
"speaker": "<string>",
"detailType": "<string>",
"functionCallId": "<string>",
"startTimeMs": 123,
"endTimeMs": 123,
"functionCalls": [
{
"name": "<string>",
"args": "<string>",
"functionCallId": "<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",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"systemResultType": "BUSY",
"voiceId": "<string>",
"versionedPromptId": "<string>"
}Gets the details of a dial.
curl --request GET \
--url https://api.vogent.ai/api/dials/{id} \
--header 'Authorization: Bearer <token>'{
"id": "<string>",
"toNumber": "<string>",
"agent": {
"id": "<string>",
"name": "<string>",
"language": "<string>",
"transcriberParams": {
"type": "deepgram",
"keywords": [
"<string>"
]
},
"metadata": {},
"utteranceDetectorConfig": {
"sensitivity": "ULTRA_FAST",
"interruptionPlayTimeMs": 123
},
"endpointDetectorConfig": {
"type": "SIMPLE",
"mode": "CONSERVATIVE"
},
"ivrConfiguration": {
"detectionType": "NONE",
"versionedPromptId": "<string>",
"aiVoiceId": "<string>",
"taggingText": "<string>"
},
"idleMessageConfig": {
"enabled": true,
"messages": [
"<string>"
],
"idleDurationMilliseconds": 5001,
"maxIdleMessages": 2
},
"maxDurationSeconds": 10800,
"defaultVoiceId": "<string>",
"defaultVersionedPromptId": "<string>",
"defaultExtractorId": "<string>",
"linkedFunctionDefinitions": [
{
"functionDefinitionId": "<string>",
"lifecycleMessagesOverride": {
"started": [
"<string>"
]
}
}
],
"fillEmptyStringVariables": true,
"silenceHangupConfiguration": {
"type": "DISABLED",
"silenceDurationSeconds": 123
},
"voiceOptionValues": [
{
"optionId": "<string>",
"value": "<string>"
}
]
},
"recordings": [
{
"url": "<string>"
}
],
"transcript": [
{
"text": "<string>",
"speaker": "<string>",
"detailType": "<string>",
"functionCallId": "<string>",
"startTimeMs": 123,
"endTimeMs": 123,
"functionCalls": [
{
"name": "<string>",
"args": "<string>",
"functionCallId": "<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",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"systemResultType": "BUSY",
"voiceId": "<string>",
"versionedPromptId": "<string>"
}In the form Bearer <api_key_here>. You can find your api key in your dashboard.
ID of the dial.
Successful operation
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The type of system result for this dial, if applicable.
BUSY, FAILED, NO_ANSWER, CANCELLED, USER_HANGUP, COUNTERPARTY_HANGUP, TIMEOUT, RATE_LIMITED, TRANSFERRED, AGENT_HANGUP, VOICEMAIL_DETECTED_HANGUP, LONG_SILENCE_HANGUP