[Index]
Model ref.: device/spark/CXContactServiceQueue
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": {
"id": {
"type": "string",
"required": false,
"title": "Queue ID",
"description": "Unique identifier for the queue."
},
"active": {
"type": "boolean",
"default": false,
"title": "Active Status",
"description": "Indicates if the queue is active."
},
"name": {
"type": "string",
"title": "Queue Name",
"description": "Name of the queue."
},
"description": {
"type": "string",
"title": "Queue Description",
"description": "Description of the queue."
},
"organizationId": {
"type": "string",
"title": "Organization ID",
"required": false,
"description": "Unique identifier for the organization."
},
"callDistributionGroups": {
"type": "array",
"title": "Call Distribution",
"required": true,
"description": "Groups for call distribution within the queue.",
"items": {
"type": "object",
"properties": {
"agentGroups": {
"type": "array",
"title": "Agent Groups",
"required": true,
"description": "List of agent groups in the call distribution group.",
"items": {
"type": "object",
"properties": {
"teamId": {
"type": "string",
"required": true,
"format": "uri",
"target_attr": "name",
"target": "/api/device/spark/CXTeam/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"convert_to_primary_key": true,
"title": "Team ID",
"description": "Identifier for the team.",
"target_model_type": "device/spark/CXTeam",
"choices": []
}
}
}
},
"duration": {
"type": "integer",
"title": "Duration",
"required": true,
"minimum": 0,
"description": "Duration for this group in seconds."
},
"order": {
"type": "integer",
"title": "Order",
"required": true,
"minimum": 1,
"description": "Order of the call distribution group."
}
}
}
},
"channelType": {
"type": "string",
"title": "Channel Type",
"required": true,
"description": "The type of channel for the queue.",
"choices": [
{
"title": "Chat",
"value": "CHAT"
},
{
"title": "Email",
"value": "EMAIL"
},
{
"title": "Social Channel",
"value": "SOCIAL_CHANNEL"
},
{
"title": "Telephony",
"value": "TELEPHONY"
}
]
},
"checkAgentAvailability": {
"type": "boolean",
"default": false,
"title": "Check Agent Availability",
"description": "Whether to check agent availability."
},
"controlFlowScriptUrl": {
"type": "string",
"title": "Control Flow Script URL",
"description": "URL for the control flow script."
},
"ivrRequeueUrl": {
"type": "string",
"title": "IVR Requeue URL",
"description": "URL for IVR requeue."
},
"defaultMusicInQueueMediaFileId": {
"type": "string",
"title": "Music In Queue Media File Id",
"description": "Music In Queue Media File Id.",
"format": "uri",
"target_attr": "name",
"target": "/api/device/spark/CXAudioFile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"convert_to_primary_key": true,
"target_model_type": "device/spark/CXAudioFile",
"choices": []
},
"imiOrgType": {
"type": "string",
"title": "IMI Org Type",
"default": "IMI",
"description": "Type of the IMI organization",
"choices": [
{
"title": "Imi",
"value": "IMI"
},
{
"title": "Mixed Mode",
"value": "MIXED_MODE"
}
]
},
"maxActiveContacts": {
"type": "integer",
"required": false,
"title": "Maximum Active Contacts",
"minimum": 0,
"description": "Maximum number of active contacts allowed in the queue."
},
"maxTimeInQueue": {
"type": "integer",
"required": true,
"title": "Maximum Time in Queue",
"minimum": 0,
"description": "Maximum time a contact can spend in the queue in hours if Channel Type is EMAIL else it is seconds."
},
"monitoringPermitted": {
"type": "boolean",
"default": false,
"title": "Monitoring Permitted",
"description": "Indicates if monitoring is permitted."
},
"outdialCampaignEnabled": {
"type": "boolean",
"default": false,
"title": "Outdial Campaign",
"description": "Outdial Campaign will enable you to set-up your Contact Center for Outdial Calls."
},
"overflowNumber": {
"type": "string",
"title": "Overflow Number",
"pattern": "^\\+\\d{10,15}$",
"description": "Overflow phone number in E.164 format."
},
"parkingPermitted": {
"type": "boolean",
"default": false,
"title": "Parking Permitted",
"description": "Indicates if parking is permitted."
},
"pauseRecordingPermitted": {
"type": "boolean",
"default": false,
"title": "Pause Recording Permitted",
"description": "Indicates if pausing recording is permitted."
},
"queueType": {
"type": "string",
"required": true,
"title": "Queue Type",
"description": "Type of the queue.",
"choices": [
{
"title": "Inbound",
"value": "INBOUND"
},
{
"title": "Outbound",
"value": "OUTBOUND"
}
]
},
"recordingAllCallsPermitted": {
"type": "boolean",
"default": false,
"title": "Record All Calls Permitted",
"description": "Indicates if recording all calls is permitted."
},
"recordingPauseDuration": {
"type": "integer",
"title": "Recording Pause Duration",
"description": "Maximum pause duration for recordings in seconds."
},
"recordingPermitted": {
"type": "boolean",
"default": false,
"title": "Recording Permitted",
"description": "Indicates if recording is permitted."
},
"routingType": {
"type": "string",
"required": true,
"title": "Queue Routing Type",
"description": "Routing strategy for the queue.",
"choices": [
{
"title": "Longest Available Agent",
"value": "LONGEST_AVAILABLE_AGENT"
},
{
"title": "Skills Based",
"value": "SKILLS_BASED"
}
]
},
"serviceLevelThreshold": {
"type": "integer",
"required": false,
"title": "Service Level Threshold",
"minimum": 0,
"description": "Service level threshold in hours if Channel Type is EMAIL else it is seconds."
},
"skillBasedRoutingType": {
"type": "string",
"title": "Skill-Based Routing Type",
"description": "Type of skill-based routing.",
"choices": [
{
"title": "Best Available Agent",
"value": "BEST_AVAILABLE_AGENT"
},
{
"title": "Longest Available Agent",
"value": "LONGEST_AVAILABLE_AGENT"
}
]
},
"socialChannelType": {
"type": "string",
"title": "Social Channel Type",
"description": "Type of social channel.",
"choices": [
{
"title": "MessageBird",
"value": "MESSAGEBIRD"
},
{
"title": "Messenger",
"value": "MESSENGER"
},
{
"title": "WhatsApp",
"value": "WHATSAPP"
}
]
},
"subscriptionId": {
"type": "string",
"title": "Subscription ID",
"description": "Unique identifier for the subscription."
},
"timezone": {
"type": "string",
"title": "Timezone",
"description": "Timezone of the queue."
},
"xspVersion": {
"type": "string",
"title": "XSP Version",
"description": "Version of the XSP system."
},
"vendorId": {
"type": "string",
"title": "Vendor ID",
"description": "Identifier for the vendor."
},
"createdTime": {
"type": "string",
"title": "Created Time",
"description": "Timestamp when the queue was created."
},
"lastUpdatedTime": {
"type": "string",
"title": "Last Updated Time",
"description": "Timestamp when the queue was last updated."
}
},
"schema_version": "1.0.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/spark/CXContactServiceQueue/add/ |
|
The GUI Add form of device/spark/CXContactServiceQueue 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/device/spark/CXContactServiceQueue | 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/device/spark/CXContactServiceQueue/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/spark/CXContactServiceQueue/[pkid1]", "/api/device/spark/CXContactServiceQueue/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/spark/CXContactServiceQueue/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/spark/CXContactServiceQueue/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/spark/CXContactServiceQueue/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/spark/CXContactServiceQueue/[pkid1]", "/api/v0/device/spark/CXContactServiceQueue/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/spark/CXContactServiceQueue/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/spark/CXContactServiceQueue |
|
{"hrefs": ["/api/device/spark/CXContactServiceQueue/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/spark/CXContactServiceQueue |
|
{"hrefs": ["/api/device/spark/CXContactServiceQueue/[pkid1]", "/api/device/spark/CXContactServiceQueue/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/spark/CXContactServiceQueue; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/spark/CXContactServiceQueue/export/ |
|
{ "hrefs":["/api/device/spark/CXContactServiceQueue/[pkid1]", "/api/device/spark/CXContactServiceQueue/[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 device/spark/CXContactServiceQueue and the JSON format can be used to import instances of device/spark/CXContactServiceQueue.
GET http://[host-proxy]/api/device/spark/CXContactServiceQueue/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/spark/CXContactServiceQueue | POST | /api/device/spark/CXContactServiceQueue/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/device/spark/CXContactServiceQueue/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag Version | PATCH | /api/device/spark/CXContactServiceQueue/+tag_version/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/spark/CXContactServiceQueue/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/spark/CXContactServiceQueue/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/device/spark/CXContactServiceQueue/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/spark/CXContactServiceQueue/ |
|
The device/spark/CXContactServiceQueue schema and all instances as JSON. |
(The list will return 0 to 3 device/spark/CXContactServiceQueue instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/device/spark/CXContactServiceQueue/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"list"
],
"meta": {
"model_type": "device/spark/CXContactServiceQueue",
"summary_attrs": [
{
"name": "name",
"title": "Queue Name"
},
{
"name": "description",
"title": "Queue Description"
},
{
"name": "active",
"title": "Active Status"
},
{
"name": "channelType",
"title": "Channel Type"
},
{
"name": "queueType",
"title": "Queue Type"
},
{
"name": "timezone",
"title": "Timezone"
},
{
"name": "createdTime",
"title": "Created Time"
},
{
"name": "lastUpdatedTime",
"title": "Last Updated Time"
},
{
"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": []
},
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"move",
"clone",
"export",
"export_bulkload_template",
"bulk_update_form",
"configuration_template",
"field_display_policy",
"help",
"migration",
"transform",
"tag",
"tag_version"
],
"schema_version": "1.0.0",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/device/spark/CXContactServiceQueue/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/device/spark/CXContactServiceQueue/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/spark/CXContactServiceQueue/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/spark/CXContactServiceQueue",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/spark/CXContactServiceQueue/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/device/spark/CXContactServiceQueue/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/device/spark/CXContactServiceQueue/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"method": "PATCH",
"class": "tag_version",
"href": "/api/device/spark/CXContactServiceQueue/+tag_version/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag Version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/spark/CXContactServiceQueue/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/spark/CXContactServiceQueue/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"migration": {
"method": "GET",
"class": "migration",
"href": "/api/device/spark/CXContactServiceQueue/migration/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Migration Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/spark/CXContactServiceQueue/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/spark/CXContactServiceQueue/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/spark/CXContactServiceQueue/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
},
{
"transform": {
"method": "GET",
"class": "transform",
"href": "/api/device/spark/CXContactServiceQueue/transform/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Transform Template"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/spark/CXContactServiceQueue. | GET | /api/device/spark/CXContactServiceQueue/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/spark/CXContactServiceQueue as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/spark/CXContactServiceQueue/purge/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Transform Template | GET | /api/device/spark/CXContactServiceQueue/transform/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/spark/CXContactServiceQueue/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/device/spark/CXContactServiceQueue/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/spark/CXContactServiceQueue/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/spark/CXContactServiceQueue/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/spark/CXContactServiceQueue | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of device/spark/CXContactServiceQueue; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/spark/CXContactServiceQueue/[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 device/spark/CXContactServiceQueue and the JSON format can be used to import instances of device/spark/CXContactServiceQueue.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/device/spark/CXContactServiceQueue/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/spark/CXContactServiceQueue/[pkid] | hierarchy=[hierarchy] | The device/spark/CXContactServiceQueue instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/spark/CXContactServiceQueue/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/spark/CXContactServiceQueue. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/spark/CXContactServiceQueue/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |