Create a task attempt

Creates a new attempt to complete a task by initiating a dial.

post/tasks/{taskId}/attempt

Request

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

Path parameters

taskIdstring required

ID of the task.

Request body

toNumberstring required

The phone number to dial in E.164 format.

fromNumberIdstring required

The ID of the phone number to use for dialing.

webhookUrlstring nullable

Optional webhook URL for notifications about the dial.

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.