APIs
XML API DeprecationGetting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
OverviewAdmin APIsAuthentication
Guides
Reference
Admin Audit EventsAuthorizationsEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesMembershipsOrganizationsPeopleRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSpace ClassificationsWebex Calling Organization SettingsWebex Calling Person Settings
Workspace LocationsWorkspace MetricsWorkspaces
Calling
Overview
Guides
Reference
BroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsLocationsPeopleRecording ReportWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person Settings
Webex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWholesale CustomersWholesale Subscribers
Devices
Meetings
Messaging
Webex Assistant Skills
FedRAMP
Full API Reference
Admin Audit EventsAttachment ActionsAuthorizationsBroadWorks Device ProvisioningBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsGroupsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting ChatsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetingsMembershipsMessagesOrganizationsPeoplePlacesRecording ReportRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSpace ClassificationsTeam MembershipsTeamsWebex Calling Organization SettingsWebex Calling Organization Settings with NumbersWebex Calling Person Settings
Webex Calling Voice MessagingWebex Calling Workspace Settings with NumbersWebhooksWholesale CustomersWholesale SubscribersWorkspace LocationsWorkspace MetricsWorkspace PersonalizationWorkspacesxAPI
API Changelog

Read Push-to-Talk Settings for a Person

Retrieve a Person's Push-to-Talk Settings

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

This API requires a full, user, or read-only administrator auth token with a scope of spark-admin:people_read.

GET/v1/people/{personId}/features/pushToTalk
URI Parameters
personId
stringrequired

Unique identifier for the person.

Query Parameters
orgId
string

Person is in this organization. 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 person 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 person but only in one direction. The person you enable Push-to-Talk for cannot respond.

TWO_WAY
string

Push-to-Talk initiators can chat with this person in a two-way conversation. The person 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 that are allowed to use the Push-to-Talk feature to interact with the person being configured.

BLOCK_MEMBERS
string

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

members
array[MonitoredPersonObject]

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

id
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
PeopleOrPlaceType

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

PEOPLE
string

Indicates a person or list of people.

PLACE
string

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

email
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.

primary
boolean

Indicates whether phone number is primary number.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/people//features/pushToTalk{?orgId}
Log in to try the API.
Header
Query Parameters
  • Person is in this organization. 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/people/Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI/features/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",
            "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
                }
            ]
        }
    ]
}