Webex · Schema

UpdatePagingGroupObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
enabled	boolean	Whether or not the paging group is enabled.
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 to be shown when calls are forwarded out of this paging group. Defaults to ".". This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead.
lastName	string	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. This field has been deprecated. Please use `directL
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 and/or workspaces, who may originate pages to this paging group.
targets	array	People, including workspaces, that are added to 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	Sets or clears the name to be used for dial by name functions. To clear the `dialByName`, the attribute must be set to null or empty string. Characters of `%`, `+`, `\`, `"` and Unicode characters are

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdatePagingGroupObject",
  "title": "UpdatePagingGroupObject",
  "type": "object",
  "properties": {
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not the paging group is enabled."
    },
    "name": {
      "type": "string",
      "example": "CallQueue-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": "Hakim",
      "description": "First name to be shown when calls are forwarded out of this paging group. Defaults to \".\". This field has been deprecated. Please use `directLineCallerIdName` and `dialByName` instead."
    },
    "lastName": {
      "type": "string",
      "example": "Smith",
      "description": "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. 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 and/or workspaces, who may originate pages to this paging group."
    },
    "targets": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "People, including workspaces, that are added to paging group as paging call targets."
    },
    "directLineCallerIdName": {
      "$ref": "#/components/schemas/DirectLineCallerIdNameObjectForPut",
      "description": "Settings for the direct line caller ID name to be shown for this paging group."
    },
    "dialByName": {
      "type": "string",
      "example": "Hakim Smith",
      "description": "Sets or clears the name to be used for dial by name functions. To clear the `dialByName`, the attribute must be set to null or empty string. Characters of `%`,  `+`, `\\`, `\"` and Unicode characters are not allowed."
    }
  }
}