Call Routing - Get a Trunk | Webex for Developers

Get a Trunk

Get a Trunk 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 a trunk requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/premisePstn/trunks/{trunkId}

URI Parameters

trunkId

stringrequired

ID of the trunk.

Query Parameters

orgId

string

Organization to which trunk belongs.

Response Properties

name

string

A unique name for the trunk.

customer

Customer

Customer associated with the trunk.

string

ID of the customer/organization.

name

string

Name of the customer/organization.

location

Location

Location associated with the trunk.

string

Unique identifier for the location.

name

string

A unique name for the location.

otgDtgId

string

Unique Outgoing and Destination trunk group associated with the dial plan.

linePort

string

The Line/Port identifies a device endpoint in standalone mode or a SIP URI public identity in IMS mode.

locationsUsingTrunk

array[Location]

Locations using trunk.

string

Unique identifier for the location.

name

string

A unique name for the location.

pilotUserId

string

User ID.

outboundProxy

object

Contains the body of the HTTP response received following the request to Console API and will not be set if the response has no body.

sipAuthenticationUserName

string

User's authentication service information.

status

DeviceStatus

Device status.

ONLINE

string

Device is online

OFFLINE

string

Device is offline

UNKNOWN

string

Unknown. Default

errorCodes

array[string]

Error codes.

responseStatus

ResponseStatus

Present partial error/warning status information included when the http response is 206.

code

number

Error Code. 25013 for error retrieving the outbound proxy. 25014 for error retrieving the status

type

ResponseStatusType

Status type.

ERROR

string

Error

WARNING

string

Warning

summaryEnglish

string

Error summary in English.

detail

array[string]

Error Details.

trackingId

string

Error Tracking ID.

dualIdentitySupportEnabled

boolean

Determines the behavior of the From and PAI headers on outbound calls.

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.

deviceType

string

Device type assosiated with trunk.

address

string

FQDN or SRV address. Required to create a static certificate-based trunk.

domain

string

Domain name. Required to create a static certificate based trunk.

port

number

FQDN port. Required to create a static certificate-based trunk.

maxConcurrentCalls

number

Max Concurrent call. Required to create a static certificate based trunk.

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}

Header

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

Query Parameters

orgId
string
Organization to which trunk belongs.

https://webexapis.com/v1/telephony/config/premisePstn/trunks/Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE

200 / OK

{
  "name": "trunkName",
  "customer": {
    "id": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
    "name": "test_org"
  },
  "location": {
    "id": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
    "name": "locationName"
  },
  "otgDtgId": "lg1_sias10_cpapi12446_lgu",
  "linePort": "lg1_sias10_cpapi16004_LGU@64941297.int10.bcld.webex.com",
  "locationsUsingTrunk": [
    {
      "id": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
      "name": "locationName"
    }
  ],
  "pilotUserId": "lg1_sias10_cpapi12446_LGU@64941297.int10.bcld.webex.com",
  "sipAuthenticationUserName": "lg1_sias10_cpapi12446_LGU",
  "status": "ONLINE",
  "errorCodes": [
    "errorCodes"
  ],
  "responseStatus": {
    "code": 25013,
    "type": "ERROR",
    "summaryEnglish": "CPAPI: Error retrieving outboundproxy.",
    "detail": [
      "OCI-P GroupOutboundProxyGetRequest: [Error 26088] Cloud PBX Console is not configured properly., OCI-P Error code: [Error 26088] Cloud PBX Console is not configured properly."
    ],
    "trackingId": "CPAPI_2da34568-1e72-4196-b613-905ce45ec592_0"
  },
  "dualIdentitySupportEnabled": true,
  "trunkType": "REGISTERING",
  "deviceType": "Cisco Unified Border Element",
  "address": "lgw1.london",
  "domain": "acme.corp",
  "port": 5000,
  "maxConcurrentCalls": 1000,
  "isRestrictedToDedicatedInstance": true
}