Get Details for a Paging Group
Retrieve Paging Group details.
Group Paging allows a person, place or virtual line a one-way call or group page to up to 75 people and/or workspaces and/or virtual line by dialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.
Retrieving paging group details requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
Retrieve settings for a paging group in this location.
Retrieve settings for the paging group with this identifier.
Query Parameters
Retrieve paging group settings from this organization.
Response Properties
A unique identifier for the paging group.
Whether or not the paging group is enabled.
Unique name for the paging group. Minimum length is 1. Maximum length is 30.
Paging group phone number. Minimum length is 1. Maximum length is 23. Either phoneNumber or extension is mandatory.
Paging group extension. Minimum length is 2. Maximum length is 10. Either phoneNumber or extension is mandatory.
Flag to indicate toll free number.
Paging language. Minimum length is 1. Maximum length is 40.
Language code.
First name that displays when a group page is performed. Minimum length is 1. Maximum length is 64.
Last name that displays when a group page is performed. Minimum length is 1. Maximum length is 64.
Determines what is shown on target users caller ID when a group page is performed. If true shows page originator ID.
An array of people, workspaces and virtual lines ID's who may originate pages to this paging group.
Agents ID.
Agent's first name. Minimum length is 1. Maximum length is 64.
Agent's last name. Minimum length is 1. Maximum length is 64.
Type of the person, workspace or virtual line.
Indicates that this object is a person.
Indicates that this object is a workspace, formerly known as a place.
Indicates that this object is a virtual line.
Agent's phone number. Minimum length is 1. Maximum length is 23. Either phoneNumber or extension is mandatory.
Agent's extension. Minimum length is 2. Maximum length is 10. Either phoneNumber or extension is mandatory.
Routing prefix of location.
Routing prefix + extension of a person or workspace.
An array of people, workspaces and virtual lines ID's that are added to paging group as paging call targets.
Agents ID.
Agent's first name. Minimum length is 1. Maximum length is 64.
Agent's last name. Minimum length is 1. Maximum length is 64.
Type of the person, workspace or virtual line.
Indicates that this object is a person.
Indicates that this object is a workspace, formerly known as a place.
Indicates that this object is a virtual line.
Agent's phone number. Minimum length is 1. Maximum length is 23. Either phoneNumber or extension is mandatory.
Agent's extension. Minimum length is 2. Maximum length is 10. Either phoneNumber or extension is mandatory.
Routing prefix of location.
Routing prefix + extension of a person or workspace.
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
- Retrieve paging group settings from this organization.
{
"id": "Y2lzY29zcGFyazovL3VzL1BBR0lOR19HUk9VUC9hSFpoWlROMk1HOHliMEEyTkRrME1USTVOeTVwYm5ReE1DNWlZMnhrTG5kbFltVjRMbU52YlE",
"enabled": true,
"name": "PagingGroup-1",
"phoneNumber": "+15558675309",
"extension": "7781",
"language": "English",
"languageCode": "en_us",
"firstName": "John",
"lastName": "Doe",
"originatorCallerIdEnabled": true,
"originators": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YTc2ZmVmNC1mZjlmLTExZWItYWYwZC00M2YwZjY1NTdjYWI",
"firstName": "John",
"lastName": "Doe",
"type": "PEOPLE",
"phoneNumber": "+15558675310",
"extension": "7781",
"routingPrefix": "567",
"esn": "5677781"
},
{
"id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg=",
"firstName": "Alice",
"lastName": "Smith",
"type": "VIRTUAL_LINE",
"phoneNumber": "+15558675311",
"extension": "7782",
"routingPrefix": "567",
"esn": "5677781"
}],
"targets": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BMQUNFLzg0YjQ1OTIyLWZmOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ",
"firstName": "Alaska Office",
"lastName": "Second Floor",
"type": "PLACE",
"phoneNumber": "+15558675311",
"extension": "7781",
"routingPrefix": "567",
"esn": "5677781"
},
{
"id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg=",
"firstName": "Alice",
"lastName": "Smith",
"type": "VIRTUAL_LINE",
"phoneNumber": "+15558675311",
"extension": "7782",
"routingPrefix": "567",
"esn": "5677781"
}]
}