API Documentation
Versioned Prompts
Phone Numbers
Models
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"
},
"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
},
"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>"
}Get Dial
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"
},
"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
},
"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>"
}Authorizations
In the form Bearer <api_key_here>. You can find your api key in your dashboard.
Path Parameters
ID of the dial.
Response
Successful operation
Show child attributes
Show child attributes
The language to use for the agent.
Configuration for endpoint detection to determine when a user has finished speaking.
Show child attributes
Show child attributes
The type of endpoint detector to use.
SIMPLE, SEMANTIC The mode for the endpoint detector (only applicable for SEMANTIC type).
CONSERVATIVE, DEFAULT, AGGRESSIVE The configuration for IVR detection and navigation including detection type, prompt, voice, and tagging settings.
Show child attributes
Show child attributes
The type of IVR detection to use.
NONE, STANDARD The versioned prompt ID to use for IVR detection.
The AI voice ID to use for IVR detection.
The tagging text for IVR detection.
Configuration for idle messages that the agent can say when the user is silent.
Show child attributes
Show child attributes
Whether idle messages are enabled for this agent.
The list of idle messages that the agent can say when the user is silent.
The duration in milliseconds that the user must be silent before an idle message is triggered.
x >= 5000The maximum number of idle messages that can be said during a call.
x >= 1The maximum duration of the call in seconds.
The default voice ID to use for the agent.
The default versioned prompt ID to use for the agent.
The default extractor ID to use for the agent.
The function definitions that should be available to this agent.
Show child attributes
Show child attributes
The ID of the function definition to link.
Lifecycle messages to override the defaults for this function link, or null to not override.
Show child attributes
Show child attributes
Messages to display when the function starts executing. One will be chosen at random.
If true, variables that are not specified will be filled with empty strings instead of being left as template placeholders.
Show child attributes
Show child attributes
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.
The function call ID if this is a tool call result.
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