Webex · Schema

GetPagingGroupObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name Type Description
id string A unique identifier for the paging group.
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.
tollFreeNumber boolean Flag to indicate toll free number.
language string Paging language. Minimum length is 1. Maximum length is 40.
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, workspaces and virtual lines ID's who may originate pages to this paging group.
targets array An array of people, workspaces and virtual lines ID's 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 Group Paging.
dialByName string The name to be used for dial by name functions.
View JSON Schema on GitHub

JSON Schema

webex-getpaginggroupobject-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetPagingGroupObject",
  "title": "GetPagingGroupObject",
  "type": "object",
  "required": [
    "id",
    "enabled",
    "name",
    "language",
    "languageCode",
    "firstName",
    "lastName",
    "originatorCallerIdEnabled"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL1BBR0lOR19HUk9VUC9hSFpoWlROMk1HOHliMEEyTkRrME1USTVOeTVwYm5ReE1DNWlZMnhrTG5kbFltVjRMbU52YlE",
      "description": "A unique identifier for the paging group."
    },
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not the paging group is enabled."
    },
    "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."
    },
    "tollFreeNumber": {
      "type": "boolean",
      "description": "Flag to indicate toll free number."
    },
    "language": {
      "type": "string",
      "example": "English",
      "description": "Paging language. Minimum length is 1. Maximum length is 40."
    },
    "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": {
        "$ref": "#/components/schemas/GetPagingGroupAgentObject"
      },
      "description": "An array of people, workspaces and virtual lines ID's who may originate pages to this paging group."
    },
    "targets": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GetPagingGroupAgentObject"
      },
      "description": "An array of people, workspaces and virtual lines ID's that are added to 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 Group Paging."
    },
    "dialByName": {
      "type": "string",
      "example": "Hakim Smith",
      "description": "The name to be used for dial by name functions."
    }
  }
}