Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Webex

Webex Contact Service Queue API

The Contact Service Queue API from Webex — 24 operation(s) for contact service queue.

Documentation Provider Profile APIs.io OpenAPI GitHub

Webex Contact Service Queue API is one of 178 APIs that Webex publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contact Service Queue. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 30 operations across 24 paths, and defines 42 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

30 operations 24 paths 42 schemas 1 DELETE15 GET1 PATCH11 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Authentication
OAuth 2.0, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 3

Webex Contact Service Queue API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow. It accepts HTTP bearer tokens (JWT) (bearer-key). It supports OAuth 2.0 (bearerAuth) using the authorizationCode flow, exposing 1 scope.

  • bearer-key — e.g. Bearer YOURAUTHORIZATIONTOKEN
  • bearerAuth — OAuth 2.0 Bearer token authentication

Paths & Operations 30

Across 24 paths, the API surfaces 30 operations — 1 DELETE, 15 GET, 1 PATCH, 11 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Contact Service Queue 30
GET
/organization/{orgid}/contact-service-queue
List Contact Service Queue(s)
getAllFilteredConfig_1 7 params → 200401403404429500
POST
/organization/{orgid}/contact-service-queue
Create a new Contact Service Queue
createConfig_16 1 param body → 201400401403409429500
POST
/organization/{orgid}/contact-service-queue/bulk
Bulk save Contact Service Queue(s)
saveAllConfig_16 1 param body → 207400401403409429500
PATCH
/organization/{orgid}/contact-service-queue/bulk
Bulk partial update Contact Service Queue(s)
patchAllConfig_1 1 param body → 207400401403404429500
GET
/organization/{orgid}/contact-service-queue/bulk-exportdeprecated
Bulk export Contact Service Queue(s)
bulkExport_14 4 params → 200401403404429500
GET
/organization/{orgid}/contact-service-queue/by-skill-profile-id/{id}
List Skill CSQs by Skill Profile
getSkillBasedCSQsBySkillProfileIdPublic 2 params → 200401403404429500
GET
/organization/{orgid}/contact-service-queue/by-skill-profile-id/{id}/internal
List Internal Skill CSQs by Profile
getSkillBasedCSQsBySkillProfileId 2 params → 200401403404429500
GET
/organization/{orgid}/contact-service-queue/by-team-id/{id}/internal
List Team CSQs by Team ID
getTeamBasedCSQByTeamId 2 params → 200401403404429500
GET
/organization/{orgid}/contact-service-queue/by-user-ci-id/{ciUserId}/internal
List Agent CSQs by CI User ID
getAgentBasedCSQsByCiUserId 2 params → 200401403404429500
POST
/organization/{orgid}/contact-service-queue/delete-reference
Delete CSQ References
deleteReferences 1 param body → 200400401403409429500
POST
/organization/{orgid}/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile
List CSQs by Skills and Profile
getSkillBasedCSQsByDynamicSkillsAndSkillProfile 1 param body → 200400401403409429500
POST
/organization/{orgid}/contact-service-queue/fetch-by-userId-skillProfileId
List CSQs by User and Profile
getSkillBasedCSQsBySkillProfileIdAndUserId 1 param body → 200400401403409429500
POST
/organization/{orgid}/contact-service-queue/fetch-manually-assignable-queues
List Manually Assignable CSQs
getManuallyAssignableCSQs 1 param body → 200400401403409429500
POST
/organization/{orgid}/contact-service-queue/purge-inactive-entities
Purge inactive Contact Service Queue(s)
purgeInactiveConfig_8 2 params → 200400401403409429500
GET
/organization/{orgid}/contact-service-queue/skill-based-queues/by-ci-user-id/{id}/internal
List Skill CSQs by CI User ID
getSkillBasedCSQsByCiUserId 2 params → 200401403404429500
GET
/organization/{orgid}/contact-service-queue/{id}
Get specific Contact Service Queue by ID
getConfig_18 3 params → 200401403404429500
PUT
/organization/{orgid}/contact-service-queue/{id}
Update specific Contact Service Queue by ID
updateConfig_18 2 params body → 200400401403404412429500
DELETE
/organization/{orgid}/contact-service-queue/{id}
Delete specific Contact Service Queue by ID
deleteConfig_16 2 params → 204401403404412429500
GET
/organization/{orgid}/contact-service-queue/{id}/incoming-references
List CSQ References by ID
getIncomingReferences_14 5 params → 200401403404429500
POST
/organization/{orgid}/contact-service-queue/v2/bulk
Bulk save Contact Service Queue(s)
saveAllConfigV2 1 param body → 207400401403409429500
GET
/organization/{orgid}/v2/contact-service-queue
List Contact Service Queue(s)
getAllFilteredConfigWithPagedMetaData 10 params → 200401403404429500
POST
/organization/{orgid}/v2/contact-service-queue
Create a new Contact Service Queue
createConfig_17 1 param body → 201400401403409429500
GET
/organization/{orgid}/v2/contact-service-queue/by-user-id/{userid}/agent-based-queues
List agent based Contact Service Queue(s)by user ID
getCSQByUserIDForAgentBasedQueue 5 params → 200401403404429500
GET
/organization/{orgid}/v2/contact-service-queue/by-user-id/{userid}/skill-based-queues
List skill based Contact Service Queue(s)by user ID
getSkillBasedQueuesByUserId 5 params → 200401403404429500
GET
/organization/{orgid}/v2/contact-service-queue/by-user-id/{userid}/team-based-queues
List team based Contact Service Queue(s)by user ID
getCSQByUserIDForTeamBasedQueue 5 params → 200401403404429500
POST
/organization/{orgid}/v2/contact-service-queue/fetch-by-grouped-assistant-skill
List queue mapping summary grouped by Assistant Skill
getAllCSQGroupedAssistantSkill 3 params body → 200400401403409429500
GET
/organization/{orgid}/v2/contact-service-queue/{id}
Get specific Contact Service Queue by ID
getConfig_19 3 params → 200401403404429500
PUT
/organization/{orgid}/v2/contact-service-queue/{id}
Update specific Contact Service Queue by ID
updateConfig_19 2 params body → 200400401403404412429500
POST
/organization/{orgid}/v2/contact-service-queue/{id}/reassign-agents
Add or remove agents/users to/from an agent based queue
reassignAgents 2 params body → 200400401403409429500
GET
/organization/{orgid}/v3/contact-service-queuedeprecated
List Contact Service Queue(s)
getAllFilteredConfigWithMetaDataV3 9 params → 200401403404429500

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are ContactServiceQueueDTO (48 properties), ContactServiceQueueDTOList (45 properties), ContactServiceQueueBulkExportDTO (29 properties), SkillBasedCSQDTO (12 properties). Each schema is shown below with its type and property counts.

