Webex · Schema

PostPagingGroupObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
name	string	Unique name for the paging group. Minimum length is 1. Maximum length is 30.
phoneNumber	string	Paging group phone number. Minimum length is 1. Maximum length is 23. Either `phoneNumber` or `extension` is mandatory.
extension	string	Paging group extension. Minimum length is 2. Maximum length is 10. Either `phoneNumber` or `extension` is mandatory.
languageCode	string	Language code.
firstName	string	First name that displays when a group page is performed. Minimum length is 1. Maximum length is 64. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead.
lastName	string	Last name that displays when a group page is performed. Minimum length is 1. Maximum length is 64. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead.
originatorCallerIdEnabled	boolean	Determines what is shown on target users caller ID when a group page is performed. If true shows page originator ID.
originators	array	An array of people, workspace, and virtual lines IDs who can originate pages to this paging group.
targets	array	An array of people, workspaces and virtual lines IDs will add to a paging group as paging call targets.
directLineCallerIdName	object	Settings for the direct line caller ID name to be shown for this paging group.
dialByName	string	The name to be used for dial by name functions. Characters of `%`, `+`, `\`, `"` and Unicode characters are not allowed.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PostPagingGroupObject",
  "title": "PostPagingGroupObject",
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "PagingGroup-1",
      "description": "Unique name for the paging group. Minimum length is 1. Maximum length is 30."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+15558675309",
      "description": "Paging group phone number. Minimum length is 1. Maximum length is 23.  Either `phoneNumber` or `extension` is mandatory."
    },
    "extension": {
      "type": "string",
      "example": "7781",
      "description": "Paging group extension. Minimum length is 2. Maximum length is 10.  Either `phoneNumber` or `extension` is mandatory."
    },
    "languageCode": {
      "type": "string",
      "example": "en_us",
      "description": "Language code."
    },
    "firstName": {
      "type": "string",
      "example": "Paging",
      "description": "First name that displays when a group page is performed. Minimum length is 1. Maximum length is 64. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead."
    },
    "lastName": {
      "type": "string",
      "example": "Group",
      "description": "Last name that displays when a group page is performed. Minimum length is 1. Maximum length is 64. This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead."
    },
    "originatorCallerIdEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Determines what is shown on target users caller ID when a group page is performed. If true shows page originator ID."
    },
    "originators": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of people, workspace, and virtual lines IDs who can originate pages to this paging group."
    },
    "targets": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "An array of people, workspaces and virtual lines IDs will add to a paging group as paging call targets."
    },
    "directLineCallerIdName": {
      "$ref": "#/components/schemas/DirectLineCallerIdNameObject",
      "description": "Settings for the direct line caller ID name to be shown for this paging group."
    },
    "dialByName": {
      "type": "string",
      "example": "Hakim Smith",
      "description": "The name to be used for dial by name functions.  Characters of `%`,  `+`, `\\`, `\"` and Unicode characters are not allowed."
    }
  }
}