Workspace Call Settings - Read Push-to-Talk Settings for a Workspace

Read Push-to-Talk Settings for a Workspace

Retrieve Push-to-Talk settings for a workspace.

Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people/workspaces in different parts of your organization.

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

NOTE: This API is only available for professional licensed workspaces.

GET/v1/telephony/config/workspaces/{workspaceId}/pushToTalk

URI Parameters

workspaceId

stringrequired

Unique identifier for the workspace.

Query Parameters

orgId

string

ID of the organization in 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 API.

Response Properties

allowAutoAnswer

boolean

Set to true to enable the Push-to-Talk feature. When enabled, a workspace receives a Push-to-Talk call and answers the call automatically.

connectionType

PushToTalkConnectionType

Specifies the connection type to be used.

ONE_WAY

string

Push-to-Talk initiators can chat with this workspace but only in one direction. The workspace you enable Push-to-Talk for cannot respond.

TWO_WAY

string

Push-to-Talk initiators can chat with this workspace in a two-way conversation. The workspace you enable Push-to-Talk for can respond.

accessType

PushToTalkAccessType

Specifies the access type to be applied when evaluating the member list.

ALLOW_MEMBERS

string

List of people/workspaces that are allowed to use the Push-to-Talk feature to interact with the workspace being configured.

BLOCK_MEMBERS

string

List of people/workspaces that are disallowed to interact using the Push-to-Talk feature with the workspace being configured.

members

array[MonitoredPersonObject]

List of people/workspaces that are allowed or disallowed to interact using the Push-to-Talk feature.

string

Unique identifier of the person.

lastName

string

Last name of the person.

firstName

string

First name of the person.

displayName

string

Display name of the person.

type

PeopleOrPlaceOrVirtualLineType

Type usually indicates PEOPLE, PLACE or VIRTUAL_LINE. Push-to-Talk and Privacy features only supports PEOPLE.

PEOPLE

string

Person or list of people.

PLACE

string

Workspace that is not assigned to a specific person such as for a shared device in a common area.

VIRTUAL_LINE

string

Virtual line or list of virtual lines.

string

Email address of the person.

numbers

array[PushToTalkNumberObject]

List of phone numbers of the person.

external

string

External phone number of the person.

extension

string

Extension number of the person.

routingPrefix

string

Routing prefix of location.

esn

string

Routing prefix + extension of a person or workspace.

primary

boolean

If true, specifies whether the phone number is primary number.

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/workspaces//pushToTalk{?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 in 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 API.

https://webexapis.com/v1/telephony/config/workspaces/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI/pushToTalk?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE

200 / OK

{
    "allowAutoAnswer": true,
    "connectionType": "ONE_WAY",
    "accessType": "ALLOW_MEMBERS",
    "members": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS82MWU3MDlkNy1hM2IxLTQ2MDctOTBiOC04NmE5MDgxYWFkNmE",
            "lastName": "Little",
            "firstName": "Alice",
            "displayName": "Alice Little",
            "type": "PEOPLE",
            "email": "alice@example.com",
            "location": {
                  "name": "Paragville",
                  "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhjOWZkMjg1LTY1MDAtNDUxOC04NTZlLWViODM2YzY3NjFkOA"
            },
            "numbers": [
                {
                    "external": "+19845551088",
                    "extension": "1088",
                    "primary": true
                }
            ]
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jMTQzMzhkNS02YTdjLTRiZjYtOTFiMS0zYmM2ZWMzMGJiMTE",
            "lastName": "Johnson",
            "firstName": "Bob",
            "displayName": "Bob Johnson",
            "type": "PEOPLE",
            "email": "bob@example.com",
            "numbers": [
                {
                    "external": "+198455501099",
                    "extension": "1099",
                    "primary": true
                }
            ]
        }
    ]
}