openapi: 3.0.0 info: title: Webex Admin Address Book AI Feature 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: AI Feature paths: /organization/{orgid}/ai-feature/auto-csat/question: post: tags: - AI Feature summary: Create a new Question mapped to AutoCSAT description: Create a new Auto CSAT mapped Question in a given organization. operationId: createConfigAutoCSATQuestion2 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/AutoCSATQuestionDTO' required: true responses: '201': description: Created content: '*/*': schema: $ref: '#/components/schemas/AutoCSATQuestionDTO' '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: [] /organization/{orgid}/ai-feature/auto-csat/question/bulk: post: tags: - AI Feature summary: Bulk save Question mapped to AutoCSAT description: Create, Update or delete Auto CSAT mapped Question(s) in bulk for Auto CSAT resource in a given organization. operationId: saveAllConfigAutoCSATQuestion2 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/BulkRequestDTOAutoCSATQuestionDTO' 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: [] /organization/{orgid}/ai-feature/auto-csat/question/{id}: get: tags: - AI Feature summary: Get specific Question mapped to AutoCSAT by ID description: Retrieve an existing Auto CSAT mapped Question by ID in a given organization. operationId: getConfigAutoCSATQuestion2 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 Auto CSAT mapped Question. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AutoCSATQuestionDTO' '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: [] delete: tags: - AI Feature summary: Delete specific Question mapped to AutoCSAT by ID description: Delete an existing Auto CSAT mapped Question by ID in a given organization. operationId: deleteConfigAutoCSATQuestion2 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 Auto CSAT mapped Question. 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: [] /organization/{orgid}/ai-feature/{id}: get: tags: - AI Feature summary: Get specific AI Feature resource by ID description: Retrieve an existing AI Feature resource by ID in a given organization. operationId: getConfigAiFeature 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 AI Feature resource. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AiFeatureDTO' '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: [] patch: tags: - AI Feature summary: Partially update AI Feature resource by ID description: Partially update AI Feature resource by ID in a given organization. operationId: patchConfigAiFeature 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 AI Feature resource. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 requestBody: content: application/json: schema: $ref: '#/components/schemas/AiFeatureDTO' examples: realTimeTranscriptsPatchExample: summary: Real time transcripts configuration update description: Real time transcripts configuration update. Must have access to update. value: id: 26e2df70-0f77-41b8-8e8f-1d76e92c9638 realtimeTranscripts: enable: true suggestedResponsesPatchExample: summary: Generated Summaries configuration update description: Generated Summaries configuration update. Must have access to update. value: id: 26e2df70-0f77-41b8-8e8f-1d76e92c9638 generatedSummaries: callDropSummariesEnabled: true virtualAgentTransferSummariesEnabled: true consultTransferSummariesEnabled: true wrapUpSummariesEnabled: true queuesInclusionType: ALL agentWellbeingPatchExample: summary: Agent Wellbeing configuration update description: Agent Wellbeing configuration update. Must have access to update. value: id: 26e2df70-0f77-41b8-8e8f-1d76e92c9638 agentWellbeing: enable: true agentInclusionType: ALL wellnessBreakReminders: ENABLED required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/AiFeatureDTO' '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: [] '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/ai-feature: get: tags: - AI Feature summary: List AI Feature resource(s) description: Retrieve a list of AI Feature resource(s) in a given organization.Only one entry per organization can exist for AI Feature resource. operationId: getAllConfigWithPagedMetaDataAiFeature 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. 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 responses: '200': description: OK content: application/json: schema: type: string example: "\"{\n \"meta\": {\n \"orgid\": \"28bde207-a31c-49de-8e66-9b83954d6355\",\n \"page\": 0,\n \"pageSize\": 100,\n \"totalPages\": 1,\n \"totalRecords\": 1,\n \"links\": {\n \"self\": \"/cms/api/organization/28bde207-a31c-49de-8e66-9b83954d6355/v2/ai-feature?page=0&pageSize=100\"\n }\n },\n \"data\": [\n {\n \"organizationId\": \"28bde207-a31c-49de-8e66-9b83954d6355\",\n \"id\": \"d4bff13d-ae88-49d6-872f-e4b58bddc10b\",\n \"version\": 9,\n \"realtimeTranscripts\": {\n \"enable\": true,\n \"agentInclusionType\": \"ALL\",\n \"queuesInclusionType\": \"ALL\"\n },\n \"suggestedResponses\": {\n \"enable\": false\n },\n \"generatedSummaries\": {\n \"callDropSummariesEnabled\": true,\n \"virtualAgentTransferSummariesEnabled\": true,\n \"consultTransferSummariesEnabled\": false,\n \"wrapUpSummariesEnabled\": false,\n \"queuesInclusionType\": \"ALL\"\n },\n \"agentWellbeing\": {\n \"enable\": true,\n \"agentInclusionType\": \"ALL\",\n \"wellnessBreakReminders\": \"DISABLED\"\n },\n \"autoCSAT\": {\n \"enable\": true,\n \"queuesInclusionType\": \"SPECIFIC\",\n \"surveyDataSource\": \"EXPERIENCE_MANAGEMENT\"\n },\n \"links\": [],\n \"createdTime\": 1770337368000,\n \"lastUpdatedTime\": 1771607999000\n }\n ]\n}\"" properties: meta: $ref: '#/components/schemas/MetaDataWithPagingInfo' data: type: array items: $ref: '#/components/schemas/AiFeatureDTO' '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: [] /organization/{orgid}/v2/ai-feature/auto-csat/question: get: tags: - AI Feature summary: List Question mapped to AutoCSAT(s) description: Retrieve a list of Auto CSAT mapped Question(s) in a given organization. operationId: getAllConfigWithMetaDataAutoCSATQuestion2 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, 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" 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.(id, questionId, questionnaireId) 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 responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/ResponseEnvelopeAutoCSATQuestionDTO' '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: [] components: schemas: RealtimeTranscriptsDTO: type: object description: This is applicable/available when either AI Assistant/AI Quality Management add-on offer/license is added to the organization. properties: enable: type: boolean description: Used to toggle the state of the AI feature sub feature configuration from active to inactive and vice-versa. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false. example: true agentInclusionType: type: string deprecated: true description: Provides information whether all or specific agents are selected for realtime transcripts. enum: - ALL - SPECIFIC example: ALL queuesInclusionType: type: string description: Provides information whether all or specific queues are selected for Real time transcription. If the value is missing in response, the consumer should assume a value as ALL. enum: - ALL - SPECIFIC example: ALL required: - enable 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' ResponseEnvelopeAutoCSATQuestionDTO: type: object properties: meta: type: object additionalProperties: {} data: type: array items: $ref: '#/components/schemas/AutoCSATQuestionDTO' AiGeneratedSummariesDTO: type: object description: This is applicable/available only when AI Assistant add-on offer/license is added to the organization. properties: callDropSummariesEnabled: type: boolean description: Used to toggle the enable/disable call drop summaries for Generated Summaries configuration. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false. example: true virtualAgentTransferSummariesEnabled: type: boolean description: Used to toggle the enable/disable virtual agent transfer summaries for Generated Summaries configuration. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false. example: true consultTransferSummariesEnabled: type: boolean description: Used to toggle the enable/disable mid call consult/transfer summaries in Generated Summaries configuration. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false. example: true wrapUpSummariesEnabled: type: boolean description: Used to toggle the enable/disable post call summaries in Generated Summaries configuration. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false. example: true queuesInclusionType: type: string description: Provides information whether all or specific queues are selected for Generated Summaries resource. If the value is missing in response, the consumer should assume a value as ALL. enum: - ALL - SPECIFIC example: ALL AgentWellbeingDTO: type: object description: This is applicable/available only when AI Assistant add-on offer/license is added to the organization. properties: enable: type: boolean description: Used to toggle the state of the AI feature sub feature configuration from active to inactive and vice-versa. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false. example: true agentInclusionType: type: string description: Provides information whether all or specific agents are selected for Agent Wellbeing. If the value is missing in response, the consumer should assume a value as ALL. enum: - ALL - SPECIFIC example: ALL wellnessBreakReminders: type: string description: Provides information whether Wellness break reminders are enabled or disabled. If the value is missing in response, the consumer should assume a value as DISABLED. enum: - DISABLED - ENABLED example: DISABLED required: - agentInclusionType - enable 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 AutoCSATQuestionDTO: 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 questionId: type: string description: Question ID that is mapped for Auto CSAT configuration example: 93912f11-6017-404b-bf14-5331890b1797 minLength: 1 questionnaireId: type: string description: Questionnaire ID corresponding to the Question ID that is mapped for Auto CSAT configuration example: 93912f11-6017-404b-bf14-5331890b1797 minLength: 1 createdTime: type: integer format: int64 description: This is the created time of the entity. example: 123456789 lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. example: 123456789 required: - questionId - questionnaireId 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. SentimentAnalysisDTO: type: object description: This is applicable/available when either AI Assistant/AI Quality Management add-on offer/license is added to the organization. properties: enable: type: boolean description: Used to toggle the state of the Sentiment Analysis configuration from active to inactive and vice-versa. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false. example: true queuesInclusionType: type: string description: Provides information whether all or specific queues are selected for Sentiment Analysis. If the value is missing in response, the consumer should assume a value as ALL. enum: - ALL - SPECIFIC example: ALL required: - enable AiFeatureDTO: type: object example: organizationId: 28bde207-a31c-49de-8e66-9b83954d6355 id: d4bff13d-ae88-49d6-872f-e4b58bddc10b version: 9 realtimeTranscripts: enable: true agentInclusionType: ALL queuesInclusionType: ALL suggestedResponses: enable: false generatedSummaries: callDropSummariesEnabled: true virtualAgentTransferSummariesEnabled: true consultTransferSummariesEnabled: false wrapUpSummariesEnabled: false queuesInclusionType: ALL agentWellbeing: enable: true agentInclusionType: ALL wellnessBreakReminders: DISABLED autoCSAT: enable: true queuesInclusionType: SPECIFIC surveyDataSource: EXPERIENCE_MANAGEMENT links: [] createdTime: 1770337368000 lastUpdatedTime: 1771607999000 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 realtimeTranscripts: $ref: '#/components/schemas/RealtimeTranscriptsDTO' suggestedResponses: $ref: '#/components/schemas/SuggestedResponsesDTO' generatedSummaries: $ref: '#/components/schemas/AiGeneratedSummariesDTO' agentWellbeing: $ref: '#/components/schemas/AgentWellbeingDTO' autoCSAT: $ref: '#/components/schemas/AiAutoCSATDTO' coachingInsights: $ref: '#/components/schemas/CoachingInsightsDTO' evaluationsAndAnalytics: $ref: '#/components/schemas/EvaluationsAnalyticsDTO' sentimentAnalysis: $ref: '#/components/schemas/SentimentAnalysisDTO' predictedWaitTime: $ref: '#/components/schemas/PredictedWaitTimeDTO' personalizedAIRouting: $ref: '#/components/schemas/PersonalizedAIRoutingDTO' createdTime: type: integer format: int64 description: This is the created time of the entity. example: 123456789 lastUpdatedTime: type: integer format: int64 description: This is the updated time of the entity. example: 123456789 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' CoachingInsightsDTO: type: object description: This is applicable/available only when AI Quality Management add-on offer/license is added to the organization. properties: enable: type: boolean description: Used to toggle the state of the Coaching Insights configuration from active to inactive and vice-versa. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false. example: true required: - enable BulkResponseDTO: type: object properties: items: type: array items: $ref: '#/components/schemas/BulkResponseItemDTO' EvaluationsAnalyticsDTO: type: object description: This is applicable/available only when AI Quality Management add-on offer/license is added to the organization. properties: enable: type: boolean description: Used to toggle the state of the Evaluations and Analytics configuration from active to inactive and vice-versa. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false. example: true required: - enable MetaDataWithPagingInfo: type: object description: Metadata of response with paging information properties: orgid: type: string format: uuid description: Organization ID. example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba1 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}$ page: type: integer format: int32 description: Current page number. example: 1 pageSize: type: integer format: int32 description: Page size for current data set. example: 100 totalPages: type: integer format: int32 description: Number of pages. example: 1 totalRecords: type: integer format: int32 description: Total number of items. 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/entity-name?page=2&pageSize=10 last: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=3&pageSize=10 prev: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=0&pageSize=10 self: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=1&pageSize=10 first: /organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/entity-name?page=0&pageSize=10 title: MetaDataWithPagingInfo PredictedWaitTimeDTO: type: object description: AI wait time feature configuration properties: enable: type: boolean description: Used to toggle the state of the Predicted Wait Time configuration from active to inactive and vice-versa. Mandatory for create/update operation. example: true queuesInclusionType: type: string description: Provides information whether all or specific queues are selected for Predicted Wait Time. enum: - ALL - SPECIFIC example: ALL required: - enable BulkRequestItemDTOAutoCSATQuestionDTO: 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/AutoCSATQuestionDTO' requestAction: type: string description: Identifier for action type. Possible values are `SAVE` and `DELETE`. example: SAVE SuggestedResponsesDTO: type: object description: This is applicable/available only when AI Assistant add-on offer/license is added to the organization. properties: enable: type: boolean description: Used to toggle the state of the AI feature sub feature configuration from active to inactive and vice-versa. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false. example: true required: - enable BulkRequestDTOAutoCSATQuestionDTO: type: object properties: items: type: array description: List of items in the bulk request. items: $ref: '#/components/schemas/BulkRequestItemDTOAutoCSATQuestionDTO' PersonalizedAIRoutingDTO: type: object properties: enable: type: boolean description: Used to toggle the state of the Personalized AI Routing configuration from active to inactive and vice-versa. Mandatory for create/update operation. example: true cjdsWorkspaceId: type: string description: Id of the CJDS workspace id to be used for model training. example: true cjdsProfileTemplateId: type: string description: Id of the CJDS Profile template to be used for model training. example: true AiAutoCSATDTO: type: object description: This is applicable/available when either AI Assistant/AI Quality Management add-on offer/license is added to the organization. properties: enable: type: boolean description: Used to toggle the state of the AI feature sub feature configuration from active to inactive and vice-versa. Mandatory for create/update operation. If the value is missing in response, the consumer should assume a value as false. example: true queuesInclusionType: type: string description: Provides information whether all or specific queues are selected for Auto CSAT. If the value is missing in response, the consumer should assume a value as ALL. enum: - ALL - SPECIFIC example: ALL selectedGlobalVariableId: type: string description: Selected Global Variable ID for Auto CSAT. If the value is missing in response, the consumer should assume a value as null. example: af9eecc5-0472-4549-9a83-2afdae0d4ba0 surveyDataSource: type: string description: Survey Data Source Type for Auto CSAT. If the value is missing in response, the consumer should assume a value as EXPERIENCE_MANAGEMENT. enum: - EXPERIENCE_MANAGEMENT - GLOBAL_VARIABLE example: EXPERIENCE_MANAGEMENT required: - enable 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