Webex · Schema

CreateHuntGroupObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
name	string	Unique name for the hunt group.
phoneNumber	string	Primary phone number of the hunt group. Either phone number or extension are required.
extension	string	Primary phone extension of the hunt group. Either phone number or extension are required.
languageCode	string	Language code.
firstName	string	First name to be shown when calls are forwarded out of this hunt 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 hunt group. Defaults to the phone number if set, otherwise defaults to call group name. This field has been deprecated. Please use `directLin
timeZone	string	Time zone for the hunt group.
callPolicies	object	Policy controlling how calls are routed to agents.
agents	array	People, workspaces and virtual lines that are eligible to receive calls.
enabled	boolean	Whether or not the hunt group is enabled.
huntGroupCallerIdForOutgoingCallsEnabled	boolean	Enable the hunt group to be used as the caller ID when the agent places outgoing calls. When set to true the hunt group's caller ID will be used.
directLineCallerIdName	object	Settings for the direct line caller ID name to be shown for this hunt 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/CreateHuntGroupObject",
  "title": "CreateHuntGroupObject",
  "type": "object",
  "required": [
    "name",
    "callPolicies",
    "agents",
    "enabled"
  ],
  "properties": {
    "name": {
      "type": "string",
      "example": "5558675309-Group",
      "description": "Unique name for the hunt group."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+15558675309",
      "description": "Primary phone number of the hunt group. Either phone number or extension are required."
    },
    "extension": {
      "type": "string",
      "example": "7781",
      "description": "Primary phone extension of the hunt group. Either phone number or extension are required."
    },
    "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 hunt 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 hunt 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."
    },
    "timeZone": {
      "type": "string",
      "example": "America/Chicago",
      "description": "Time zone for the hunt group."
    },
    "callPolicies": {
      "$ref": "#/components/schemas/PostHuntGroupCallPolicyObject",
      "description": "Policy controlling how calls are routed to agents."
    },
    "agents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/PostPersonPlaceVirtualLineHuntGroupObject"
      },
      "description": "People, workspaces and virtual lines that are eligible to  receive calls."
    },
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not the hunt group is enabled."
    },
    "huntGroupCallerIdForOutgoingCallsEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Enable the hunt group to be used as the caller ID when the agent places outgoing calls. When set to true the hunt group's caller ID will be used."
    },
    "directLineCallerIdName": {
      "$ref": "#/components/schemas/DirectLineCallerIdNameObject",
      "description": "Settings for the direct line caller ID name to be shown for this hunt 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."
    }
  }
}