[Index]

API Reference for relation/WebexCXChannel

This relation implements the workflows to manage Webex Contact Center Channels.

Model ref.: relation/WebexCXChannel

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For [auth_token]:
1. The VOSS portal will extract the [auth_token] from the URLs and send these as an Authorization header.
2. Model schemas show that the auth_token parameter is still supported.

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/relation/WebexCXChannel/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "id": {
               "type": "string",
               "title": "ID",
               "description": "Unique identifier for the schema"
          },
          "active": {
               "type": "boolean",
               "title": "Active Status",
               "description": "Indicates if the schema is active",
               "default": false
          },
          "name": {
               "type": "string",
               "title": "Plan Name",
               "description": "Name of the plan"
          },
          "description": {
               "type": "string",
               "title": "Description",
               "description": "Description of the plan"
          },
          "organizationId": {
               "type": "string",
               "title": "Organization ID",
               "description": "Unique identifier for the organization"
          },
          "version": {
               "type": "integer",
               "title": "Version",
               "description": "Version number of the schema"
          },
          "entryPointType": {
               "type": "string",
               "required": true,
               "title": "Entry Point Type",
               "description": "Type of the entry point",
               "choices": [
                    {
                         "title": "Inbound",
                         "value": "INBOUND"
                    },
                    {
                         "title": "Outbound",
                         "value": "OUTBOUND"
                    }
               ]
          },
          "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"
                    }
               ]
          },
          "socialChannelType": {
               "type": "string",
               "title": "Social Channel Type",
               "description": "Type of social channel.",
               "choices": [
                    {
                         "title": "MessageBird",
                         "value": "MESSAGEBIRD"
                    },
                    {
                         "title": "Messenger",
                         "value": "MESSENGER"
                    }
               ]
          },
          "serviceLevelThreshold": {
               "type": "integer",
               "title": "Service Level Threshold",
               "min": 1,
               "description": "Service level threshold"
          },
          "maximumActiveContacts": {
               "type": "integer",
               "title": "Maximum Active Contacts",
               "description": "Maximum number of active contacts"
          },
          "controlFlowScriptUrl": {
               "type": "string",
               "title": "Control Flow Script URL",
               "description": "URL for the control flow script"
          },
          "overflowNumber": {
               "type": "string",
               "title": "Overflow Number",
               "description": "Overflow phone number"
          },
          "flowId": {
               "type": "string",
               "title": "Flow ID",
               "description": "ID of the flow",
               "format": "uri",
               "target_attr": "name",
               "target": "/api/device/spark/CXFlow/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
               "convert_to_primary_key": true,
               "target_model_type": "device/spark/CXFlow",
               "choices": []
          },
          "flowTagId": {
               "type": "string",
               "title": "Flow Tag ID",
               "description": "ID of the flow tag"
          },
          "timezone": {
               "type": "string",
               "title": "Timezone",
               "description": "Timezone of the plan"
          },
          "imiOrgType": {
               "type": "string",
               "default": "",
               "title": "IMI Org Type",
               "description": "Type of the IMI organization",
               "choices": [
                    {
                         "title": "Imi",
                         "value": "IMI"
                    },
                    {
                         "title": "Mixed Mode",
                         "value": "MIXED_MODE"
                    }
               ]
          },
          "assetId": {
               "type": "string",
               "title": "Asset ID",
               "description": "Unique identifier for the asset"
          },
          "outdialQueueId": {
               "type": "string",
               "title": "Outdial Queue ID",
               "description": "Unique identifier for the outdial queue"
          },
          "dnEpMappingCount": {
               "type": "integer",
               "title": "DN EP Mapping Count",
               "description": "Number of DN EP mappings"
          },
          "musicOnHoldId": {
               "type": "string",
               "title": "Music On Hold ID",
               "description": "Unique identifier for the music on hold",
               "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": []
          },
          "xspVersion": {
               "type": "string",
               "title": "XSP Version",
               "description": "Version of the XSP system"
          },
          "subscriptionId": {
               "type": "string",
               "title": "Subscription ID",
               "description": "Unique identifier for the subscription"
          },
          "routePointId": {
               "type": "string",
               "title": "Route Point ID",
               "description": "Unique identifier for the route point"
          },
          "systemDefault": {
               "type": "boolean",
               "title": "System Default",
               "description": "Indicates if the plan is a system default",
               "default": false
          },
          "outdialTransferToQueueEnabled": {
               "type": "boolean",
               "title": "Outdial Transfer To Queue Enabled",
               "description": "Indicates if outdial transfer to queue is enabled",
               "default": false
          },
          "createdTime": {
               "type": "string",
               "title": "Created Time",
               "description": "Timestamp when the schema was created"
          },
          "lastUpdatedTime": {
               "type": "string",
               "title": "Last Updated Time",
               "description": "Timestamp when the schema was last updated"
          },
          "dialNumber": {
               "title": "Dial Number",
               "type": "array",
               "items": {
                    "type": "object",
                    "properties": {
                         "dialledNumber": {
                              "type": "string",
                              "description": "Dialled phone number",
                              "title": "Support Number"
                         },
                         "id": {
                              "type": "string",
                              "description": "Unique identifier for the record",
                              "title": "Record ID"
                         },
                         "organizationId": {
                              "type": "string",
                              "description": "Unique identifier for the organization",
                              "title": "Organization ID"
                         },
                         "version": {
                              "type": "integer",
                              "description": "Version number of the record",
                              "title": "Version"
                         },
                         "routePointId": {
                              "type": "string",
                              "description": "Unique identifier for the route point",
                              "title": "Route Point"
                         },
                         "entryPointId": {
                              "type": "string",
                              "description": "Unique identifier for the entry point",
                              "title": "Entry Point"
                         },
                         "entryPointName": {
                              "type": "string",
                              "description": "Name of the entry point",
                              "title": "Entry Point Name"
                         },
                         "defaultAni": {
                              "type": "boolean",
                              "description": "Indicates if the default ANI is used",
                              "title": "Default ANI"
                         },
                         "location": {
                              "type": "string",
                              "description": "Unique identifier for the location",
                              "title": "Webex Calling location"
                         },
                         "location_node": {
                              "type": "string",
                              "description": "Location Node ID",
                              "title": "Location Node ID"
                         },
                         "regionId": {
                              "type": "string",
                              "description": "Unique identifier for the region",
                              "title": "PSTN Region"
                         },
                         "createdTime": {
                              "type": "string",
                              "readonly": true,
                              "description": "Timestamp when the record was created",
                              "title": "Created Time"
                         },
                         "lastUpdatedTime": {
                              "type": "string",
                              "readonly": true,
                              "description": "Timestamp when the record was last updated",
                              "title": "Last Updated Time"
                         }
                    }
               }
          }
     },
     "schema_version": "0.6"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/relation/WebexCXChannel/add/	hierarchy=[hierarchy] format=json	The GUI Add form of relation/WebexCXChannel 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/WebexCXChannel	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

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/WebexCXChannel/	hierarchy=[hierarchy]	{"hrefs":["/api/relation/WebexCXChannel/[pkid1]", "/api/relation/WebexCXChannel/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: relation/WebexCXChannel
```
GET http://[host-proxy]/api/relation/WebexCXChannel/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=relation/WebexCXChannel	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/relation/WebexCXChannel/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=relation/WebexCXChannel	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/relation/WebexCXChannel/[pkid1]", "/api/relation/WebexCXChannel/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/relation/WebexCXChannel/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/WebexCXChannel; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/relation/WebexCXChannel/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/relation/WebexCXChannel/[pkid1]", "/api/relation/WebexCXChannel/[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/WebexCXChannel and the JSON format can be used to import instances of relation/WebexCXChannel.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for relation/WebexCXChannel:

 GET http://[host-proxy]/api/relation/WebexCXChannel/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for relation/WebexCXChannel	POST	/api/relation/WebexCXChannel/export_bulkload_template/	hierarchy=[hierarchy] modeltype=relation/WebexCXChannel	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/relation/WebexCXChannel/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/relation/WebexCXChannel/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/relation/WebexCXChannel/	hierarchy=[hierarchy] format=json schema=true	The relation/WebexCXChannel schema and all instances as JSON.

(The list will return 0 to 3 relation/WebexCXChannel instances)

GET http://[host]/api/relation/WebexCXChannel/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "name",
          "direction": "asc",
          "current": "/api/relation/WebexCXChannel/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
     },
     "operations": [
          "remove",
          "list",
          "get",
          "add",
          "export",
          "bulk_update",
          "export_bulkload_template",
          "configuration_template",
          "help",
          "update",
          "move",
          "field_display_policy"
     ],
     "meta": {
          "model_type": "relation/WebexCXChannel",
          "summary_attrs": [
               {
                    "name": "name",
                    "title": "Plan Name"
               },
               {
                    "name": "active",
                    "title": "Active Status"
               },
               {
                    "name": "entryPointType",
                    "title": "Entry Point Type"
               },
               {
                    "name": "channelType",
                    "title": "Channel Type"
               },
               {
                    "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": [],
               "self": [
                    {
                         "href": "/api/relation/WebexCXChannel/None/",
                         "pkid": null
                    }
               ]
          },
          "model_specific_actions": [
               "remove",
               "get",
               "add",
               "list",
               "export",
               "export_bulkload_template",
               "configuration_template",
               "help",
               "update",
               "move",
               "field_display_policy"
          ],
          "schema_version": "0.6",
          "actions": [
               {
                    "add": {
                         "method": "GET",
                         "class": "add",
                         "href": "/api/relation/WebexCXChannel/add/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Add"
                    }
               },
               {
                    "remove": {
                         "method": "DELETE",
                         "class": "delete",
                         "href": "/api/relation/WebexCXChannel/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Delete"
                    }
               },
               {
                    "move": {
                         "method": "POST",
                         "class": "move",
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/WebexCXChannel",
                         "support_async": true,
                         "title": "Move",
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               },
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/relation/WebexCXChannel/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/WebexCXChannel/export_bulkload_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export Bulk Load Template"
                    }
               },
               {
                    "configuration_template": {
                         "method": "GET",
                         "class": "config",
                         "href": "/api/relation/WebexCXChannel/configuration_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Configuration Template"
                    }
               },
               {
                    "field_display_policy": {
                         "method": "GET",
                         "class": "display_policy",
                         "href": "/api/relation/WebexCXChannel/field_display_policy/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Field Display Policy"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/relation/WebexCXChannel/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "help": {
                         "method": "GET",
                         "class": "help",
                         "href": "/api/relation/WebexCXChannel/help?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Help"
                    }
               }
          ]
     },
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for relation/WebexCXChannel.	GET	/api/relation/WebexCXChannel/help	hierarchy=[hierarchy]	On-line help of Model ref.: relation/WebexCXChannel as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/relation/WebexCXChannel/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/relation/WebexCXChannel/[pkid]	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=relation/WebexCXChannel	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 relation/WebexCXChannel; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/relation/WebexCXChannel/[pkid]/export	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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/WebexCXChannel and the JSON format can be used to import instances of relation/WebexCXChannel.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/relation/WebexCXChannel/[pkid]	hierarchy=[hierarchy]	The relation/WebexCXChannel instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/relation/WebexCXChannel/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for relation/WebexCXChannel.

API Reference for relation/WebexCXChannel

GET http://[host-proxy]/api/relation/WebexCXChannel/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/relation/WebexCXChannel/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Move

Export

Get

Help