Update a Paging Group
Update the designated Paging Group.
Group Paging allows a person to place a one-way call or group page to up to 75 people, workspaces and virtual lines 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.
Updating a paging group requires a full administrator or location administrator auth token with a scope of spark-admin:telephony_config_write
.
URI Parameters
Update settings for a paging group in this location.
Update settings for the paging group with this identifier.
Query Parameters
Update paging group settings from this organization.
Body Parameters
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.
Language code.
First name to be shown when calls are forwarded out of this paging group. Defaults to ".".
Last name to be shown when calls are forwarded out of this paging group. Defaults to the phone number if set, otherwise defaults to call group name.
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 and/or workspaces, who may originate pages to this paging group.
People, including workspaces, that are added to paging group as paging call targets.
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
- orgIdstringUpdate paging group settings from this organization.
Body
- enabledbooleanWhether or not the paging group is enabled.
- namestringUnique name for the paging group. Minimum length is 1. Maximum length is 30.
- phoneNumberstringPaging group phone number. Minimum length is 1. Maximum length is 23. Either `phoneNumber` or `extension` is mandatory.
- extensionstringPaging group extension. Minimum length is 2. Maximum length is 10. Either `phoneNumber` or `extension` is mandatory.
- languageCodestringLanguage code.
- firstNamestringFirst name to be shown when calls are forwarded out of this paging group. Defaults to ".".
- lastNamestringLast name to be shown when calls are forwarded out of this paging group. Defaults to the phone number if set, otherwise defaults to call group name.
- originatorCallerIdEnabledbooleanDetermines what is shown on target users caller ID when a group page is performed. If true shows page originator ID.
- originatorsarrayAn array of people and/or workspaces, who may originate pages to this paging group.
- targetsarrayPeople, including workspaces, that are added to paging group as paging call targets.
{ "name": "PagingGroup-1", "phoneNumber": "+15558675309", "extension": "7781", "languageCode": "en_us", "firstName": "John", "lastName": "Doe", "originatorCallerIdEnabled": false, "originators": [ "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YTc2ZmVmNC1mZjlmLTExZWItYWYwZC00M2YwZjY1NTdjYWI", "Y2lzY29zcGFyazovL3VzL1BMQUNFLzU1YjUyZThhLWZmOWYtMTFlYi05ZjRhLTAzZDY1NzdhYzg1Yg", "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg="], "targets": [ "Y2lzY29zcGFyazovL3VzL1BMQUNFLzg0YjQ1OTIyLWZmOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ", "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg="] }