Skip to main content
GET
/
dials
/
{id}
Get 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": "<string>",
      "keywords": [
        "<string>"
      ]
    },
    "metadata": {},
    "utteranceDetectorConfig": {
      "interruptionPlayTimeMs": 123
    },
    "endpointDetectorConfig": {},
    "ivrConfiguration": {
      "versionedPromptId": "<string>",
      "aiVoiceId": "<string>",
      "taggingText": "<string>"
    },
    "idleMessageConfig": {
      "enabled": true,
      "messages": [
        "<string>"
      ],
      "idleDurationMilliseconds": 5001,
      "maxIdleMessages": 2
    },
    "maxDurationSeconds": 10800,
    "timeoutMessage": "<string>",
    "timeoutBehaviorConfiguration": {
      "transferNumber": "<string>"
    },
    "defaultVoiceId": "<string>",
    "defaultVersionedPromptId": "<string>",
    "defaultExtractorId": "<string>",
    "linkedFunctionDefinitions": [
      {
        "functionDefinitionId": "<string>",
        "lifecycleMessagesOverride": {
          "started": [
            "<string>"
          ]
        }
      }
    ],
    "fillEmptyStringVariables": true,
    "silenceHangupConfiguration": {
      "silenceDurationSeconds": 123
    },
    "ivrSilenceHangupConfiguration": {
      "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,
  "aiDurationSeconds": 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",
  "voiceId": "<string>",
  "versionedPromptId": "<string>"
}

Authorizations

​
Authorization
string
header
required

In the form Bearer <api_key_here>. You can find your api key in your dashboard.

Path Parameters

​
id
string
required

ID of the dial.

Response

Successful operation

​
id
string
required
​
toNumber
string
​
agent
object
​
recordings
object[]
​
transcript
object[]
​
durationSeconds
integer

The total duration of the call, including all telephony time (if the call was transferred, this will include the transfer time)

​
aiDurationSeconds
integer

The total duration of the call during which the AI was involved. Does not include transfer time.

​
aiResult
object
​
inputs
object
​
status
string
​
dialTaskId
string
​
fromNumberId
string
​
startedAt
string<date-time>
​
endedAt
string<date-time>
​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
systemResultType
enum<string> | null

The type of system result for this dial, if applicable.

Available options:
BUSY,
FAILED,
NO_ANSWER,
CANCELLED,
USER_HANGUP,
COUNTERPARTY_HANGUP,
TIMEOUT,
RATE_LIMITED,
TRANSFERRED,
AGENT_HANGUP,
VOICEMAIL_DETECTED_HANGUP,
LONG_SILENCE_HANGUP
​
voiceId
string
​
versionedPromptId
string