v51

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

Outplan

Retrieve outplan details by ID.

Retrieves the details of the specified outplan based on the given ID.

get/outplans/{id}

Path parameters

idstring required

The unique identifier of the outplan.

Response

The requested outplan details.

idstring uuid

The unique identifier of the outplan.

customer_idstring uuid

The unique identifier of the customer. Returned from the GET /customers response.

namestring

Name of the outplan.

detailstring

Detailed information about the outplan.

dial_timeoutinteger

Dial timeout in milliseconds.

try_intervalinteger

Interval between dialing attempts in milliseconds.

max_try_count_0integer

Maximum number of tries for level 0.

max_try_count_1integer

Maximum number of tries for level 1.

max_try_count_2integer

Maximum number of tries for level 2.

max_try_count_3integer

Maximum number of tries for level 3.

max_try_count_4integer

Maximum number of tries for level 4.

tm_createstring date-time

Timestamp when the outplan was created.

tm_updatestring date-time

Timestamp when the outplan was last updated.

tm_deletestring date-time

Timestamp when the outplan was deleted.

Example response

{
  "id": "2b3c4d5e-6f7a-8901-bcde-f12345678901",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "name": "Standard Outbound Plan",
  "detail": "Default outbound dialing plan for campaigns",
  "source": {
    "type": "tel",
    "target": "+14155551234",
    "target_name": "John Smith",
    "name": "Main Office",
    "detail": "Primary contact number"
  },
  "dial_timeout": 30000,
  "try_interval": 60000,
  "max_try_count_0": 3,
  "max_try_count_1": 2,
  "max_try_count_2": 1,
  "max_try_count_3": 1,
  "max_try_count_4": 1,
  "tm_create": "2026-01-15T09:30:00.000000Z",
  "tm_update": "2026-01-15T09:30:00.000000Z",
  "tm_delete": "2026-01-15T09:30:00.000000Z"
}