[Index]
Webex Calling hunt groups
Model ref.: relation/WebexHuntGroup
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"hg_id": {
"title": "hg_key",
"type": "string"
},
"id": {
"title": "id",
"type": "string"
},
"locationId": {
"title": "locationId",
"type": "string"
},
"locationName": {
"title": "locationName",
"type": "string"
},
"name": {
"title": "Name",
"type": "string",
"required": true
},
"enabled": {
"title": "Enabled",
"type": "boolean"
},
"phoneNumber": {
"title": "Phone Number",
"type": "string"
},
"extension": {
"title": "Extension",
"type": "string"
},
"alternateNumberSettings": {
"title": "Alternate Number Settings",
"description": "Alternate Number Settings",
"required": false,
"type": "object",
"properties": {
"alternateNumbers": {
"type": "array",
"title": "Alternate Numbers",
"items": {
"type": "object",
"properties": {
"phoneNumber": {
"type": "string",
"title": "Phone Number",
"description": "phoneNumber"
},
"ringPattern": {
"type": "string",
"title": "Ring Pattern",
"description": "ringPattern",
"required": true,
"choices": [
{
"title": "NORMAL",
"value": "NORMAL"
},
{
"title": "LONG_LONG",
"value": "LONG_LONG"
},
{
"title": "SHORT_SHORT_LONG",
"value": "SHORT_SHORT_LONG"
},
{
"title": "SHORT_LONG_SHORT",
"value": "SHORT_LONG_SHORT"
}
]
},
"tollFreeNumber": {
"type": "boolean",
"title": "TollFree Number",
"description": "tollFreeNumber"
}
}
}
},
"distinctiveRingEnabled": {
"type": "boolean",
"title": "Distinctive Ring Enabled",
"description": "distinctiveRingEnabled"
}
}
},
"language": {
"title": "Language",
"type": "string"
},
"languageCode": {
"title": "Language Code",
"type": "string"
},
"firstName": {
"title": "First Name",
"type": "string"
},
"lastName": {
"title": "Last Name",
"type": "string"
},
"timeZone": {
"title": "Time Zone",
"type": "string"
},
"callPolicies": {
"title": "Call Policies",
"description": "Call Policy settings",
"type": "object",
"properties": {
"policy": {
"type": "string",
"title": "Policy",
"required": true,
"description": "policy",
"choices": [
{
"title": "CIRCULAR",
"value": "CIRCULAR"
},
{
"title": "REGULAR",
"value": "REGULAR"
},
{
"title": "SIMULTANEOUS",
"value": "SIMULTANEOUS"
},
{
"title": "UNIFORM",
"value": "UNIFORM"
},
{
"title": "WEIGHTED",
"value": "WEIGHTED"
}
]
},
"waitingEnabled": {
"type": "boolean",
"title": "Waiting Enabled",
"description": "waitingEnabled"
},
"groupBusyEnabled": {
"type": "boolean",
"title": "Group Busy Enabled",
"description": "Group Busy Enabled"
},
"allowMembersToControlGroupBusyEnabled": {
"type": "boolean",
"title": "Allow Members To Control Group Busy Enabled",
"description": "Allow Members To Control Group Busy Enabled"
},
"noAnswer": {
"title": "No Answer",
"description": "No Answer",
"required": false,
"type": "object",
"properties": {
"nextAgentEnabled": {
"type": "boolean",
"title": "Next Agent Enabled",
"description": "nextAgentEnabled"
},
"nextAgentRings": {
"type": "integer",
"title": "Next Agent Rings",
"description": "nextAgentRings"
},
"forwardEnabled": {
"type": "boolean",
"title": "Forward Enabled",
"description": "forwardEnabled"
},
"destination": {
"type": "string",
"title": "Destination",
"description": "destination"
},
"numberOfRings": {
"type": "integer",
"title": "Number Of Rings",
"description": "numberOfRings"
},
"systemMaxNumberOfRings": {
"type": "integer",
"title": "System Max Number Of Rings",
"description": "systemMaxNumberOfRings"
},
"destinationVoicemailEnabled": {
"type": "boolean",
"title": "Destination Voicemail Enabled",
"description": "destinationVoicemailEnabled"
}
}
},
"busyRedirect": {
"title": "Busy Redirect",
"description": "Busy Redirect",
"required": false,
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "enabled"
},
"destination": {
"type": "string",
"title": "Destination",
"description": "destination"
},
"destinationVoicemailEnabled": {
"type": "boolean",
"title": "Destination Voicemail Enabled",
"description": "destinationVoicemailEnabled"
}
}
},
"businessContinuityRedirect": {
"title": "Business Continuity Redirect",
"description": "Business Continuity",
"required": false,
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "enabled"
},
"destination": {
"type": "string",
"title": "Destination",
"description": "destination"
},
"destinationVoicemailEnabled": {
"type": "boolean",
"title": "Destination Voicemail Enabled",
"description": "destinationVoicemailEnabled"
}
}
}
}
},
"agents": {
"title": "Agents",
"description": "Agents",
"required": false,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"title": "id",
"description": "id",
"format": "uri",
"target_attr": "email",
"target": "/api/device/spark/User/choices/?field=email&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"convert_to_primary_key": true,
"target_model_type": "device/spark/User",
"choices": []
},
"phoneNumber": {
"type": "string",
"title": "Phone Number",
"description": "Phone Number",
"readonly": true
},
"extension": {
"type": "string",
"title": "Extension",
"description": "Extension",
"readonly": true
},
"type": {
"type": "string",
"title": "Type",
"description": "type",
"readonly": true
},
"firstName": {
"type": "string",
"title": "First Name",
"description": "First Name",
"readonly": true
},
"lastName": {
"type": "string",
"title": "Last Name",
"description": "Last Name",
"readonly": true
},
"weight": {
"type": "string",
"title": "Weight",
"description": "Weight"
}
}
}
},
"callForwarding": {
"title": "Call Forwarding Settings",
"description": "Call Forwarding Settings",
"required": false,
"type": "object",
"properties": {
"always": {
"title": "Always",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "enabled"
},
"ringReminderEnabled": {
"type": "boolean",
"title": "Ring Reminder Enabled",
"description": "ringReminderEnabled"
},
"destinationVoiceMailEnabled": {
"type": "boolean",
"title": "Send To Voicemail Enabled",
"description": "destinationVoiceMailEnabled"
},
"destination": {
"type": "string",
"title": "Destination",
"description": "destination"
}
}
},
"selective": {
"title": "Selective",
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "enabled"
},
"ringReminderEnabled": {
"type": "boolean",
"title": "Ring Reminder Enabled",
"description": "ringReminderEnabled"
},
"destinationVoiceMailEnabled": {
"type": "boolean",
"title": "Send To Voicemail Enabled",
"description": "destinationVoiceMailEnabled"
},
"destination": {
"type": "string",
"title": "Destination",
"description": "destination"
}
}
},
"rules": {
"title": "Rules",
"description": "rules",
"required": false,
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "name"
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "enabled"
},
"id": {
"type": "string",
"title": "id",
"description": "id"
},
"holidaySchedule": {
"type": "string",
"title": "Holiday Schedule",
"description": "holidaySchedule"
},
"businessSchedule": {
"type": "string",
"title": "Business Schedule",
"description": "businessSchedule"
},
"forwardTo": {
"type": "object",
"title": "Forward To",
"description": "forwardTo",
"properties": {
"selection": {
"type": "string",
"title": "Selection",
"description": "selection",
"choices": [
{
"title": "FORWARD_TO_DEFAULT_NUMBER",
"value": "FORWARD_TO_DEFAULT_NUMBER"
},
{
"title": "FORWARD_TO_SPECIFIED_NUMBER",
"value": "FORWARD_TO_SPECIFIED_NUMBER"
},
{
"title": "DO_NOT_FORWARD",
"value": "DO_NOT_FORWARD"
}
]
},
"phoneNumber": {
"type": "string",
"title": "Phone Number",
"description": "phoneNumber"
}
}
},
"callsFrom": {
"type": "object",
"title": "Calls From",
"description": "callsFrom",
"properties": {
"selection": {
"type": "string",
"title": "selection",
"description": "selection",
"choices": [
{
"title": "ANY",
"value": "ANY"
},
{
"title": "CUSTOM",
"value": "CUSTOM"
}
]
},
"customNumbers": {
"type": "object",
"title": "Custom Numbers",
"description": "customNumbers",
"properties": {
"privateNumberEnabled": {
"type": "boolean",
"title": "Any Private Numbers ",
"description": "privateNumberEnabled"
},
"unavailableNumberEnabled": {
"type": "boolean",
"title": "Any Unavailable Numbers",
"description": "unavailableNumberEnabled"
},
"numbers": {
"type": "array",
"title": "Numbers",
"items": {
"type": "string"
}
}
}
}
}
},
"callsTo": {
"type": "object",
"title": "Calls To",
"description": "callsTo",
"properties": {
"numbers": {
"title": "Calls To Numbers",
"description": "Array of numbers to be matched against the calling destination number",
"required": false,
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"title": "Type",
"description": "Indicates that the given phoneNumber or extension associated with this rule's containing object is a primary or alternate number",
"choices": [
{
"title": "PRIMARY",
"value": "PRIMARY"
},
{
"title": "ALTERNATE",
"value": "ALTERNATE"
}
]
},
"phoneNumber": {
"type": "string",
"title": "Phone Number",
"description": "Only return call queues with matching primary phone number or extension"
},
"extension": {
"type": "string",
"title": "Extension",
"description": "Primary phone extension of the call queue."
}
}
}
}
}
}
}
}
}
}
},
"noinstance": {
"title": "Noinstance",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"maxItems": 1
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/WebexHuntGroup/add/ |
|
The GUI Add form of relation/WebexHuntGroup as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/relation/WebexHuntGroup | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/WebexHuntGroup/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/WebexHuntGroup/[pkid1]", "/api/relation/WebexHuntGroup/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/WebexHuntGroup/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/WebexHuntGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/WebexHuntGroup/export/ |
|
{ "hrefs":["/api/relation/WebexHuntGroup/[pkid1]", "/api/relation/WebexHuntGroup/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of relation/WebexHuntGroup and the JSON format can be used to import instances of relation/WebexHuntGroup.
GET http://[host-proxy]/api/relation/WebexHuntGroup/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/WebexHuntGroup | POST | /api/relation/WebexHuntGroup/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/WebexHuntGroup/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/WebexHuntGroup/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/WebexHuntGroup/ |
|
The relation/WebexHuntGroup schema and all instances as JSON. |
(The list will return 0 to 3 relation/WebexHuntGroup instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/WebexHuntGroup/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"remove",
"add",
"clone",
"export",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/WebexHuntGroup",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "enabled",
"title": "Enabled"
},
{
"name": "phoneNumber",
"title": "Phone Number"
},
{
"name": "extension",
"title": "Extension"
},
{
"name": "firstName",
"title": "First Name"
},
{
"name": "lastName",
"title": "Last Name"
},
{
"name": "locationName",
"title": "locationName"
},
{
"name": "callPolicies.policy",
"title": "Policy",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "language",
"title": "Language"
},
{
"name": "timeZone",
"title": "Time Zone"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/WebexHuntGroup/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"field_display_policy",
"get",
"configuration_template",
"update",
"remove",
"add",
"clone",
"export",
"export_bulkload_template"
],
"schema_version": null,
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/WebexHuntGroup/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/WebexHuntGroup/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/WebexHuntGroup/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/WebexHuntGroup/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/relation/WebexHuntGroup/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/relation/WebexHuntGroup/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/WebexHuntGroup/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/WebexHuntGroup/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/WebexHuntGroup/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/WebexHuntGroup/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/WebexHuntGroup/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/WebexHuntGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/WebexHuntGroup/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of relation/WebexHuntGroup and the JSON format can be used to import instances of relation/WebexHuntGroup.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/WebexHuntGroup/[pkid] | hierarchy=[hierarchy] | The relation/WebexHuntGroup instance with [pkid]. |