Workspace Call Settings - Retrieve Outgoing Permission Settings for a Workspace

Retrieve Outgoing Permission Settings for a Workspace

Retrieve Outgoing Permission settings for a Workspace.

Turn on outgoing call settings for this workspace to override the calling settings from the location that are used by default.

This API requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:workspaces_read or a user auth token with spark:workspaces_read scope can be used to read workspace settings.

GET/v1/workspaces/{workspaceId}/features/outgoingPermission

URI Parameters

workspaceId

stringrequired

Unique identifier for the workspace.

Query Parameters

orgId

string

ID of the organization within which the workspace 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 the API.

Response Properties

useCustomEnabled

boolean

When true, indicates that this workspace uses the shared control that applies to all outgoing call settings categories when placing outbound calls.

useCustomPermissions

boolean

When true, indicates that this workspace uses the specified outgoing calling permissions when placing outbound calls.

callingPermissions

array[CallingPermission]

Workspace's list of outgoing permissions.

callType

enum

Type of the outgoing call.

INTERNAL_CALL

string

Indicates the internal call type.

TOLL_FREE

string

Indicates the toll free call type.

INTERNATIONAL

string

Indicates the international call type.

OPERATOR_ASSISTED

string

Indicates the operator assisted call type.

CHARGEABLE_DIRECTORY_ASSISTED

string

Indicates the chargeable directory assisted call type.

SPECIAL_SERVICES_I

string

Indicates the special services I call type.

SPECIAL_SERVICES_II

string

Indicates the special services II call type.

PREMIUM_SERVICES_I

string

Indicates the premium services I call type.

PREMIUM_SERVICES_II

string

Indicates the premium services II call type.

NATIONAL

string

Indicates the national call type.

action

enum

Indicates permission for call types.

ALLOW

string

The call type is allowed.

BLOCK

string

The call type is blocked.

AUTH_CODE

string

Indicates access code action for the specified call type.

TRANSFER_NUMBER_1

string

Indicates transfer number 1 for the specified call type.

TRANSFER_NUMBER_2

string

Indicates transfer number 2 for the specified call type.

TRANSFER_NUMBER_3

string

Indicates transfer number 3 for the specified call type.

transferEnabled

boolean

Indicate calling permission for call type enable status.

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

Header

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

Query Parameters

orgId
string
ID of the organization within which the workspace 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 the API.

https://webexapis.com/v1/workspaces/Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=/features/outgoingPermission?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE

200 / OK

{
    "useCustomEnabled": true,
    "useCustomPermissions": true,
    "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
        }
    ]
}