List byoc trunk

GET /v1/ByocTrunks

BYOC Trunks allow you to bring your own voice carrier to Twilio, enabling your calls to use our Programmable Voice APIs.

Query parameters

  • PageSize integer

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

Responses

  • • 200

    OK

    Hide response attributes Show response attributes object
    • byoc_trunks array[object]
      Hide byoc_trunks attributes Show byoc_trunks attributes
      • account_sid string | null

        The SID of the Account that created the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • cnam_lookup_enabled boolean | null

        Whether Caller ID Name (CNAM) lookup is enabled for the trunk

      • connection_policy_sid string | null

        Origination Connection Policy (to your Carrier)

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^NY[0-9a-fA-F]{32}$.

      • date_created string(date-time) | null

        The RFC 2822 date and time in GMT that the resource was created

      • date_updated string(date-time) | null

        The RFC 2822 date and time in GMT that the resource was last updated

      • friendly_name string | null

        The string that you assigned to describe the resource

      • from_domain_sid string | null

        The SID of the SIP Domain that should be used in the From header of originating calls

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^SD[0-9a-fA-F]{32}$.

      • sid string | null

        The unique string that identifies the resource

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BY[0-9a-fA-F]{32}$.

      • status_callback_method string(http-method) | null

        The HTTP method we use to call status_callback_url

        Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

      • status_callback_url string(uri) | null

        The URL that we call with status updates

      • url string(uri) | null

        The absolute URL of the resource

      • voice_fallback_method string(http-method) | null

        The HTTP method used with voice_fallback_url

        Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

      • voice_fallback_url string(uri) | null

        The URL we call when an error occurs while executing TwiML

      • voice_method string(http-method) | null

        The HTTP method to use with voice_url

        Values are HEAD, GET, POST, PATCH, PUT, or DELETE.

      • voice_url string(uri) | null

        The URL we call when receiving a call

    • meta object
      Hide meta attributes Show meta attributes
GET /v1/ByocTrunks 
curl \
 -X GET https://voice.twilio.com/v1/ByocTrunks \
 --user "username:password"
Response examples (200) 
{
  "byoc_trunks": [
    {
      "account_sid": "string",
      "cnam_lookup_enabled": true,
      "connection_policy_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "friendly_name": "string",
      "from_domain_sid": "string",
      "sid": "string",
      "status_callback_method": "HEAD",
      "status_callback_url": "https://example.com",
      "url": "https://example.com",
      "voice_fallback_method": "HEAD",
      "voice_fallback_url": "https://example.com",
      "voice_method": "HEAD",
      "voice_url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}