POST
/
dials
Create a new dial
curl --request POST \
  --url https://api.vogent.ai/api/dials \
  --header 'Content-Type: application/json' \
  --data '{
  "webhookUrl": "https://test.com/webhook",
  "browserCall": false,
  "toNumber": "+11234567890",
  "fromNumberId": "1caec78c-4bba-477d-82cf-bcfce2b73856",
  "aiVoiceId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
  "voiceOptionValues": [
    {
      "optionId": "<string>",
      "value": "<string>"
    }
  ],
  "voiceVolumeLevel": -100,
  "callAgentId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
  "versionedModelId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
  "timeoutMinutes": 10,
  "callAgentExtractorId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
  "callAgentInput": {},
  "keywords": [
    "<string>"
  ]
}'
{
  "dialToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZXN0IjoidGVzdCJ9.9EQaLsDRKDVXLUVLR9JgDTjEULaT2-OMbHayQAzgZH8",
  "sessionId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
  "dialId": "57555c5e-5a56-49ca-8fe8-24946d2fbc3e"
}

Body

application/json

Create a new dial

​
callAgentId
string
required

Required. The ID of the agent.

Example:

"61ccefdf-ea02-4f49-811b-1241f8e20d26"

​
webhookUrl
string | null

Optional. The URL for the webhook for this dial session.

Example:

"https://test.com/webhook"

​
browserCall
boolean | null

Set to true if this is a browser call.

Example:

false

​
toNumber
string | null

Required if this is a phone dial, in E.164 format.

Example:

"+11234567890"

​
fromNumberId
string | null

The ID for the phone number to use to start the call. Required if this is a phone dial.

Example:

"1caec78c-4bba-477d-82cf-bcfce2b73856"

​
aiVoiceId
string | null

The ID for the voice on the call. If not specified, the default voice for the agent will be used.

Example:

"61ccefdf-ea02-4f49-811b-1241f8e20d26"

​
voiceOptionValues
object[]

An optional configuration for the voice being used.

​
voiceVolumeLevel
integer

The volume level for the voice on the call, from -300 (quiet) to 300 (loud).

Example:

-100

​
versionedModelId
string

The prompt/model version to use for this call, if not specified, the default on the agent is used.

Example:

"61ccefdf-ea02-4f49-811b-1241f8e20d26"

​
timeoutMinutes
integer

The number of minutes before the call will be timed out. If not specified, there will be no limit on the calls, it's recommended to provide something here.

Example:

10

​
callAgentExtractorId
string

The ID of the extractor to use for this call, if not specified, the default on the agent is used.

Example:

"61ccefdf-ea02-4f49-811b-1241f8e20d26"

​
callAgentInput
object | null

Any macros in the call agent prompt.

​
keywords
string[] | null

A list of keywords to be used in the call.

Response

Successful operation

​
dialToken
string
required

You can pass this dial token to Elto's web UI, or use this token to authorize any requests for this dial. It's safe to pass this token to a client -- it only allows users to run requests against the dial associated with this session.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZXN0IjoidGVzdCJ9.9EQaLsDRKDVXLUVLR9JgDTjEULaT2-OMbHayQAzgZH8"

​
sessionId
string
required
Example:

"61ccefdf-ea02-4f49-811b-1241f8e20d26"

​
dialId
string
required
Example:

"57555c5e-5a56-49ca-8fe8-24946d2fbc3e"