Webex · Schema

GetHuntGroupObject

CallingCollaborationCommunicationEnterpriseMessagingVideo Conferencing

Properties

Name	Type	Description
id	string	A unique identifier for the hunt group.
name	string	Unique name for the hunt group.
enabled	boolean	Whether or not the hunt group is enabled.
phoneNumber	string	Primary phone number of the hunt group.
extension	string	Extension of the hunt group.
distinctiveRing	boolean	Whether or not the hunt group has the distinctive ring option enabled.
alternateNumbers	array	The alternate numbers feature allows you to assign multiple phone numbers or extensions to a hunt group. Each number will reach the same greeting and each menu will function identically to the main nu
language	string	Language for hunt group.
languageCode	string	Language code for hunt group.
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 phone number if set, otherwise defaults to call group name. This field has been deprecated. Please use `directLineCal
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.
huntGroupCallerIdForOutgoingCallsEnabled	boolean	Whether or not the hunt group can be used as the caller ID when the agent places outgoing calls.
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.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/GetHuntGroupObject",
  "title": "GetHuntGroupObject",
  "type": "object",
  "required": [
    "id",
    "name",
    "enabled",
    "distinctiveRing",
    "alternateNumbers",
    "callPolicies",
    "agents"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
      "description": "A unique identifier for the hunt group."
    },
    "name": {
      "type": "string",
      "example": "5558675309-Group",
      "description": "Unique name for the hunt group."
    },
    "enabled": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not the hunt group is enabled."
    },
    "phoneNumber": {
      "type": "string",
      "example": "+15558675309",
      "description": "Primary phone number of the hunt group."
    },
    "extension": {
      "type": "string",
      "example": "7781",
      "description": "Extension of the hunt group."
    },
    "distinctiveRing": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not the hunt group has the distinctive ring option enabled."
    },
    "alternateNumbers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AlternateNumbersWithPattern"
      },
      "description": "The alternate numbers feature allows you to assign multiple phone numbers or extensions to a hunt group. Each number will reach the same greeting and each menu will function identically to the main number. The alternate numbers option enables you to have up to ten (10) phone numbers ring into the hunt group."
    },
    "language": {
      "type": "string",
      "example": "English",
      "description": "Language for hunt group."
    },
    "languageCode": {
      "type": "string",
      "example": "en-US",
      "description": "Language code for hunt group."
    },
    "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 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/GetHuntGroupCallPolicyObject",
      "description": "Policy controlling how calls are routed to agents."
    },
    "agents": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/GetPersonPlaceVirtualLineHuntGroupObject"
      },
      "description": "People, workspaces and virtual lines that are eligible to  receive calls."
    },
    "huntGroupCallerIdForOutgoingCallsEnabled": {
      "type": "boolean",
      "example": true,
      "description": "Whether or not the hunt group can be used as the caller ID when the agent places outgoing calls."
    },
    "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."
    }
  }
}