Response
object
3 properties
ApiErrorResponse
object
Response body for an API error.
2 properties
Link
object
8 properties
SkillBasedQueueRequestDTO
object
Request DTO for querying skill-based Contact Service Queues.
3 properties
ResponseEnvelopeMappedCSQDTO
object
Response envelope containing mapped Contact Service Queue data.
2 properties
ContactServiceQueueDTO
object
48 properties 11 required
PaginationLinks
object
5 properties 1 required
QueueSkillRequirementDTO
object
Skill requirement for the queue
12 properties 3 required
EntityInfo
object
6 properties
CSQGroupedAssistantSkillResponseDTO
object
Queue mapping summary per Assistant Skill
3 properties
CallDistributionGroupDTO
object
3 properties
ManuallyAssignableQueuesRequest
object
Request body for fetching manually assignable Contact Service Queues.
2 properties
MetaDataPagedInfo
object
6 properties
ContactServiceQueueBulkExportDTO
object
DTO for bulk export of Contact Service Queue data.
29 properties
SkillBasedCSQDTO
object
Skill-based Contact Service Queue data transfer object.
12 properties
BulkResponseItemDTO
object
5 properties
BulkExportDTOContactServiceQueueBulkExportDTO
object
Bulk export Dto
5 properties
QueuePersonalizedAIRoutingDTO
object
Queue-level Personalized AI Routing configuration. Enables intelligent agent routing based on AI/ML predictions.
3 properties
QueueAgentsDTO
object
2 properties 1 required
OperationError
object
An error message providing details about the operation failure.
1 property
FieldRequestBody
object
Request body containing field references for delete operations.
1 property
ResponseEnvelopeRoutingBasedQueueDTO
object
Response envelope containing routing-based Contact Service Queue data.
2 properties
CallDistributionGroupBulkExportDTO
object
Call distribution group data for bulk export.
3 properties
CSQGroupedAssistantSkillRequestDTO
object
Request payload for fetching queue mapping summary grouped by Assistant Skill
1 property
BulkRequestDTOContactServiceQueueDTO
object
Bulk request DTO containing a list of Contact Service Queue items for bulk operations.
1 property
ErrorDetails
object
Details of an error.
2 properties
ResponseEnvelopeSkillBasedCSQDTO
object
Response envelope containing skill-based Contact Service Queue data.
2 properties
AssistantSkillMappingDTO
object
2 properties
BulkResponseDTO
object
1 property
ReassignAgentsRequestDTO
object
2 properties
BulkRequestItemDTOContactServiceQueueDTO
object
List of items in the bulk request.
3 properties
RoutingBasedQueueDTO
object
Routing-based Contact Service Queue data transfer object.
7 properties
AgentGroupDTO
object
1 property
ResponseMetaEnvelopeContactServiceQueueDTOMetaDataPagedInfo
object
2 properties
EntityReferenceInfoDTO
object
3 properties
ContactServiceQueueDTOList
object
Contact Service Queue list data transfer object with condensed fields for list operations.
45 properties
AgentGroupsBulkExportDTO
object
Agent group data for bulk export.
2 properties
MappedCSQDTO
object
Mapped Contact Service Queue data transfer object.
7 properties
DynamicSkillDTO
object
Dynamic skill data transfer object for skill-based queue filtering.
5 properties
MetaDataReferencesPagingInfo
object
Metadata of response for references with paging information
8 properties
ResponseEnvelopeCSQGroupedAssistantSkillResponseDTO
object
2 properties
MetaDataPagedCSQ
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webex-contact-service-queue-api-openapi.yml Raw ↑

Other APIs Webex publishes across the network.

Webex Address Book API
AE Profile APIs.io
Webex Admin Audit Events API
AE Profile APIs.io
Webex Agent Personal Greeting Files API
AE Profile APIs.io
Webex Agent Summaries API
AE Profile APIs.io
Webex Agent Wellbeing API
AE Profile APIs.io
Webex Agents API
AE Profile APIs.io
Webex AI Feature API
AE Profile APIs.io
Webex API - Domain Management API
AE Profile APIs.io
Webex Archive Users API
AE Profile APIs.io
Webex Attachment Actions API
AE Profile APIs.io
Webex Audio Files API
AE Profile APIs.io
Webex Authorizations API
AE Profile APIs.io
#Contact Service Queue
← Back to W APIs
API Details
ID
webex:webex-contact-service-queue-api
Docs
https://developer.webex.com/docs/messaging
Provider
Webex
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network