openapi: 3.0.0
info:
title: Webex Admin Address Book Team API
version: 1.0.0
description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: Team
paths:
/organization/{orgid}/team:
get:
tags:
- Team
summary: List Team(s)
description: Retrieve a list of Team(s) in a given organization.
operationId: getAllConfig_1
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: filter
in: 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"
required: false
schema:
type: string
example: id=="2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
- name: attributes
in: query
description: Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)
required: false
schema:
type: string
format: string
example: id
- name: page
in: query
description: Defines the number of displayed page. The page number starts from 0.
schema:
type: integer
default: 0
example: 0
example: 0
- name: pageSize
in: 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.
schema:
type: integer
default: 100
example: 100
example: 100
- name: singleObjectResponse
in: 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.
schema:
type: boolean
default: false
example: false
responses:
'200':
description: OK
content:
'*/*':
schema:
type: array
items:
$ref: '#/components/schemas/TeamResponseDTO'
example:
- active: true
description: string
version: 1
skillProfileId: f53c8b54-46ca-43f6-ba05-08426a46e23d
capacity: 1
organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d
dialedNumber: '+14085550123'
systemDefault: false
rankQueuesForTeam: true
multiMediaProfileId: f53c8b54-46ca-43f6-ba05-08426a46e23d
name: inline-pcs-team
siteId: 8e6bb6da-2a78-4768-bef9-7e229f92af22
createdTime: 1617536244000
lastUpdatedTime: 1617536244000
id: 93912f11-6017-404b-bf14-5331890b1797
teamType: AGENT
teamStatus: IN_SERVICE
desktopLayoutId: f53c8b54-46ca-43f6-ba05-08426a46e23d
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '401'
reason: Test reason
message:
- description: Test error
code: '401'
entity: cc_user
references: []
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '403'
reason: Test reason
message:
- description: Test error
code: '403'
entity: cc_user
references: []
'404':
description: Resource not found or URI is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '404'
reason: Test reason
message:
- description: Test error
code: '404'
entity: cc_user
references: []
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '429'
reason: Test reason
message:
- description: Test error
code: '429'
entity: cc_user
references: []
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '500'
reason: Test reason
message:
- description: Test error
code: '500'
entity: cc_user
references: []
deprecated: false
post:
tags:
- Team
summary: Create a new Team
description: Create a new Team in a given organization.
operationId: createConfig_3
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: teamDTO
in: query
required: true
schema:
$ref: '#/components/schemas/TeamDTO'
responses:
'201':
description: Created
content:
'*/*':
schema:
$ref: '#/components/schemas/TeamResponseDTO'
'400':
description: The request was invalid and cannot be served. An accompanying error message will explain further
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '400'
reason: Test reason
message:
- description: Test error
code: '400'
entity: cc_user
references: []
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '401'
reason: Test reason
message:
- description: Test error
code: '401'
entity: cc_user
references: []
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '403'
reason: Test reason
message:
- description: Test error
code: '403'
entity: cc_user
references: []
'409':
description: Similar entity is already present
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '409'
reason: Test reason
message:
- description: Test error
code: '409'
entity: cc_user
references: []
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '429'
reason: Test reason
message:
- description: Test error
code: '429'
entity: cc_user
references: []
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '500'
reason: Test reason
message:
- description: Test error
code: '500'
entity: cc_user
references: []
deprecated: false
/organization/{orgid}/team/bulk:
post:
tags:
- Team
summary: Bulk save Team(s)
description: Create, Update or delete Team(s) in bulk in a given organization.
operationId: saveAllConfig_3
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkRequestDTOTeamDTO'
required: true
responses:
'207':
description: Multi-Status
content:
'*/*':
schema:
$ref: '#/components/schemas/BulkResponseDTO'
'400':
description: The request was invalid and cannot be served. An accompanying error message will explain further
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '400'
reason: Test reason
message:
- description: Test error
code: '400'
entity: cc_user
references: []
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '401'
reason: Test reason
message:
- description: Test error
code: '401'
entity: cc_user
references: []
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '403'
reason: Test reason
message:
- description: Test error
code: '403'
entity: cc_user
references: []
'409':
description: Similar entity is already present
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '409'
reason: Test reason
message:
- description: Test error
code: '409'
entity: cc_user
references: []
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '429'
reason: Test reason
message:
- description: Test error
code: '429'
entity: cc_user
references: []
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '500'
reason: Test reason
message:
- description: Test error
code: '500'
entity: cc_user
references: []
deprecated: false
/organization/{orgid}/team/purge-inactive-entities:
post:
tags:
- Team
summary: Purge inactive Team(s)
description: Purge inactive Team(s) older than the configured interval for a given organization.
operationId: purgeInactiveConfig_2
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: nextStartId
in: query
description: This is the entity ID from which items for the next purge batch with be selected.
required: false
schema:
type: string
default: ''
example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/Response'
'400':
description: The request was invalid and cannot be served. An accompanying error message will explain further
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '400'
reason: Test reason
message:
- description: Test error
code: '400'
entity: cc_user
references: []
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '401'
reason: Test reason
message:
- description: Test error
code: '401'
entity: cc_user
references: []
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '403'
reason: Test reason
message:
- description: Test error
code: '403'
entity: cc_user
references: []
'409':
description: Similar entity is already present
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '409'
reason: Test reason
message:
- description: Test error
code: '409'
entity: cc_user
references: []
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '429'
reason: Test reason
message:
- description: Test error
code: '429'
entity: cc_user
references: []
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '500'
reason: Test reason
message:
- description: Test error
code: '500'
entity: cc_user
references: []
deprecated: false
/organization/{orgid}/team/{id}:
get:
tags:
- Team
summary: Get specific Team by ID
description: Retrieve an existing Team by ID in a given organization.
operationId: getConfig_4
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: id
in: path
description: Resource ID of the Team
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/TeamResponseDTO'
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '401'
reason: Test reason
message:
- description: Test error
code: '401'
entity: cc_user
references: []
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '403'
reason: Test reason
message:
- description: Test error
code: '403'
entity: cc_user
references: []
'404':
description: Resource not found or URI is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '404'
reason: Test reason
message:
- description: Test error
code: '404'
entity: cc_user
references: []
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '429'
reason: Test reason
message:
- description: Test error
code: '429'
entity: cc_user
references: []
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '500'
reason: Test reason
message:
- description: Test error
code: '500'
entity: cc_user
references: []
deprecated: false
put:
tags:
- Team
summary: Update specific Team by ID
description: Update an existing Team by ID in a given organization.
operationId: updateConfig_4
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: id
in: path
description: Resource ID of the Team.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
- name: teamDTO
in: query
required: true
schema:
$ref: '#/components/schemas/TeamDTO'
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/TeamResponseDTO'
'400':
description: The request was invalid and cannot be served. An accompanying error message will explain further
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '400'
reason: Test reason
message:
- description: Test error
code: '400'
entity: cc_user
references: []
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '401'
reason: Test reason
message:
- description: Test error
code: '401'
entity: cc_user
references: []
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '403'
reason: Test reason
message:
- description: Test error
code: '403'
entity: cc_user
references: []
'404':
description: Resource not found or URI is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '404'
reason: Test reason
message:
- description: Test error
code: '404'
entity: cc_user
references: []
'412':
description: Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '412'
reason: Test reason
message:
- description: Test error
code: '412'
entity: cc_user
references: []
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '429'
reason: Test reason
message:
- description: Test error
code: '429'
entity: cc_user
references: []
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '500'
reason: Test reason
message:
- description: Test error
code: '500'
entity: cc_user
references: []
deprecated: false
delete:
tags:
- Team
summary: Delete specific Team by ID
description: Delete an existing Team by ID in a given organization.
operationId: deleteConfig_3
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: id
in: path
description: Resource ID of the Team.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2
responses:
'204':
description: No Content
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '401'
reason: Test reason
message:
- description: Test error
code: '401'
entity: cc_user
references: []
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '403'
reason: Test reason
message:
- description: Test error
code: '403'
entity: cc_user
references: []
'404':
description: Resource not found or URI is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '404'
reason: Test reason
message:
- description: Test error
code: '404'
entity: cc_user
references: []
'412':
description: Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '412'
reason: Test reason
message:
- description: Test error
code: '412'
entity: cc_user
references: []
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '429'
reason: Test reason
message:
- description: Test error
code: '429'
entity: cc_user
references: []
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '500'
reason: Test reason
message:
- description: Test error
code: '500'
entity: cc_user
references: []
deprecated: false
/organization/{orgid}/team/{id}/incoming-references:
get:
tags:
- Team
summary: List references for a specific Team
description: Retrieve a list of all entities that have reference to an existing Team by ID in a given organization.
operationId: getIncomingReferences_2
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: id
in: path
description: ID of this contact center resource.
required: true
schema:
type: string
example: af9eecc5-0472-4549-9a83-2afdae0d4ba0
- name: type
in: query
description: Entity type of the other entity that has a reference to this specific entity.
required: false
schema:
type: string
example: type_text
- name: page
in: query
description: Defines the number of displayed page. The page number starts from 0.
schema:
type: integer
default: 0
example: 0
example: 0
- name: pageSize
in: 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.
schema:
type: integer
default: 100
example: 100
example: 100
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/EntityReferenceInfoDTO'
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '401'
reason: Test reason
message:
- description: Test error
code: '401'
entity: cc_user
references: []
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '403'
reason: Test reason
message:
- description: Test error
code: '403'
entity: cc_user
references: []
'404':
description: Resource not found or URI is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '404'
reason: Test reason
message:
- description: Test error
code: '404'
entity: cc_user
references: []
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '429'
reason: Test reason
message:
- description: Test error
code: '429'
entity: cc_user
references: []
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '500'
reason: Test reason
message:
- description: Test error
code: '500'
entity: cc_user
references: []
deprecated: false
/organization/{orgid}/v2/team:
get:
tags:
- Team
summary: List Team(s)
description: Retrieve a list of Team(s) in a given organization.
operationId: getAllConfigWithMetaData_4
parameters:
- name: orgid
in: path
description: Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.
required: true
schema:
type: string
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
- name: filter
in: query
description: "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \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"
required: false
schema:
type: string
example: id=="2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
- name: attributes
in: query
description: Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)
required: false
schema:
type: string
format: string
example: id
- name: search
in: query
description: 'Filter data based on the search keyword.Supported search columns(name, description)
The examples below show some search queries
- "Cisco"
- field=="name";value=="Cisco"
- fields=in=("name","description");value=="Cisco"
'
required: false
schema:
type: string
example: contact center
- name: page
in: query
description: Defines the number of displayed page. The page number starts from 0.
schema:
type: integer
default: 0
example: 0
example: 0
- name: pageSize
in: 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.
schema:
type: integer
default: 100
example: 100
example: 100
- name: supervisorView
in: query
description: If set to true, the API will only return data that user has access to, according to User Profile
schema:
type: boolean
default: false
example: false
- name: provisioningView
in: query
description: If set to true, the API will only return data that user has access to, according to User Profile.
schema:
type: boolean
default: false
example: false
- name: singleObjectResponse
in: 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.
schema:
type: boolean
default: false
example: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/ResponseEnvelopeTeamResponseDTO'
example:
data:
- active: true
description: string
version: 1
skillProfileId: f53c8b54-46ca-43f6-ba05-08426a46e23d
capacity: 1
organizationId: f53c8b54-46ca-43f6-ba05-08426a46e23d
dialedNumber: '+14085550123'
systemDefault: false
rankQueuesForTeam: true
multiMediaProfileId: f53c8b54-46ca-43f6-ba05-08426a46e23d
name: inline-pcs-team
siteId: 8e6bb6da-2a78-4768-bef9-7e229f92af22
createdTime: string
lastUpdatedTime: string
id: 93912f11-6017-404b-bf14-5331890b1797
teamType: AGENT
teamStatus: IN_SERVICE
desktopLayoutId: f53c8b54-46ca-43f6-ba05-08426a46e23d
meta:
additionalProp1: string
additionalProp2: string
additionalProp3: string
'401':
description: Unauthorized Operation
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '401'
reason: Test reason
message:
- description: Test error
code: '401'
entity: cc_user
references: []
'403':
description: Operation is forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '403'
reason: Test reason
message:
- description: Test error
code: '403'
entity: cc_user
references: []
'404':
description: Resource not found or URI is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '404'
reason: Test reason
message:
- description: Test error
code: '404'
entity: cc_user
references: []
'429':
description: Too many requests have been sent in a given amount of time and the request has been rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '429'
reason: Test reason
message:
- description: Test error
code: '429'
entity: cc_user
references: []
'500':
description: An Unexpected Error Occurred
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponse'
example:
trackingId: ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0
error:
key: '500'
reason: Test reason
message:
- description: Test error
code: '500'
entity: cc_user
references: []
deprecated: false
components:
schemas:
BulkRequestItemDTOTeamDTO:
type: object
description: List of items in the bulk request.
properties:
itemIdentifier:
type: integer
format: int32
description: Unique item identifier for a bulk operation.
example: 10
item:
$ref: '#/components/schemas/TeamDTO'
description: The Team resource for this bulk operation item.
requestAction:
type: string
description: Identifier for action type. Possible values are `SAVE` and `DELETE`.
example: SAVE
Response:
type: object
properties:
code:
type: integer
format: int32
details:
type: object
additionalProperties:
type: object
links:
type: array
items:
$ref: '#/components/schemas/Link'
ApiErrorResponse:
description: Response body for an API error.
type: object
properties:
trackingId:
type: string
description: "An opaque identifier for mapping protocol failures to service internal codes. \n\nWhen specified in a request, it can be used for co-relating events across services"
example: c1a4fcef-aee2-4dea-8977-29f594760552
error:
description: An object containing details about the error.
$ref: '#/components/schemas/ErrorDetails'
Link:
type: object
properties:
href:
type: string
hreflang:
type: string
title:
type: string
type:
type: string
deprecation:
type: string
profile:
type: string
name:
type: string
templated:
type: boolean
QueueRankingDTO:
type: object
properties:
organizationId:
type: string
format: uuid
description: ID of the contact center organization. This field is required for all bulk save operations.
example: f53c8b54-46ca-43f6-ba05-08426a46e23d
maxLength: 36
minLength: 32
pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$
id:
type: string
description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
example: 93912f11-6017-404b-bf14-5331890b1797
version:
type: integer
format: int32
description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
example: 1
queueId:
type: string
minLength: 1
rank:
type: integer
format: int32
maximum: 50
createdTime:
type: integer
format: int64
description: This is the created time of the entity.
lastUpdatedTime:
type: integer
format: int64
description: This is the updated time of the entity.
required:
- queueId
- rank
ErrorDetails:
description: Details of an error.
type: object
properties:
key:
type: string
description: An application defined error code.
example: '401'
message:
type: array
description: A message providing details about the error.
items:
$ref: '#/components/schemas/OperationError'
BulkResponseItemDTO:
type: object
properties:
itemIdentifier:
type: integer
description: Unique item identifier for a bulk operation.
format: int32
example: 10
status:
type: integer
description: Indicates the error status code.
format: int32
example: 400
operationType:
type: string
description: The kind of operation desired of an entity.
example: CREATE
enum:
- CREATE
- UPDATE
- DELETE
- GET
href:
type: string
description: The resource URI of an entity.
example: /api/organization/6705c69d-4585-42ad-bfc3-79cc485dfb15/team/7b26d174-0016-4682-9858-65918e05f85
apiError:
$ref: '#/components/schemas/ApiErrorResponse'
example:
apiError:
error:
key: '400'
message:
- description: 'siteId: not found for given orgId.'
entity: string
references:
- id: string
name: string
reason: dependency exists
trackingId: ccconfig_c1a4fcef-aee2-4dea-8977-29f594760552
href: /api/organization/6705c69d-4585-42ad-bfc3-79cc485dfb15/team/7b26d174-0016-4682-9858-65918e05f85
itemIdentifier: 10
operationType: CREATE
status: 400
ResponseEnvelopeTeamResponseDTO:
type: object
properties:
meta:
type: object
additionalProperties: {}
data:
type: array
items:
$ref: '#/components/schemas/TeamResponseDTO'
TeamDTO:
type: object
description: Team resource used for create and update operations.
properties:
organizationId:
type: string
format: uuid
description: ID of the contact center organization. This field is required for all bulk save operations.
example: f53c8b54-46ca-43f6-ba05-08426a46e23d
maxLength: 36
minLength: 32
pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$
id:
type: string
description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
example: 93912f11-6017-404b-bf14-5331890b1797
version:
type: integer
format: int32
description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
example: 1
name:
type: string
description: Enter the name for the team. Generally, use names that indicate the function of the team, such as Billing or Customer Support. This field should be specified for create and update operation. Two teams in the same site in an organization cannot share the same name.
example: inline-pcs-team
teamType:
type: string
description: 'Team type can be the following:
AGENT: You assign a specific number of agents to the team.
CAPACITY: You don’t assign any specific number of agents to the team. You use capacity-based teams for voice mailboxes or agent groups that are not managed by the Webex Contact Center system.
Once created, teamType cannot be modified.'
enum:
- AGENT
- CAPACITY
example: AGENT
teamStatus:
type: string
description: 'Select the status of the team to indicate whether the team is available to handle customer contacts.
Can be one of: IN_SERVICE/NOT_AVAILABLE.'
enum:
- IN_SERVICE
- NOT_AVAILABLE
example: IN_SERVICE
dialedNumber:
type: string
description: "Enter the dial number where the system distributes the calls for this team. \nThis setting is applicable only for capacity-based teams."
example: '+14085550123'
capacity:
type: integer
format: int32
description: 'Enter the maximum number of simultaneous contacts that this team can handle.
This setting is applicable only for capacity-based teams.'
example: 1
active:
type: boolean
description: Specify whether the team is active or not Active.
example: true
siteId:
type: string
description: Identifier for a site which is a physical contact center location under the control of your enterprise. Once specified, siteId should not be modified.
example: 8e6bb6da-2a78-4768-bef9-7e229f92af22
minLength: 1
desktopLayoutId:
type: string
description: Identifier for an agent desktop layout which a Contact Center administrator has configured.
example: f53c8b54-46ca-43f6-ba05-08426a46e23d
skillProfileId:
type: string
description: "(Optional) If your enterprise uses the optional Skills-Based Routing feature, you can select a skill profile for this team. \nNote: You can’t assign this profile to a capacity-based team."
example: f53c8b54-46ca-43f6-ba05-08426a46e23d
multiMediaProfileId:
type: string
description: "(Optional) If your organization administrator enables Multimedia for your enterprise, you can select a multimedia profile for this team. \nNote: You can’t assign this profile to a capacity-based team."
example: f53c8b54-46ca-43f6-ba05-08426a46e23d
userIds:
type: array
description: "Specify the agents id who will be part of this team. \nNote: You can’t assign this profile to a capacity-based team."
example:
- f53c8b54-46ca-43f6-ba05-08426a46e23d
- a53c8b54-46ca-43f6-ba05-08426a46e23f
items:
type: string
description: "Specify the agents id who will be part of this team. \nNote: You can’t assign this profile to a capacity-based team."
example: f53c8b54-46ca-43f6-ba05-08426a46e23d
uniqueItems: true
description:
type: string
description: Description of the team.
maxLength: 255
minLength: 0
systemDefault:
type: boolean
description: Indicates whether the created resource is system created or not
example: false
rankQueuesForTeam:
type: boolean
description: Indicates whether the queues should be ranked for the team.
example: true
queueRankings:
type: array
description: List of queue rankings associated with this team.
items:
$ref: '#/components/schemas/QueueRankingDTO'
uniqueItems: true
createdTime:
type: integer
format: int64
description: This is the created time of the entity.
lastUpdatedTime:
type: integer
format: int64
description: This is the updated time of the entity.
required:
- active
- name
- rankQueuesForTeam
- siteId
- teamStatus
- teamType
OperationError:
description: An error message providing details about the operation failure.
type: object
properties:
description:
type: string
description: A human readable explanation for the occurrence of an error.
example: Incorrect Credentials.
BulkResponseDTO:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/BulkResponseItemDTO'
TeamResponseDTO:
type: object
properties:
organizationId:
type: string
format: uuid
description: ID of the contact center organization. This field is required for all bulk save operations.
example: f53c8b54-46ca-43f6-ba05-08426a46e23d
maxLength: 36
minLength: 32
pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$
id:
type: string
description: ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.
example: 93912f11-6017-404b-bf14-5331890b1797
version:
type: integer
format: int32
description: The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.
example: 1
name:
type: string
description: Indicates the name of the team such as Billing or Customer Support
example: Customer Support
teamType:
type: string
description: 'Team type can be the following:
AGENT: A specific number of agents are assigned to the team.
CAPACITY: Specific number of agents not assigned to the team. Capacity-based teams for voice mailboxes or agent groups that are not managed by the Webex Contact Center system.'
enum:
- AGENT
- CAPACITY
example: AGENT
teamStatus:
type: string
description: 'Indicates whether the team is available to handle customer contacts.
Can be one of: IN_SERVICE/NOT_AVAILABLE.
'
enum:
- IN_SERVICE
- NOT_AVAILABLE
example: IN_SERVICE
dialedNumber:
type: string
description: "The dial number where the system distributes the calls for this team. \nThis setting is applicable only for capacity-based teams."
example: '+14085550123'
capacity:
type: integer
format: int32
description: 'The maximum number of simultaneous contacts that this team can handle.
This setting is applicable only for capacity-based teams.'
example: 1
active:
type: boolean
description: Indicates whether the team is active(when true) or not active(when false).
example: true
siteId:
type: string
description: Identifier for a site which is a physical contact center location under the control of your enterprise.
example: 8e6bb6da-2a78-4768-bef9-7e229f92af22
desktopLayoutId:
type: string
description: Identifier for an agent desktop layout which a Contact Center administrator has configured.
example: f53c8b54-46ca-43f6-ba05-08426a46e23d
siteName:
type: string
description: The name of the site this team belongs to.
example: New_York
skillProfileId:
type: string
description: Id of the skill profile for this team if your enterprise uses the optional Skills-Based Routing feature.
example: f53c8b54-46ca-43f6-ba05-08426a46e23d
multiMediaProfileId:
type: string
description: Id of the multimedia profile for this team.
example: f53c8b54-46ca-43f6-ba05-08426a46e23d
userIds:
type: array
description: Indicates the agents id(s) who are part of this team.
example:
- f53c8b54-46ca-43f6-ba05-08426a46e23d
- a53c8b54-46ca-43f6-ba05-08426a46e23f
items:
type: string
description: Indicates the agents id(s) who are part of this team.
example:
- f53c8b54-46ca-43f6-ba05-08426a46e23d
- a53c8b54-46ca-43f6-ba05-08426a46e23f
uniqueItems: true
description:
type: string
description: Indicates the team
example: Capacity based team
systemDefault:
type: boolean
description: Indicates whether the created resource is system created or not
example: false
rankQueuesForTeam:
type: boolean
queueRankings:
type: array
items:
$ref: '#/components/schemas/QueueRankingDTO'
uniqueItems: true
createdTime:
type: integer
format: int64
description: This is the created time of the entity.
lastUpdatedTime:
type: integer
format: int64
description: This is the updated time of the entity.
MetaDataReferencesPagingInfo:
title: MetaDataReferencesPagingInfo
type: object
properties:
orgid:
maxLength: 36
minLength: 32
pattern: ^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$
type: string
description: Org ID
format: uuid
example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1
page:
type: integer
description: Current page number
format: int32
example: 1
pageSize:
type: integer
description: Page size for current data set
format: int32
example: 100
totalPages:
type: integer
description: Number of pages
format: int32
example: 1
totalRecords:
type: integer
description: Total number of items
format: int32
example: 1000
links:
type: object
description: Map of pagination links with self, next, prev, last and first
example:
next: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=2&pageSize=10
last: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=3&pageSize=10
prev: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=0&pageSize=10
self: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=1&pageSize=10
first: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=0&pageSize=10
referencedEntities:
type: array
description: List of referenced entities
example:
- agent-profile
- entrypoint
items:
type: string
currentEntity:
type: string
description: Name of current entity
example: entity_name
description: Metadata of response for references with paging information
EntityInfo:
type: object
properties:
id:
type: string
description: id
example: id.
name:
type: string
description: name
example: name.
additionalAttributes:
type: object
additionalProperties:
type: string
description: A map containing additional attributes of entity where both the key and value are Strings.
example: '{"key1":"value1","key2":"value2"}'
description: A map containing additional attributes of entity where both the key and value are Strings.
example:
key1: value1
key2: value2
createdDate:
type: string
lastModifiedDate:
type: string
version:
type: integer
format: int32
BulkRequestDTOTeamDTO:
type: object
description: Bulk request containing a list of Team operations.
properties:
items:
type: array
description: List of items in the bulk request.
items:
$ref: '#/components/schemas/BulkRequestItemDTOTeamDTO'
EntityReferenceInfoDTO:
type: object
properties:
description:
type: string
description: Description about reference info.
example: list of referenced entities
meta:
$ref: '#/components/schemas/MetaDataReferencesPagingInfo'
data:
type: array
items:
$ref: '#/components/schemas/EntityInfo'
securitySchemes:
oauth2:
flows:
authorizationCode:
authorizationUrl: /
scopes: {}
tokenUrl: /
type: oauth2
bearer-key:
type: http
description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN
scheme: bearer
bearerFormat: JWT
bearerAuth:
type: oauth2
description: OAuth 2.0 Bearer token authentication
flows:
authorizationCode:
authorizationUrl: https://webexapis.com/v1/authorize
tokenUrl: https://webexapis.com/v1/access_token
scopes:
spark:applications_token: Create access tokens for Service Apps