Setup PSTN Connection for a Location
Set up or update the PSTN connection details for a location.
PSTN location connection settings enables the admin to configure or change the PSTN provider for a location.
Setting up PSTN connection on a location requires a full administrator auth token with a scope of spark-admin:telephony_pstn_write.
PUT/v1/telephony/pstn/locations/{locationId}/connection
URI Parameters
locationId
stringrequired
Setup PSTN location connection options for this location.
Query Parameters
orgId
string
Setup PSTN location connection for this organization.
Body Parameters
id
string
A unique identifier for the connection. This is required for non-integrated CCP.
premiseRouteType
string
Premise route type. The possible types are TRUNK and ROUTE_GROUP. This is required for the local gateway.
premiseRouteId
string
Premise route ID. This refers to either a Trunk ID or a Route Group ID and is required for the local gateway.
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. |
PUT
/v1/telephony/pstn/locations//connection{?orgId}
Log in to try the API.
Header
Query Parameters
- Setup PSTN location connection for this organization.
Body
- A unique identifier for the connection. This is required for non-integrated CCP.
- Premise route type. The possible types are TRUNK and ROUTE_GROUP. This is required for the local gateway.
- Premise route ID. This refers to either a Trunk ID or a Route Group ID and is required for the local gateway.
https://webexapis.com/v1/telephony/pstn/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1/connection?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
"id": "Y2lzY29zcGFyazovL3VzL1BTVE5fQ09OTkVDVElPTi81MWRlNDg5Yy1hYTYwLTRjMjUtOWFmNi1jYzRjYjE3MTczMGU",
"premiseRouteType": "TRUNK",
"premiseRouteId": "Y2lzY29zcGFyazovL3VzL1RSVU5LLzUxZGU0ODljLWFhNjAtNGMyNS05YWY2LWNjNGNiMTcxNzMxZg"
}
204 / No Content