v51

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

Call

Get outbound config detail

Returns detailed information about the specified outbound config.

get/outbound_configs/{id}

Path parameters

idstring uuid required

The unique identifier of the outbound config.

Response

Detailed outbound config information.

idstring uuid

The unique identifier of the outbound config.

customer_idstring uuid

The customer ID that owns this outbound config. Returned from the GET /customers response.

namestring

Human-readable name for this outbound config.

detailstring

Free-text description of this outbound config.

destination_whiteliststring[]

ISO 3166 alpha-2 country codes (lowercase). Empty array = deny all PSTN calls.

codecsstring

Comma-separated codec preference list (e.g. PCMU,PCMA,G729). Empty = server default.

default_outgoing_source_number_idstring uuid nullable

UUID of the customer's default outgoing source number, used as the caller ID when an outgoing tel call has no valid caller-supplied source. Set to 00000000-0000-0000-0000-000000000000 to clear the default. The number must belong to the customer, be of type normal, and be active. Validated at update time and re-validated at call time. Obtained from the id field of the GET /numbers response.

tm_createstring date-time nullable

Timestamp when the outbound config was created.

tm_updatestring date-time nullable

Timestamp when the outbound config was last updated.

tm_deletestring date-time nullable

Timestamp when the outbound config was deleted (soft-delete).

Example response

{
  "id": "00000000-0000-0000-0000-000000000001",
  "customer_id": "00000000-0000-0000-0000-000000000001",
  "name": "production outbound config",
  "detail": "allows US and UK PSTN calls",
  "destination_whitelist": [
    "us",
    "gb",
    "kr"
  ],
  "codecs": "PCMU,PCMA",
  "default_outgoing_source_number_id": "00000000-0000-0000-0000-000000000001"
}