Call Routing - Read the List of Trunks

Read the List of Trunks

List all Trunks for the organization.

A Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device. The trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.

Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/premisePstn/trunks

Query Parameters

orgId

string

List trunks for this organization.

name

string array

Return the list of trunks matching the local gateway names.

locationName

string array

Return the list of trunks matching the location names.

trunkType

string

Return the list of trunks matching the trunk type.

max

number

Limit the number of objects returned to this maximum count.

start

number

Start at the zero-based offset in the list of matching objects.

order

string

Order the trunks according to the designated fields. Available sort fields: name, locationName. Sort order is ascending by default

Response Properties

trunks

array[Trunk]

Array of trunks.

string

Unique identifier for the trunk.

name

string

A unique name for the trunk.

location

Location

Location associated with the trunk.

string

Unique identifier for the location.

name

string

A unique name for the location.

inUse

boolean

Trunk in use flag.

trunkType

TrunkType

Trunk Type associated with the trunk.

REGISTERING

string

For Cisco CUBE Local Gateway.

CERTIFICATE_BASED

string

For Cisco Unified Border Element, Oracle ACME Session Border Controller, AudioCodes Session Border Controller, Ribbon Session Border Controller.

isRestrictedToDedicatedInstance

boolean

Flag to indicate if the trunk is restricted to a dedicated instance.

Response Codes

The list below describes the common success and error responses you should expect from the API.

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	Not Found	The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.
405	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	Conflict	The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.
410	Gone	The requested resource is no longer available.
415	Unsupported Media Type	The request was made to a resource without specifying a media type or used a media type that is not supported.
423	Locked	The requested resource is temporarily unavailable. A `Retry-After` header may be present that specifies how many seconds you need to wait before attempting the request again.
428	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	Too Many Requests	Too many requests have been sent in a given amount of time and the request has been rate limited. A `Retry-After` header should be present that specifies how many seconds you need to wait before a successful request can be made.
500	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

GET

/v1/telephony/config/premisePstn/trunks{?orgId,name,locationName,trunkType,max,start,order}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
List trunks for this organization.
name
string array
Return the list of trunks matching the local gateway names.
locationName
string array
Return the list of trunks matching the location names.
trunkType
string
Return the list of trunks matching the trunk type.
max
number
Limit the number of objects returned to this maximum count.
start
number
Start at the zero-based offset in the list of matching objects.
order
string
Order the trunks according to the designated fields. Available sort fields: name, locationName. Sort order is ascending by default

https://webexapis.com/v1/telephony/config/premisePstn/trunks?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&name=LG1,LG2&locationName=Boston,SJ-1&trunkType=REGISTERING&max=5&start=0&order=name-asc%7ClocationName-desc

200 / OK

{
  "trunks": [
    {
      "id": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
      "name": "trunkName",
      "location": {
        "id": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
        "name": "locationName"
      },
      "inUse": true,
      "trunkType": "REGISTERING",
      "isRestrictedToDedicatedInstance": true
    }
  ]
}