openapi: 3.0.0 info: title: Webex Admin Address Book Agent Personal Greeting Files 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: Agent Personal Greeting Files paths: /organization/{orgid}/agent-personal-greeting: post: tags: - Agent Personal Greeting Files summary: Create a new Greeting File description: Create a new agent personal greeting File for a given organization. operationId: createConfig_28 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: type: object properties: agentPersonalGreetingInfo: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithAttributeTag' audioFile: type: string format: binary required: - agentPersonalGreetingInfo - audioFile multipart/form-data: schema: type: object properties: agentPersonalGreetingInfo: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithAttributeTag' audioFile: type: string format: binary required: - agentPersonalGreetingInfo - audioFile responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithAttributeTag' '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: true /organization/{orgid}/agent-personal-greeting/delete-reference: post: tags: - Agent Personal Greeting Files operationId: deleteReferences_1 parameters: - name: orgid in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/FieldRequestBody' required: true 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: [] /organization/{orgid}/agent-personal-greeting/{id}: get: tags: - Agent Personal Greeting Files summary: Get specific Greeting File by ID description: Retrieve an existing Greeting File by ID in a given organization. operationId: getConfig_28 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 Greeting File. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 - name: includeUrl in: query description: Indicates if the URL for downloading Greeting Fileshould be included in the response. required: false schema: type: boolean example: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithAttributeTag' '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: true put: tags: - Agent Personal Greeting Files summary: Update specific Greeting File by ID description: Update specific Greeting File by ID in a given organization. operationId: updateConfig_28 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 Greeting File. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 requestBody: content: application/json: schema: type: object properties: agentPersonalGreetingInfo: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithAttributeTag' audioFile: type: string format: binary required: - agentPersonalGreetingInfo - audioFile multipart/form-data: schema: type: object properties: agentPersonalGreetingInfo: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithAttributeTag' audioFile: type: string format: binary required: - agentPersonalGreetingInfo - audioFile responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithAttributeTag' '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: true delete: tags: - Agent Personal Greeting Files summary: Delete specific Greeting File by ID description: Delete an existing Greeting File by ID for a given organization. operationId: deleteConfig_24 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 Greeting File. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 responses: '200': description: OK '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: true patch: tags: - Agent Personal Greeting Files summary: Partially update Greeting File by ID description: Partially update Greeting File by ID in a given organization. operationId: patchConfig_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 Greeting File. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 requestBody: content: application/json: schema: $ref: '#/components/schemas/AgentPersonalGreetingPatchDTO_AgentPersonalGreetingsWithAttributeTag' multipart/form-data: schema: $ref: '#/components/schemas/AgentPersonalGreetingPatchDTO_AgentPersonalGreetingsWithAttributeTag' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithAttributeTag' '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: true /organization/{orgid}/v2/agent-personal-greeting: get: tags: - Agent Personal Greeting Files operationId: getAllConfigWithMetaData 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 fields are : firstname, lastname, email, ciUserId and attribute tag \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: search in: query description: 'Filter data based on the search keyword.Supported search columns(firstName, lastName, email, attributeTag) The examples below show some search queries - "Cisco" - field=="firstName";value=="Cisco" - fields=in=("firstName","email");value=="Cisco" ' required: false schema: type: string example: contact center - 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 - name: includeAgentDetails in: query description: If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled. schema: type: boolean default: false responses: '200': description: OK content: '*/*': schema: type: object properties: meta: $ref: '#/components/schemas/MetaDataWithPagingInfo' data: type: array items: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithAttributeTag' '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: [] post: tags: - Agent Personal Greeting Files summary: Create a new Greeting File using v2 API operationId: createV2Config 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: type: object properties: agentPersonalGreetingInfo: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithGreetingPurpose' audioFile: type: string format: binary required: - agentPersonalGreetingInfo - audioFile multipart/form-data: schema: type: object properties: agentPersonalGreetingInfo: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithGreetingPurpose' audioFile: type: string format: binary required: - agentPersonalGreetingInfo - audioFile responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithGreetingPurpose' '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}/v2/agent-personal-greeting/{id}: get: tags: - Agent Personal Greeting Files summary: Get specific Greeting File by ID using v2 API description: Retrieve an existing Greeting File by ID in a given organization. operationId: getV2Config 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 Greeting File. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 - name: includeUrl in: query description: Indicates if the URL for downloading Greeting Fileshould be included in the response. required: false schema: type: boolean example: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithGreetingPurpose' '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: - Agent Personal Greeting Files summary: Update specific Greeting File by ID using v2 API description: Update specific Greeting File by ID in a given organization. operationId: updateV2Config 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 Greeting File. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 requestBody: content: application/json: schema: type: object properties: agentPersonalGreetingInfo: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithGreetingPurpose' audioFile: type: string format: binary required: - agentPersonalGreetingInfo - audioFile multipart/form-data: schema: type: object properties: agentPersonalGreetingInfo: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithGreetingPurpose' audioFile: type: string format: binary required: - agentPersonalGreetingInfo - audioFile responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithGreetingPurpose' '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: - Agent Personal Greeting Files summary: Delete specific Greeting File by ID using v2 API description: Delete an existing Greeting File by ID for a given organization. operationId: deleteV2Config 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 Greeting File. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 responses: '200': description: OK '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 patch: tags: - Agent Personal Greeting Files summary: Partially update Greeting File by ID using v2 API description: Partially update Greeting File by ID in a given organization. operationId: patchV2Config 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 Greeting File. required: true schema: type: string example: 2f9eecc5-0472-4549-9a83-2afdae0d4ba2 requestBody: content: application/json: schema: $ref: '#/components/schemas/AgentPersonalGreetingPatchDTO_AgentPersonalGreetingsWithGreetingPurpose' multipart/form-data: schema: $ref: '#/components/schemas/AgentPersonalGreetingPatchDTO_AgentPersonalGreetingsWithGreetingPurpose' required: true responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithGreetingPurpose' '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}/v3/agent-personal-greeting: get: tags: - Agent Personal Greeting Files summary: List Greeting File(s) description: Retrieve a list of Greeting File(s) in a given organization. operationId: getAllV2ConfigWithMetaData 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 fields are : firstname, lastname, email, ciUserId and attribute tag \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: search in: query description: 'Filter data based on the search keyword.Supported search columns(firstName, lastName, email, attributeTag) The examples below show some search queries - "Cisco" - field=="firstName";value=="Cisco" - fields=in=("firstName","email");value=="Cisco" ' required: false schema: type: string example: contact center - 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 - name: includeAgentDetails in: query description: If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled. schema: type: boolean default: false responses: '200': description: OK content: '*/*': schema: type: object properties: meta: $ref: '#/components/schemas/MetaDataWithPagingInfo' data: type: array items: $ref: '#/components/schemas/AgentPersonalGreetingDTO_AgentPersonalGreetingsWithGreetingPurpose' '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: AgentPersonalGreetingDTO_AgentPersonalGreetingsWithGreetingPurpose: 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: 'A name for the Agent''s personal greeting file. It should have valid extension i.e. .wav ' example: WelcomeMessage.wav maxLength: 80 minLength: 0 pattern: ^[a-zA-Z0-9._\-\s]*$ contentType: type: string description: 'Indicates Content-Type of the Audio file. It can take one of these values: AUDIO_WAV, AUDIO_X_WAV' enum: - AUDIO_WAV - TEXT_HTML - TEXT_PHP - AUDIO_X_WAV - APPLICATION_OCTET_STREAM example: AUDIO_WAV blobId: type: string description: Identifier for the audio file. example: audio-file_a7c700d5-2fac-4a6c-9a16-eb2f2b42d7a8 url: type: string format: url description: Audio file download url. example: https://cjp-ccone-devus1-ivr-media.s3.amazonaws.com/bde75a64-f4d5-4ffc-a239-feb607c17ef8/ agentId: type: string description: Agent Id with which this greeting file is to be associated with. example: 955fe2b9-ba25-4de9-92b0-6cb055d5b432 minLength: 1 firstName: type: string description: First Name of the Agent with whom this greeting file is to be associated with. example: John lastName: type: string description: Last Name of the Agent with whom this greeting file is to be associated with. example: Doe email: type: string description: Email of the Agent with whom this greeting file is to be associated with. example: JohnDoe@example.com agentActive: type: boolean description: Indicates whether the Agent with whom this greeting file is to be associated with is active or not active example: true ciUserId: type: string description: Id of the Agent in common identity with whom this greeting file is to be associated with. example: c71876ae-ddfa-4049-9a1b-298535152578 greetingPurposeId: type: string description: Id of the greeting purpose example: f53c8b54-46ca-43f6-ba05-08426a46e23d greetingPurposeName: type: string description: Name of the greeting purpose example: en audioFile: type: string format: binary 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: - agentId - contentType - name 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 AgentPersonalGreetingDTO_AgentPersonalGreetingsWithAttributeTag: 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: 'A name for the Agent''s personal greeting file. It should have valid extension i.e. .wav ' example: WelcomeMessage.wav maxLength: 80 minLength: 0 pattern: ^[a-zA-Z0-9._\-\s]*$ contentType: type: string description: 'Indicates Content-Type of the Audio file. It can take one of these values: AUDIO_WAV, AUDIO_X_WAV' enum: - AUDIO_WAV - TEXT_HTML - TEXT_PHP - AUDIO_X_WAV - APPLICATION_OCTET_STREAM example: AUDIO_WAV blobId: type: string description: Identifier for the audio file. example: audio-file_a7c700d5-2fac-4a6c-9a16-eb2f2b42d7a8 url: type: string format: url description: Audio file download url. example: https://cjp-ccone-devus1-ivr-media.s3.amazonaws.com/bde75a64-f4d5-4ffc-a239-feb607c17ef8/ agentId: type: string description: Agent Id with which this greeting file is to be associated with. example: 955fe2b9-ba25-4de9-92b0-6cb055d5b432 minLength: 1 attributeTag: type: string description: This is used to identify the purpose of a greeting. example: ENVIP maxLength: 80 minLength: 0 pattern: ^[a-zA-Z0-9_-]*$ firstName: type: string description: First Name of the Agent with whom this greeting file is to be associated with. example: John lastName: type: string description: Last Name of the Agent with whom this greeting file is to be associated with. example: Doe email: type: string description: Email of the Agent with whom this greeting file is to be associated with. example: JohnDoe@example.com agentActive: type: boolean description: Indicates whether the Agent with whom this greeting file is to be associated with is active or not active example: true ciUserId: type: string description: Id of the Agent in common identity with whom this greeting file is to be associated with. example: c71876ae-ddfa-4049-9a1b-298535152578 audioFile: type: string format: binary 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: - agentId - contentType - name AgentPersonalGreetingPatchDTO_AgentPersonalGreetingsWithAttributeTag: type: object properties: attributeTag: type: string description: This is used to identify the purpose of a greeting. example: ENVIP greetingPurposeId: type: string description: Id of the greeting purpose example: f53c8b54-46ca-43f6-ba05-08426a46e23d 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' 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. FieldRequestBody: type: object description: Request body containing field references for delete operations. properties: references: type: object description: A map of reference field names to their values. additionalProperties: type: string 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 AgentPersonalGreetingPatchDTO_AgentPersonalGreetingsWithGreetingPurpose: type: object properties: attributeTag: type: string description: This is used to identify the purpose of a greeting. example: ENVIP greetingPurposeId: type: string description: Id of the greeting purpose example: f53c8b54-46ca-43f6-ba05-08426a46e23d 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