Create a new Paging Group
Create a new Paging Group for the given location.
Group Paging allows 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.
Creating a paging group requires a full administrator or location administrator auth token with a scope of spark-admin:telephony_config_write.
URI Parameters
Create the paging group for this location.
Query Parameters
Create the paging group for this organization.
Body Parameters
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 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, workspace, and virtual lines IDs who can originate pages to this paging group.
An array of people, workspaces and virtual lines IDs will add to a paging group as paging call targets.
Response Properties
ID of the newly created paging group.
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
- Create the paging group for this organization.
Body
- 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 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, workspace, and virtual lines IDs who can originate pages to this paging group.
- An array of people, workspaces and virtual lines IDs will add to a 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="]
}
{
"id": "Y2lzY29zcGFyazovL3VzL1BBR0lOR19HUk9VUC9hSFpoWlROMk1HOHliMEEyTkRrME1USTVOeTVwYm5ReE1DNWlZMnhrTG5kbFltVjRMbU52YlE"
}