Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Outdial

Create a new target for an outdial.

Creates a new target for the specified outdial and returns the created target information.

post/outdials/{id}/targets

Path parameters

idstring required

The ID of the outdial to associate with the target.

Request body

namestring required
detailstring required
datastring required

Example request

{
  "destination_0": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destination_1": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destination_2": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destination_3": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destination_4": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  }
}

Response

The created outdial target details.

idstring uuid

The unique identifier for the outdial target.

outdial_idstring uuid

The unique identifier of the outdial. Returned from the POST /outdials or GET /outdials response.

namestring

The name of the outdial target.

detailstring

Additional details about the outdial target.

datastring

The data associated with the outdial target.

status'progressing' | 'done' | 'idle'

The status of the outdial.

try_count_0integer

The try count for destination 0.

try_count_1integer

The try count for destination 1.

try_count_2integer

The try count for destination 2.

try_count_3integer

The try count for destination 3.

try_count_4integer

The try count for destination 4.

tm_createstring date-time

The creation timestamp.

tm_updatestring date-time

The update timestamp.

tm_deletestring date-time

The deletion timestamp.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "outdial_id": "3c4d5e6f-7a8b-9012-cdef-012345678901",
  "name": "John Smith",
  "detail": "Priority customer",
  "data": "vip-tag",
  "status": "idle",
  "destination_0": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destination_1": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destination_2": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destination_3": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "destination_4": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}