Get Location Outgoing Permission
Retrieve the location's outgoing call settings.
A location's outgoing call settings allow you to determine the types of calls the people/workspaces at the location are allowed to make, as well as configure the default calling permission for each call type at the location.
Retrieving a location's outgoing call settings requires a full, user or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Retrieve outgoing call settings for this location.
Query Parameters
Retrieve outgoing call settings for this organization.
Response Properties
Array of calling permissions.
Below are the call type values.
Controls calls within your own company.
Controls calls to a telephone number that is billed for all arriving calls instead of incurring charges to the originating caller, usually free of charge from a landline.
Controls calls to locations outside of the Long Distance areas that require an international calling code before the number is dialed.
Controls calls requiring Operator Assistance.
Controls calls to Directory Assistant companies that require a charge to connect the call.
Controls calls to carrier-specific number assignments to special services or destinations.
Controls calls to carrier-specific number assignments to special services or destinations.
Controls calls used to provide information or entertainment for a fee charged directly to the caller.
Controls calls used to provide information or entertainment for a fee charged directly to the caller.
Controls calls that are National.
Allows to configure settings for each call type.
Callers at this location can make these types of calls.
Callers at this location can't make these types of calls.
Callers must enter the authorization code that you set before placing an outgoing call.
Calls are transferred automatically to the configured auto transfer number autoTransferNumber1.
Calls are transferred automatically to the configured auto transfer number. autoTransferNumber2.
Calls are transferred automatically to the configured auto transfer number. autoTransferNumber3.
If true, allows a person to transfer or forward internal calls.
If true, indicates the call restriction is enabled for the specific call type.
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. |
Header
Query Parameters
- Retrieve outgoing call settings for this organization.
{
"callingPermissions": [
{
"callType": "INTERNAL_CALL",
"action": "ALLOW",
"transferEnabled": true,
"isCallTypeRestrictionEnabled": false
},
{
"callType": "TOLL_FREE",
"action": "ALLOW",
"transferEnabled": true,
"isCallTypeRestrictionEnabled": false
},
{
"callType": "INTERNATIONAL",
"action": "BLOCK",
"transferEnabled": false,
"isCallTypeRestrictionEnabled": true
},
{
"callType": "OPERATOR_ASSISTED",
"action": "ALLOW",
"transferEnabled": true,
"isCallTypeRestrictionEnabled": false
},
{
"callType": "CHARGEABLE_DIRECTORY_ASSISTED",
"action": "BLOCK",
"transferEnabled": true,
"isCallTypeRestrictionEnabled": false
},
{
"callType": "SPECIAL_SERVICES_I",
"action": "ALLOW",
"transferEnabled": true,
"isCallTypeRestrictionEnabled": false
},
{
"callType": "SPECIAL_SERVICES_II",
"action": "ALLOW",
"transferEnabled": true,
"isCallTypeRestrictionEnabled": false
},
{
"callType": "PREMIUM_SERVICES_I",
"action": "BLOCK",
"transferEnabled": false,
"isCallTypeRestrictionEnabled": true
},
{
"callType": "PREMIUM_SERVICES_II",
"action": "BLOCK",
"transferEnabled": false,
"isCallTypeRestrictionEnabled": true
},
{
"callType": "NATIONAL",
"action": "ALLOW",
"transferEnabled": true,
"isCallTypeRestrictionEnabled": false
}
]
}