VOvogent

Create a new dial

Creates a one-off dial session, either for phone dials or browser dials.

post/dials

Request

  • Base URL
    https://api.vogent.ai/api
  • Auth
    HTTP bearer

Request body

webhookUrlstring nullable

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

browserCallboolean nullable

Set to true if this is a browser call.

toNumberstring nullable

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

fromNumberIdstring nullable

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

fromNumberPoolIdstring nullable

The ID of a phone number pool to use when starting the call.

aiVoiceIdstring nullable

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

voiceVolumeLevelinteger

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

callAgentIdstring required

Required. The ID of the agent.

versionedModelIdstring

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

ivrVersionedPromptIdstring

The prompt/model version to use for the IVR portion of this call, if ivr nav is enabled on the agent.

overrideTranscriberFinalDurationMsinteger

How long in ms after an utterance is complete to ignore the final/non-final status of the transcript and run inference.

timeoutMinutesinteger

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.

callAgentExtractorIdstring

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

callAgentInputobject nullable

Any macros in the call agent prompt.

keywordsstring[] nullable

A list of keywords to be used in the call.

advancedBrowserInteractionboolean

If browserCall is false, and you want to have a more complex flow, allowing the web SDK to have transcribed barge-in lines, you should set this to true. Contact the vogent team to enable this feature.

idempotencyKeystring nullable

Optional. A unique key that keeps a retried request from placing a second call. If a dial in this workspace was already created with this key, the request fails with a 409 naming that dial instead of dialing again.

Response

Successful operation

dialTokenstring 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.

sessionIdstring required
dialIdstring required

Example response

{
  "dialToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0ZXN0IjoidGVzdCJ9.9EQaLsDRKDVXLUVLR9JgDTjEULaT2-OMbHayQAzgZH8",
  "sessionId": "61ccefdf-ea02-4f49-811b-1241f8e20d26",
  "dialId": "57555c5e-5a56-49ca-8fe8-24946d2fbc3e"
}

Changes

No recorded changes to this operation across all 1 revision of this API.