Skip to main content
GET
/
batch_dial_jobs
/
{id}
/
dials
List Batch Dials
curl --request GET \
  --url https://api.vogent.ai/api/batch_dial_jobs/{id}/dials \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "toNumber": "<string>",
      "agent": {
        "id": "<string>",
        "name": "<string>",
        "transcriberParams": {
          "type": "deepgram",
          "keywords": [
            "<string>"
          ]
        },
        "metadata": {},
        "utteranceDetectorConfig": {
          "sensitivity": "ULTRA_FAST"
        },
        "endpointDetectorConfig": {
          "type": "SIMPLE",
          "mode": "CONSERVATIVE"
        },
        "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>"
              ]
            }
          }
        ],
        "fillEmptyStringVariables": true
      },
      "recordings": [
        {
          "url": "<string>"
        }
      ],
      "transcript": [
        {
          "text": "<string>",
          "speaker": "<string>",
          "detailType": "<string>",
          "functionCallId": "<string>",
          "startTimeMs": 123,
          "endTimeMs": 123,
          "functionCalls": [
            {
              "functionCallId": "<string>",
              "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",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "systemResultType": "BUSY",
      "voiceId": "<string>",
      "versionedPromptId": "<string>"
    }
  ],
  "cursor": "<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 batch dial job.

Query Parameters

limit
integer

The number of dials to return.

cursor
string

The cursor for pagination.

Response

Successful operation

data
object[]
required
cursor
string | null
required