Retrieve a virtual line's Outgoing Calling Permissions Settings
Retrieve a virtual line's Outgoing Calling Permissions settings.
Outgoing calling permissions regulate behavior for calls placed to various destinations and default to the local level settings. You can change the outgoing calling permissions for a virtual line if you want them to be different from your organization's default.
Retrieving the outgoing permission settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Retrieve settings for a virtual line with the matching ID.
Query Parameters
ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
Response Properties
When true, indicates that this user uses the shared control that applies to all outgoing call settings categories when placing outbound calls.
When true, indicates that this user uses the specified outgoing calling permissions when placing outbound calls.
Specifies the outbound calling permissions settings.
Designates the action to be taken for each call type and if transferring the call type is allowed.
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 within your country of origin, both within and outside of your local area code.
Action on the given callType.
Allow the designated call type.
Block the designated call type.
Allow only via Authorization Code.
Transfer to Auto Transfer Number 1. The answering virtual line can then approve the call and send it through or reject the call.
Transfer to Auto Transfer Number 2. The answering virtual line can then approve the call and send it through or reject the call.
Transfer to Auto Transfer Number 3. The answering virtual line can then approve the call and send it through or reject the call.
Allow the virtual line to transfer or forward a call of the specified call type.
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
- ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API.
{
"useCustomEnabled": true,
"useCustomPermissions": true,
"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": false
},
{
"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": false
},
{
"callType": "PREMIUM_SERVICES_II",
"action": "BLOCK",
"transferEnabled": false,
"isCallTypeRestrictionEnabled": true
},
{
"callType": "NATIONAL",
"action": "ALLOW",
"transferEnabled": true,
"isCallTypeRestrictionEnabled": false
}
]
}