Location Call Settings: Call Handling Draft - Get Location Outgoing Permission

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.

GET/v1/telephony/config/locations/{locationId}/outgoingPermission

URI Parameters

locationId

stringrequired

Retrieve outgoing call settings for this location.

Query Parameters

orgId

string

Retrieve outgoing call settings for this organization.

Response Properties

callingPermissions

array[CallingPermissionObject]

Array of calling permissions.

callType

enum

Below are the call type values.

INTERNAL_CALL

string

Controls calls within your own company.

TOLL_FREE

string

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.

INTERNATIONAL

string

Controls calls to locations outside of the Long Distance areas that require an international calling code before the number is dialed.

OPERATOR_ASSISTED

string

Controls calls requiring Operator Assistance.

CHARGEABLE_DIRECTORY_ASSISTED

string

Controls calls to Directory Assistant companies that require a charge to connect the call.

SPECIAL_SERVICES_I

string

Controls calls to carrier-specific number assignments to special services or destinations.

SPECIAL_SERVICES_II

string

Controls calls to carrier-specific number assignments to special services or destinations.

PREMIUM_SERVICES_I

string

Controls calls used to provide information or entertainment for a fee charged directly to the caller.

PREMIUM_SERVICES_II

string

Controls calls used to provide information or entertainment for a fee charged directly to the caller.

NATIONAL

string

Controls calls that are National.

action

enum

Allows to configure settings for each call type.

ALLOW

string

Callers at this location can make these types of calls.

BLOCK

string

Callers at this location can't make these types of calls.

AUTH_CODE

string

Callers must enter the authorization code that you set before placing an outgoing call.

TRANSFER_NUMBER_1

string

If you select this, then these types of calls are transferred automatically to the configured auto transfer number autoTransferNumber1.

TRANSFER_NUMBER_2

string

If you select this, then these types of calls are transferred automatically to the configured auto transfer number autoTransferNumber2.

TRANSFER_NUMBER_3

string

If you select this, then these types of calls are transferred automatically to the configured auto transfer number autoTransferNumber3.

transferEnabled

boolean

If enabled, allow the person to transfer or forward internal calls.

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/locations//outgoingPermission{?orgId}

Header

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

Query Parameters

orgId
string
Retrieve outgoing call settings for this organization.

https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx/outgoingPermission?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE

200 / OK

{
    "callingPermissions": [
        {
            "callType": "INTERNAL_CALL",
            "action": "ALLOW",
            "transferEnabled": true
        },
        {
            "callType": "TOLL_FREE",
            "action": "ALLOW",
            "transferEnabled": true
        },
        {
            "callType": "INTERNATIONAL",
            "action": "BLOCK",
            "transferEnabled": false
        },
        {
            "callType": "OPERATOR_ASSISTED",
            "action": "ALLOW",
            "transferEnabled": true
        },
        {
            "callType": "CHARGEABLE_DIRECTORY_ASSISTED",
            "action": "BLOCK",
            "transferEnabled": true
        },
        {
            "callType": "SPECIAL_SERVICES_I",
            "action": "ALLOW",
            "transferEnabled": true
        },
        {
            "callType": "SPECIAL_SERVICES_II",
            "action": "ALLOW",
            "transferEnabled": true
        },
        {
            "callType": "PREMIUM_SERVICES_I",
            "action": "BLOCK",
            "transferEnabled": false
        },
        {
            "callType": "PREMIUM_SERVICES_II",
            "action": "BLOCK",
            "transferEnabled": false
        },
        {
            "callType": "NATIONAL",
            "action": "ALLOW",
            "transferEnabled": true
        }
    ]
}