Twilio Trunks API

The Trunks API from Twilio — 12 operation(s) for trunks.

Documentation

Specifications

Other Resources

OpenAPI Specification

twilio-trunks-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Twilio - Accounts A2p Trunks API
  description: This is the public Twilio REST API.
  termsOfService: https://www.twilio.com/legal/tos
  contact:
    name: Twilio Support
    url: https://support.twilio.com
    email: support@twilio.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.52.0
servers:
- url: https://accounts.twilio.com
tags:
- name: Trunks
paths:
  /v2/Trunks/{SipTrunkDomain}:
    servers:
    - url: https://routes.twilio.com
    description: 'TODO: Resource-level docs'
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      - date_created
      pathType: instance
    post:
      description: Assign an Inbound Processing Region to a SIP Trunk
      tags:
      - Trunks
      parameters:
      - name: SipTrunkDomain
        in: path
        description: The absolute URL of the SIP Trunk
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/routes.v2.trunks'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: UpdateTrunks
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateTrunksRequest'
    get:
      description: Fetch the Inbound Processing Region assigned to a SIP Trunk.
      tags:
      - Trunks
      parameters:
      - name: SipTrunkDomain
        in: path
        description: The absolute URL of the SIP Trunk
        schema:
          type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/routes.v2.trunks'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchTrunks
      x-maturity:
      - GA
  /v1/Trunks/{TrunkSid}/CredentialLists/{Sid}:
    servers:
    - url: https://trunking.twilio.com
    description: List of credentials for accessing a trunk
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      - date_created
      pathType: instance
      parent: /Trunks/{Sid}
      mountName: credentials_lists
      className: credential_list
    get:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk from which to fetch the credential list.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      - name: Sid
        in: path
        description: The unique string that we created to identify the CredentialList resource to fetch.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^CL[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trunking.v1.trunk.credential_list'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchCredentialList
      x-maturity:
      - GA
    delete:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk from which to delete the credential list.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      - name: Sid
        in: path
        description: The unique string that we created to identify the CredentialList resource to delete.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^CL[0-9a-fA-F]{32}$
        required: true
      responses:
        '204':
          description: The resource was deleted successfully.
      security:
      - accountSid_authToken: []
      operationId: DeleteCredentialList
      x-maturity:
      - GA
  /v1/Trunks/{TrunkSid}/CredentialLists:
    servers:
    - url: https://trunking.twilio.com
    description: List of credentials for accessing a trunk
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      - date_created
      pathType: list
      parent: /Trunks/{Sid}
      mountName: credentials_lists
      className: credential_list
    post:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk to associate the credential list with.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trunking.v1.trunk.credential_list'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateCredentialList
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateCredentialListRequest'
    get:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk from which to read the credential lists.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCredentialListResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListCredentialList
      x-maturity:
      - GA
  /v1/Trunks/{TrunkSid}/IpAccessControlLists/{Sid}:
    servers:
    - url: https://trunking.twilio.com
    description: List of IP addresses for accessing a trunk
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      - date_created
      pathType: instance
      parent: /Trunks/{Sid}
    get:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk from which to fetch the IP Access Control List.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      - name: Sid
        in: path
        description: The unique string that we created to identify the IpAccessControlList resource to fetch.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AL[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trunking.v1.trunk.ip_access_control_list'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchIpAccessControlList
      x-maturity:
      - GA
    delete:
      description: Remove an associated IP Access Control List from a Trunk
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk from which to delete the IP Access Control List.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      - name: Sid
        in: path
        description: The unique string that we created to identify the IpAccessControlList resource to delete.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AL[0-9a-fA-F]{32}$
        required: true
      responses:
        '204':
          description: The resource was deleted successfully.
      security:
      - accountSid_authToken: []
      operationId: DeleteIpAccessControlList
      x-maturity:
      - GA
  /v1/Trunks/{TrunkSid}/IpAccessControlLists:
    servers:
    - url: https://trunking.twilio.com
    description: List of IP addresses for accessing a trunk
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      - date_created
      pathType: list
      parent: /Trunks/{Sid}
    post:
      description: Associate an IP Access Control List with a Trunk
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk to associate the IP Access Control List with.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trunking.v1.trunk.ip_access_control_list'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateIpAccessControlList
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateIpAccessControlListRequest'
    get:
      description: List all IP Access Control Lists for a Trunk
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk from which to read the IP Access Control Lists.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIpAccessControlListResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListIpAccessControlList
      x-maturity:
      - GA
  /v1/Trunks/{TrunkSid}/OriginationUrls/{Sid}:
    servers:
    - url: https://trunking.twilio.com
    description: Network element entry points into your communications infrastructure
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      - sip_url
      - priority
      - weight
      pathType: instance
      parent: /Trunks/{Sid}
    get:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk from which to fetch the OriginationUrl.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      - name: Sid
        in: path
        description: The unique string that we created to identify the OriginationUrl resource to fetch.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^OU[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trunking.v1.trunk.origination_url'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchOriginationUrl
      x-maturity:
      - GA
    delete:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk from which to delete the OriginationUrl.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      - name: Sid
        in: path
        description: The unique string that we created to identify the OriginationUrl resource to delete.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^OU[0-9a-fA-F]{32}$
        required: true
      responses:
        '204':
          description: The resource was deleted successfully.
      security:
      - accountSid_authToken: []
      operationId: DeleteOriginationUrl
      x-maturity:
      - GA
    post:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk from which to update the OriginationUrl.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      - name: Sid
        in: path
        description: The unique string that we created to identify the OriginationUrl resource to update.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^OU[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trunking.v1.trunk.origination_url'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: UpdateOriginationUrl
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateOriginationUrlRequest'
  /v1/Trunks/{TrunkSid}/OriginationUrls:
    servers:
    - url: https://trunking.twilio.com
    description: Network element entry points into your communications infrastructure
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      - sip_url
      - priority
      - weight
      pathType: list
      parent: /Trunks/{Sid}
    post:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk to associate the resource with.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trunking.v1.trunk.origination_url'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateOriginationUrl
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateOriginationUrlRequest'
    get:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk from which to read the OriginationUrl.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOriginationUrlResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListOriginationUrl
      x-maturity:
      - GA
  /v1/Trunks/{TrunkSid}/PhoneNumbers/{Sid}:
    servers:
    - url: https://trunking.twilio.com
    description: Phone numbers associated with trunks
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      - phone_number
      pathType: instance
      parent: /Trunks/{Sid}
    get:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk from which to fetch the PhoneNumber resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      - name: Sid
        in: path
        description: The unique string that we created to identify the PhoneNumber resource to fetch.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^PN[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trunking.v1.trunk.phone_number'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchPhoneNumber
      x-maturity:
      - GA
    delete:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk from which to delete the PhoneNumber resource.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      - name: Sid
        in: path
        description: The unique string that we created to identify the PhoneNumber resource to delete.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^PN[0-9a-fA-F]{32}$
        required: true
      responses:
        '204':
          description: The resource was deleted successfully.
      security:
      - accountSid_authToken: []
      operationId: DeletePhoneNumber
      x-maturity:
      - GA
  /v1/Trunks/{TrunkSid}/PhoneNumbers:
    servers:
    - url: https://trunking.twilio.com
    description: Phone numbers associated with trunks
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      - phone_number
      pathType: list
      parent: /Trunks/{Sid}
    post:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk to associate the phone number with.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trunking.v1.trunk.phone_number'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreatePhoneNumber
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreatePhoneNumberRequest'
    get:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk from which to read the PhoneNumber resources.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPhoneNumberResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListPhoneNumber
      x-maturity:
      - GA
  /v1/Trunks/{TrunkSid}/Recording:
    servers:
    - url: https://trunking.twilio.com
    description: Recording settings for a trunk
    x-twilio:
      defaultOutputProperties:
      - mode
      - trim
      pathType: instance
      parent: /Trunks/{Sid}
      mountName: recordings
    get:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk from which to fetch the recording settings.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trunking.v1.trunk.recording'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchRecording
      x-maturity:
      - GA
    post:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: TrunkSid
        in: path
        description: The SID of the Trunk that will have its recording settings updated.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trunking.v1.trunk.recording'
          description: Accepted
      security:
      - accountSid_authToken: []
      operationId: UpdateRecording
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateRecordingRequest'
  /v1/Trunks/{Sid}:
    servers:
    - url: https://trunking.twilio.com
    description: Represents a SIP trunk
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      - domain_name
      pathType: instance
      dependentProperties:
        origination_urls:
          mapping:
            trunk_sid: sid
          resource_url: /v1/Trunks/{trunk_sid}/OriginationUrls
        credentials_lists:
          mapping:
            trunk_sid: sid
          resource_url: /v1/Trunks/{trunk_sid}/CredentialLists
        ip_access_control_lists:
          mapping:
            trunk_sid: sid
          resource_url: /v1/Trunks/{trunk_sid}/IpAccessControlLists
        phone_numbers:
          mapping:
            trunk_sid: sid
          resource_url: /v1/Trunks/{trunk_sid}/PhoneNumbers
        recordings:
          mapping:
            trunk_sid: sid
          resource_url: /v1None
    get:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: Sid
        in: path
        description: The unique string that we created to identify the Trunk resource to fetch.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trunking.v1.trunk'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchTrunk
      x-maturity:
      - GA
    delete:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: Sid
        in: path
        description: The unique string that we created to identify the Trunk resource to delete.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      responses:
        '204':
          description: The resource was deleted successfully.
      security:
      - accountSid_authToken: []
      operationId: DeleteTrunk
      x-maturity:
      - GA
    post:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: Sid
        in: path
        description: The unique string that we created to identify the OriginationUrl resource to update.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^TK[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trunking.v1.trunk'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: UpdateTrunk
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateTrunkRequest'
  /v1/Trunks:
    servers:
    - url: https://trunking.twilio.com
    description: Represents a SIP trunk
    x-twilio:
      defaultOutputProperties:
      - sid
      - friendly_name
      - domain_name
      pathType: list
      dependentProperties:
        origination_urls:
          mapping:
            trunk_sid: sid
          resource_url: /v1/Trunks/{trunk_sid}/OriginationUrls
        credentials_lists:
          mapping:
            trunk_sid: sid
          resource_url: /v1/Trunks/{trunk_sid}/CredentialLists
        ip_access_control_lists:
          mapping:
            trunk_sid: sid
          resource_url: /v1/Trunks/{trunk_sid}/IpAccessControlLists
        phone_numbers:
          mapping:
            trunk_sid: sid
          resource_url: /v1/Trunks/{trunk_sid}/PhoneNumbers
        recordings:
          mapping:
            trunk_sid: sid
          resource_url: /v1None
    post:
      description: ''
      tags:
      - Trunks
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/trunking.v1.trunk'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreateTrunk
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateTrunkRequest'
    get:
      description: ''
      tags:
      - Trunks
      parameters:
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTrunkResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListTrunk
      x-maturity:
      - GA
components:
  schemas:
    trunking.v1.trunk:
      type: object
      properties:
        account_sid:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          nullable: true
          description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Trunk resource.
        domain_name:
          type: string
          nullable: true
          description: The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and `-` and must end with `pstn.twilio.com`. See [Termination Settings](https://www.twilio.com/docs/sip-trunking#termination) for more information.
        disaster_recovery_method:
          type: string
          format: http-method
          enum:
          - HEAD
          - GET
          - POST
          - PATCH
          - PUT
          - DELETE
          nullable: true
          description: 'The HTTP method we use to call the `disaster_recovery_url`. Can be: `GET` or `POST`.'
        disaster_recovery_url:
          type: string
          format: uri
          nullable: true
          description: The URL we call using the `disaster_recovery_method` if an error occurs while sending SIP traffic towards the configured Origination URL. We retrieve TwiML from this URL and execute the instructions like any other normal TwiML call. See [Disaster Recovery](https://www.twilio.com/docs/sip-trunking#disaster-recovery) for more information.
          x-twilio:
            pii:
              handling: standard
              deleteSla: 30
        friendly_name:
          type: string
          nullable: true
          description: The string that you assigned to describe the resource.
        secure:
          type: boolean
          nullable: true
          description: Whether Secure Trunking is enabled for the trunk. If enabled, all calls going through the trunk will be secure using SRTP for media and TLS for signaling. If disabled, then RTP will be used for media. See [Secure Trunking](https://www.twilio.com/docs/sip-trunking#securetrunking) for more information.
        recording:
          nullable: true
          description: 'The recording settings for the trunk. Can be: `do-not-record`, `record-from-ringing`, `record-from-answer`. If set to `record-from-ringing` or `record-from-answer`, all calls going through the trunk will be recorded. The only way to change recording parameters is on a sub-resource of a Trunk after it has been created. e.g.`/Trunks/[Trunk_SID]/Recording -XPOST -d''Mode=record-from-answer''`. See [Recording](https://www.twilio.com/docs/sip-trunking#recording) for more information.'
        transfer_mode:
          type: string
          $ref: '#/components/schemas/trunk_enum_transfer_setting'
          nullable: true
          description: 'The call transfer settings for the trunk. Can be: `enable-all`, `sip-only` and `disable-all`. See [Transfer](https://www.twilio.com/docs/sip-trunking/call-transfer) for more information.'
        transfer_caller_id:
          type: string
          $ref: '#/components/schemas/trunk_enum_transfer_caller_id'
          nullable: true
          description: 'Caller Id for transfer target. Can be: `from-transferee` (default) or `from-transferor`.'
        cnam_lookup_enabled:
          type: boolean
          nullable: true
          description: Whether Caller ID Name (CNAM) lookup is enabled for the trunk. If enabled, all inbound calls to the SIP Trunk from the United States and Canada automatically perform a CNAM Lookup and display Caller ID data on your phone. See [CNAM Lookups](https://www.twilio.com/docs/sip-trunking#CNAM) for more information.
        auth_type:
          type: string
          nullable: true
          description: 'The types of authentication mapped to the domain. Can be: `IP_ACL` and `CREDENTIAL_LIST`. If both are mapped, the values are returned in a comma delimited list. If empty, the domain will not r

# --- truncated at 32 KB (62 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/twilio/refs/heads/main/openapi/twilio-trunks-api-openapi.yml