Read Push-to-Talk Settings for a Virtual Line
Retrieve a virtual line'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.
Retrieving the Push-to-Talk 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 virtual line 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
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.
Specifies the connection type to be used.
Push-to-Talk initiators can chat with this person but only in one direction. The person you enable Push-to-Talk for cannot respond.
Push-to-Talk initiators can chat with this person in a two-way conversation. The person you enable Push-to-Talk for can respond.
Specifies the access type to be applied when evaluating the member list.
List of people that are allowed to use the Push-to-Talk feature to interact with the virtual line being configured.
List of people that are disallowed to interact using the Push-to-Talk feature with the virtual line being configured.
List of people that are allowed or disallowed to interact using the Push-to-Talk feature.
Unique identifier of the person.
Last name of the person.
First name of the person.
Display name of the person.
Type usually indicates PEOPLE, PLACE or VIRTUAL_LINE. Push-to-Talk and Privacy features only supports PEOPLE.
Indicates a person or list of people.
Indicates a workspace that is not assigned to a specific person such as for a shared device in a common area.
Indicates a virtual line or list of virtual lines.
Email address of the person.
List of phone numbers of the person.
External phone number of the person.
Extension number of the person.
Routing prefix of location.
Routing prefix + extension of a person or workspace.
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:
| 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 virtual line 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.
{
"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",
"routingPrefix": "1234",
"esn": "12341088",
"primary": true
}
]
},
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jMTQzMzhkNS02YTdjLTRiZjYtOTFiMS0zYmM2ZWMzMGJiMTE",
"lastName": "Johnson",
"firstName": "Bob",
"displayName": "Bob Johnson",
"type": "PEOPLE",
"email": "bob@example.com",
"numbers": [
{
"external": "+198455501099",
"extension": "1099",
"routingPrefix": "1234",
"esn": "12341099",
"primary": true
}
]
}
]
}