{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Contact Service Queue API", "version": "1.0.0" }, "items": [ { "info": { "name": "Contact Service Queue", "type": "folder" }, "items": [ { "info": { "name": "List Contact Service Queue(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "query", "description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n" }, { "name": "channelTypes", "value": "TELEPHONY,CHAT", "type": "query", "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering." }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "query", "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size." }, { "name": "singleObjectResponse", "value": "", "type": "query", "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception." } ] }, "docs": "Retrieve a list of Contact Service Queue(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API." }, { "info": { "name": "Create a new Contact Service Queue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Contact Service Queue in a given organization." }, { "info": { "name": "Bulk save Contact Service Queue(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Contact Service Queue(s) in bulk in a given organization." }, { "info": { "name": "Bulk partial update Contact Service Queue(s)", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update some or all properties for multiple Contact Service Queue(s) in bulk in a given organization." }, { "info": { "name": "Bulk export Contact Service Queue(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "type", "value": "INBOUND", "type": "query", "description": "Indicates the queue type; can be INBOUND or OUTBOUND." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "query", "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size." } ] }, "docs": "Export all Contact Service Queue(s) in a given organization." }, { "info": { "name": "List Skill CSQs by Skill Profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-skill-profile-id/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." } ] }, "docs": "Retrieve skill-based Contact Service Queues by skill profile ID in a given organization." }, { "info": { "name": "List Internal Skill CSQs by Profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-skill-profile-id/:id/internal", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." } ] }, "docs": "Retrieve skill-based Contact Service Queues by skill profile ID for internal use in a given organization." }, { "info": { "name": "List Team CSQs by Team ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-team-id/:id/internal", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." } ] }, "docs": "Retrieve team-based Contact Service Queues by team ID for internal use in a given organization." }, { "info": { "name": "List Agent CSQs by CI User ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-user-ci-id/:ciUserId/internal", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "ciUserId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ciUserId" } ] }, "docs": "Retrieve agent-based Contact Service Queues by CI user ID for internal use in a given organization." }, { "info": { "name": "Delete CSQ References", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/delete-reference", "params": [ { "name": "orgid", "value": "", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete references for Contact Service Queues in a given organization." }, { "info": { "name": "List CSQs by Skills and Profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve skill-based Contact Service Queues by dynamic skills and skill profile in a given organization." }, { "info": { "name": "List CSQs by User and Profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-userId-skillProfileId", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve skill-based Contact Service Queues by user ID and skill profile ID in a given organization." }, { "info": { "name": "List Manually Assignable CSQs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-manually-assignable-queues", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve manually assignable Contact Service Queues in a given organization." }, { "info": { "name": "Purge inactive Contact Service Queue(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/purge-inactive-entities", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "nextStartId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "query", "description": "This is the entity ID from which items for the next purge batch with be selected." } ] }, "docs": "Purge inactive Contact Service Queue(s) older than the configured interval for a given organization." }, { "info": { "name": "List Skill CSQs by CI User ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/skill-based-queues/by-ci-user-id/:id/internal", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." } ] }, "docs": "Retrieve skill-based Contact Service Queues by CI user ID for internal use in a given organization." }, { "info": { "name": "Get specific Contact Service Queue by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Contact Service Queue." }, { "name": "agentsUpdatedInfo", "value": "", "type": "query", "description": "If `true`, returns the user details who has last updated the agents list in an agent based queue." } ] }, "docs": "Retrieve an existing Contact Service Queue by ID in a given organization." }, { "info": { "name": "Update specific Contact Service Queue by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Contact Service Queue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Contact Service Queue by ID in a given organization." }, { "info": { "name": "Delete specific Contact Service Queue by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Contact Service Queue." } ] }, "docs": "Delete an existing Contact Service Queue by ID in a given organization." }, { "info": { "name": "List CSQ References by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "query", "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Contact Service Queue by ID in a given organization." }, { "info": { "name": "Bulk save Contact Service Queue(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/v2/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Contact Service Queue(s) in bulk in a given organization." }, { "info": { "name": "List Contact Service Queue(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "query", "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)" }, { "name": "search", "value": "contact center", "type": "query", "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "query", "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size." }, { "name": "desktopProfileFilter", "value": "", "type": "query", "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false." }, { "name": "provisioningView", "value": "", "type": "query", "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false." }, { "name": "singleObjectResponse", "value": "", "type": "query", "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception." }, { "name": "includeAIMappingCount", "value": "", "type": "query", "description": "If set to true, the API response will include the count of each AI features mapped to the entity." } ] }, "docs": "Retrieve a list of Contact Service Queue(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API." }, { "info": { "name": "Create a new Contact Service Queue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Contact Service Queue in a given organization." }, { "info": { "name": "List agent based Contact Service Queue(s)by user ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/by-user-id/:userid/agent-based-queues", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "userid", "value": "", "type": "path" }, { "name": "search", "value": "contact center", "type": "query", "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "query", "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size." } ] }, "docs": "Retrieve a list of agent based Contact Service Queue(s) by user iD in a given organization." }, { "info": { "name": "List skill based Contact Service Queue(s)by user ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/by-user-id/:userid/skill-based-queues", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "userid", "value": "", "type": "path" }, { "name": "search", "value": "contact center", "type": "query", "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "query", "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size." } ] }, "docs": "Retrieve a list of skill based Contact Service Queue(s) by user ID in a given organization." }, { "info": { "name": "List team based Contact Service Queue(s)by user ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/by-user-id/:userid/team-based-queues", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "userid", "value": "", "type": "path" }, { "name": "search", "value": "contact center", "type": "query", "description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "query", "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size." } ] }, "docs": "Retrieve a list of team based Contact Service Queue(s) by user ID in a given organization." }, { "info": { "name": "List queue mapping summary grouped by Assistant Skill", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/fetch-by-grouped-assistant-skill", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "query", "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve a list of queue mapping summary for a specified list of Assistant Skills specified in a given organization. The summary currently includes mapped queue count, and the last assigned time of queue mapping." }, { "info": { "name": "Get specific Contact Service Queue by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Contact Service Queue." }, { "name": "agentsUpdatedInfo", "value": "", "type": "query", "description": "If `true`, returns the user details who has last updated the agents list in an agent based queue." } ] }, "docs": "Retrieve an existing Contact Service Queue by ID in a given organization." }, { "info": { "name": "Update specific Contact Service Queue by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Contact Service Queue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Contact Service Queue by ID in a given organization." }, { "info": { "name": "Add or remove agents/users to/from an agent based queue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/:id/reassign-agents", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Contact Service Queue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API can be used by a contact center supervisor to add or remove agents to/from an agent based queue that they have access to by virtue of their user profile access rights. Additionally, the request payload should contain the user id(s) managed by the supervisor." }, { "info": { "name": "List Contact Service Queue(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v3/contact-service-queue", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "query", "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)" }, { "name": "search", "value": "contact center", "type": "query", "description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "query", "description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size." }, { "name": "desktopProfileFilter", "value": "", "type": "query", "description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false." }, { "name": "provisioningView", "value": "", "type": "query", "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false." }, { "name": "singleObjectResponse", "value": "", "type": "query", "description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception." } ] }, "docs": "Retrieve a list of Contact Service Queue(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API." } ] } ], "bundled": true }