[Index]
Model ref.: device/msteamsonline/CsCallQueue
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": { "Name": { "type": "string", "name": "Name", "title": "Name" }, "AgentAlertTime": { "description": "Between 15 and 180 seconds", "title": "Call agent alert time (seconds)", "maximum": 180, "minimum": 15, "type": "integer", "name": "AgentAlertTime" }, "LanguageId": { "target": "/api/device/msteamsonline/CsAutoAttendantSupportedLanguage/choices/?field=DisplayName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Language", "convert_to_primary_key": true, "name": "LanguageId", "target_attr": "DisplayName", "target_model_type": "device/msteamsonline/CsAutoAttendantSupportedLanguage", "choices": [], "type": "string", "description": "Required parameter if either OverflowAction or TimeoutAction is set to SharedVoicemail" }, "RoutingMethod": { "choices": [ { "value": "Attendant", "title": "Attendant routing" }, { "value": "Serial", "title": "Serial routing" }, { "value": "RoundRobin", "title": "Round robin" }, { "value": "LongestIdle", "title": "Longest idle" } ], "type": "string", "name": "RoutingMethod", "title": "Routing Method" }, "Greeting": { "properties": { "WelcomeMusicFileName": { "format": "db_filename", "type": "string", "name": "WelcomeMusicFileName", "title": "Audio File" }, "Options": { "choices": [ { "value": "None", "title": "No greeting" }, { "value": "AudioFile", "title": "Play an audio file" }, { "value": "TextToSpeech", "title": "Add a greeting message" } ], "type": "string", "name": "Options", "title": "Options" }, "WelcomeTextToSpeechPrompt": { "readonly": false, "type": "string", "name": "WelcomeTextToSpeechPrompt", "title": "Message" } }, "type": "object", "name": "Greeting", "title": "Greeting" }, "ApplicationInstances": { "items": { "target": "/api/device/msteamsonline/CsOnlineApplicationInstance/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "convert_to_primary_key": true, "choices": [], "target_attr": "UserPrincipalName", "target_model_type": "device/msteamsonline/CsOnlineApplicationInstance", "type": "string" }, "type": "array", "name": "ApplicationInstances", "title": "Resource Accounts" }, "TimeoutThreshold": { "description": "Will be set by the device to the multiple of 15 closest to the provided value", "type": "integer", "name": "TimeoutThreshold", "title": "Maximum wait time" }, "AllowOptOut": { "type": "boolean", "name": "AllowOptOut", "title": "Call agents can opt out of taking calls" }, "PresenceBasedRouting": { "type": "boolean", "name": "PresenceBasedRouting", "title": "Presence-based routing" }, "TimeoutHandling": { "properties": { "Redirect": { "properties": { "RedirectTo": { "choices": [ { "value": "Person in organization", "title": "Person in organization" }, { "value": "Voice app", "title": "Voice app" }, { "value": "External phone number", "title": "External phone number" }, { "value": "VoicemailPersonal", "title": "Voicemail (personal)" }, { "value": "VoicemailShared", "title": "Voicemail (shared)" } ], "type": "string", "name": "RedirectTo", "title": "Redirect to" }, "VoicemailShared": { "type": "string", "name": "VoicemailShared", "title": "Voicemail (shared)" }, "VoicemailPersonal": { "type": "string", "name": "VoicemailPersonal", "title": "Voicemail (personal)" }, "Person": { "target": "/api/device/msteamsonline/CsOnlineUser/choices/?field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Person in organization", "convert_to_primary_key": true, "choices": [], "target_attr": "Identity", "target_model_type": "device/msteamsonline/CsOnlineUser", "type": "string", "name": "Person" }, "Phone": { "type": "string", "name": "Phone", "title": "External phone number" }, "EnableTimeoutSharedVoicemailTranscription": { "type": "boolean", "name": "EnableTimeoutSharedVoicemailTranscription", "title": "Transcription" }, "VoicemailSharedGreeting": { "properties": { "TimeoutSharedVoicemailAudioFilePromptFileName": { "format": "db_filename", "type": "string", "name": "TimeoutSharedVoicemailAudioFilePromptFileName", "title": "Audio File" }, "Options": { "choices": [ { "value": "AudioFile", "title": "Play an audio file" }, { "value": "TextToSpeech", "title": "Add a greeting message" } ], "type": "string", "name": "Options", "title": "Options" }, "TimeoutSharedVoicemailTextToSpeechPrompt": { "type": "string", "name": "TimeoutSharedVoicemailTextToSpeechPrompt", "title": "Message" } }, "type": "object", "name": "VoicemailSharedGreeting", "title": "Greeting" }, "VoiceApp": { "target": "/api/device/msteamsonline/CsOnlineApplicationInstance/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Voice app", "convert_to_primary_key": true, "choices": [], "target_attr": "UserPrincipalName", "target_model_type": "device/msteamsonline/CsOnlineApplicationInstance", "type": "string", "name": "VoiceApp" }, "VoicemailSharedSkipSystemMessage": { "type": "boolean", "name": "VoicemailSharedSkipSystemMessage", "title": "Skip voicemail system message" } }, "type": "object", "name": "Redirect", "title": "Redirect this call to" }, "Options": { "choices": [ { "value": "Disconnect", "title": "Disconnect" }, { "value": "Redirect", "title": "Redirect this call to" } ], "type": "string", "name": "Options", "title": "Options" } }, "type": "object", "name": "TimeoutHandling", "title": "When call times out" }, "FirstApplicationInstanceFirstPhoneNumber": { "readonly": true, "type": "string", "name": "FirstApplicationInstanceFirstPhoneNumber", "title": "1st Phone Number of 1st Resource Account" }, "MusicOnHold": { "properties": { "Options": { "choices": [ { "value": "UseDefaultMusicOnHold", "title": "Play default music" }, { "value": "AudioFile", "title": "Play an audio file" } ], "type": "string", "name": "Options", "title": "Options" }, "MusicOnHoldFileName": { "format": "db_filename", "type": "string", "name": "MusicOnHoldFileName", "title": "Audio file" } }, "type": "object", "name": "MusicOnHold", "title": "Music on hold" }, "ApplicationInstancesCount": { "readonly": true, "type": "integer", "name": "ApplicationInstancesCount", "title": "Number of Resource Accounts" }, "OverflowHandling": { "properties": { "Redirect": { "properties": { "RedirectTo": { "choices": [ { "value": "Person in organization", "title": "Person in organization" }, { "value": "Voice app", "title": "Voice app" }, { "value": "External phone number", "title": "External phone number" }, { "value": "VoicemailPersonal", "title": "Voicemail (personal)" }, { "value": "VoicemailShared", "title": "Voicemail (shared)" } ], "type": "string", "name": "RedirectTo", "title": "Redirect to" }, "VoicemailShared": { "type": "string", "name": "VoicemailShared", "title": "Voicemail (shared)" }, "VoicemailPersonal": { "type": "string", "name": "VoicemailPersonal", "title": "Voicemail (personal)" }, "EnableOverflowSharedVoicemailTranscription": { "type": "boolean", "name": "EnableOverflowSharedVoicemailTranscription", "title": "Transcription" }, "Person": { "target": "/api/device/msteamsonline/CsOnlineUser/choices/?field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Person in organization", "convert_to_primary_key": true, "choices": [], "target_attr": "Identity", "target_model_type": "device/msteamsonline/CsOnlineUser", "type": "string", "name": "Person" }, "Phone": { "type": "string", "name": "Phone", "title": "External phone number" }, "VoicemailSharedGreeting": { "properties": { "OverflowSharedVoicemailTextToSpeechPrompt": { "type": "string", "name": "OverflowSharedVoicemailTextToSpeechPrompt", "title": "Message" }, "OverflowSharedVoicemailAudioFilePromptFileName": { "format": "db_filename", "type": "string", "name": "OverflowSharedVoicemailAudioFilePromptFileName", "title": "Audio File" }, "Options": { "choices": [ { "value": "AudioFile", "title": "Play an audio file" }, { "value": "TextToSpeech", "title": "Add a greeting message" } ], "type": "string", "name": "Options", "title": "Options" } }, "type": "object", "name": "VoicemailSharedGreeting", "title": "Greeting" }, "VoiceApp": { "target": "/api/device/msteamsonline/CsOnlineApplicationInstance/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "title": "Voice app", "convert_to_primary_key": true, "choices": [], "target_attr": "UserPrincipalName", "target_model_type": "device/msteamsonline/CsOnlineApplicationInstance", "type": "string", "name": "VoiceApp" }, "VoicemailSharedSkipSystemMessage": { "type": "boolean", "name": "VoicemailSharedSkipSystemMessage", "title": "Skip voicemail system message" } }, "type": "object", "name": "Redirect", "title": "Redirect this call to" }, "Options": { "choices": [ { "value": "Disconnect", "title": "Disconnect" }, { "value": "Redirect", "title": "Redirect this call to" } ], "type": "string", "name": "Options", "title": "Options" } }, "type": "object", "name": "OverflowHandling", "title": "When the maximum number of calls is reached" }, "FirstApplicationInstanceName": { "readonly": true, "type": "string", "name": "FirstApplicationInstanceName", "title": "1st Resource Account Name" }, "ConferenceMode": { "type": "boolean", "name": "ConferenceMode", "title": "Conference Mode" }, "CallAnswering": { "properties": { "Users": { "items": { "target": "/api/device/msteamsonline/CsOnlineUser/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "convert_to_primary_key": true, "choices": [], "target_attr": "UserPrincipalName", "target_model_type": "device/msteamsonline/CsOnlineUser", "type": "string" }, "type": "array", "name": "Users", "title": "Call Agents" }, "ShouldOverwriteCallableChannelProperty": { "description": "If the channel is in use by another Call Queue, set this setting to true to overwrite it.", "type": "boolean", "name": "ShouldOverwriteCallableChannelProperty", "title": "Should Overwrite Callable Channel Property" }, "ChannelId": { "type": "string", "name": "ChannelId", "title": "Channel Id" }, "DistributionLists": { "items": { "type": "string" }, "type": "array", "name": "DistributionLists", "title": "Distribution Lists and Groups" }, "UsersCount": { "readonly": true, "type": "integer", "name": "UsersCount", "title": "Number of Call Agents" }, "ChannelUserObjectId": { "type": "string", "name": "ChannelUserObjectId", "title": "ChannelUserObjectId" }, "Team": { "type": "string", "name": "Team", "title": "Team" }, "Options": { "choices": [ { "value": "Team", "title": "Choose a team" }, { "value": "UsersAndGroups", "title": "Choose users and groups" } ], "type": "string", "name": "Options", "title": "Options" }, "Channel": { "type": "string", "name": "Channel", "title": "Channel" } }, "type": "object", "name": "CallAnswering", "title": "Call answering" }, "OverflowThreshold": { "type": "integer", "name": "OverflowThreshold", "maximum": 200, "title": "Maximum calls in the queue" }, "Identity": { "type": "string", "name": "Identity", "title": "Identity" }, "AssignCallingIds": { "items": { "target": "/api/device/msteamsonline/CsOnlineApplicationInstance/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "convert_to_primary_key": true, "choices": [], "target_attr": "UserPrincipalName", "target_model_type": "device/msteamsonline/CsOnlineApplicationInstance", "type": "string" }, "type": "array", "name": "AssignCallingIds", "title": "Assign calling ID" } }, "schema_version": "2019.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/msteamsonline/CsCallQueue/add/ |
|
The GUI Add form of device/msteamsonline/CsCallQueue 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/msteamsonline/CsCallQueue | 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/msteamsonline/CsCallQueue/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/msteamsonline/CsCallQueue/[pkid1]", "/api/device/msteamsonline/CsCallQueue/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/msteamsonline/CsCallQueue/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/msteamsonline/CsCallQueue/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/msteamsonline/CsCallQueue/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/msteamsonline/CsCallQueue/[pkid1]", "/api/v0/device/msteamsonline/CsCallQueue/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/msteamsonline/CsCallQueue/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsCallQueue |
|
{"hrefs": ["/api/device/msteamsonline/CsCallQueue/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/msteamsonline/CsCallQueue |
|
{"hrefs": ["/api/device/msteamsonline/CsCallQueue/[pkid1]", "/api/device/msteamsonline/CsCallQueue/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/msteamsonline/CsCallQueue; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/msteamsonline/CsCallQueue/export/ |
|
{ "hrefs":["/api/device/msteamsonline/CsCallQueue/[pkid1]", "/api/device/msteamsonline/CsCallQueue/[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/msteamsonline/CsCallQueue and the JSON format can be used to import instances of device/msteamsonline/CsCallQueue.
GET http://[host-proxy]/api/device/msteamsonline/CsCallQueue/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/msteamsonline/CsCallQueue | POST | /api/device/msteamsonline/CsCallQueue/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/device/msteamsonline/CsCallQueue/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/msteamsonline/CsCallQueue/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/device/msteamsonline/CsCallQueue/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/msteamsonline/CsCallQueue/ |
|
The device/msteamsonline/CsCallQueue schema and all instances as JSON. |
(The list will return 0 to 3 device/msteamsonline/CsCallQueue instances)
{ "operations": [ "list", "add" ], "pagination": { "direction": "asc", "order_by": "Name", "maximum_limit": 2000, "skip": 0, "current": "/api/device/msteamsonline/CsCallQueue/?skip=0&limit=3&order_by=Name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 118 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "2019.1", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/msteamsonline/CsCallQueue/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/msteamsonline/CsCallQueue/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/msteamsonline/CsCallQueue/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Bulk Modify" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/msteamsonline/CsCallQueue", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/msteamsonline/CsCallQueue/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/device/msteamsonline/CsCallQueue/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/device/msteamsonline/CsCallQueue/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/device/msteamsonline/CsCallQueue/+tag_version/?hierarchy=[hierarchy]", "class": "tag_version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/msteamsonline/CsCallQueue/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/msteamsonline/CsCallQueue/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "migration": { "support_async": false, "class": "migration", "href": "/api/device/msteamsonline/CsCallQueue/migration/?hierarchy=[hierarchy]", "method": "GET", "title": "Migration Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/msteamsonline/CsCallQueue/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/msteamsonline/CsCallQueue/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/msteamsonline/CsCallQueue/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } }, { "transform": { "support_async": false, "class": "transform", "href": "/api/device/msteamsonline/CsCallQueue/transform/?hierarchy=[hierarchy]", "method": "GET", "title": "Transform Template" } } ], "model_type": "device/msteamsonline/CsCallQueue", "model_specific_actions": [ "list", "get", "add", "update", "remove", "move", "export", "export_bulkload_template", "bulk_update_form", "configuration_template", "field_display_policy", "help", "migration", "transform", "tag", "tag_version" ], "summary_attrs": [ { "name": "Name", "title": "Name" }, { "name": "ApplicationInstancesCount", "title": "Number of Resource Accounts" }, { "name": "FirstApplicationInstanceName", "title": "1st Resource Account Name" }, { "name": "FirstApplicationInstanceFirstPhoneNumber", "title": "1st Phone Number of 1st Resource Account" }, { "allow_filtering": true, "allow_ordering": false, "name": "CallAnswering.UsersCount", "title": "Number of Call Agents" }, { "name": "OverflowThreshold", "title": "Maximum calls in the queue" }, { "name": "TimeoutThreshold", "title": "Maximum wait time" }, { "name": "RoutingMethod", "title": "Routing Method" }, { "name": "PresenceBasedRouting", "title": "Presence-based routing" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [ { "pkid": "655efe6440d96fe47c25664e", "meta": { "tags": [], "cached": true, "title": "AAA_CQ", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "655efaa040d96fe47c23f48e", "href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e" } ], "self": [ { "pkid": "655efe6440d96fe47c25664e", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/" } ], "parent": [ { "pkid": "655ef9d340d96fe47c238be3", "href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/", "method": "DELETE", "title": "Delete" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/655efe6440d96fe47c25664e/?model_type=device/msteamsonline/CsCallQueue", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/+tag/", "class": "tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/+tag_version/", "class": "tag_version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/help", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/purge/", "method": "POST", "title": "Purge" } } ], "model_type": "device/msteamsonline/CsCallQueue", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae236ce894e001204efa0", "655ef9d340d96fe47c238be3", "655efe6440d96fe47c25664e" ], "summary_attrs": [ { "name": "Name", "title": "Name" }, { "name": "ApplicationInstancesCount", "title": "Number of Resource Accounts" }, { "name": "FirstApplicationInstanceName", "title": "1st Resource Account Name" }, { "name": "FirstApplicationInstanceFirstPhoneNumber", "title": "1st Phone Number of 1st Resource Account" }, { "allow_filtering": true, "allow_ordering": false, "name": "CallAnswering.UsersCount", "title": "Number of Call Agents" }, { "name": "OverflowThreshold", "title": "Maximum calls in the queue" }, { "name": "TimeoutThreshold", "title": "Maximum wait time" }, { "name": "RoutingMethod", "title": "Routing Method" }, { "name": "PresenceBasedRouting", "title": "Presence-based routing" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "Identity": "dd8ceaa5-c6eb-4b0d-884c-e4e9dc7446fb", "Name": "AAA_CQ", "CallAnswering": { "Options": "Team" }, "LanguageId": "English (United States)", "hierarchy": "655ef9d340d96fe47c238be3", "OverflowThreshold": 50, "Greeting": { "Options": "None" }, "AgentAlertTime": 30, "TimeoutHandling": { "Options": "Disconnect" }, "RoutingMethod": "Attendant", "AllowOptOut": true, "ApplicationInstancesCount": 0, "ConferenceMode": true, "OverflowHandling": { "Options": "Disconnect" }, "hierarchy_friendly_name": "VossAutoBuild (Customer)", "summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild", "PresenceBasedRouting": true, "TimeoutThreshold": 1200, "MusicOnHold": { "Options": "UseDefaultMusicOnHold" }, "hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild" } }, { "pkid": "655efe6540d96fe47c256680", "meta": { "tags": [], "cached": true, "title": "Audit Call Queue", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "655efaa040d96fe47c23f48e", "href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e" } ], "self": [ { "pkid": "655efe6540d96fe47c256680", "href": "/api/device/msteamsonline/CsCallQueue/655efe6540d96fe47c256680/" } ], "parent": [ { "pkid": "655ef9d340d96fe47c238be3", "href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/device/msteamsonline/CsCallQueue/655efe6540d96fe47c256680/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/device/msteamsonline/CsCallQueue/655efe6540d96fe47c256680/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/655efe6540d96fe47c256680/?model_type=device/msteamsonline/CsCallQueue", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/msteamsonline/CsCallQueue/655efe6540d96fe47c256680/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "class": "tag", "href": "/api/device/msteamsonline/CsCallQueue/655efe6540d96fe47c256680/+tag/", "method": "PATCH", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "title": "Tag Version", "support_async": true, "class": "tag_version", "href": "/api/device/msteamsonline/CsCallQueue/655efe6540d96fe47c256680/+tag_version/", "method": "PATCH", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "support_async": false, "href": "/api/device/msteamsonline/CsCallQueue/655efe6540d96fe47c256680/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/device/msteamsonline/CsCallQueue/655efe6540d96fe47c256680/help", "title": "Help", "class": "help", "method": "GET" } }, { "purge": { "support_async": false, "href": "/api/device/msteamsonline/CsCallQueue/655efe6540d96fe47c256680/purge/", "title": "Purge", "class": "purge", "method": "POST" } } ], "model_type": "device/msteamsonline/CsCallQueue", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae236ce894e001204efa0", "655ef9d340d96fe47c238be3", "655efe6540d96fe47c256680" ], "summary_attrs": [ { "name": "Name", "title": "Name" }, { "name": "ApplicationInstancesCount", "title": "Number of Resource Accounts" }, { "name": "FirstApplicationInstanceName", "title": "1st Resource Account Name" }, { "name": "FirstApplicationInstanceFirstPhoneNumber", "title": "1st Phone Number of 1st Resource Account" }, { "allow_filtering": true, "allow_ordering": false, "name": "CallAnswering.UsersCount", "title": "Number of Call Agents" }, { "name": "OverflowThreshold", "title": "Maximum calls in the queue" }, { "name": "TimeoutThreshold", "title": "Maximum wait time" }, { "name": "RoutingMethod", "title": "Routing Method" }, { "name": "PresenceBasedRouting", "title": "Presence-based routing" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "Identity": "1a98df2b-ca86-4c68-97a4-76dd52f2bf47", "Name": "Audit Call Queue", "CallAnswering": { "Options": "Team" }, "LanguageId": "", "hierarchy": "655ef9d340d96fe47c238be3", "OverflowThreshold": 50, "Greeting": { "Options": "None" }, "AgentAlertTime": 30, "TimeoutHandling": { "Options": "Disconnect" }, "RoutingMethod": "Attendant", "AllowOptOut": true, "ApplicationInstancesCount": 0, "ConferenceMode": false, "OverflowHandling": { "Options": "Disconnect" }, "hierarchy_friendly_name": "VossAutoBuild (Customer)", "summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild", "PresenceBasedRouting": false, "TimeoutThreshold": 1200, "MusicOnHold": { "Options": "UseDefaultMusicOnHold" }, "hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild" } }, { "pkid": "655efe6240d96fe47c256614", "meta": { "tags": [], "cached": true, "title": "Bean Tree Cafe 149", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "655efaa040d96fe47c23f48e", "href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e" } ], "self": [ { "pkid": "655efe6240d96fe47c256614", "href": "/api/device/msteamsonline/CsCallQueue/655efe6240d96fe47c256614/" } ], "parent": [ { "pkid": "655ef9d340d96fe47c238be3", "href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/device/msteamsonline/CsCallQueue/655efe6240d96fe47c256614/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/device/msteamsonline/CsCallQueue/655efe6240d96fe47c256614/", "class": "delete", "title": "Delete" } }, { "move": { "title": "Move", "support_async": true, "method": "POST", "href": "/api/tool/DataMove/655efe6240d96fe47c256614/?model_type=device/msteamsonline/CsCallQueue", "class": "move", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/device/msteamsonline/CsCallQueue/655efe6240d96fe47c256614/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "class": "tag", "href": "/api/device/msteamsonline/CsCallQueue/655efe6240d96fe47c256614/+tag/", "method": "PATCH", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "title": "Tag Version", "support_async": true, "class": "tag_version", "href": "/api/device/msteamsonline/CsCallQueue/655efe6240d96fe47c256614/+tag_version/", "method": "PATCH", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/device/msteamsonline/CsCallQueue/655efe6240d96fe47c256614/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/device/msteamsonline/CsCallQueue/655efe6240d96fe47c256614/help", "class": "help", "title": "Help" } }, { "purge": { "support_async": false, "method": "POST", "href": "/api/device/msteamsonline/CsCallQueue/655efe6240d96fe47c256614/purge/", "class": "purge", "title": "Purge" } } ], "model_type": "device/msteamsonline/CsCallQueue", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae236ce894e001204efa0", "655ef9d340d96fe47c238be3", "655efe6240d96fe47c256614" ], "summary_attrs": [ { "name": "Name", "title": "Name" }, { "name": "ApplicationInstancesCount", "title": "Number of Resource Accounts" }, { "name": "FirstApplicationInstanceName", "title": "1st Resource Account Name" }, { "name": "FirstApplicationInstanceFirstPhoneNumber", "title": "1st Phone Number of 1st Resource Account" }, { "allow_filtering": true, "allow_ordering": false, "name": "CallAnswering.UsersCount", "title": "Number of Call Agents" }, { "name": "OverflowThreshold", "title": "Maximum calls in the queue" }, { "name": "TimeoutThreshold", "title": "Maximum wait time" }, { "name": "RoutingMethod", "title": "Routing Method" }, { "name": "PresenceBasedRouting", "title": "Presence-based routing" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "Identity": "7e96760a-ebc2-4c8c-902d-1a2bfc32957d", "Name": "Bean Tree Cafe 149", "CallAnswering": { "UsersCount": 2, "Options": "UsersAndGroups", "Users": [ "[email protected]", "[email protected]" ] }, "LanguageId": "English (Canada)", "hierarchy": "655ef9d340d96fe47c238be3", "OverflowThreshold": 50, "Greeting": { "Options": "None" }, "AgentAlertTime": 50, "TimeoutHandling": { "Redirect": { "RedirectTo": "Person in organization", "Person": "680998c3-f737-4c89-90b6-7a46c84983e8" }, "Options": "Redirect" }, "RoutingMethod": "RoundRobin", "AllowOptOut": false, "ApplicationInstancesCount": 0, "ConferenceMode": true, "OverflowHandling": { "Redirect": { "RedirectTo": "Person in organization", "Person": "680998c3-f737-4c89-90b6-7a46c84983e8" }, "Options": "Redirect" }, "hierarchy_friendly_name": "VossAutoBuild (Customer)", "summary_device": "Connection parameters for Microsoft TeamsOnline Auto Build Tenant, Auto Build Tenant, hcs.CS-P.CS-NB.VossAutoBuild", "PresenceBasedRouting": true, "TimeoutThreshold": 1200, "MusicOnHold": { "Options": "UseDefaultMusicOnHold" }, "hierarchy_path": "sys.hcs.CS-P.CS-NB.VossAutoBuild" } } ] }
(Show the first instance)
{ "pkid": "655efe6440d96fe47c25664e", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "AAA_CQ", "business_key": {}, "schema_version": "", "references": { "parent": [ { "pkid": "655ef9d340d96fe47c238be3", "href": "/api/data/HierarchyNode/655ef9d340d96fe47c238be3" } ], "self": [ { "pkid": "655efe6440d96fe47c25664e", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/" } ], "foreign_key": [], "owner": [ { "pkid": "" } ], "device": [ { "pkid": "655efaa040d96fe47c23f48e", "href": "/api/v0/data/MSTeamsOnline/655efaa040d96fe47c23f48e" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/655efe6440d96fe47c25664e/?hierarchy=[hierarchy]&model_type=device/msteamsonline/CsCallQueue", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "title": "Tag Version", "support_async": true, "method": "PATCH", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/+tag_version/?hierarchy=[hierarchy]", "class": "tag_version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/msteamsonline/CsCallQueue/655efe6440d96fe47c25664e/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/msteamsonline/CsCallQueue", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae236ce894e001204efa0", "655ef9d340d96fe47c238be3", "655efe6440d96fe47c25664e" ], "summary_attrs": [ { "name": "Name", "title": "Name" }, { "name": "ApplicationInstancesCount", "title": "Number of Resource Accounts" }, { "name": "FirstApplicationInstanceName", "title": "1st Resource Account Name" }, { "name": "FirstApplicationInstanceFirstPhoneNumber", "title": "1st Phone Number of 1st Resource Account" }, { "allow_filtering": true, "allow_ordering": false, "name": "CallAnswering.UsersCount", "title": "Number of Call Agents" }, { "name": "OverflowThreshold", "title": "Maximum calls in the queue" }, { "name": "TimeoutThreshold", "title": "Maximum wait time" }, { "name": "RoutingMethod", "title": "Routing Method" }, { "name": "PresenceBasedRouting", "title": "Presence-based routing" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "Name": "AAA_CQ", "LanguageId": "English (United States)", "hierarchy": "655ef9d340d96fe47c238be3", "OverflowThreshold": 50, "Greeting": { "Options": "None" }, "AgentAlertTime": 30, "Identity": "dd8ceaa5-c6eb-4b0d-884c-e4e9dc7446fb", "RoutingMethod": "Attendant", "AllowOptOut": true, "ApplicationInstancesCount": 0, "ConferenceMode": true, "OverflowHandling": { "Options": "Disconnect" }, "CallAnswering": { "Options": "Team" }, "PresenceBasedRouting": true, "TimeoutThreshold": 1200, "MusicOnHold": { "Options": "UseDefaultMusicOnHold" }, "TimeoutHandling": { "Options": "Disconnect" } } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/msteamsonline/CsCallQueue. | GET | /api/device/msteamsonline/CsCallQueue/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/msteamsonline/CsCallQueue as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/msteamsonline/CsCallQueue/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/msteamsonline/CsCallQueue/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/msteamsonline/CsCallQueue | 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/msteamsonline/CsCallQueue; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/msteamsonline/CsCallQueue/[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/msteamsonline/CsCallQueue and the JSON format can be used to import instances of device/msteamsonline/CsCallQueue.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/device/msteamsonline/CsCallQueue/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/msteamsonline/CsCallQueue/[pkid] | hierarchy=[hierarchy] | The device/msteamsonline/CsCallQueue instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/msteamsonline/CsCallQueue/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/msteamsonline/CsCallQueue. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/msteamsonline/CsCallQueue/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |