v51

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

Call

Create an outbound config

Creates a new outbound config and returns the created resource.

post/outbound_configs

Request body

namestring

Human-readable name for this outbound config.

detailstring

Free-text description of this outbound config.

destination_whiteliststring[] nullable

ISO 3166 alpha-2 country codes (lowercase). Send null or omit to leave unchanged. Send [] to deny all PSTN calls.

codecsstring nullable

Comma-separated codec preference list. Send null or omit to leave unchanged. Send empty string to use server default.

default_outgoing_source_number_idstring uuid

UUID of the customer's default outgoing source number to set. Send 00000000-0000-0000-0000-000000000000 to clear the default. Omit this field (or send null) to leave the current value unchanged. The number must belong to the customer, be of type normal, and be active.

Example request

{
  "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"
}

Response

The created outbound config.

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"
}