{
"openapi": "3.0.0",
"info": {
"title": "Webex Contact Center",
"version": "1.0.0",
"description": "The Webex Contact Center APIs allow developers to deeply integrate, configure, and manage cloud-based contact center solutions. These APIs cover agent lifecycle management, queue and routing configuration, customer journey tracking, and access to real-time and historical analytics. Use cases include embedding agent controls in custom UIs, automating workforce management, integrating with CRM and ticketing systems, and building custom reporting dashboards. The APIs empower organizations to deliver personalized, efficient customer experiences and optimize contact center operations.",
"x-provenance": {
"method": "harvested",
"authored_by": "Cisco Webex",
"harvested_by": "API Evangelist",
"harvested_on": "2026-07-31",
"first_party": true,
"note": "Published by Cisco. Retrieved unmodified except for this x-provenance block.",
"provider_published": true
},
"x-evidence": [
{
"type": "source",
"url": "https://github.com/webex/webex-openapi-specs/blob/main/public-spec/webex-contact-center.json"
},
{
"type": "raw",
"url": "https://raw.githubusercontent.com/webex/webex-openapi-specs/main/public-spec/webex-contact-center.json"
}
]
},
"tags": [
{
"name": "Agent Summaries"
},
{
"name": "Agents"
},
{
"name": "Callbacks",
"description": "APIs for scheduling and managing callbacks for customers."
},
{
"name": "Tasks"
},
{
"name": "DNC Management",
"description": "Operations for managing Do Not Contact (DNC) lists and phone number entries"
},
{
"name": "Campaign Group",
"description": "Operations for retrieving campaigns associated with a campaign group"
},
{
"name": "Contact List Management",
"description": "Operations for managing contact lists and contacts"
}
],
"paths": {
"/generated-summaries/search": {
"post": {
"tags": [
"Agent Summaries"
],
"summary": "List summaries",
"description": "Lists summaries based on the requested search type.",
"operationId": "listSummaries",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SummaryListRequest"
},
"examples": {
"listByOrganization": {
"summary": "Case 1: List by organizationId",
"value": {
"searchType": "ORGANIZATION",
"orgId": "acc80d18-b1fb-4261-b44e-a46435eea1da"
}
},
"listByInteraction": {
"summary": "Case 2: List by interactionId",
"value": {
"searchType": "INTERACTION",
"orgId": "acc80d18-b1fb-4261-b44e-a46435eea1da",
"interactionId": "9d2a7879-8957-4cd6-a39c-46d4f21eaea5"
}
},
"listByAgentCiUserId": {
"summary": "Case 3: List by agentCiUserId",
"value": {
"searchType": "AGENT",
"agentCiUserId": "77e70d79-64b1-402e-9b84-b113ad71b06d",
"orgId": "acc80d18-b1fb-4261-b44e-a46435eea1da"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SummaryListResponse"
},
"examples": {
"listByOrganization": {
"summary": "Case 1: List by organizationId",
"value": {
"interactionId": null,
"orgId": "acc80d18-b1fb-4261-b44e-a46435eea1da",
"searchType": "ORGANIZATION",
"agentCiUserId": null,
"summaries": {
"POST_CALL": {
"acc80d18-b1fb-4261-b44e-a46435eea1da:1bf3bd99-633b-401a-a3d4-61157a446809:c47d7c08-0776-4e38-a6bb-751d933a0c5d": {
"initialContactReason": "Broken tools appointment request",
"additionalContext": "Customer mentioned they had previously tried to fix the tools themselves but were unsuccessful.",
"additionalContactReasons": "Customer also asked about warranty coverage for the broken tools.",
"keyActionsTaken": "Scheduled an appointment with Doctor Petrophe for the caller",
"nextSteps": "Confirm appointment details via email and follow up on warranty inquiry.",
"chosenWrapUpCode": "Appointment Scheduled",
"proposedWrapUpCodes": [
{
"name": "Appointment Scheduled"
},
{
"name": "Service Request"
}
]
}
},
"MID_CALL": {
"acc80d18-b1fb-4261-b44e-a46435eea1da:9d2a7879-8957-4cd6-a39c-46d4f21eaea5:c47d7c08-0776-4e38-a6bb-751d933a0c5d": {
"reasonForTransferOrConsult": "The caller wants to purchase fifteen tickets for an upcoming match but the current agent needs to check with teammates for ticket availability, requiring a transfer to another agent who can assist with ticket sales.",
"additionalContext": "The match will take place next weekend at 6 PM, and the caller is part of a group looking to buy a large number of tickets.",
"keyActionsTaken": "Checked the match schedule\\nInquired about the number of tickets needed\\nInitiated a transfer to check ticket availability with teammates"
}
}
},
"queueId": null
}
},
"listByInteraction": {
"summary": "Case 2: List by interactionId",
"value": {
"interactionId": "9d2a7879-8957-4cd6-a39c-46d4f21eaea5",
"orgId": "acc80d18-b1fb-4261-b44e-a46435eea1da",
"searchType": "INTERACTION",
"agentCiUserId": null,
"summaries": {
"POST_CALL": {
"acc80d18-b1fb-4261-b44e-a46435eea1da:9d2a7879-8957-4cd6-a39c-46d4f21eaea5:c47d7c08-0776-4e38-a6bb-751d933a0c5d": {
"initialContactReason": "The caller wants to buy tickets for a match.",
"additionalContext": "The match is next weekend and the caller represents a group looking for tickets.",
"additionalContactReasons": "The caller also inquired about group discount options.",
"keyActionsTaken": "The agent checked ticket availability with teammates.\\nThe agent engaged with the caller about their request.",
"nextSteps": "Agent will confirm ticket availability for fifteen tickets and get back to the caller.",
"chosenWrapUpCode": "Ticket Inquiry",
"proposedWrapUpCodes": [
{
"name": "Ticket Inquiry"
},
{
"name": "Group Booking"
}
]
}
},
"MID_CALL": {
"acc80d18-b1fb-4261-b44e-a46435eea1da:9d2a7879-8957-4cd6-a39c-46d4f21eaea5:c47d7c08-0776-4e38-a6bb-751d933a0c5d": {
"reasonForTransferOrConsult": "The caller wants to purchase fifteen tickets for an upcoming match but the current agent needs to check with teammates for ticket availability, requiring a transfer to another agent who can assist with ticket sales.",
"additionalContext": "The match will take place next weekend at 6 PM, and the caller is part of a group looking to buy a large number of tickets.",
"keyActionsTaken": "Checked the match schedule\\nInquired about the number of tickets needed\\nInitiated a transfer to check ticket availability with teammates"
}
}
},
"queueId": null
}
},
"listByAgentCiUserId": {
"summary": "Case 3: List by agentCiUserId",
"value": {
"interactionId": null,
"orgId": "acc80d18-b1fb-4261-b44e-a46435eea1da",
"searchType": "AGENT",
"agentCiUserId": "77e70d79-64b1-402e-9b84-b113ad71b06d",
"summaries": {
"POST_CALL": {
"acc80d18-b1fb-4261-b44e-a46435eea1da:9d2a7879-8957-4cd6-a39c-46d4f21eaea5:77e70d79-64b1-402e-9b84-b113ad71b06d": {
"initialContactReason": "Customer wants to buy tickets for an upcoming match.",
"additionalContext": "Customer has a group of fifteen people and needs the tickets to be together.",
"additionalContactReasons": "Customer asked about group seating arrangements.",
"keyActionsTaken": "Checked availability of fifteen tickets for the match.\\nConfirmed grouped discount for the tickets.\\nProcessed the ticket purchase and confirmed ticket sending via email.",
"nextSteps": "Send the tickets to the customer's email.",
"chosenWrapUpCode": "Ticket Purchase",
"proposedWrapUpCodes": [
{
"name": "Ticket Purchase"
},
{
"name": "Group Booking"
}
]
}
}
},
"queueId": null
}
}
}
}
}
},
"400": {
"description": "Validation Error"
},
"401": {
"description": "Unauthorized Operation"
},
"403": {
"description": "Forbidden Operation"
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited."
},
"500": {
"description": "An Unexpected Error Occurred"
}
}
}
},
"/v1/agentburnout/subscribe": {
"post": {
"parameters": [
{
"name": "X-ORGANIZATION-ID",
"in": "header",
"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"
}
],
"tags": [
"Agent Wellbeing"
],
"summary": "Subscribe for realtime burnout events",
"description": "This endpoint provides real-time burnout events that are generated for agents belonging to the organization. It gives us a WebSocket URL to which we can connect to receive the real-time burnout events.",
"operationId": "subscribe_agentburnout",
"requestBody": {
"description": "Subscribes to the realtime burnout events.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionResponse"
}
}
}
},
"400": {
"description": "Validation Error"
},
"401": {
"description": "Unauthorized Operation"
},
"403": {
"description": "Forbidden Operation"
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited."
},
"500": {
"description": "An Unexpected Error Occurred"
}
}
}
},
"/v1/agentburnout/action": {
"post": {
"tags": [
"Agent Wellbeing"
],
"parameters": [
{
"name": "X-ORGANIZATION-ID",
"in": "header",
"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"
}
],
"summary": "Record the realtime burnout events",
"description": "The endpoint need to be invoked by Partners and Third-Party that will subscribe to the Agent Burnout system, in order to take certain action based on the agent burnout index calculated.",
"operationId": "post_action",
"requestBody": {
"description": "Record the action taken by integrating partners.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActionResponse"
}
}
}
},
"400": {
"description": "Validation Error"
},
"401": {
"description": "Unauthorized Operation"
},
"403": {
"description": "Forbidden Operation"
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited."
},
"500": {
"description": "An Unexpected Error Occurred"
}
}
}
},
"/organization/{orgid}/agent-burnout/{id}": {
"get": {
"tags": [
"Agent Wellbeing"
],
"summary": "Get specific Agent Burnout resource by ID",
"description": "Retrieve an existing Agent Burnout resource by ID in a given organization. Deprecated. Use GET /ai-feature/agent-burnout/{id} instead.",
"operationId": "getConfigAgentBurnout",
"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 Agent Burnout resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentBurnoutDTO"
}
}
}
},
"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 Wellbeing"
],
"summary": "Update specific Agent Burnout resource by ID",
"description": "Update an existing Agent Burnout resource by ID in a given organization. Deprecated. Use PUT /ai-feature/agent-burnout/{id} instead.",
"operationId": "updateConfigAgentBurnout",
"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 Agent Burnout resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentBurnoutDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentBurnoutDTO"
}
}
}
},
"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
}
},
"/organization/{orgid}/v2/agent-burnout": {
"get": {
"tags": [
"Agent Wellbeing"
],
"summary": "List Agent Burnout resource(s)",
"description": "Retrieve a list of Agent Burnout resource(s) in a given organization.Only one entry per organization can exist for Agent Burnout resource. Deprecated. Use GET /v2/ai-feature/agent-burnout instead.",
"operationId": "getAllConfigWithMetaDataAgentBurnout",
"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.",
"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": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataWithPagingInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentBurnoutDTO"
}
}
}
}
}
}
},
"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}/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": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/auto-csat/{autoCsatId}/question": {
"post": {
"tags": [
"Auto CSAT"
],
"summary": "Create a new Auto CSAT mapped Question",
"description": "Create a new Auto CSAT mapped Question in a given organization. Deprecated. Use POST /ai-feature/auto-csat/question instead.",
"operationId": "createConfigAutoCSATQuestion1",
"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": "autoCsatId",
"in": "path",
"description": "Resource ID of the Auto CSAT resource",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"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": []
}
]
}
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/auto-csat/{autoCsatId}/question/bulk": {
"post": {
"tags": [
"Auto CSAT"
],
"summary": "Bulk save Auto CSAT mapped Question(s)",
"description": "Create, Update or delete Auto CSAT mapped Question(s) in bulk for Auto CSAT resource in a given organization. Deprecated. Use POST /ai-feature/auto-csat/question/bulk instead.",
"operationId": "saveAllConfigAutoCSATQuestion1",
"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": "autoCsatId",
"in": "path",
"description": "Resource ID of the Auto CSAT resource",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"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": []
}
]
}
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/auto-csat/{autoCsatId}/question/{id}": {
"get": {
"tags": [
"Auto CSAT"
],
"summary": "Get specific Auto CSAT mapped Question by ID",
"description": "Retrieve an existing Auto CSAT mapped Question by ID in a given organization. Deprecated. Use GET /ai-feature/auto-csat/question/{id} instead.",
"operationId": "getConfigAutoCSATQuestion1",
"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": "autoCsatId",
"in": "path",
"description": "Resource ID of the Auto CSAT resource",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"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": []
}
]
}
}
}
}
}
},
"deprecated": true
},
"delete": {
"tags": [
"Auto CSAT"
],
"summary": "Delete specific Auto CSAT mapped Question by ID",
"description": "Delete an existing Auto CSAT mapped Question by ID in a given organization. Deprecated. Use DELETE /ai-feature/auto-csat/question/{id} instead.",
"operationId": "deleteConfigAutoCSATQuestion1",
"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": "autoCsatId",
"in": "path",
"description": "Resource ID of the Auto CSAT resource",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"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": []
}
]
}
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/auto-csat/{id}": {
"get": {
"tags": [
"Auto CSAT"
],
"summary": "Get specific Auto CSAT resource by ID",
"description": "Retrieve an existing Auto CSAT resource by ID in a given organization. Deprecated. Use GET /ai-feature/auto-csat/{id} instead.",
"operationId": "getConfigAutoCSAT",
"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 resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/AutoCSATDTO"
}
}
}
},
"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": [
"Auto CSAT"
],
"summary": "Update specific Auto CSAT resource by ID",
"description": "Update an existing Auto CSAT resource by ID in a given organization. Deprecated. Use PUT /ai-feature/auto-csat/{id} instead.",
"operationId": "updateConfigAutoCSAT",
"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 resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AutoCSATDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/AutoCSATDTO"
}
}
}
},
"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
}
},
"/organization/{orgid}/v2/auto-csat": {
"get": {
"tags": [
"Auto CSAT"
],
"summary": "List Auto CSAT resource(s)",
"description": "Retrieve a list of Auto CSAT resource(s) in a given organization.Only one entry per organization can exist for Auto CSAT resource. Deprecated. Use GET /v2/ai-feature/auto-csat instead.",
"operationId": "getAllConfigWithMetaDataAutoCSAT",
"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.",
"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/ResponseEnvelopeAutoCSATDTO"
}
}
}
},
"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/auto-csat/{autoCsatId}/question": {
"get": {
"tags": [
"Auto CSAT"
],
"summary": "List Auto CSAT mapped Question(s)",
"description": "Retrieve a list of Auto CSAT mapped Question(s) in a given organization. Deprecated. Use GET /v2/ai-feature/auto-csat/question instead.",
"operationId": "getAllConfigWithMetaDataAutoCSATQuestion1",
"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": "autoCsatId",
"in": "path",
"description": "Resource ID of the Auto CSAT resource",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"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": []
}
]
}
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/generated-summaries/{id}": {
"get": {
"tags": [
"Generated Summaries"
],
"summary": "Get specific Generated Summaries resource by ID",
"description": "Retrieve an existing Generated Summaries resource by ID in a given organization. Deprecated. Use GET /ai-feature/generated-summaries/{id} instead.",
"operationId": "getConfigGeneratedSummaries",
"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 Generated Summaries resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GeneratedSummariesDTO"
}
}
}
},
"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": [
"Generated Summaries"
],
"summary": "Update specific Generated Summaries resource by ID",
"description": "Update an existing Generated Summaries resource by ID in a given organization. Deprecated. Use PUT /ai-feature/generated-summaries/{id} instead.",
"operationId": "updateConfigGeneratedSummaries",
"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 Generated Summaries resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GeneratedSummariesDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/GeneratedSummariesDTO"
}
}
}
},
"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
}
},
"/organization/{orgid}/v2/generated-summaries": {
"get": {
"tags": [
"Generated Summaries"
],
"summary": "List Generated Summaries resource(s)",
"description": "Retrieve a list of Generated Summaries resource(s) in a given organization.Only one entry per organization can exist for Generated Summaries resource. Deprecated. Use GET /v2/ai-feature/generated-summaries instead.",
"operationId": "getAllConfigWithMetaDataGeneratedSummaries",
"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.",
"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/ResponseMetaEnvelopeGeneratedSummariesDTOMetaDataPagedInfo"
}
}
}
},
"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}/business-hours": {
"get": {
"tags": [
"Business Hour"
],
"summary": "List Business Hours resources",
"description": "Retrieve a list of Business Hours resources in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigBusinessHours",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "filter",
"in": "query",
"description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n",
"required": false,
"schema": {
"type": "string"
},
"example": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\""
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)",
"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
}
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BusinessHoursDTOList"
}
},
"example": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"holidaysId": "string",
"timezone": "America/New_York",
"name": "New Business Hour",
"description": "This business hour can be set for happy hours",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"workingHoursCount": "string",
"version": 1,
"overridesId": "string"
}
]
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
},
"post": {
"tags": [
"Business Hour"
],
"summary": "Create a new Business Hours resource",
"description": "Create a new Business Hours resource in a given organization.",
"operationId": "createConfigBusinessHours",
"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/BusinessHoursDTO"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BusinessHoursDTO"
}
}
}
},
"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}/business-hours/bulk": {
"post": {
"tags": [
"Business Hour"
],
"summary": "Bulk save Business Hours resources",
"description": "Create, Update or delete Business Hours resources in bulk in a given organization.",
"operationId": "saveAllConfigBusinessHours",
"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/BulkRequestDTOBusinessHoursDTO"
}
}
},
"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}/business-hours/{id}": {
"get": {
"tags": [
"Business Hour"
],
"summary": "Get specific Business Hours resource by ID",
"description": "Retrieve an existing Business Hours resource by ID in a given organization.",
"operationId": "getConfigBusinessHours",
"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 Business Hour.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BusinessHoursDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"put": {
"tags": [
"Business Hour"
],
"summary": "Update specific Business Hours resource by ID",
"description": "Update an existing Business Hours resource by ID in a given organization.",
"operationId": "updateConfigBusinessHours",
"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 Business Hour.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BusinessHoursDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BusinessHoursDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"delete": {
"tags": [
"Business Hour"
],
"summary": "Delete specific Business Hours resource by ID",
"description": "Delete an existing Business Hours resource by ID in a given organization.",
"operationId": "deleteConfigBusinessHours",
"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 Business Hour.",
"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}/business-hours/{id}/incoming-references": {
"get": {
"tags": [
"Business Hour"
],
"summary": "List references for a specific Business Hours resource",
"description": "Retrieve a list of all entities that have reference to an existing Business Hours resource by ID in a given organization.",
"operationId": "getIncomingReferencesBusinessHours",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "reference-entity"
},
{
"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
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/v2/business-hours": {
"get": {
"tags": [
"Business Hour"
],
"summary": "List Business Hours resources",
"description": "Retrieve a list of Business Hours resources in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigWithMetaDataBusinessHours",
"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, workingHours, 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==\"af9eecc5-0472-4549-9a83-2afdae0d4ba0\""
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (workingHours)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
}
},
{
"name": "sort",
"in": "query",
"description": "Sorting criteria in the format: property(, asc | desc). Default sort order is ascending. Supported sortable fields (name, timezone, createdTime, lastUpdatedTime). \n\n\nThe examples below show some sort queries\n- name,asc\n- timezone,desc\n",
"schema": {
"type": "string",
"default": "timeZone",
"example": "timeZone"
}
},
{
"name": "includeCount",
"in": "query",
"description": "Enable this flag to get the count of working hours.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeBusinessHoursDTO"
},
"example": {
"data": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"holidaysId": "string",
"timezone": "America/New_York",
"name": "New Business Hour",
"description": "This business hour can be set for happy hours",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"workingHoursCount": "string",
"version": 1,
"overridesId": "string"
}
],
"meta": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/holiday-list": {
"get": {
"tags": [
"Holiday List"
],
"summary": "List Holiday Lists",
"description": "Retrieve a list of Holiday Lists in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigHolidayList",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "filter",
"in": "query",
"description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n",
"required": false,
"schema": {
"type": "string"
},
"example": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\""
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except holidays",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HolidayListDTOList"
}
},
"example": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"name": "Holiday List 2022",
"description": "This is a holiday list for year 2022.",
"holidaysCount": "string",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1
}
]
}
}
},
"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": [
"Holiday List"
],
"summary": "Create a new Holiday List",
"description": "Create a new Holiday List in a given organization.",
"operationId": "createConfigHolidayList",
"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/HolidayListDTO"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/HolidayListDTO"
}
}
}
},
"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}/holiday-list/bulk": {
"post": {
"tags": [
"Holiday List"
],
"summary": "Bulk save Holiday Lists",
"description": "Create, Update or delete Holiday Lists in bulk in a given organization.",
"operationId": "saveAllConfigHolidayList",
"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/BulkRequestDTOHolidayListDTO"
}
}
},
"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}/holiday-list/{id}": {
"get": {
"tags": [
"Holiday List"
],
"summary": "Get specific Holiday List by ID",
"description": "Retrieve an existing Holiday List by ID in a given organization.",
"operationId": "getConfigHolidayList",
"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 Holiday List.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/HolidayListDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"put": {
"tags": [
"Holiday List"
],
"summary": "Update specific Holiday List by ID",
"description": "Update an existing Holiday List by ID in a given organization.",
"operationId": "updateConfigHolidayList",
"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 Holiday List.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HolidayListDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/HolidayListDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"delete": {
"tags": [
"Holiday List"
],
"summary": "Delete specific Holiday List by ID",
"description": "Delete an existing Holiday List by ID in a given organization.",
"operationId": "deleteConfigHolidayList",
"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 Holiday List.",
"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}/holiday-list/{id}/incoming-references": {
"get": {
"tags": [
"Holiday List"
],
"summary": "List references for a specific Holiday List",
"description": "Retrieve a list of all entities that have reference to an existing Holiday List by ID in a given organization.",
"operationId": "getIncomingReferencesHolidayList",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/v2/holiday-list": {
"get": {
"tags": [
"Holiday List"
],
"summary": "List Holiday Lists",
"description": "Retrieve a list of Holiday Lists in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigWithMetaDataHolidayList",
"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, holidays, 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. except holidays",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "sort",
"in": "query",
"description": "Sorting criteria in the format: property(, asc | desc). Default sort order is ascending. Supported sortable fields (name, createdTime, lastUpdatedTime). \n\n\nThe examples below show some sort queries\n- name,asc\n- createdTime,desc\n",
"schema": {
"type": "string",
"default": "name",
"example": "name"
}
},
{
"name": "includeCount",
"in": "query",
"description": "Enable this flag to get the count of holidays.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeHolidayListDTO"
},
"example": {
"data": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"name": "Holiday List 2022",
"description": "This is a holiday list for year 2022.",
"holidaysCount": "string",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1
}
],
"meta": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/overrides": {
"get": {
"tags": [
"Overrides"
],
"summary": "List Overrides resource(s)",
"description": "Retrieve a list of Overrides resource(s) in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfig_4",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "filter",
"in": "query",
"description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n",
"required": false,
"schema": {
"type": "string"
},
"example": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\""
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (overrides)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OverridesDTOList"
}
},
"example": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"latestOverride": {
"name": "Fire Drill",
"startDateTime": "2022-05-26T14:30",
"endDateTime": "2022-05-26T16:30",
"workingHours": false
},
"timezone": "America/New_York",
"overridesCount": 2,
"name": "My Overrides",
"description": "My Overrides Desc",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1
}
]
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"Overrides"
],
"summary": "Create a new Overrides resource",
"description": "Create a new Overrides resource in a given organization.",
"operationId": "createConfig_6",
"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/OverridesDTO"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/OverridesDTO"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/overrides/bulk": {
"post": {
"tags": [
"Overrides"
],
"summary": "Bulk save Overrides resource(s)",
"description": "Create, Update or delete Overrides resource(s) in bulk in a given organization.",
"operationId": "saveAllConfig_5",
"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/BulkRequestDTOOverridesDTO"
}
}
},
"required": true
},
"responses": {
"207": {
"description": "Multi-Status",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BulkResponseDTO"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/overrides/{id}": {
"get": {
"tags": [
"Overrides"
],
"summary": "Get specific Overrides resource by ID",
"description": "Retrieve an existing Overrides resource by ID in a given organization.",
"operationId": "getConfig_6",
"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 Overrides resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/OverridesDTO"
}
}
}
},
"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": [
"Overrides"
],
"summary": "Update specific Overrides resource by ID",
"description": "Update an existing Overrides resource by ID in a given organization.",
"operationId": "updateConfig_6",
"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 Overrides resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OverridesDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/OverridesDTO"
}
}
}
},
"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": [
"Overrides"
],
"summary": "Delete specific Overrides resource by ID",
"description": "Delete an existing Overrides resource by ID in a given organization.",
"operationId": "deleteConfig_6",
"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 Overrides resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"412": {
"description": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "412",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "412",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/overrides/{id}/incoming-references": {
"get": {
"tags": [
"Overrides"
],
"summary": "List references for a specific Overrides resource",
"description": "Retrieve a list of all entities that have reference to an existing Overrides resource by ID in a given organization.",
"operationId": "getIncomingReferences_5",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/v2/overrides": {
"get": {
"tags": [
"Overrides"
],
"summary": "List Overrides resource(s)",
"description": "Retrieve a list of Overrides resource(s) in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigWithMetaData_7",
"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, overrides, 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. except (overrides)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "sort",
"in": "query",
"description": "Sorting criteria in the format: property(, asc | desc). Default sort order is ascending. Supported sortable fields (name, timezone, createdTime, lastUpdatedTime). \n\n\nThe examples below show some sort queries\n- name,asc\n- createdTime,desc\n",
"schema": {
"type": "string",
"default": "name",
"example": "name"
}
},
{
"name": "includeLatestOverride",
"in": "query",
"description": "Enable the flag to get the latest Override",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeOverridesDTO"
},
"example": {
"data": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"latestOverride": "string",
"timezone": "America/New_York",
"overridesCount": "string",
"name": "My Overrides",
"description": "My Overrides Desc",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1
}
],
"meta": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/address-book": {
"get": {
"tags": [
"Address Book"
],
"summary": "List Address Book(s)",
"description": "Retrieve a list of Address Book(s) in a given organization. To get address book having large entries use latest apis.",
"operationId": "getAllConfigWithEntries",
"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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with 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",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressBookWithEntriesDTO"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": true
},
"post": {
"tags": [
"Address Book"
],
"summary": "Create a new Address Book",
"description": "Create a new Address Book in a given organization. To create address book having large entries use latest apis.",
"operationId": "createConfigWithEntries",
"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/AddressBookWithEntriesDTO"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressBookWithEntriesDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/address-book/bulk-export": {
"get": {
"tags": [
"Address Book"
],
"summary": "Bulk export Address Book(s)",
"description": "Export all Address Book(s) in a given organization.",
"operationId": "bulkExport_22",
"deprecated": true,
"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": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkExportDTOAddressBookBulkExportDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/address-book/{addressBookId}/entry": {
"post": {
"tags": [
"Address Book"
],
"summary": "Create a new Address Book Entry",
"description": "Create a new Address Book Entry in a given organization.",
"operationId": "createConfig_31",
"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": "addressBookId",
"in": "path",
"description": "Resource ID of the Address Book",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressBookEntryDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressBookEntryDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/address-book/{addressBookId}/entry/bulk": {
"post": {
"tags": [
"Address Book"
],
"summary": "Bulk save Address Book Entry(s)",
"description": "Create, Update or delete Address Book Entry(s) in bulk for an Address Book in a given organization.",
"operationId": "saveAllConfig_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": "addressBookId",
"in": "path",
"description": "Resource ID of the Address Book",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkRequestDTOAddressBookEntryDTO"
}
}
},
"required": true
},
"responses": {
"207": {
"description": "Multi-Status",
"content": {
"application/json": {
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/address-book/{addressBookId}/entry/{id}": {
"get": {
"tags": [
"Address Book"
],
"summary": "Get specific Address Book Entry by ID",
"description": "Retrieve an existing Address Book Entry by ID in a given organization.",
"operationId": "getConfig_31",
"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": "addressBookId",
"in": "path",
"description": "Resource ID of the Address Book",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Address Book Entry",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressBookEntryDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Address Book"
],
"summary": "Update specific Address Book Entry by ID",
"description": "Update an existing Address Book Entry by ID in a given organization.",
"operationId": "updateConfig_31",
"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": "addressBookId",
"in": "path",
"description": "Resource ID of the Address Book",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Address Book Entry",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressBookEntryDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressBookEntryDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Address Book"
],
"summary": "Delete specific Address Book Entry by ID",
"description": "Delete an existing Address Book Entry by ID in a given organization.",
"operationId": "deleteConfig_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": "addressBookId",
"in": "path",
"description": "Resource ID of the Address Book",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Address Book Entry",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/address-book/{id}": {
"get": {
"tags": [
"Address Book"
],
"summary": "Get specific Address Book by ID",
"description": "Retrieve an existing Address Book by ID in a given organization. To get address book having large entries use latest apis.",
"operationId": "getConfigWithEntries",
"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 Address Book.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressBookWithEntriesDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": true
},
"put": {
"tags": [
"Address Book"
],
"summary": "Update specific Address Book by ID",
"description": "Update an existing Address Book by ID in a given organization. To update address book having large entries use latest apis.",
"operationId": "updateConfigWithEntries",
"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 Address Book",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressBookWithEntriesDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressBookWithEntriesDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": true
},
"delete": {
"tags": [
"Address Book"
],
"summary": "Delete specific Address Book by ID",
"description": "Delete an existing Address Book by ID in a given organization. To delete address book having large entries use latest apis.",
"operationId": "deleteConfigWithEntries",
"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 Address Book.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/address-book/{id}/incoming-references": {
"get": {
"tags": [
"Address Book"
],
"summary": "List references for a specific Address Book",
"description": "Retrieve a list of all entities that have reference to an existing Address Book by ID in a given organization.",
"operationId": "getIncomingReferences_21",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/v2/address-book": {
"get": {
"tags": [
"Address Book"
],
"summary": "List Address Book(s)",
"description": "Retrieve a list of Address Book(s) in a given organization. To get address book having large entries use latest apis.",
"operationId": "getAllConfigWithMetaDataWithEntries",
"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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with specified columns. All Attributes are supported",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeAddressBookWithEntriesDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/v2/address-book/{addressBookId}/entry": {
"get": {
"tags": [
"Address Book"
],
"summary": "List Address Book Entry(s)",
"description": "Retrieve a list of Address Book Entry(s) in a given organization.",
"operationId": "getAllConfigWithMetaData_29",
"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": "addressBookId",
"in": "path",
"description": "Resource ID of the Address Book",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with specified columns. All Attributes are supported",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name, number)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"number\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataWithPagingInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressBookEntryDTO"
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/v3/address-book": {
"get": {
"tags": [
"Address Book"
],
"summary": "List Address Book(s)",
"description": "Retrieve a list of Address Book(s) in a given organization.",
"operationId": "getAllConfigWithMetaData_1",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "filter",
"in": "query",
"description": "Specify a filter based on which the results will be fetched. 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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with specified columns. All Attributes are supported",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name, number)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"number\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeAddressBookDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Address Book"
],
"summary": "Create a new Address Book",
"description": "Create a new Address Book in a given organization.",
"operationId": "createConfig_2",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressBookDTO"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressBookDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/v3/address-book/{id}": {
"get": {
"tags": [
"Address Book"
],
"summary": "Get specific Address Book by ID",
"description": "Retrieve an existing Address Book by ID in a given organization.",
"operationId": "getConfig_2",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Address Book.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressBookDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Address Book"
],
"summary": "Update specific Address Book by ID",
"description": "Update an existing Address Book by ID in a given organization.",
"operationId": "updateConfig_2",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Address Book.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressBookDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressBookDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Address Book"
],
"summary": "Delete specific Address Book by ID",
"description": "Delete an existing Address Book by ID in a given organization.",
"operationId": "deleteConfig_2",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Address Book.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/agent-personal-greeting": {
"post": {
"tags": [
"Agent Personal Greeting Files"
],
"summary": "Create a new Greeting File",
"description": "Create a new Greeting File in a given organization.",
"operationId": "createConfigAgentPersonalGreeting",
"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"
],
"summary": "Delete references of an agent from greeting files",
"description": "Removes all references of the specified agent (ciUserId) from greeting files in the given organization. Typically invoked when an agent is deleted or unassigned. in a given organization.",
"operationId": "deleteReferencesAgentPersonalGreeting",
"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": "getConfigAgentPersonalGreeting",
"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 whether the URL for downloading the greeting file should 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 an existing Greeting File by ID in a given organization.",
"operationId": "updateConfigAgentPersonalGreeting",
"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 in a given organization.",
"operationId": "deleteConfigAgentPersonalGreeting",
"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": "patchConfigAgentPersonalGreeting",
"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"
],
"summary": "List Greeting Files",
"description": "Retrieve a list of Greeting Files in a given organization.",
"operationId": "getAllConfigWithMetaDataAgentPersonalGreeting",
"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 attributeTag.\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)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"email\");value==\"Cisco\"\n",
"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, projection, filtering, searching, and sorting on the agent's 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",
"description": "Create a new Greeting File in a given organization.",
"operationId": "createV2ConfigAgentPersonalGreeting",
"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",
"description": "Retrieve an existing Greeting File by ID in a given organization.",
"operationId": "getV2ConfigAgentPersonalGreeting",
"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 whether the URL for downloading the greeting file should 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": []
}
]
}
}
}
}
}
}
},
"put": {
"tags": [
"Agent Personal Greeting Files"
],
"summary": "Update specific Greeting File by ID",
"description": "Update an existing Greeting File by ID in a given organization.",
"operationId": "updateV2ConfigAgentPersonalGreeting",
"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": []
}
]
}
}
}
}
}
}
},
"delete": {
"tags": [
"Agent Personal Greeting Files"
],
"summary": "Delete specific Greeting File by ID",
"description": "Delete an existing Greeting File by ID in a given organization.",
"operationId": "deleteV2ConfigAgentPersonalGreeting",
"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": []
}
]
}
}
}
}
}
}
},
"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": "patchV2ConfigAgentPersonalGreeting",
"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": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/v3/agent-personal-greeting": {
"get": {
"tags": [
"Agent Personal Greeting Files"
],
"summary": "List Greeting Files",
"description": "Retrieve a list of Greeting Files in a given organization.",
"operationId": "getAllV2ConfigWithMetaDataAgentPersonalGreeting",
"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 attributeTag.\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)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"email\");value==\"Cisco\"\n",
"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, projection, filtering, searching, and sorting on the agent's 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": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/audio-file": {
"post": {
"tags": [
"Audio Files"
],
"summary": "Create a new Audio File",
"description": "Create a new Audio File in a given organization.",
"operationId": "createConfig_26",
"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": {
"required": [
"audioFile",
"audioFileInfo"
],
"type": "object",
"properties": {
"audioFileInfo": {
"$ref": "#/components/schemas/AudioFileInfoDTO"
},
"audioFile": {
"type": "string",
"format": "binary"
}
}
}
},
"multipart/form-data": {
"schema": {
"required": [
"audioFile",
"audioFileInfo"
],
"type": "object",
"properties": {
"audioFileInfo": {
"$ref": "#/components/schemas/AudioFileInfoDTO"
},
"audioFile": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudioFileInfoDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/audio-file/{id}": {
"get": {
"tags": [
"Audio Files"
],
"summary": "Get specific Audio File by ID",
"description": "Retrieve an existing Audio File by ID in a given organization.",
"operationId": "getConfig_26",
"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 Audio File.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
},
{
"name": "includeUrl",
"in": "query",
"description": "Indicates if the URL for downloading Audio Fileshould be included in the response.",
"required": false,
"schema": {
"type": "boolean"
},
"example": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudioFileInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"Audio Files"
],
"summary": "Update specific Audio File by ID",
"description": "Update an existing Audio File by ID in a given organization.",
"operationId": "updateConfig_26",
"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 Audio File.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"audioFile",
"audioFileInfo"
],
"type": "object",
"properties": {
"audioFileInfo": {
"$ref": "#/components/schemas/AudioFileInfoDTO"
},
"audioFile": {
"type": "string",
"format": "binary"
}
}
}
},
"multipart/form-data": {
"schema": {
"required": [
"audioFile",
"audioFileInfo"
],
"type": "object",
"properties": {
"audioFileInfo": {
"$ref": "#/components/schemas/AudioFileInfoDTO"
},
"audioFile": {
"type": "string",
"format": "binary"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudioFileInfoDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Audio Files"
],
"summary": "Delete specific Audio File by ID",
"description": "Delete an existing Audio File by ID in 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 Audio File.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"patch": {
"tags": [
"Audio Files"
],
"summary": "Partially update Audio File by ID",
"description": "Partially update Audio File by ID in a given organization.",
"operationId": "patchConfig_1",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Audio File.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudioFileInfoPatchDTO"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/AudioFileInfoPatchDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AudioFileInfoDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/audio-file/{id}/incoming-references": {
"get": {
"tags": [
"Audio Files"
],
"summary": "List references for a specific Audio File",
"description": "Retrieve a list of all entities that have reference to an existing Audio File by ID in a given organization.",
"operationId": "getIncomingReferences_19",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/v2/audio-file": {
"get": {
"tags": [
"Audio Files"
],
"summary": "List Audio File(s)",
"description": "Retrieve a list of Audio File(s) in a given organization.",
"operationId": "getAllConfigWithMetaData_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": "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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with specified columns. All Attributes are supported except URL",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeAudioFileInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/auxiliary-code": {
"get": {
"tags": [
"Auxiliary Code"
],
"summary": "List Auxiliary Code(s)",
"description": "Retrieve a list of Auxiliary Code(s) in a given organization.",
"operationId": "getAllConfig_12",
"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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with 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",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuxiliaryCodeDTO"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": true
},
"post": {
"tags": [
"Auxiliary Code"
],
"summary": "Create a new Auxiliary Code",
"description": "Create a new Auxiliary Code in a given organization.",
"operationId": "createConfig_23",
"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/AuxiliaryCodeDTO"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/AuxiliaryCodeDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/auxiliary-code/bulk": {
"post": {
"tags": [
"Auxiliary Code"
],
"summary": "Bulk save Auxiliary Code(s)",
"description": "Create, Update or delete Auxiliary Code(s) in bulk in a given organization.",
"operationId": "saveAllConfig_20",
"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/BulkRequestDTOAuxiliaryCodeDTO"
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
},
"patch": {
"tags": [
"Auxiliary Code"
],
"summary": "Bulk partial update Auxiliary Code(s)",
"description": "Update some or all properties for multiple Auxiliary codes in bulk in a given organization.",
"operationId": "patchAllConfig_2",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
}
],
"requestBody": {
"description": "For each of the item to update,\nWe only need to provide the patch JSON.\nOnly the following properties are mandatory to identify unique item for update. Other properties are optional.\nMandatory Properties: [id]\nAll properties that can be updated via PUT Api are allowed to be updated.\nTo nullify a property or remove it, specify null as value for the Json property.\nValid value for requestAction property is 'SAVE'. It is optional property and default SAVE is assumed.\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkRequestDTOAuxiliaryCodeDTO"
},
"example": {
"items": [
{
"item": {
"id": "26e2df70-0f77-41b8-8e8f-1d76e92c9638",
"burnoutInclusion": "EXCLUDED"
},
"itemIdentifier": 0,
"requestAction": "SAVE"
}
]
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/auxiliary-code/bulk-export": {
"get": {
"tags": [
"Auxiliary Code"
],
"summary": "Bulk export Auxiliary Code(s)",
"description": "Export all Auxiliary Code(s) in a given organization.",
"operationId": "bulkExport_20",
"deprecated": true,
"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": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BulkExportDTOAuxCodeBulkExportDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/auxiliary-code/purge-inactive-entities": {
"post": {
"tags": [
"Auxiliary Code"
],
"summary": "Purge inactive Auxiliary Code(s)",
"description": "Purge inactive Auxiliary Code(s) older than the configured interval for a given organization.",
"operationId": "purgeInactiveConfig_10",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "nextStartId",
"in": "query",
"description": "This is the entity ID from which items for the next purge batch with be selected.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/auxiliary-code/{id}": {
"get": {
"tags": [
"Auxiliary Code"
],
"summary": "Get specific Auxiliary Code by ID",
"description": "Retrieve an existing Auxiliary Code by ID in a given organization.",
"operationId": "getConfig_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 Auxiliary Code",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/AuxiliaryCodeDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Auxiliary Code"
],
"summary": "Update specific Auxiliary Code by ID",
"description": "Update an existing Auxiliary Code by ID in a given organization.",
"operationId": "updateConfig_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 Auxiliary Code.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuxiliaryCodeDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/AuxiliaryCodeDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Auxiliary Code"
],
"summary": "Delete specific Auxiliary Code by ID",
"description": "Delete an existing Auxiliary Code by ID in a given organization.",
"operationId": "deleteConfig_22",
"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 Auxiliary Code.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/auxiliary-code/{id}/incoming-references": {
"get": {
"tags": [
"Auxiliary Code"
],
"summary": "List references for a specific Auxiliary Code",
"description": "Retrieve a list of all entities that have reference to an existing Auxiliary Code by ID in a given organization.",
"operationId": "getIncomingReferences_18",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/v2/auxiliary-code": {
"get": {
"tags": [
"Auxiliary Code"
],
"summary": "List Auxiliary Code(s)",
"description": "Retrieve a list of Auxiliary Code(s) in a given organization.",
"operationId": "getAllConfigWithMetaData_21",
"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, validBurnoutForWrapUpCode, validBurnoutForIdleCode \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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with specified columns. All Attributes are supported",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
},
{
"name": "desktopProfileFilter",
"in": "query",
"description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.",
"schema": {
"type": "boolean",
"example": false,
"default": false
}
},
{
"name": "supervisedUserId",
"in": "query",
"description": "User Id of the Agent whose Agent Profile associated Idle Codes are to be fetched.",
"schema": {
"type": "string",
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataWithPagingInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuxiliaryCodeDTO"
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
}
}
},
"/organization/{orgid}/contact-number": {
"post": {
"tags": [
"Contact Number"
],
"summary": "Create a new Contact Number",
"description": "Create a new Contact Number in a given organization.",
"operationId": "createConfig_20",
"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/ContactNumberDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ContactNumberDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/contact-number/all-numbers": {
"get": {
"tags": [
"Contact Number"
],
"summary": "List all contact numbers(property - number)",
"description": "Retrieve a list of only contact numbers(property - number) from Contact Number(s) without pagination in a given organization.",
"operationId": "getAllContactNumbers",
"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"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/contact-number/bulk": {
"post": {
"tags": [
"Contact Number"
],
"summary": "Bulk save Contact Number(s)",
"description": "Create, Update or delete Contact Number(s) in bulk in a given organization.",
"operationId": "saveAllConfig_17",
"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/BulkRequestDTOContactNumberDTO"
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/contact-number/bulk-export": {
"get": {
"tags": [
"Contact Number"
],
"summary": "Bulk export Contact Number(s)",
"description": "Export all Contact Number(s) in a given organization.",
"operationId": "bulkExport_17",
"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": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 10
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BulkExportDTOContactNumberBulkExportDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/contact-number/{id}": {
"get": {
"tags": [
"Contact Number"
],
"summary": "Get specific Contact Number by ID",
"description": "Retrieve an existing Contact Number by ID in a given organization.",
"operationId": "getConfig_21",
"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 Contact Number.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ContactNumberDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"Contact Number"
],
"summary": "Update specific Contact Number by ID",
"description": "Update an existing Contact Number by ID in a given organization.",
"operationId": "updateConfig_21",
"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 Contact Number.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactNumberDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ContactNumberDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Contact Number"
],
"summary": "Delete specific Contact Number by ID",
"description": "Delete an existing Contact Number by ID in a given organization.",
"operationId": "deleteConfig_19",
"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 Contact Number.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/v2/contact-number": {
"get": {
"tags": [
"Contact Number"
],
"summary": "List Contact Number(s)",
"description": "Retrieve a list of Contact Number(s) in a given organization.",
"operationId": "getAllConfigWithMetaData_19",
"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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with specified columns. All Attributes are supported",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeContactNumberDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/contact-service-queue": {
"get": {
"tags": [
"Contact Service Queue"
],
"summary": "List Contact Service Queues",
"description": "Retrieve a list of Contact Service Queues in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead. Deprecated. Use GET /v2/contact-service-queue instead.",
"operationId": "getAllFilteredConfigContactServiceQueue",
"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": "channelTypes",
"in": "query",
"description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"TELEPHONY",
"CHAT"
]
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactServiceQueueDTOList"
}
},
"example": [
{
"recordingPermitted": true,
"ivrRequeueUrl": "https://www.youtube.com",
"agentsLastUpdatedByUserEmailPrefix": "string",
"personalizedAIRouting": "string",
"timezone": "America/New_York",
"socialChannelType": "MESSENGER",
"controlFlowScriptUrl": "https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield",
"description": "Queue created by system",
"monitoringPermitted": true,
"vendorId": "AB123CSDR",
"queueLevelRealTimeTranscriptionsInclusion": "INCLUDED",
"channelType": "TELEPHONY",
"queueRoutingType": "TEAM_BASED",
"recordingAllCallsPermitted": true,
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"recordingPauseDuration": 2,
"systemDefault": false,
"defaultMusicInQueueMediaFileId": "defaultmusic_on_hold.wav",
"queueLevelPredictedWaitTimeInclusion": "INCLUDED",
"queueLevelAutoCsatInclusion": "INCLUDED",
"serviceLevelThreshold": 0,
"routingType": "SKILLS_BASED",
"skillBasedRoutingType": "BEST_AVAILABLE_AGENT",
"pauseAndResume": "string",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"maxTimeInQueue": 2,
"xspVersion": "xsp-24.0",
"maxActiveContacts": 5,
"pauseRecordingPermitted": true,
"checkAgentAvailability": true,
"outdialCampaignEnabled": true,
"assistantSkill": "string",
"parkingPermitted": true,
"agentsLastUpdatedByUserName": "string",
"active": true,
"version": 1,
"queueLevelSummariesInclusion": "INCLUDED",
"overflowNumber": "1245677",
"agentsLastUpdatedTime": 1742553000000,
"queueLevelSentimentAnalysisInclusion": "INCLUDED",
"name": "Queue-1",
"queueType": "INBOUND",
"subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"manuallyAssignable": false
}
]
}
}
},
"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}/contact-service-queue/bulk": {
"post": {
"tags": [
"Contact Service Queue"
],
"summary": "Bulk save Contact Service Queues",
"description": "Create, Update or delete Contact Service Queues in bulk in a given organization.",
"operationId": "saveAllConfigContactServiceQueue",
"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/BulkRequestDTOContactServiceQueueDTO"
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"patch": {
"tags": [
"Contact Service Queue"
],
"summary": "Bulk partial update Contact Service Queues",
"description": "Update some or all properties for multiple Contact Service Queues in bulk in a given organization.",
"operationId": "patchAllConfigContactServiceQueue",
"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": {
"description": "For each of the item to update,\nWe only need to provide the patch JSON.\nOnly the following properties are mandatory to identify a unique item for update. Other properties are optional.\nMandatory Properties: [id]\nAll properties that can be updated via the PUT API can also be updated here.\nTo nullify or remove a property, specify null as the value for the JSON property.\nValid value for requestAction property is 'SAVE'. It is optional property and default SAVE is assumed.\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkRequestDTOContactServiceQueueDTO"
},
"example": {
"items": [
{
"item": {
"id": "26e2df70-0f77-41b8-8e8f-1d76e92c9638",
"assistantSkill": {
"assistantSkillId": "26e2df70-0f77-41b8-8e8f-1d76e92c9639"
}
},
"itemIdentifier": 0,
"requestAction": "SAVE"
}
]
}
}
},
"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": []
}
]
}
}
}
}
},
"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}/contact-service-queue/by-skill-profile-id/{id}": {
"get": {
"tags": [
"Contact Service Queue"
],
"summary": "List skill-based Contact Service Queues by skill profile ID (public)",
"description": "Retrieve a list of skill-based Contact Service Queues associated with a given skill profile ID, accessible to authorized clients in a given organization.",
"operationId": "getSkillBasedCSQsBySkillProfileIdPublicContactServiceQueue",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeSkillBasedCSQDTO"
}
}
}
},
"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}/contact-service-queue/delete-reference": {
"post": {
"tags": [
"Contact Service Queue"
],
"summary": "Delete references from Contact Service Queues",
"description": "Removes the references to the specified entities (such as teams, sites, or agents) from Contact Service Queues for a given organization.",
"operationId": "deleteReferencesContactServiceQueue",
"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}/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile": {
"post": {
"tags": [
"Contact Service Queue"
],
"summary": "List skill-based Contact Service Queues by dynamic skills and skill profile",
"description": "Retrieve a list of skill-based Contact Service Queues that match the given dynamic skills and skill profile criteria in a given organization.",
"operationId": "getSkillBasedCSQsByDynamicSkillsAndSkillProfileContactServiceQueue",
"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/SkillBasedQueueRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeMappedCSQDTO"
}
}
}
},
"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}/contact-service-queue/fetch-by-userId-skillProfileId": {
"post": {
"tags": [
"Contact Service Queue"
],
"summary": "List skill-based Contact Service Queues by skill profile ID and user ID",
"description": "Retrieve a list of skill-based Contact Service Queues associated with the given skill profile ID and user ID combination in a given organization.",
"operationId": "getSkillBasedCSQsBySkillProfileIdAndUserIdContactServiceQueue",
"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/SkillBasedQueueRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeMappedCSQDTO"
}
}
}
},
"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}/contact-service-queue/fetch-manually-assignable-queues": {
"post": {
"tags": [
"Contact Service Queue"
],
"summary": "List manually assignable Contact Service Queues",
"description": "Retrieve a list of Contact Service Queues that are eligible for manual contact assignment based on the provided criteria in a given organization.",
"operationId": "getManuallyAssignableCSQsContactServiceQueue",
"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/ManuallyAssignableQueuesRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successfully fetched the manually assignable contact service queues for the given agent and team.",
"content": {
"*/*": {
"schema": {
"type": "object",
"description": "Response wrapper containing the list of manually assignable contact service queues.",
"properties": {
"data": {
"type": "array",
"description": "List of manually assignable contact service queues for the given agent and team.",
"items": {
"$ref": "#/components/schemas/MappedCSQDTO"
}
}
}
}
}
}
},
"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}/contact-service-queue/purge-inactive-entities": {
"post": {
"tags": [
"Contact Service Queue"
],
"summary": "Purge inactive Contact Service Queues",
"description": "Purge inactive Contact Service Queues older than the configured interval for a given organization.",
"operationId": "purgeInactiveConfigContactServiceQueue",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "nextStartId",
"in": "query",
"description": "This is the entity ID from which items for the next purge batch will be selected.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/contact-service-queue/{id}": {
"get": {
"tags": [
"Contact Service Queue"
],
"summary": "Get specific Contact Service Queue by ID",
"description": "Retrieve an existing Contact Service Queue by ID in a given organization.",
"operationId": "getConfigContactServiceQueue",
"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 Contact Service Queue.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
},
{
"name": "agentsUpdatedInfo",
"in": "query",
"description": "If `true`, returns the user details who has last updated the agents list in an agent based queue.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ContactServiceQueueDTO"
}
}
}
},
"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": [
"Contact Service Queue"
],
"summary": "Delete specific Contact Service Queue by ID",
"description": "Delete an existing Contact Service Queue by ID in a given organization.",
"operationId": "deleteConfigContactServiceQueue",
"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 Contact Service Queue.",
"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}/contact-service-queue/{id}/incoming-references": {
"get": {
"tags": [
"Contact Service Queue"
],
"summary": "List references for a specific Contact Service Queue",
"description": "Retrieve a list of all entities that have reference to an existing Contact Service Queue by ID in a given organization.",
"operationId": "getIncomingReferencesContactServiceQueue",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/contact-service-queue/v2/bulk": {
"post": {
"tags": [
"Contact Service Queue"
],
"summary": "Bulk save Contact Service Queues",
"description": "Create, Update or delete Contact Service Queues in bulk in a given organization.",
"operationId": "saveAllConfigV2ContactServiceQueue",
"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/BulkRequestDTOContactServiceQueueDTO"
}
}
},
"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}/v2/contact-service-queue": {
"get": {
"tags": [
"Contact Service Queue"
],
"summary": "List Contact Service Queues",
"description": "Retrieve a list of Contact Service Queues in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllFilteredConfigWithPagedMetaDataContactServiceQueue",
"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, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n",
"required": false,
"schema": {
"type": "string"
},
"example": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\""
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "desktopProfileFilter",
"in": "query",
"description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.",
"schema": {
"type": "boolean",
"default": false,
"example": true
}
},
{
"name": "provisioningView",
"in": "query",
"description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
},
{
"name": "includeAIMappingCount",
"in": "query",
"description": "If set to true, the API response will include the count of each AI feature mapped to the entity.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataPagedCSQ"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactServiceQueueDTO"
},
"description": "List of contact service queues returned in this page."
}
},
"description": "Paged response wrapper containing contact service queues."
},
"example": {
"data": [
{
"recordingPermitted": true,
"ivrRequeueUrl": "https://www.youtube.com",
"agentsLastUpdatedByUserEmailPrefix": "string",
"personalizedAIRouting": {
"aiRoutingMode": "EVALUATION",
"aiRoutingKPIId": "63beec53-8a61-489f-afc6-bb03c8c73834"
},
"timezone": "America/New_York",
"socialChannelType": "MESSENGER",
"controlFlowScriptUrl": "https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield",
"description": "Queue created by system",
"monitoringPermitted": true,
"vendorId": "AB123CSDR",
"queueLevelRealTimeTranscriptionsInclusion": "INCLUDED",
"channelType": "TELEPHONY",
"queueRoutingType": "TEAM_BASED",
"recordingAllCallsPermitted": true,
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"recordingPauseDuration": 2,
"systemDefault": false,
"defaultMusicInQueueMediaFileId": "defaultmusic_on_hold.wav",
"queueLevelPredictedWaitTimeInclusion": "INCLUDED",
"queueLevelAutoCsatInclusion": "INCLUDED",
"serviceLevelThreshold": 0,
"routingType": "SKILLS_BASED",
"skillBasedRoutingType": "BEST_AVAILABLE_AGENT",
"pauseAndResume": {
"enabled": true,
"pauseTimeout": {
"days": 1,
"hours": 2,
"minutes": 30
}
},
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"maxTimeInQueue": 2,
"xspVersion": "xsp-24.0",
"maxActiveContacts": 5,
"pauseRecordingPermitted": true,
"checkAgentAvailability": true,
"outdialCampaignEnabled": true,
"assistantSkill": {
"assistantSkillId": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
"parkingPermitted": true,
"agentsLastUpdatedByUserName": "string",
"active": true,
"version": 1,
"queueLevelSummariesInclusion": "INCLUDED",
"overflowNumber": "1245677",
"agentsLastUpdatedTime": 1742553000000,
"queueLevelSentimentAnalysisInclusion": "INCLUDED",
"name": "Queue-1",
"queueType": "INBOUND",
"subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"manuallyAssignable": false,
"callDistributionGroups": [
{
"agentGroups": [
{
"teamId": "76cf35bc-12df-49ef-88e1-c86226d8a645"
}
],
"order": 1,
"duration": 0
}
]
}
],
"meta": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
},
"post": {
"tags": [
"Contact Service Queue"
],
"summary": "Create a new Contact Service Queue",
"description": "Create a new Contact Service Queue in a given organization.",
"operationId": "createConfigContactServiceQueue_1",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
}
],
"requestBody": {
"description": "Contact Service Queue configuration data",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactServiceQueueDTO"
},
"example": {
"name": "SupportQueue",
"description": "Queue for support calls",
"queueType": "INBOUND",
"channelType": "TELEPHONY",
"socialChannelType": "MESSENGER",
"routingType": "SKILLS_BASED",
"queueRoutingType": "TEAM_BASED",
"skillBasedRoutingType": "BEST_AVAILABLE_AGENT",
"active": true,
"checkAgentAvailability": true,
"serviceLevelThreshold": 60,
"maxActiveContacts": 5,
"maxTimeInQueue": 7200,
"defaultMusicInQueueMediaFileId": "defaultmusic_on_hold.wav",
"timezone": "America/New_York",
"outdialCampaignEnabled": false,
"monitoringPermitted": true,
"parkingPermitted": true,
"recordingPermitted": true,
"recordingAllCallsPermitted": true,
"pauseRecordingPermitted": true,
"recordingPauseDuration": 2,
"controlFlowScriptUrl": "https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield",
"ivrRequeueUrl": "https://www.youtube.com",
"overflowNumber": "1245677",
"vendorId": "AB123CSDR",
"xspVersion": "xsp-24.0",
"subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"systemDefault": false,
"manuallyAssignable": false,
"agentsLastUpdatedByUserName": "John Doe",
"agentsLastUpdatedByUserEmailPrefix": "johndoe",
"agentsLastUpdatedTime": 1711017000000,
"callDistributionGroups": [
{
"agentGroups": [
{
"teamId": "76cf35bc-12df-49ef-88e1-c86226d8a645"
}
],
"order": 1,
"duration": 0
}
],
"queueSkillRequirements": [
{
"skillId": "af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"condition": "IS_NOT",
"skillValue": "Credit card SME",
"weight": 100,
"dynamicSkill": false
}
],
"agents": [
{
"id": "16c93b13-f1e9-4a4f-bc47-957b9075a56f",
"ciUserId": "660e0a5a-8230-47d7-ae98-047fb180e1ff"
}
],
"assistantSkill": {
"assistantSkillId": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
"queueLevelSummariesInclusion": "INCLUDED",
"queueLevelSentimentAnalysisInclusion": "INCLUDED",
"queueLevelPredictedWaitTimeInclusion": "INCLUDED",
"queueLevelAutoCsatInclusion": "INCLUDED",
"queueLevelRealTimeTranscriptionsInclusion": "INCLUDED",
"personalizedAIRouting": {
"aiRoutingMode": "EVALUATION",
"aiRoutingKPIId": "63beec53-8a61-489f-afc6-bb03c8c73834"
},
"pauseAndResume": {
"enabled": true,
"pauseTimeout": {
"days": 1,
"hours": 2,
"minutes": 30
}
}
}
}
}
},
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ContactServiceQueueDTO"
}
}
}
},
"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/contact-service-queue/by-user-id/{userid}/agent-based-queues": {
"get": {
"tags": [
"Contact Service Queue"
],
"summary": "List agent-based Contact Service Queues by user ID",
"description": "Retrieve a list of agent-based Contact Service Queues by user ID in a given organization.",
"operationId": "getCSQByUserIDForAgentBasedQueueContactServiceQueue",
"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": "userid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0
}
},
{
"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
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeRoutingBasedQueueDTO"
}
}
}
},
"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/contact-service-queue/by-user-id/{userid}/skill-based-queues": {
"get": {
"tags": [
"Contact Service Queue"
],
"summary": "List skill-based Contact Service Queues by user ID",
"description": "Retrieve a list of skill-based Contact Service Queues by user ID in a given organization.",
"operationId": "getSkillBasedQueuesByUserIdContactServiceQueue",
"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": "userid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0
}
},
{
"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
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeRoutingBasedQueueDTO"
}
}
}
},
"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/contact-service-queue/by-user-id/{userid}/team-based-queues": {
"get": {
"tags": [
"Contact Service Queue"
],
"summary": "List team-based Contact Service Queues by user ID",
"description": "Retrieve a list of team-based Contact Service Queues by user ID in a given organization.",
"operationId": "getCSQByUserIDForTeamBasedQueueContactServiceQueue",
"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": "userid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0
}
},
{
"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
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeRoutingBasedQueueDTO"
}
}
}
},
"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/contact-service-queue/fetch-by-grouped-assistant-skill": {
"post": {
"tags": [
"Contact Service Queue"
],
"summary": "List queue mapping summary grouped by Assistant Skill",
"description": "Retrieve a list of queue mapping summary for a specified list of Assistant Skills specified in a given organization. The summary currently includes mapped queue count, and the last assigned time of queue mapping.",
"operationId": "getAllCSQGroupedAssistantSkillContactServiceQueue",
"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": "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
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CSQGroupedAssistantSkillRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeCSQGroupedAssistantSkillResponseDTO"
}
}
}
},
"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/contact-service-queue/{id}": {
"get": {
"tags": [
"Contact Service Queue"
],
"summary": "Get specific Contact Service Queue by ID",
"description": "Retrieve an existing Contact Service Queue by ID in a given organization.",
"operationId": "getConfigContactServiceQueue_1",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Contact Service Queue.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
},
{
"name": "agentsUpdatedInfo",
"in": "query",
"description": "If `true`, returns the user details who has last updated the agents list in an agent based queue.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ContactServiceQueueDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"put": {
"tags": [
"Contact Service Queue"
],
"summary": "Update specific Contact Service Queue by ID",
"description": "Update an existing Contact Service Queue by ID in a given organization.",
"operationId": "updateConfigContactServiceQueue_1",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Contact Service Queue.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"description": "Contact Service Queue configuration data for update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactServiceQueueDTO"
},
"example": {
"name": "SupportQueue Updated",
"description": "Updated queue for support calls",
"queueType": "INBOUND",
"channelType": "TELEPHONY",
"socialChannelType": "MESSENGER",
"routingType": "SKILLS_BASED",
"queueRoutingType": "TEAM_BASED",
"skillBasedRoutingType": "BEST_AVAILABLE_AGENT",
"active": true,
"checkAgentAvailability": true,
"serviceLevelThreshold": 60,
"maxActiveContacts": 5,
"maxTimeInQueue": 7200,
"defaultMusicInQueueMediaFileId": "defaultmusic_on_hold.wav",
"timezone": "America/New_York",
"outdialCampaignEnabled": false,
"monitoringPermitted": true,
"parkingPermitted": true,
"recordingPermitted": true,
"recordingAllCallsPermitted": true,
"pauseRecordingPermitted": true,
"recordingPauseDuration": 2,
"controlFlowScriptUrl": "https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield",
"ivrRequeueUrl": "https://www.youtube.com",
"overflowNumber": "1245677",
"vendorId": "AB123CSDR",
"xspVersion": "xsp-24.0",
"subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"systemDefault": false,
"manuallyAssignable": false,
"agentsLastUpdatedByUserName": "John Doe",
"agentsLastUpdatedByUserEmailPrefix": "johndoe",
"agentsLastUpdatedTime": 1711017000000,
"callDistributionGroups": [
{
"agentGroups": [
{
"teamId": "76cf35bc-12df-49ef-88e1-c86226d8a645"
}
],
"order": 1,
"duration": 0
}
],
"queueSkillRequirements": [
{
"skillId": "af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"condition": "IS_NOT",
"skillValue": "Credit card SME",
"weight": 100,
"dynamicSkill": false
}
],
"agents": [
{
"id": "16c93b13-f1e9-4a4f-bc47-957b9075a56f",
"ciUserId": "660e0a5a-8230-47d7-ae98-047fb180e1ff"
}
],
"assistantSkill": {
"assistantSkillId": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
"queueLevelSummariesInclusion": "INCLUDED",
"queueLevelSentimentAnalysisInclusion": "INCLUDED",
"queueLevelPredictedWaitTimeInclusion": "INCLUDED",
"queueLevelAutoCsatInclusion": "INCLUDED",
"queueLevelRealTimeTranscriptionsInclusion": "INCLUDED",
"personalizedAIRouting": {
"aiRoutingMode": "EVALUATION",
"aiRoutingKPIId": "63beec53-8a61-489f-afc6-bb03c8c73834"
},
"pauseAndResume": {
"enabled": true,
"pauseTimeout": {
"days": 1,
"hours": 2,
"minutes": 30
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ContactServiceQueueDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/v2/contact-service-queue/{id}/reassign-agents": {
"post": {
"tags": [
"Contact Service Queue"
],
"summary": "Add or remove agents/users to/from an agent based queue",
"description": "This API can be used by a contact center supervisor to add or remove agents to or from an agent-based queue that they can access through their user profile access rights. Additionally, the request payload should contain the user ID(s) managed by the supervisor.",
"operationId": "reassignAgentsContactServiceQueue",
"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 Contact Service Queue.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReassignAgentsRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "object",
"description": "Acknowledgement response for the reassign-agents operation.",
"properties": {
"status": {
"type": "string",
"description": "Status of the reassign-agents operation.",
"example": "SUCCESS"
},
"message": {
"type": "string",
"description": "Human-readable result message.",
"example": "Agents updated successfully."
}
}
}
}
}
},
"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}/v3/contact-service-queue": {
"get": {
"tags": [
"Contact Service Queue"
],
"summary": "List Contact Service Queues",
"description": "Retrieve a list of Contact Service Queues in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead. Deprecated. Use GET /v2/contact-service-queue instead.",
"operationId": "getAllFilteredConfigWithMetaDataV3ContactServiceQueue",
"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, queueSkillRequirements, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n",
"required": false,
"schema": {
"type": "string"
},
"example": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\""
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (callDistributionGroups,queueSkillRequirements,links)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "desktopProfileFilter",
"in": "query",
"description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If unspecified, the default value is false.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
},
{
"name": "provisioningView",
"in": "query",
"description": "If set to true, the API will only return data that the user has access to, according to the User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseMetaEnvelopeContactServiceQueueDTOMetaDataPagedInfo"
},
"example": [
{
"recordingPermitted": true,
"ivrRequeueUrl": "https://www.youtube.com",
"agentsLastUpdatedByUserEmailPrefix": "string",
"personalizedAIRouting": "string",
"timezone": "America/New_York",
"socialChannelType": "MESSENGER",
"controlFlowScriptUrl": "https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield",
"description": "Queue created by system",
"monitoringPermitted": true,
"vendorId": "AB123CSDR",
"queueLevelRealTimeTranscriptionsInclusion": "INCLUDED",
"channelType": "TELEPHONY",
"queueRoutingType": "TEAM_BASED",
"recordingAllCallsPermitted": true,
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"recordingPauseDuration": 2,
"systemDefault": false,
"defaultMusicInQueueMediaFileId": "defaultmusic_on_hold.wav",
"queueLevelPredictedWaitTimeInclusion": "INCLUDED",
"queueLevelAutoCsatInclusion": "INCLUDED",
"serviceLevelThreshold": 0,
"routingType": "SKILLS_BASED",
"skillBasedRoutingType": "BEST_AVAILABLE_AGENT",
"pauseAndResume": "string",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"maxTimeInQueue": 2,
"xspVersion": "xsp-24.0",
"maxActiveContacts": 5,
"pauseRecordingPermitted": true,
"checkAgentAvailability": true,
"outdialCampaignEnabled": true,
"assistantSkill": "string",
"parkingPermitted": true,
"agentsLastUpdatedByUserName": "string",
"active": true,
"version": 1,
"queueLevelSummariesInclusion": "INCLUDED",
"overflowNumber": 1245677,
"agentsLastUpdatedTime": 1742553000000,
"queueLevelSentimentAnalysisInclusion": "INCLUDED",
"name": "Queue-1",
"queueType": "INBOUND",
"subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"manuallyAssignable": false
}
]
}
}
},
"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}/desktop-layout": {
"post": {
"tags": [
"Desktop Layout"
],
"summary": "Create a new Desktop Layout",
"description": "Create a new Desktop Layout in a given organization.",
"operationId": "createConfig_14",
"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/DesktopLayoutDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DesktopLayoutDTO"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/desktop-layout/bulk": {
"post": {
"tags": [
"Desktop Layout"
],
"summary": "Bulk save Desktop Layout(s)",
"description": "Create, Update or delete Desktop Layout(s) in bulk in a given organization.",
"operationId": "saveAllConfig_13",
"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/BulkRequestDTODesktopLayoutDTO"
}
}
},
"required": true
},
"responses": {
"207": {
"description": "Multi-Status",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BulkResponseDTO"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/desktop-layout/purge-inactive-entities": {
"post": {
"tags": [
"Desktop Layout"
],
"summary": "Purge inactive Desktop Layout(s)",
"description": "Purge inactive Desktop Layout(s) older than the configured interval for a given organization.",
"operationId": "purgeInactiveConfig_6",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "nextStartId",
"in": "query",
"description": "This is the entity ID from which items for the next purge batch with be selected.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/desktop-layout/{id}": {
"get": {
"tags": [
"Desktop Layout"
],
"summary": "Get specific Desktop Layout by ID",
"description": "Retrieve an existing Desktop Layout by ID in a given organization.",
"operationId": "getConfig_14",
"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 Desktop Layout.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DesktopLayoutDTO"
}
}
}
},
"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": [
"Desktop Layout"
],
"summary": "Update specific Desktop Layout by ID",
"description": "Update an existing Desktop Layout by ID in a given organization.",
"operationId": "updateConfig_14",
"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 Desktop Layout.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DesktopLayoutDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DesktopLayoutDTO"
}
}
}
},
"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": [
"Desktop Layout"
],
"summary": "Delete specific Desktop Layout by ID",
"description": "Delete an existing Desktop Layout by ID in a given organization.",
"operationId": "deleteConfig_14",
"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 Desktop Layout.",
"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
}
},
"/organization/{orgid}/desktop-layout/{id}/incoming-references": {
"get": {
"tags": [
"Desktop Layout"
],
"summary": "List references for a specific Desktop Layout",
"description": "Retrieve a list of all entities that have reference to an existing Desktop Layout by ID in a given organization.",
"operationId": "getIncomingReferences_12",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/v2/desktop-layout": {
"get": {
"tags": [
"Desktop Layout"
],
"summary": "List Desktop Layout(s)",
"description": "Retrieve a list of Desktop Layout(s) in a given organization. Json file content field won't be avalible in get all even though it is showing in sample response structure. and it will be avialable only in get by id.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigWithMetaData_14",
"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, validatedTime, defaultJsonModifiedTime, modifiedTime, teamIds, 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.",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
},
{
"name": "provisioningView",
"in": "query",
"description": "If set to true, the API will only return data that user has access to, according to User Profile.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeDesktopLayoutDTO"
},
"example": {
"data": [
{
"modifiedTime": 1617536244000,
"defaultJsonModifiedTime": 1617536244000,
"editedBy": "System",
"jsonFileName": "Desktop Layout.json",
"description": "This is the global layout",
"validatedTime": 1617536244000,
"global": true,
"version": 1,
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"systemDefault": false,
"validated": false,
"defaultJsonModified": true,
"name": "New Desktop Layout",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"jsonFileContent": {
"version": "0.0.6",
"appTitle": "Contact Center Desktop",
"logo": "",
"dragDropEnabled": false,
"notificationTimer": 8,
"maximumNotificationCount": 3,
"browserNotificationTimer": 8,
"wxmConfigured": false,
"area": {
"headless": {
"id": "dw-headless",
"widgets": {
"comp1": {
"comp": "div"
}
},
"layout": {
"areas": [
[
"comp1"
]
],
"size": {
"cols": [
1
],
"rows": [
1
]
}
}
}
}
},
"status": true
}
],
"meta": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/agent-profile": {
"get": {
"tags": [
"Desktop Profile"
],
"summary": "List Desktop Profiles",
"description": "Retrieve a list of Desktop Profiles in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead. Deprecated. Use GET /v2/agent-profile instead.",
"operationId": "getAllConfigDesktopProfile",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "filter",
"in": "query",
"description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n",
"required": false,
"schema": {
"type": "string"
},
"example": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\""
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentProfileResponseDTOList"
}
},
"example": [
{
"timeoutDesktopInactivityMins": 5,
"showUserDetailsMS": true,
"manageChannelAvailability": true,
"buddyTeams": [
"5_Jan_Testing",
"7_Feb_Testing"
],
"scheduleAndManageCallBack": true,
"timeoutDesktopInactivityCustomEnabled": true,
"wrapUpCodes": [
"WrapUp_Sale",
"WrapUp_Field"
],
"description": "This profile allows agent to auto wrap-up time and extend the wrap-up time.",
"agentDNValidation": "ALL",
"autoAcceptDigitalInteractions": false,
"agentDNValidationCriterions": [
"DN_5_Sept",
"DN_7_Jan"
],
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"systemDefault": false,
"outdialANIId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"stateSynchronizationMS": true,
"outdialEnabled": true,
"allowAutoWrapUpExtension": true,
"idleCodes": [
"aux_code_sale",
"aux_code2"
],
"accessIdleCode": "ALL",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"showUserDetailsWebex": true,
"dialPlans": [
"US",
"Any Format"
],
"accessWrapUpCode": "ALL",
"dialPlanEnabled": true,
"autoAnswer": true,
"accessBuddyTeam": "ALL",
"active": true,
"outdialEntryPointId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"version": 1,
"loginVoiceOptions": [
"AGENT_DN",
"EXTENSION",
"BROWSER"
],
"parentType": "SITE",
"addressBookId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"agentPersonalGreeting": true,
"lastAgentRouting": true,
"autoWrapUp": true,
"accessEntryPoint": "ALL",
"consultToQueue": true,
"name": "Agent-Profile(Auto WrapUp)",
"stateSynchronizationWebex": true,
"siteId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"screenPopup": true,
"agentAvailableAfterOutdial": true,
"agentDNValidationCriteria": "SPECIFIC",
"autoWrapAfterSeconds": 15,
"accessQueue": "ALL"
}
]
}
}
},
"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
},
"post": {
"tags": [
"Desktop Profile"
],
"summary": "Create a new Desktop Profile",
"description": "Create a new Desktop Profile in a given organization.",
"operationId": "createConfigDesktopProfile",
"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": "agentProfileDTO",
"in": "query",
"description": "Agent profile configuration data",
"required": true,
"schema": {
"$ref": "#/components/schemas/AgentProfileDTO"
},
"example": {
"name": "Agent-Profile(Auto WrapUp)",
"description": "This profile allows agent to auto wrap-up time",
"parentType": "SITE",
"siteId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"screenPopup": true,
"lastAgentRouting": true,
"accessWrapUpCode": "ALL",
"accessIdleCode": "ALL",
"accessQueue": "ALL",
"accessEntryPoint": "ALL",
"accessBuddyTeam": "ALL",
"agentDNValidation": "ALL",
"viewableStatistics": {
"accessQueueStats": "ALL",
"accessTeamStats": "ALL"
},
"active": true,
"autoAcceptDigitalInteractions": false
}
}
],
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/AgentProfileResponseDTO"
}
}
}
},
"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-profile/bulk": {
"post": {
"tags": [
"Desktop Profile"
],
"summary": "Bulk save Desktop Profiles",
"description": "Create, Update or delete Desktop Profiles in bulk in a given organization.",
"operationId": "saveAllConfigDesktopProfile",
"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/BulkRequestDTOAgentProfileDTO"
}
}
},
"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}/agent-profile/purge-inactive-entities": {
"post": {
"tags": [
"Desktop Profile"
],
"summary": "Purge inactive Desktop Profiles",
"description": "Purge inactive Desktop Profiles older than the configured interval for a given organization.",
"operationId": "purgeInactiveConfigDesktopProfile",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "nextStartId",
"in": "query",
"description": "This is the entity ID from which items for the next purge batch will be selected.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/agent-profile/{id}": {
"get": {
"tags": [
"Desktop Profile"
],
"summary": "Get specific Desktop Profile by ID",
"description": "Retrieve an existing Desktop Profile by ID in a given organization.",
"operationId": "getConfigDesktopProfile",
"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 Desktop Profile.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/AgentProfileResponseDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"put": {
"tags": [
"Desktop Profile"
],
"summary": "Update specific Desktop Profile by ID",
"description": "Update an existing Desktop Profile by ID in a given organization.",
"operationId": "updateConfigDesktopProfile",
"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 Desktop Profile.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
},
{
"name": "agentProfileDTO",
"in": "query",
"description": "Agent profile configuration data for update",
"required": true,
"schema": {
"$ref": "#/components/schemas/AgentProfileDTO"
},
"example": {
"name": "Agent-Profile(Auto WrapUp) Updated",
"description": "Updated profile for auto wrap-up time",
"parentType": "SITE",
"siteId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"screenPopup": false,
"lastAgentRouting": false,
"accessWrapUpCode": "ALL",
"accessIdleCode": "ALL",
"accessQueue": "ALL",
"accessEntryPoint": "ALL",
"accessBuddyTeam": "ALL",
"agentDNValidation": "ALL",
"viewableStatistics": {
"accessQueueStats": "ALL",
"accessTeamStats": "ALL"
},
"active": true,
"autoAcceptDigitalInteractions": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/AgentProfileResponseDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"delete": {
"tags": [
"Desktop Profile"
],
"summary": "Delete specific Desktop Profile by ID",
"description": "Delete an existing Desktop Profile by ID in a given organization.",
"operationId": "deleteConfigDesktopProfile",
"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 Desktop Profile.",
"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}/agent-profile/{id}/incoming-references": {
"get": {
"tags": [
"Desktop Profile"
],
"summary": "List references for a specific Desktop Profile",
"description": "Retrieve a list of all entities that have reference to an existing Desktop Profile by ID in a given organization.",
"operationId": "getIncomingReferencesDesktopProfile",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
}
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/v2/agent-profile": {
"get": {
"tags": [
"Desktop Profile"
],
"summary": "List Desktop Profiles",
"description": "Retrieve a list of Desktop Profiles in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigWithMetaDataDesktopProfile",
"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, autoWrapAfterSeconds, wrapUpCodes, idleCodes, queues, entryPoints, buddyTeams, dialPlans, agentDNValidationCriteria, agentDNValidationCriterions, loginVoiceOptions, viewableStatistics, thresholdRules, 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. except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) ",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
}
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
},
{
"name": "provisioningView",
"in": "query",
"description": "If set to true, the API will only return data that the user has access to, according to the User Profile.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataWithPagingInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AgentProfileResponseDTOList"
}
}
}
},
"example": {
"data": [
{
"timeoutDesktopInactivityMins": 5,
"showUserDetailsMS": true,
"manageChannelAvailability": true,
"buddyTeams": [
"5_Jan_Testing",
"7_Feb_Testing"
],
"scheduleAndManageCallBack": true,
"timeoutDesktopInactivityCustomEnabled": true,
"wrapUpCodes": [
"WrapUp_Sale",
"WrapUp_Field"
],
"description": "This profile allows agent to auto wrap-up time and extend the wrap-up time.",
"agentDNValidation": "ALL",
"autoAcceptDigitalInteractions": false,
"agentDNValidationCriterions": [
"DN_5_Sept",
"DN_7_Jan"
],
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"systemDefault": false,
"outdialANIId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"stateSynchronizationMS": true,
"outdialEnabled": true,
"allowAutoWrapUpExtension": true,
"idleCodes": [
"aux_code_sale",
"aux_code2"
],
"accessIdleCode": "ALL",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"showUserDetailsWebex": true,
"dialPlans": [
"US",
"Any Format"
],
"accessWrapUpCode": "ALL",
"dialPlanEnabled": true,
"autoAnswer": true,
"accessBuddyTeam": "ALL",
"active": true,
"outdialEntryPointId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"version": 1,
"loginVoiceOptions": [
"AGENT_DN",
"EXTENSION",
"BROWSER"
],
"parentType": "SITE",
"addressBookId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"agentPersonalGreeting": true,
"lastAgentRouting": true,
"autoWrapUp": true,
"accessEntryPoint": "ALL",
"consultToQueue": true,
"name": "Agent-Profile(Auto WrapUp)",
"stateSynchronizationWebex": true,
"siteId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"screenPopup": true,
"agentAvailableAfterOutdial": true,
"agentDNValidationCriteria": "SPECIFIC",
"autoWrapAfterSeconds": 15,
"accessQueue": "ALL"
}
],
"meta": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/dial-number": {
"get": {
"tags": [
"Dial Number"
],
"summary": "List Dialed Number Mapping(s)",
"description": "Retrieve a list of Dialed Number Mapping(s) in a given organization.",
"operationId": "getAllConfig_9",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "filter",
"in": "query",
"description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n",
"required": false,
"schema": {
"type": "string"
},
"example": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\""
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (links)",
"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": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DialledNumberEntryPointDTO"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"Dial Number"
],
"summary": "Create a new Dialed Number Mapping",
"description": "Create a new Dialed Number Mapping in a given organization.",
"operationId": "createConfig_14",
"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/DialledNumberEntryPointDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DialledNumberEntryPointDTO"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Dial Number"
],
"summary": "Delete all Dialed Number Mapping(s)",
"description": "Delete all Dialed Number Mapping(s) in a given organization.",
"operationId": "deleteAllConfig",
"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"
}
],
"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
}
},
"/organization/{orgid}/dial-number/bulk": {
"post": {
"tags": [
"Dial Number"
],
"summary": "Bulk save Dialed Number Mapping(s)",
"description": "Create, Update or delete Dialed Number Mapping(s) in bulk in a given organization.",
"operationId": "saveAllConfig_14",
"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/BulkRequestDTODialledNumberEntryPointDTO"
}
}
},
"required": true
},
"responses": {
"207": {
"description": "Multi-Status",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BulkResponseDTO"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/dial-number/bulk-export": {
"get": {
"tags": [
"Dial Number"
],
"summary": "Bulk export Dialed Number Mapping(s)",
"description": "Export all Dialed Number Mapping(s) in a given organization.",
"operationId": "bulkExport_12",
"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": "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/BulkExportDTODialledNumberEntryPointExportDTO"
}
}
}
},
"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}/dial-number/numbers-only": {
"get": {
"tags": [
"Dial Number"
],
"summary": "List only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s)",
"description": "Retrieve a list of only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s) without pagination in a given organization.",
"operationId": "getDNsbyOrgID",
"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"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/dial-number/{id}": {
"get": {
"tags": [
"Dial Number"
],
"summary": "Get specific Dialed Number Mapping by ID",
"description": "Retrieve an existing Dialed Number Mapping by ID in a given organization.",
"operationId": "getConfig_16",
"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 Dialed Number Mapping.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DialledNumberEntryPointDTO"
}
}
}
},
"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": [
"Dial Number"
],
"summary": "Update specific Dialed Number Mapping by ID",
"description": "Update an existing Dialed Number Mapping by ID in a given organization.",
"operationId": "updateConfig_16",
"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 Dialed Number Mapping.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DialledNumberEntryPointDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DialledNumberEntryPointDTO"
}
}
}
},
"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": [
"Dial Number"
],
"summary": "Delete specific Dialed Number Mapping by ID",
"description": "Delete an existing Dialed Number Mapping by ID in a given organization.",
"operationId": "deleteConfig_14",
"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 Dialed Number Mapping.",
"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
}
},
"/organization/{orgid}/dial-number/{id}/incoming-references": {
"get": {
"tags": [
"Dial Number"
],
"summary": "List references for a specific Dialed Number Mapping",
"description": "Retrieve a list of all entities that have reference to an existing Dialed Number Mapping by ID in a given organization.",
"operationId": "getIncomingReferences_12",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/v2/dial-number": {
"get": {
"tags": [
"Dial Number"
],
"summary": "List Dialed Number Mapping(s)",
"description": "Retrieve a list of Dialed Number Mapping(s) in a given organization.",
"operationId": "getAllConfigWithMetaData_15",
"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. except (links)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "includeEntryPointName",
"in": "query",
"description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeDialledNumberEntryPointDTO"
}
}
}
},
"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/dial-number": {
"get": {
"tags": [
"Dial Number"
],
"summary": "List Dialed Number Mapping(s)",
"description": "Retrieve a list of Dialed Number Mapping(s) in a given organization.",
"operationId": "getAllConfigWithMetaDataV3",
"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. except (links)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(dialledNumber)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"dialledNumber\";value==\"Cisco\"\n- fields=in=(\"dialledNumber\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "includeEntryPointName",
"in": "query",
"description": "If includeEntryPointName is set to true and entryPointName is in the attributes, the API will return entryPointName in the Get All response, and filtering, searching, and sorting on entryPointName will also be enabled.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeDialledNumberEntryPointDTO"
}
}
}
},
"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}/dial-plan": {
"get": {
"tags": [
"Dial Plan"
],
"summary": "List Dial Plans",
"description": "Retrieve a list of Dial Plans in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.",
"operationId": "getAllConfigDialPlan",
"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": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DialPlanDTO"
}
}
}
}
},
"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
},
"post": {
"tags": [
"Dial Plan"
],
"summary": "Create a new Dial Plan",
"description": "Create a new Dial Plan in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.",
"operationId": "createConfigDialPlan",
"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/DialPlanDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DialPlanDTO"
}
}
}
},
"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}/dial-plan/bulk": {
"post": {
"tags": [
"Dial Plan"
],
"summary": "Bulk save Dial Plans",
"description": "Create, Update or delete Dial Plans in bulk in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.",
"operationId": "saveAllConfigDialPlan",
"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/BulkRequestDTODialPlanDTO"
}
}
},
"required": true
},
"responses": {
"207": {
"description": "Multi-Status",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BulkResponseDTO"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/dial-plan/{id}": {
"get": {
"tags": [
"Dial Plan"
],
"summary": "Get specific Dial Plan by ID",
"description": "Retrieve an existing Dial Plan by ID in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.",
"operationId": "getConfigDialPlan",
"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 Dial Plan.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DialPlanDTO"
}
}
}
},
"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": [
"Dial Plan"
],
"summary": "Update specific Dial Plan by ID",
"description": "Update an existing Dial Plan by ID in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.",
"operationId": "updateConfigDialPlan",
"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 Dial Plan.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DialPlanDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/DialPlanDTO"
}
}
}
},
"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": [
"Dial Plan"
],
"summary": "Delete specific Dial Plan by ID",
"description": "Delete an existing Dial Plan by ID in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.",
"operationId": "deleteConfigDialPlan",
"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 Dial Plan.",
"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
}
},
"/organization/{orgid}/dial-plan/{id}/incoming-references": {
"get": {
"tags": [
"Dial Plan"
],
"summary": "List references for a specific Dial Plan",
"description": "Retrieve a list of all entities that have reference to an existing Dial Plan by ID in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.",
"operationId": "getIncomingReferencesDialPlan",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/v2/dial-plan": {
"get": {
"tags": [
"Dial Plan"
],
"summary": "List Dial Plans",
"description": "Retrieve a list of Dial Plans in a given organization.\n\n**Deprecated:** Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent Profile setting, so agents can no longer use them for agent dial number validation.",
"operationId": "getAllConfigWithMetaDataDialPlan",
"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.",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeDialPlanDTO"
}
}
}
},
"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}/entry-point": {
"get": {
"tags": [
"Entry Point"
],
"summary": "List Entry Point(s)",
"description": "Retrieve a list of Entry Point(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.",
"operationId": "getAllFilteredConfig",
"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 space, and if so kindly bound it with quotes to apply filter.\n",
"required": false,
"schema": {
"type": "string"
},
"example": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\""
},
{
"name": "channelTypes",
"in": "query",
"description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering.",
"required": false,
"schema": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"example": "TELEPHONY,CHAT"
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ",
"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",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.",
"schema": {
"type": "boolean",
"example": false,
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntryPointDTO"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": true
},
"post": {
"tags": [
"Entry Point"
],
"summary": "Create a new Entry Point",
"description": "Create a new Entry Point in a given organization.",
"operationId": "createConfig_14",
"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/EntryPointDTO"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntryPointDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/entry-point/bulk": {
"post": {
"tags": [
"Entry Point"
],
"summary": "Bulk save Entry Point(s)",
"description": "Create, Update or delete Entry Point(s) in bulk in a given organization.",
"operationId": "saveAllConfig_12",
"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/BulkRequestDTOEntryPointDTO"
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/entry-point/bulk-export": {
"get": {
"tags": [
"Entry Point"
],
"summary": "Bulk export Entry Point(s)",
"description": "Export all Entry Point(s) in a given organization.",
"operationId": "bulkExport_12",
"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": "type",
"in": "query",
"description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND.",
"required": true,
"schema": {
"type": "string",
"enum": [
"INBOUND",
"OUTBOUND"
]
},
"example": "INBOUND"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BulkExportDTOEntryPointBulkExportDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/entry-point/purge-inactive-entities": {
"post": {
"tags": [
"Entry Point"
],
"summary": "Purge inactive Entry Point(s)",
"description": "Purge inactive Entry Point(s) older than the configured interval for a given organization.",
"operationId": "purgeInactiveConfig_6",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "nextStartId",
"in": "query",
"description": "This is the entity ID from which items for the next purge batch with be selected.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/entry-point/{id}": {
"get": {
"tags": [
"Entry Point"
],
"summary": "Get specific Entry Point by ID",
"description": "Retrieve an existing Entry Point by ID in a given organization.",
"operationId": "getConfig_15",
"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 Entry Point.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
},
{
"name": "includeNames",
"in": "query",
"description": "Specifiy whether to include flow override settings reference variable names.",
"schema": {
"type": "boolean",
"example": false,
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntryPointDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"Entry Point"
],
"summary": "Update specific Entry Point by ID",
"description": "Update an existing Entry Point by ID in a given organization.",
"operationId": "updateConfig_15",
"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 Entry Point.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntryPointDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntryPointDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Entry Point"
],
"summary": "Delete specific Entry Point by ID",
"description": "Delete an existing Entry Point by ID in a given organization.",
"operationId": "deleteConfig_14",
"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 Entry Point.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/entry-point/{id}/incoming-references": {
"get": {
"tags": [
"Entry Point"
],
"summary": "List references for a specific Entry Point",
"description": "Retrieve a list of all entities that have reference to an existing Entry Point by ID in a given organization.",
"operationId": "getIncomingReferences_11",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/v2/entry-point": {
"get": {
"tags": [
"Entry Point"
],
"summary": "List Entry Point(s)",
"description": "Retrieve a list of Entry Point(s) in a given organization.\n Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.",
"operationId": "getAllFilteredConfigWithMetaData_1",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "filter",
"in": "query",
"description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with specified columns. All Attributes are supported except (ccOneQueue, userIds, queueRankings, links) ",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
},
{
"name": "desktopProfileFilter",
"in": "query",
"description": "If set to true, the API will return only the data that the user has access to according to its Desktop Profile. If set to false, the API will not check for Desktop Profile level access.",
"schema": {
"type": "boolean",
"example": false,
"default": false
}
},
{
"name": "provisioningView",
"in": "query",
"description": "If set to true, the API will only return data that user has access to, according to User Profile. If set to false and desktopProfileFilter query parameter is not specified, the API will add user associated data, based on desktop. ",
"schema": {
"type": "boolean",
"example": false,
"default": false
}
},
{
"name": "includeCount",
"in": "query",
"description": "Enable the flag to get the count of DN-EP Mapping",
"schema": {
"type": "boolean",
"example": false,
"default": false
}
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.",
"schema": {
"type": "boolean",
"example": false,
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeEntryPointDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/cad-variable": {
"post": {
"tags": [
"Global Variables"
],
"summary": "Create a new Global Variable",
"description": "Create a new Global Variable in a given organization.",
"operationId": "createConfig_21",
"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/CadVariableDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/CadVariableDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/cad-variable/bulk": {
"post": {
"tags": [
"Global Variables"
],
"summary": "Bulk save Global Variable(s)",
"description": "Export all Global Variable(s) in a given organization.",
"operationId": "saveAllConfig_18",
"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/BulkRequestDTOCadVariableDTO"
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/cad-variable/bulk-export": {
"get": {
"tags": [
"Global Variables"
],
"summary": "Bulk export Global Variable(s)",
"description": "Export all Global Variable(s) in a given organization.",
"operationId": "bulkExport_18",
"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": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BulkExportDTOCadVariableBulkExportDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/cad-variable/purge-inactive-entities": {
"post": {
"tags": [
"Global Variables"
],
"summary": "Purge inactive Global Variable(s)",
"description": "Purge inactive Global Variable(s) older than the configured interval for a given organization.",
"operationId": "purgeInactiveConfig_9",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "nextStartId",
"in": "query",
"description": "This is the entity ID from which items for the next purge batch with be selected.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/cad-variable/reportable-count": {
"get": {
"tags": [
"Global Variables"
],
"summary": "Get reportable count for Global Variable(s)",
"description": "Get count for all the reportable Global Variable(s) in a given organization.",
"operationId": "getReportableCountConfig",
"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"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "object",
"additionalProperties": {
"type": "integer",
"format": "int64"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/cad-variable/{id}": {
"get": {
"tags": [
"Global Variables"
],
"summary": "Get specific Global Variable by ID",
"description": "Retrieve an existing Global Variable by ID in a given organization.",
"operationId": "getConfig_22",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of the Global Variable.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/CadVariableDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"Global Variables"
],
"summary": "Update specific Global Variable by ID",
"description": "Update an existing Global Variable by ID in a given organization. Required fields in payload are agentEditable, variableType, agentViewable, reportable, active, defaultValue.",
"operationId": "updateConfig_22",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of the Global Variable.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CadVariableDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/CadVariableDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Global Variables"
],
"summary": "Delete specific Global Variable by ID",
"description": "Delete an existing Global Variable by ID in a given organization.",
"operationId": "deleteConfig_20",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of the Global Variable.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/cad-variable/{id}/incoming-references": {
"get": {
"tags": [
"Global Variables"
],
"summary": "List references for a specific Global Variable",
"description": "Retrieve a list of all entities that have reference to an existing Global Variable by ID in a given organization.",
"operationId": "getIncomingReferences_16",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/v2/cad-variable": {
"get": {
"tags": [
"Global Variables"
],
"summary": "List Global Variable(s)",
"description": "Retrieve a list of Global Variable(s) in a given organization.",
"operationId": "getAllConfigWithMetaData_31",
"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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with specified columns. All Attributes are supported",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeCadVariableDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/multimedia-profile": {
"get": {
"tags": [
"Multimedia Profile"
],
"summary": "List Multimedia Profile(s)",
"description": "Retrieve a list of Multimedia Profile(s) in a given organization.",
"operationId": "getAllConfig_6",
"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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with 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",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MultimediaProfileDTO"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"Multimedia Profile"
],
"summary": "Create a new Multimedia Profile",
"description": "Create a new Multimedia Profile in a given organization.",
"operationId": "createConfig_11",
"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/MultimediaProfileDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MultimediaProfileDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/multimedia-profile/bulk": {
"post": {
"tags": [
"Multimedia Profile"
],
"summary": "Bulk save Multimedia Profile(s)",
"description": "Create, Update or delete Multimedia Profile(s) in bulk in a given organization.",
"operationId": "saveAllConfig_10",
"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/BulkRequestDTOMultimediaProfileDTO"
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/multimedia-profile/bulk-export": {
"get": {
"tags": [
"Multimedia Profile"
],
"summary": "Bulk export Multimedia Profile(s)",
"description": "Export all Multimedia Profile(s) in a given organization.",
"operationId": "bulkExport_10",
"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": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BulkExportDTOMultimediaProfileExportDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/multimedia-profile/purge-inactive-entities": {
"post": {
"tags": [
"Multimedia Profile"
],
"summary": "Purge inactive Multimedia Profile(s)",
"description": "Purge inactive Multimedia Profile(s) older than the configured interval for a given organization.",
"operationId": "purgeInactiveConfig_5",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "nextStartId",
"in": "query",
"description": "This is the entity ID from which items for the next purge batch with be selected.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/multimedia-profile/{id}": {
"get": {
"tags": [
"Multimedia Profile"
],
"summary": "Get specific Multimedia Profile by ID",
"description": "Retrieve an existing Multimedia Profile by ID in a given organization.",
"operationId": "getConfig_12",
"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 Multimedia Profile.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MultimediaProfileDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"Multimedia Profile"
],
"summary": "Update specific Multimedia Profile by ID",
"description": "Update an existing Multimedia Profile by ID in a given organization.",
"operationId": "updateConfig_12",
"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 Multimedia Profile.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MultimediaProfileDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/MultimediaProfileDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Multimedia Profile"
],
"summary": "Delete specific Multimedia Profile by ID",
"description": "Delete an existing Multimedia Profile by ID in a given organization.",
"operationId": "deleteConfig_11",
"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 Multimedia Profile.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/multimedia-profile/{id}/incoming-references": {
"get": {
"tags": [
"Multimedia Profile"
],
"summary": "List references for a specific Multimedia Profile",
"description": "Retrieve a list of all entities that have reference to an existing Multimedia Profile by ID in a given organization.",
"operationId": "getIncomingReferences_9",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/v2/multimedia-profile": {
"get": {
"tags": [
"Multimedia Profile"
],
"summary": "List Multimedia Profile(s)",
"description": "Retrieve a list of Multimedia Profile(s) in a given organization.",
"operationId": "getAllConfigWithMetaData_13",
"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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with specified columns. All Attributes are supported",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeMultimediaProfileDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/outdial-ani": {
"get": {
"tags": [
"Outdial ANI"
],
"summary": "List Outdial ANIs",
"description": "Retrieve a list of Outdial ANIs in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigOutdialANI",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "filter",
"in": "query",
"description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n",
"required": false,
"schema": {
"type": "string"
},
"example": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\""
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except outdialANIEntries",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OutdialANIDTOList"
}
},
"example": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"name": "outdial-ANI1",
"description": "This profile allows agent to select a phone number as the caller ID for an outdial call.",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1
}
]
}
}
},
"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": [
"Outdial ANI"
],
"summary": "Create a new Outdial ANI",
"description": "Create a new Outdial ANI in a given organization.",
"operationId": "createConfigOutdialANI",
"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/OutdialANIDTO"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/OutdialANIDTO"
}
}
}
},
"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}/outdial-ani/bulk": {
"post": {
"tags": [
"Outdial ANI"
],
"summary": "Bulk save Outdial ANIs",
"description": "Create, Update or delete Outdial ANIs in bulk in a given organization.",
"operationId": "saveAllConfigOutdialANI",
"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/BulkRequestDTOOutdialANIDTO"
}
}
},
"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}/outdial-ani/entry": {
"get": {
"tags": [
"Outdial ANI"
],
"summary": "List Outdial ANI Entries",
"description": "Retrieve a list of Outdial ANI Entries in a given organization.",
"operationId": "getAllConfigWithMetaDataOutDialANIEntry2",
"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": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeOutdialANIEntryDTO"
}
}
}
},
"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}/outdial-ani/{id}": {
"get": {
"tags": [
"Outdial ANI"
],
"summary": "Get specific Outdial ANI by ID",
"description": "Retrieve an existing Outdial ANI by ID in a given organization.",
"operationId": "getConfigOutdialANI",
"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 Outdial ANI.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/OutdialANIDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"put": {
"tags": [
"Outdial ANI"
],
"summary": "Update specific Outdial ANI by ID",
"description": "Update an existing Outdial ANI by ID in a given organization.",
"operationId": "updateConfigOutdialANI",
"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 Outdial ANI.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutdialANIDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/OutdialANIDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"delete": {
"tags": [
"Outdial ANI"
],
"summary": "Delete specific Outdial ANI by ID",
"description": "Delete an existing Outdial ANI by ID in a given organization.",
"operationId": "deleteConfigOutdialANI",
"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 Outdial ANI.",
"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}/outdial-ani/{id}/incoming-references": {
"get": {
"tags": [
"Outdial ANI"
],
"summary": "List references for a specific Outdial ANI",
"description": "Retrieve a list of all entities that have reference to an existing Outdial ANI by ID in a given organization.",
"operationId": "getIncomingReferencesOutdialANI",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/outdial-ani/{outDialAniId}/entry": {
"post": {
"tags": [
"Outdial ANI"
],
"summary": "Create a new Outdial ANI Entry",
"description": "Create a new Outdial ANI Entry in a given organization.",
"operationId": "createConfigOutDialANIEntry",
"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": "outDialAniId",
"in": "path",
"description": "Resource ID of the Outdial ANI",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutdialANIEntryDTO"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/OutdialANIEntryDTO"
}
}
}
},
"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}/outdial-ani/{outDialAniId}/entry/bulk": {
"post": {
"tags": [
"Outdial ANI"
],
"summary": "Bulk save Outdial ANI Entries",
"description": "Create, Update or delete Outdial ANI Entries in bulk for an Address Book in a given organization.",
"operationId": "saveAllConfigOutDialANIEntry",
"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": "outDialAniId",
"in": "path",
"description": "Resource ID of the Outdial ANI",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkRequestDTOOutdialANIEntryDTO"
}
}
},
"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}/outdial-ani/{outDialAniId}/entry/{id}": {
"get": {
"tags": [
"Outdial ANI"
],
"summary": "Get specific Outdial ANI Entry by ID",
"description": "Retrieve an existing Outdial ANI Entry by ID in a given organization.",
"operationId": "getConfigOutDialANIEntry",
"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": "outDialAniId",
"in": "path",
"description": "Resource ID of the Outdial ANI",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/OutdialANIEntryDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"put": {
"tags": [
"Outdial ANI"
],
"summary": "Update specific Outdial ANI Entry by ID",
"description": "Update an existing Outdial ANI Entry by ID in a given organization.",
"operationId": "updateConfigOutDialANIEntry",
"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": "outDialAniId",
"in": "path",
"description": "Resource ID of the Outdial ANI",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OutdialANIEntryDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/OutdialANIEntryDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"delete": {
"tags": [
"Outdial ANI"
],
"summary": "Delete specific Outdial ANI Entry by ID",
"description": "Delete an existing Outdial ANI Entry by ID in a given organization.",
"operationId": "deleteConfigOutDialANIEntry",
"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": "outDialAniId",
"in": "path",
"description": "Resource ID of the Outdial ANI",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"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": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/v2/outdial-ani": {
"get": {
"tags": [
"Outdial ANI"
],
"summary": "List Outdial ANIs",
"description": "Retrieve a list of Outdial ANIs in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigWithMetaDataOutdialANI",
"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, outdialANIEntries, 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. except outdialANIEntries",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeOutdialANIDTO"
},
"example": {
"data": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"name": "outdial-ANI1",
"description": "This profile allows agent to select a phone number as the caller ID for an outdial call.",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1
}
],
"meta": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/v2/outdial-ani/{outDialAniId}/entry": {
"get": {
"tags": [
"Outdial ANI"
],
"summary": "List Outdial ANI Entries",
"description": "Retrieve a list of Outdial ANI Entries in a given organization.",
"operationId": "getAllConfigWithMetaDataOutDialANIEntry1",
"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": "outDialAniId",
"in": "path",
"description": "Resource ID of the Outdial ANI",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"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.",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeOutdialANIEntryDTO"
}
}
}
},
"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}/resource-collection": {
"post": {
"tags": [
"Resource Collection"
],
"summary": "Create a new Resource Collection",
"description": "Create a new resource collection in a given organization.",
"operationId": "createResourceCollection",
"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/ResourceCollectionDTO"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResourceCollectionDTO"
}
}
}
},
"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}/resource-collection/bulk": {
"patch": {
"tags": [
"Resource Collection"
],
"summary": "Bulk partial update Resource Collections",
"description": "Update some or all properties for resource collections in bulk for a given organization.",
"operationId": "bulkPatchResourceCollections",
"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": {
"description": "For each of the item to update,\nWe only need to provide the patch JSON.\nOnly the following properties are mandatory to identify unique item for update. Other properties are optional.\nMandatory Properties: [id]\nAll properties that can be updated via PUT Api are allowed to be updated.\nTo nullify a property or remove it, specify null as value for the Json property.\nValid value for requestAction property is 'SAVE'. It is optional property and default SAVE is assumed.\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkRequestDTO"
},
"example": {
"items": [
{
"item": {
"id": "26e2df70-0f77-41b8-8e8f-1d76e92c9638",
"name": "Updated Collection",
"description": "Updated description",
"queues": []
},
"itemIdentifier": 0,
"requestAction": "SAVE"
}
]
}
}
},
"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": []
}
]
}
}
}
}
},
"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}/resource-collection/update-resource": {
"post": {
"tags": [
"Resource Collection"
],
"summary": "Update resource with default resource collection",
"description": "Update resource with default resource collection. Ensure resource should not associated to any resource collection and resource should not be updated and not older than 15 min. Only single Resource Collection is allowed to update.",
"operationId": "updateResourceToResourceCollection",
"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/UpdateResourceRequestDTO"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/UpdateResourceResponseDTO"
}
}
}
},
"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}/resource-collection/{id}": {
"get": {
"tags": [
"Resource Collection"
],
"summary": "Get specific Resource Collection by ID",
"description": "Retrieve an existing Resource Collection by ID in a given organization.",
"operationId": "getResourceCollectionById",
"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 Resource Collection.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResourceCollectionDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"put": {
"tags": [
"Resource Collection"
],
"summary": "Update specific Resource Collection by ID",
"description": "Update an existing resource collection by ID in a given organization.",
"operationId": "updateResourceCollection",
"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 Resource Collection.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceCollectionDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResourceCollectionDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"delete": {
"tags": [
"Resource Collection"
],
"summary": "Delete specific Resource Collection by ID",
"description": "Delete an existing resource collection by ID in a given organization.",
"operationId": "deleteResourceCollection",
"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 Resource Collection.",
"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}/resource-collection/{id}/incoming-references": {
"get": {
"tags": [
"Resource Collection"
],
"summary": "List references for a specific Resource Collection",
"description": "Retrieve a list of all entities that have reference to an existing resource collection by ID in a given organization.",
"operationId": "getIncomingReferencesForResourceCollection",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/v2/resource-collection": {
"get": {
"tags": [
"Resource Collection"
],
"summary": "List Resource Collections",
"description": "Retrieve a list of resource collections in a given organization.",
"operationId": "getAllResourceCollections",
"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.",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataWithPagingInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ResourceCollectionDTO"
}
}
}
},
"example": {
"meta": {
"orgid": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"page": 1,
"pageSize": 100,
"totalPages": 1,
"totalRecords": 1000,
"links": {
"next": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/resource-collection?page=2&pageSize=10",
"last": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/resource-collection?page=3&pageSize=10",
"prev": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/resource-collection?page=0&pageSize=10",
"self": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/resource-collection?page=1&pageSize=10",
"first": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/resource-collection?page=0&pageSize=10"
}
},
"data": [
{
"id": "80f49a6e-11d7-4651-b730-99ed2f726f61",
"name": "Department1",
"description": "Department1 description.",
"resources": [
{
"name": "team",
"accessLevel": "SPECIFIC",
"ids": [
"00734874-4732-43bb-bfff-d1e75d309eb1",
"00734874-4732-43bb-bfff-d1e75d309eb2"
]
},
{
"name": "desktop-profile",
"accessLevel": "ALL"
},
{
"name": "desktop-layout",
"accessLevel": "NONE"
}
],
"resourceCount": 2
}
]
}
}
}
},
"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}/site": {
"get": {
"tags": [
"Site"
],
"summary": "List Site(s)",
"description": "Retrieve a list of Site(s) in a given organization.",
"operationId": "getAllConfigWithoutPagination_1",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "filter",
"in": "query",
"description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with specified columns. All Attributes are supported",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteDTO"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"Site"
],
"summary": "Create a new Site",
"description": "Create a new Site in a given organization.",
"operationId": "createConfig_7",
"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/SiteDTO"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SiteDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/site/bulk": {
"post": {
"tags": [
"Site"
],
"summary": "Bulk save Site(s)",
"description": "Create, Update or delete Site(s) in bulk in a given organization.",
"operationId": "saveAllConfig_6",
"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/BulkRequestDTOSiteDTO"
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/site/bulk-export": {
"get": {
"tags": [
"Site"
],
"summary": "Bulk export Site(s)",
"description": "Export all Site(s) in a given organization.",
"operationId": "bulkExport_7",
"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": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BulkExportDTOSiteBulkExportDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/site/purge-inactive-entities": {
"post": {
"tags": [
"Site"
],
"summary": "Purge inactive Site(s)",
"description": "Purge inactive Site(s) older than the configured interval for a given organization.",
"operationId": "purgeInactiveConfig_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": "nextStartId",
"in": "query",
"description": "This is the entity ID from which items for the next purge batch with be selected.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/site/{id}": {
"get": {
"tags": [
"Site"
],
"summary": "Get specific Site by ID",
"description": "Retrieve an existing Site by ID in a given organization.",
"operationId": "getConfig_8",
"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 Site.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SiteDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"Site"
],
"summary": "Update specific Site by ID",
"description": "Update an existing Site by ID in a given organization.",
"operationId": "updateConfig_8",
"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 Site.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SiteDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SiteDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Site"
],
"summary": "Delete specific Site by ID",
"description": "Delete an existing Site by ID in a given organization.",
"operationId": "deleteConfig_7",
"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 Site.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/site/{id}/incoming-references": {
"get": {
"tags": [
"Site"
],
"summary": "List references for a specific Site",
"description": "Retrieve a list of all entities that have reference to an existing Site by ID in a given organization.",
"operationId": "getIncomingReferences_6",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/v2/site": {
"get": {
"tags": [
"Site"
],
"summary": "List Site(s)",
"description": "Retrieve a list of Site(s) in a given organization.",
"operationId": "getAllConfigWithMetaData_9",
"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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with specified columns. All Attributes are supported",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeSiteDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/skill": {
"get": {
"tags": [
"Skill"
],
"summary": "List Skill(s)",
"description": "Retrieve a list of Skill(s) in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfig_2",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "filter",
"in": "query",
"description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n",
"required": false,
"schema": {
"type": "string"
},
"example": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\""
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (enumSkillValues)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SkillDTO"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"Skill"
],
"summary": "Create a new Skill",
"description": "Create a new Skill in a given organization.",
"operationId": "createConfig_3",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "payloadDTO",
"in": "query",
"description": "Skill configuration data",
"required": true,
"schema": {
"$ref": "#/components/schemas/SkillDTO"
},
"example": {
"name": "German Speaking",
"description": "Skill to speak fluent German",
"serviceLevelThreshold": 0,
"active": true,
"skillType": "Boolean"
}
}
],
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SkillDTO"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/skill/bulk": {
"post": {
"tags": [
"Skill"
],
"summary": "Bulk save Skill(s)",
"description": "Create, Update or delete Skill(s) in bulk in a given organization.",
"operationId": "saveAllConfig_2",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkRequestDTOSkillDTO"
}
}
},
"required": true
},
"responses": {
"207": {
"description": "Multi-Status",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BulkResponseDTO"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/skill/populate-json-attr/{id}": {
"post": {
"tags": [
"Skill"
],
"summary": "Populate json-attributes field for a given skill-id of an organization",
"operationId": "populateJsonAttributesByOrgIdAndSkillId",
"parameters": [
{
"name": "orgid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"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}/skill/purge-inactive-entities": {
"post": {
"tags": [
"Skill"
],
"summary": "Purge inactive Skill(s)",
"description": "Purge inactive Skill(s) older than the configured interval for a given organization.",
"operationId": "purgeInactiveConfig_2",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "nextStartId",
"in": "query",
"description": "This is the entity ID from which items for the next purge batch with be selected.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/skill/{id}": {
"get": {
"tags": [
"Skill"
],
"summary": "Get specific Skill by ID",
"description": "Retrieve an existing Skill by ID in a given organization.",
"operationId": "getConfig_3",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Skill.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SkillDTO"
}
}
}
},
"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": [
"Skill"
],
"summary": "Update specific Skill by ID",
"description": "Update an existing Skill by ID in a given organization.",
"operationId": "updateConfig_3",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Skill.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
},
{
"name": "payloadDTO",
"in": "query",
"description": "Skill configuration data for update",
"required": true,
"schema": {
"$ref": "#/components/schemas/SkillDTO"
},
"example": {
"name": "German Speaking Updated",
"description": "Updated skill to speak fluent German",
"serviceLevelThreshold": 5,
"active": true,
"skillType": "Boolean"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SkillDTO"
}
}
}
},
"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": [
"Skill"
],
"summary": "Delete specific Skill by ID",
"description": "Delete an existing Skill by ID in a given organization.",
"operationId": "deleteConfig_3",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Skill.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"412": {
"description": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "412",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "412",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/skill/{id}/incoming-references": {
"get": {
"tags": [
"Skill"
],
"summary": "List references for a specific Skill",
"description": "Retrieve a list of all entities that have reference to an existing Skill by ID in a given organization.",
"operationId": "getIncomingReferences_2",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/v2/skill": {
"get": {
"tags": [
"Skill"
],
"summary": "List Skill(s)",
"description": "Retrieve a list of Skill(s) in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigWithMetaData_4",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "filter",
"in": "query",
"description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, enumSkillValues, 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. except (enumSkillValues)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeSkillDTO"
}
}
}
},
"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}/skill-profile": {
"get": {
"tags": [
"Skill Profile"
],
"summary": "List Skill Profile(s)",
"description": "Retrieve a list of Skill Profile(s) in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfig_3",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "filter",
"in": "query",
"description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n",
"required": false,
"schema": {
"type": "string"
},
"example": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\""
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (activeSkills,activeEnumSkills)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SkillProfileDTOList"
}
},
"example": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"name": "German Speaker",
"description": "Required for transferring out-dial calls to Queues",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1
}
]
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
},
"post": {
"tags": [
"Skill Profile"
],
"summary": "Create a new Skill Profile",
"description": "Create a new Skill Profile in a given organization.",
"operationId": "createConfig_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": "skillProfileDTO",
"in": "query",
"description": "Skill profile configuration data",
"required": true,
"schema": {
"$ref": "#/components/schemas/SkillProfileDTO"
},
"example": {
"name": "German Speaker",
"description": "Required for transferring out-dial calls to Queues",
"activeSkills": [
{
"skillId": "123e4567-e89b-12d3-a456-426614174000",
"proficiencyValue": 5,
"booleanValue": true
}
]
}
}
],
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SkillProfileDTO"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/skill-profile/bulk": {
"post": {
"tags": [
"Skill Profile"
],
"summary": "Bulk save Skill Profile(s)",
"description": "Create, Update or delete Skill Profile(s) in bulk in a given organization.",
"operationId": "saveAllConfig_3",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkRequestDTOSkillProfileDTO"
}
}
},
"required": true
},
"responses": {
"207": {
"description": "Multi-Status",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BulkResponseDTO"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/skill-profile/{id}": {
"get": {
"tags": [
"Skill Profile"
],
"summary": "Get specific Skill Profile by ID",
"description": "Retrieve an existing Skill Profile by ID in a given organization.",
"operationId": "getConfig_4",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Skill Profile.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
},
{
"name": "includeSkillDetails",
"in": "query",
"description": "If set to true returns skill details",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SkillProfileDTO"
}
}
}
},
"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": [
"Skill Profile"
],
"summary": "Update specific Skill Profile by ID",
"description": "Update an existing Skill Profile by ID in a given organization.",
"operationId": "updateConfig_4",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Skill Profile.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
},
{
"name": "skillProfileDTO",
"in": "query",
"description": "Skill profile configuration data for update",
"required": true,
"schema": {
"$ref": "#/components/schemas/SkillProfileDTO"
},
"example": {
"name": "German Speaker Updated",
"description": "Updated skill profile for transferring calls",
"activeSkills": [
{
"skillId": "123e4567-e89b-12d3-a456-426614174000",
"proficiencyValue": 8,
"booleanValue": true
}
]
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/SkillProfileDTO"
}
}
}
},
"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": [
"Skill Profile"
],
"summary": "Delete specific Skill Profile by ID",
"description": "Delete an existing Skill Profile by ID in a given organization.",
"operationId": "deleteConfig_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 Skill Profile.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"412": {
"description": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "412",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "412",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/skill-profile/{id}/incoming-references": {
"get": {
"tags": [
"Skill Profile"
],
"summary": "List references for a specific Skill Profile",
"description": "Retrieve a list of all entities that have reference to an existing Skill Profile by ID in a given organization.",
"operationId": "getIncomingReferences_3",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/v2/skill-profile": {
"get": {
"tags": [
"Skill Profile"
],
"summary": "List Skill Profile(s)",
"description": "Retrieve a list of Skill Profile(s) in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigWithMetaData_5",
"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, activeSkills, activeEnumSkills, 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. except (activeSkills,activeEnumSkills)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specifiy whether to include array fields in the response, This query param should use only if the response contain single record, if we are using for multiple objects response query param not supported and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeSkillProfileDTO"
},
"example": {
"data": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"name": "German Speaker",
"description": "Required for transferring out-dial calls to Queues",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1
}
],
"meta": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/team": {
"get": {
"tags": [
"Team"
],
"summary": "List Teams",
"description": "Retrieve a list of Teams in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigTeam",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "filter",
"in": "query",
"description": "Specify a filter based on which the results will be fetched. Supported filterable fields: id. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n",
"required": false,
"schema": {
"type": "string"
},
"example": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\""
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamResponseDTO"
}
},
"example": [
{
"active": true,
"description": "string",
"version": 1,
"skillProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"capacity": 1,
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"dialedNumber": "+14085550123",
"systemDefault": false,
"rankQueuesForTeam": true,
"multiMediaProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"name": "inline-pcs-team",
"siteId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"teamType": "AGENT",
"teamStatus": "IN_SERVICE",
"desktopLayoutId": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
}
]
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
},
"post": {
"tags": [
"Team"
],
"summary": "Create a new Team",
"description": "Create a new Team in a given organization.",
"operationId": "createConfigTeam",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "teamDTO",
"in": "query",
"required": true,
"schema": {
"$ref": "#/components/schemas/TeamDTO"
}
}
],
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/TeamResponseDTO"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/team/bulk": {
"post": {
"tags": [
"Team"
],
"summary": "Bulk save Teams",
"description": "Create, Update or delete Teams in bulk in a given organization.",
"operationId": "saveAllConfigTeam",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkRequestDTOTeamDTO"
}
}
},
"required": true
},
"responses": {
"207": {
"description": "Multi-Status",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BulkResponseDTO"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/team/purge-inactive-entities": {
"post": {
"tags": [
"Team"
],
"summary": "Purge inactive Teams",
"description": "Purge inactive Teams older than the configured interval for a given organization.",
"operationId": "purgeInactiveConfigTeam",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "nextStartId",
"in": "query",
"description": "This is the entity ID from which items for the next purge batch will be selected.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "409",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "409",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/team/{id}": {
"get": {
"tags": [
"Team"
],
"summary": "Get specific Team by ID",
"description": "Retrieve an existing Team by ID in a given organization.",
"operationId": "getConfigTeam",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Team",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/TeamResponseDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
},
"put": {
"tags": [
"Team"
],
"summary": "Update specific Team by ID",
"description": "Update an existing Team by ID in a given organization.",
"operationId": "updateConfigTeam",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Team.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
},
{
"name": "teamDTO",
"in": "query",
"required": true,
"schema": {
"$ref": "#/components/schemas/TeamDTO"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/TeamResponseDTO"
}
}
}
},
"400": {
"description": "The request was invalid and cannot be served. An accompanying error message will explain further",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "400",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "400",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"412": {
"description": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "412",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "412",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
},
"delete": {
"tags": [
"Team"
],
"summary": "Delete specific Team by ID",
"description": "Delete an existing Team by ID in a given organization.",
"operationId": "deleteConfigTeam",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "Resource ID of the Team.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"412": {
"description": "Resource referred in other entity(s). Please get all the reference entities info by invoking Get incoming-references api.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "412",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "412",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/team/{id}/incoming-references": {
"get": {
"tags": [
"Team"
],
"summary": "List references for a specific Team",
"description": "Retrieve a list of all entities that have reference to an existing Team by ID in a given organization.",
"operationId": "getIncomingReferencesTeam",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/v2/team": {
"get": {
"tags": [
"Team"
],
"summary": "List Teams",
"description": "Retrieve a list of Teams in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigWithMetaDataTeam",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "filter",
"in": "query",
"description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse the userId field to filter teams associated with the provided user.\n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n",
"required": false,
"schema": {
"type": "string"
},
"example": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\""
},
{
"name": "attributes",
"in": "query",
"description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported. except (userIds, queueRankings)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "supervisorView",
"in": "query",
"description": "If set to true, the API will only return data that the user has access to, according to the User Profile.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
},
{
"name": "provisioningView",
"in": "query",
"description": "If set to true, the API will only return data that the user has access to, according to the User Profile.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeTeamResponseDTO"
},
"example": {
"data": [
{
"active": true,
"description": "string",
"version": 1,
"skillProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"capacity": 1,
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"dialedNumber": "+14085550123",
"systemDefault": false,
"rankQueuesForTeam": true,
"multiMediaProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"name": "inline-pcs-team",
"siteId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"teamType": "AGENT",
"teamStatus": "IN_SERVICE",
"desktopLayoutId": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
}
],
"meta": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/user-profile/{id}/incoming-references": {
"get": {
"tags": [
"User Profiles"
],
"summary": "List references for a specific User Profile",
"description": "Retrieve a list of all entities that have reference to an existing user profile by ID in a given organization.",
"operationId": "getIncomingReferencesUserProfile",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/v3/user-profile": {
"get": {
"tags": [
"User Profiles"
],
"summary": "List user profiles",
"description": "Retrieve a list of user profiles in a given organization.\n Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigWithPagedMetaDataUserProfileGranularAccess",
"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, userProfileAppModules, entryPoints, sites, queues, teams, editableFolderIds, viewableFolderIds, nonViewableFolderIds, 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. except (entryPoints,sites, queues, teams, userProfileAppModules,editableFolderIds, viewableFolderIds, nonViewableFolderIds)",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name, profileType, description)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\",\"description\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"type": "object",
"example": {
"meta": {
"orgid": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"page": 1,
"pageSize": 100,
"totalPages": 1,
"totalRecords": 1000,
"links": {
"next": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user-profile?page=2&pageSize=10",
"last": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user-profile?page=3&pageSize=10",
"prev": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user-profile?page=0&pageSize=10",
"self": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user-profile?page=1&pageSize=10",
"first": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user-profile?page=0&pageSize=10"
}
},
"data": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"name": "Contact Center Admin Profile",
"description": "This profile should be applied only to contact center admins.",
"profileType": "PREMIUM_AGENT",
"active": true,
"permissionAccessLevel": "ALL",
"resourceAccessLevel": "ALL",
"permissions": [
{
"id": "00734874-4732-43bb-bfff-d1e75d309eb1",
"name": "sites",
"access": "NONE"
}
],
"editableFolderIds": [
1,
2
],
"viewableFolderIds": [
1,
2
],
"nonViewableFolderIds": [
1,
2
],
"systemDefault": false,
"defaultResourceCollectionId": "80f49a6e-11d7-4651-b730-99ed2f726f61",
"resourceCollections": [
{
"id": "80f49a6e-11d7-4651-b730-99ed2f726f61",
"name": "Department1",
"description": "Department1 description.",
"resources": [
{
"name": "team",
"accessLevel": "SPECIFIC",
"ids": [
"00734874-4732-43bb-bfff-d1e75d309eb1",
"00734874-4732-43bb-bfff-d1e75d309eb2"
]
},
{
"name": "desktop-profile",
"accessLevel": "ALL"
},
{
"name": "desktop-layout",
"accessLevel": "NONE"
}
],
"resourceCount": 2
}
],
"createdTime": 0,
"lastUpdatedTime": 0
}
]
},
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataWithPagingInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserProfileGranularAccessDTO"
}
}
}
},
"example": [
{
"accessAllQueues": "ALL",
"description": "This profile should be applied only to contact center admins.",
"active": true,
"version": 1,
"accessAllModules": "ALL",
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"systemDefault": false,
"profileType": "PREMIUM_AGENT",
"accessAllSites": "ALL",
"name": "Contact Center Admin Profile",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"accessAllEntryPoints": "ALL",
"accessAllTeams": "ALL"
}
]
}
}
},
"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": [
"User Profiles"
],
"summary": "Create a new User Profile",
"description": "Create a new user profile in a given organization.",
"operationId": "createConfigUserProfileGranularAccess",
"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/UserProfileGranularAccessDTO"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/UserProfileGranularAccessDTO"
}
}
}
},
"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}/v3/user-profile/bulk": {
"post": {
"tags": [
"User Profiles"
],
"summary": "Bulk save User Profiles",
"description": "Create, Update or delete user profiles in bulk in a given organization.",
"operationId": "saveAllConfigUserProfileGranularAccess",
"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/BulkRequestDTOUserProfileGranularAccessDTO"
}
}
},
"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}/v3/user-profile/{id}": {
"get": {
"tags": [
"User Profiles"
],
"summary": "Get specific User Profile by ID",
"description": "Retrieve an existing user profile by ID in a given organization.",
"operationId": "getConfigUserProfileGranularAccess",
"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 User Profile.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
},
{
"name": "includeNames",
"in": "query",
"description": "Flag to include resource names in the response.",
"required": false,
"schema": {
"type": "boolean"
},
"example": true
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/UserProfileGranularAccessDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"put": {
"tags": [
"User Profiles"
],
"summary": "Update specific User Profile by ID",
"description": "Update an existing user profile by ID in a given organization.",
"operationId": "updateConfigUserProfileGranularAccess",
"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 User Profile.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserProfileGranularAccessDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/UserProfileGranularAccessDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"delete": {
"tags": [
"User Profiles"
],
"summary": "Delete specific User Profile by ID",
"description": "Delete an existing user profile by ID in a given organization.",
"operationId": "deleteConfigUserProfileGranularAccess",
"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 User Profile.",
"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}/v3/user-profile/{id}/acl": {
"get": {
"tags": [
"User Profiles"
],
"summary": "Get specific User Profile ACL by ID",
"description": "Retrieve an existing User Profile ACL by ID in a given organization.",
"operationId": "getACLByUserProfileUserProfileGranularAccess",
"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 User Profile.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
},
{
"name": "names",
"in": "query",
"description": " Default all resources are returned in the ACL.\n If you want to filter the ACL by specific resources,\n provide a comma-separated list of resource names to filter the ACL. Ex: /url?names=site,team\n",
"required": false,
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"site",
"team"
]
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/AccessControlListDTO"
}
}
}
},
"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}/user": {
"get": {
"tags": [
"Users"
],
"summary": "List Users",
"description": "Retrieve a list of Users in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead. Deprecated. Use GET /v2/user instead.",
"operationId": "getAllConfigUser",
"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,firstName,lastName,email"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
},
"example": false
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponseDTO"
}
},
"example": [
{
"imiUserCreated": false,
"lastName": "Wick",
"userLevelSummariesInclusion": "INCLUDED",
"supervisorCapabilitiesEnabled": false,
"timezone": "America/New_York",
"preferredSupervisorTeamId": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"broadCloudUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"externalIdentifier": "121212",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"contactCenterEnabled": true,
"email": "johnwick@company.com",
"ciUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"xspVersion": "xsp-24.0",
"userLevelAutoCSATInclusion": "INCLUDED",
"mobile": "1234567890",
"active": true,
"version": 1,
"skillProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"firstName": "John",
"userLevelWellnessBreakReminders": "DISABLED",
"agentProfileId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"siteId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"userLevelBurnoutInclusion": "INCLUDED",
"workPhone": "1234567890",
"userProfileId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"multimediaProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"agentCapabilitiesEnabled": false,
"deafultDialledNumber": "1234567890"
}
]
},
"application/hal+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponseDTO"
}
},
"example": [
{
"imiUserCreated": false,
"lastName": "Wick",
"userLevelSummariesInclusion": "INCLUDED",
"supervisorCapabilitiesEnabled": false,
"timezone": "America/New_York",
"preferredSupervisorTeamId": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"broadCloudUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"externalIdentifier": "121212",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"contactCenterEnabled": true,
"email": "johnwick@company.com",
"ciUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"xspVersion": "xsp-24.0",
"userLevelAutoCSATInclusion": "INCLUDED",
"mobile": "1234567890",
"active": true,
"version": 1,
"skillProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"firstName": "John",
"userLevelWellnessBreakReminders": "DISABLED",
"agentProfileId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"siteId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"userLevelBurnoutInclusion": "INCLUDED",
"workPhone": "1234567890",
"userProfileId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"multimediaProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"agentCapabilitiesEnabled": false,
"deafultDialledNumber": "1234567890"
}
]
}
}
},
"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}/user/bulk": {
"patch": {
"tags": [
"Users"
],
"summary": "Bulk partial update Users",
"description": "Update some or all properties for multiple users in bulk for a given organization.",
"operationId": "patchAllConfigUser",
"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": {
"description": "For each of the item to update,\nWe only need to provide the patch JSON.\nOnly the following properties are mandatory to identify a unique item for update. Other properties are optional.\nMandatory Properties: [id]\nAll properties that can be updated via the PUT API can also be updated here.\nTo nullify or remove a property, specify null as the value for the JSON property.\nValid value for requestAction property is 'SAVE'. It is optional property and default SAVE is assumed.\n",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkRequestDTOUserDTO"
},
"example": {
"items": [
{
"item": {
"id": "26e2df70-0f77-41b8-8e8f-1d76e92c9638",
"firstName": "John14",
"lastName": "Wick14",
"email": "john.wick14@company.com",
"ciUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"userProfileId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"contactCenterEnabled": true,
"userLevelBurnoutInclusion": "INCLUDED",
"active": true
},
"itemIdentifier": 0,
"requestAction": "SAVE"
}
]
}
}
},
"required": true
},
"responses": {
"207": {
"description": "Multi-Status",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/BulkResponseDTO"
}
},
"application/json": {
"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": []
}
]
}
}
}
}
},
"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}/user/bulk/update-dynamic-skill/{skillId}": {
"patch": {
"tags": [
"Users"
],
"summary": "Bulk partial update Users with dynamic skills",
"description": "Assign or unassign a dynamic skill to/from multiple users in bulk for a given organization.",
"operationId": "patchDynamicSkillsUser",
"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": "skillId",
"in": "path",
"description": "Dynamic skill ID used for bulk update",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkRequestDTOUpdateDynamicSkillsDTO"
}
}
},
"required": true
},
"responses": {
"207": {
"description": "Multi-Status",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/BulkResponseDTO"
}
},
"application/json": {
"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": []
}
]
}
}
}
}
},
"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}/user/by-call-monitoring-id/{id}": {
"get": {
"tags": [
"Users"
],
"summary": "List users by call monitoring id",
"description": "Fetch paginated users associated to the selected call monitoring team filters while enforcing team ACL.",
"operationId": "getUsersByCallMonitoringIdUser",
"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 call monitoring.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
},
{
"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": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataPagedUser"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDetailsResponseDTO"
}
}
}
}
},
"application/hal+json": {
"schema": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataPagedUser"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDetailsResponseDTO"
}
}
}
}
}
}
},
"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}/user/by-ci-user-id/{id}": {
"get": {
"tags": [
"Users"
],
"summary": "Get specific User by CI User ID",
"description": "Retrieve an existing User using the CI ID in a given organization. Deprecated. Use GET /v2/user/by-ci-user-id/{id} instead.",
"operationId": "getUserByCiUserIdUser",
"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": "CI ID of the User.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
},
{
"name": "includeUserProfile",
"in": "query",
"description": "Specifiy whether to include user profile data",
"required": false,
"schema": {
"type": "boolean"
},
"example": true
},
{
"name": "includeSkillDetails",
"in": "query",
"description": "If set to true, the response includes skill information for each dynamic skill assignment.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/UserResponseDTO_UserResponseWithUserProfile",
"example": {
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"firstName": "John",
"lastName": "Wick",
"email": "johnwick@company.com",
"workPhone": "1234567890",
"mobile": "1234567890",
"ciUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"broadCloudUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"timezone": "America/New_York",
"xspVersion": "xsp-24.0",
"subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"userProfileId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"userProfileType": "PREMIUM_AGENT",
"contactCenterEnabled": true,
"siteId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"siteName": "bengaluru",
"teamIds": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"skillProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"agentProfileId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"multimediaProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"deafultDialledNumber": "1234567890",
"externalIdentifier": "121212",
"active": true,
"dbId": "1dq45f23-1234-6r18-9a83-2atuiy0d4bh1",
"userProfileData": {
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"name": "Contact Center Admin Profile",
"description": "This profile should be applied only to contact center admins.",
"profileType": "PREMIUM_AGENT",
"accessAllModules": "ALL",
"userProfileAppModules": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"appModuleId": "m_provisioning",
"moduleAccessType": "EDIT",
"userProfileAppFeature": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"appFeatureId": "f_manage_sites",
"appFeatureName": "Manage Sites",
"featureAccessType": "ON",
"createdTime": 123456789,
"lastUpdatedTime": 123456789
}
],
"createdTime": 123456789,
"lastUpdatedTime": 123456789
}
],
"accessAllEntryPoints": "ALL",
"accessAllSites": "ALL",
"accessAllQueues": "ALL",
"accessAllTeams": "ALL",
"active": true,
"editableFolderIds": 1,
"viewableFolderIds": 1,
"nonViewableFolderIds": 1,
"systemDefault": false,
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"entryPoints": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"sites": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"queues": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"teams": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"imiUserCreated": true,
"preferredSupervisorTeamId": "e27d2b54-46ca-43g6-ba65-08426e46e23d",
"systemDefault": false,
"userLevelBurnoutInclusion": "INCLUDED",
"userLevelWellnessBreakReminders": "DISABLED",
"queuesCount": {
"teamBased": 0,
"skillBased": 0,
"agentBased": 0
},
"skillProfileUpdatedBy": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"dynamicSkills": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"skillId": "skill456",
"skillName": "CustomerService",
"textValue": "Credit card SME",
"booleanValue": true,
"proficiencyValue": 5,
"enumValue": "french",
"enumSkillValues": "FRENCH",
"createdTime": 123456789,
"lastUpdatedTime": 123456789
}
],
"dynamicSkillsLimitReached": true,
"dynamicSkillsUpdatedBy": "string",
"dynamicSkillsUpdatedTime": 1679394600000,
"dynamicSkillAssigned": true,
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"skillProfileUpdatedTime": 1679394600000
}
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseDTO_UserResponseWithUserProfile",
"example": {
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"firstName": "John",
"lastName": "Wick",
"email": "johnwick@company.com",
"workPhone": "1234567890",
"mobile": "1234567890",
"ciUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"broadCloudUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"timezone": "America/New_York",
"xspVersion": "xsp-24.0",
"subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"userProfileId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"userProfileType": "PREMIUM_AGENT",
"contactCenterEnabled": true,
"siteId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"siteName": "bengaluru",
"teamIds": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"skillProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"agentProfileId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"multimediaProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"deafultDialledNumber": "1234567890",
"externalIdentifier": "121212",
"active": true,
"dbId": "1dq45f23-1234-6r18-9a83-2atuiy0d4bh1",
"userProfileData": {
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"name": "Contact Center Admin Profile",
"description": "This profile should be applied only to contact center admins.",
"profileType": "PREMIUM_AGENT",
"accessAllModules": "ALL",
"userProfileAppModules": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"appModuleId": "m_provisioning",
"moduleAccessType": "EDIT",
"userProfileAppFeature": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"appFeatureId": "f_manage_sites",
"appFeatureName": "Manage Sites",
"featureAccessType": "ON",
"createdTime": 123456789,
"lastUpdatedTime": 123456789
}
],
"createdTime": 123456789,
"lastUpdatedTime": 123456789
}
],
"accessAllEntryPoints": "ALL",
"accessAllSites": "ALL",
"accessAllQueues": "ALL",
"accessAllTeams": "ALL",
"active": true,
"editableFolderIds": 1,
"viewableFolderIds": 1,
"nonViewableFolderIds": 1,
"systemDefault": false,
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"entryPoints": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"sites": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"queues": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"teams": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"imiUserCreated": true,
"preferredSupervisorTeamId": "e27d2b54-46ca-43g6-ba65-08426e46e23d",
"systemDefault": false,
"userLevelBurnoutInclusion": "INCLUDED",
"userLevelWellnessBreakReminders": "DISABLED",
"queuesCount": {
"teamBased": 0,
"skillBased": 0,
"agentBased": 0
},
"skillProfileUpdatedBy": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"dynamicSkills": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"skillId": "skill456",
"skillName": "CustomerService",
"textValue": "Credit card SME",
"booleanValue": true,
"proficiencyValue": 5,
"enumValue": "french",
"enumSkillValues": "FRENCH",
"createdTime": 123456789,
"lastUpdatedTime": 123456789
}
],
"dynamicSkillsLimitReached": true,
"dynamicSkillsUpdatedBy": "string",
"dynamicSkillsUpdatedTime": 1679394600000,
"dynamicSkillAssigned": true,
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"skillProfileUpdatedTime": 1679394600000
}
}
}
}
},
"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}/user/by-dynamic-skill-id/{skillId}": {
"get": {
"tags": [
"Users"
],
"summary": "Get users by dynamic skill ID",
"description": "Fetches all users assigned to a specific dynamic skill with search and pagination support. Returns user details with the specific dynamic skill value.",
"operationId": "getUsersByDynamicSkillIdUser",
"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": "skillId",
"in": "path",
"description": "The dynamic skill ID to fetch users for",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email, value)\n\nThe examples below show some search queries\n- \"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeUserDynamicSkillResponseDTO"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeUserDynamicSkillResponseDTO"
}
}
}
},
"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}/user/fetch-by-skill-requirements": {
"post": {
"tags": [
"Users"
],
"summary": "Get the agents matching skill requirements criteria",
"description": "This API can be used to fetch the agents who match the provided skill requirements criteria. Maximum of 50 skill requirements criteria can be passed in the request.",
"operationId": "getUsersBySkillRequirementsUser",
"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": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"skillRequirements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/QueueSkillRequirementDTO"
}
}
}
},
"example": {
"skillRequirements": [
{
"organizationId": "0271223b-91de-427d-872a-1b3c1bb746b9",
"id": "5e8cdad5-94da-4ffc-86d7-c904e4490626",
"skillId": "bc5658a9-5aa7-45ec-b960-43dcfc73c34d",
"skillName": "skillA",
"skillType": "TEXT",
"condition": "IS",
"skillValue": "abc"
},
{
"condition": "IS",
"skillValue": "8",
"skillName": "ProfSkillC",
"skillType": "PROFICIENCY",
"skillId": "c683cf8d-49e8-4e85-9e08-c8749affa9cc"
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataWithPagingInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserWithSkillDetailsDTO"
}
}
}
}
},
"application/json": {
"schema": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataWithPagingInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserWithSkillDetailsDTO"
}
}
}
}
}
}
},
"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}/user/fetch-user-details-by-ids": {
"post": {
"tags": [
"Users"
],
"summary": "List Users with details",
"description": "Retrieve an existing User's first name, last name and email by list of IDs in a given organization.",
"operationId": "getUserdataByIdsUser",
"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": "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": 10,
"example": 10
},
"example": 10
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDetailsRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDetailsResponseEnvelopeDTO"
}
},
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/UserDetailsResponseEnvelopeDTO"
}
}
}
},
"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}/user/with-user-profile": {
"get": {
"tags": [
"Users"
],
"summary": "List Users along with profile",
"description": "Retrieve a list of Users along with their User Profiles in a given organization.",
"operationId": "getAllUsersWithUserProfileUser",
"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"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponseDTO"
}
}
},
"application/hal+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponseDTO"
}
}
}
}
},
"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}/user/with-user-profile/{id}": {
"get": {
"tags": [
"Users"
],
"summary": "Get specific User along with profile by ID",
"description": "Retrieve an existing User along with the corresponding User Profile by ID in a given organization.",
"operationId": "getUserWithUserProfileUser",
"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 User.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/UserResponseDTO"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseDTO"
}
}
}
},
"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}/user/{id}": {
"get": {
"tags": [
"Users"
],
"summary": "Get specific User by ID",
"description": "Retrieve an existing Users by ID in a given organization.",
"operationId": "getConfigUser",
"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 User.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
},
{
"name": "includeCount",
"in": "query",
"description": "If set to true, the API response will include the count of each type of Contact Service Queue to which the user is assigned.",
"schema": {
"type": "boolean",
"default": false,
"example": false
},
"example": false
},
{
"name": "includeUserProfileType",
"in": "query",
"description": "If set to true, the API response includes the User Profile.",
"schema": {
"type": "boolean",
"default": false,
"example": false
},
"example": false
},
{
"name": "includeSkillProfileAudit",
"in": "query",
"description": "If set to true gives skill profile modification info.",
"schema": {
"type": "boolean",
"default": false,
"example": false
},
"example": false
},
{
"name": "includeReskillAuditInfo",
"in": "query",
"description": "If set to true gives skill profile and dynamic skill modification info.",
"schema": {
"type": "boolean",
"default": false,
"example": false
},
"example": false
},
{
"name": "includeSkillDetails",
"in": "query",
"description": "If set to true, the response includes skill information for each dynamic skill assignment.",
"schema": {
"type": "boolean",
"default": false,
"example": false
},
"example": false
},
{
"name": "checkIfUserHasDynamicSkill",
"in": "query",
"description": "If set to true, checks if user has the specified dynamic skill",
"schema": {
"type": "boolean",
"default": false,
"example": false
},
"example": false
},
{
"name": "dynamicSkillId",
"in": "query",
"description": "Dynamic skill ID to check if user has it assigned (required when checkIfUserHasDynamicSkill is true)",
"schema": {
"type": "string",
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/UserResponseDTO"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"put": {
"tags": [
"Users"
],
"summary": "Update specific User by ID",
"description": "Update an existing User by ID in a given organization.",
"operationId": "updateConfigUser",
"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 User.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"description": "User configuration data for update",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserDTO"
},
"example": {
"firstName": "John",
"lastName": "Wick",
"email": "johnwick@company.com",
"workPhone": "1234567890",
"mobile": "1234567890",
"ciUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"broadCloudUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"userProfileId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"contactCenterEnabled": true,
"timezone": "America/New_York",
"xspVersion": "xsp-24.0",
"subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"siteId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"teamIds": [
"f53c8b54-46ca-43f6-ba05-08426a46e23d"
],
"skillProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"agentProfileId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"multimediaProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"deafultDialledNumber": "1234567890",
"externalIdentifier": "121212",
"active": true,
"preferredSupervisorTeamId": "e27d2b54-46ca-43g6-ba65-08426e46e23d",
"userLevelBurnoutInclusion": "INCLUDED",
"userLevelAutoCSATInclusion": "INCLUDED",
"userLevelWellnessBreakReminders": "DISABLED",
"userLevelSummariesInclusion": "INCLUDED",
"supervisorCapabilitiesEnabled": false,
"agentCapabilitiesEnabled": true,
"dynamicSkills": [
{
"skillId": "af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"proficiencyValue": 7
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/UserResponseDTO"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
},
"patch": {
"tags": [
"Users"
],
"summary": "Partially update User by ID",
"description": "Partially update User by ID in a given organization.",
"operationId": "patchConfigUser",
"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 User.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonValue"
}
},
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/JsonValue"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/UserResponseDTO"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResponseDTO"
}
}
}
},
"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": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/user/{id}/incoming-references": {
"get": {
"tags": [
"Users"
],
"summary": "List references for a specific User",
"description": "Retrieve a list of all entities that have reference to an existing User by ID in a given organization.",
"operationId": "getIncomingReferencesUser",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "type_text"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
},
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/user/{id}/reskill": {
"patch": {
"tags": [
"Users"
],
"summary": "Reskill Agents",
"description": "Reskill agents by assigning or unassigning skills.",
"operationId": "reSkillAgentUser",
"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 User.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReSkillAgentRequestDTO"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content"
},
"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": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/v2/user": {
"get": {
"tags": [
"Users"
],
"summary": "List Users",
"description": "Retrieve a list of Users in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.",
"operationId": "getAllConfigWithPagedMetaDataUser",
"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, xspVersion, createdTime, lastUpdatedTime \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n",
"required": false,
"schema": {
"type": "string"
},
"example": "id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\""
},
{
"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": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(firstName, lastName, email)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"firstName\";value==\"Cisco\"\n- fields=in=(\"firstName\",\"lastName\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"default": 0,
"example": 0
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Defines the number of items to be displayed on a page. If the number specified is more than allowed max page size, the API will automatically adjust the page size to the max page size.",
"schema": {
"type": "integer",
"default": 100,
"example": 100
},
"example": 100
},
{
"name": "supervisorManagedAgentsOnly",
"in": "query",
"description": "If set to true, the API will return contact center enabled users based on the invoking supervisor user's user profile access rights to sites and teams.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
},
{
"name": "singleObjectResponse",
"in": "query",
"description": "Specify whether to include array fields in the response. This query parameter should be used only when the response contains a single record. It is not supported for responses with multiple objects and throws an exception.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
},
{
"name": "buddyTeamAgentsOnly",
"in": "query",
"description": "If set to true, returns only users who are part of buddy teams without PBAC check.",
"schema": {
"type": "boolean",
"default": false,
"example": false
}
},
{
"name": "userInQueue",
"in": "query",
"description": "Can be either assigned or unassigned. If passed, returns the users who are assigned or not assigned to an agent based queue managed by the supervisor.",
"schema": {
"type": "string",
"example": "assigned"
}
},
{
"name": "queueId",
"in": "query",
"description": "Contact Service Queue ID for which the list of assigned or unassigned agents must be fetched.",
"schema": {
"type": "string",
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
},
{
"name": "includeAIMappingCount",
"in": "query",
"description": "If set to true, the API response will include the count of each AI feature mapped to the entity.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"name": "includeDynamicSkillsLimitReached",
"in": "query",
"description": "If true, includes whether each user has reached the dynamic skills assignment limit.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataPagedUser"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponseDTO"
}
}
}
},
"example": {
"data": [
{
"imiUserCreated": false,
"lastName": "Wick",
"userLevelSummariesInclusion": "INCLUDED",
"supervisorCapabilitiesEnabled": false,
"timezone": "America/New_York",
"preferredSupervisorTeamId": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"broadCloudUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"externalIdentifier": "121212",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"contactCenterEnabled": true,
"email": "johnwick@company.com",
"ciUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"xspVersion": "xsp-24.0",
"userLevelAutoCSATInclusion": "INCLUDED",
"mobile": "1234567890",
"active": true,
"version": 1,
"skillProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"firstName": "John",
"userLevelWellnessBreakReminders": "DISABLED",
"agentProfileId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"siteId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"userLevelBurnoutInclusion": "INCLUDED",
"workPhone": "1234567890",
"userProfileId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"multimediaProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"agentCapabilitiesEnabled": false,
"deafultDialledNumber": "1234567890"
}
],
"meta": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
},
"application/hal+json": {
"schema": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataPagedUser"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResponseDTO"
}
}
}
},
"example": {
"data": [
{
"imiUserCreated": false,
"lastName": "Wick",
"userLevelSummariesInclusion": "INCLUDED",
"supervisorCapabilitiesEnabled": false,
"timezone": "America/New_York",
"preferredSupervisorTeamId": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"broadCloudUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"externalIdentifier": "121212",
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"id": "93912f11-6017-404b-bf14-5331890b1797",
"contactCenterEnabled": true,
"email": "johnwick@company.com",
"ciUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"xspVersion": "xsp-24.0",
"userLevelAutoCSATInclusion": "INCLUDED",
"mobile": "1234567890",
"active": true,
"version": 1,
"skillProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"firstName": "John",
"userLevelWellnessBreakReminders": "DISABLED",
"agentProfileId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"siteId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"userLevelBurnoutInclusion": "INCLUDED",
"workPhone": "1234567890",
"userProfileId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"multimediaProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"agentCapabilitiesEnabled": false,
"deafultDialledNumber": "1234567890"
}
],
"meta": {
"additionalProp3": "string",
"additionalProp2": "string",
"additionalProp1": "string"
}
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "401",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "401",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "403",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "403",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "404",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "404",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "429",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "429",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"trackingId": "ccconfig_af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"error": {
"key": "500",
"reason": "Test reason",
"message": [
{
"description": "Test error",
"code": "500",
"entity": "cc_user",
"references": []
}
]
}
}
}
}
}
}
}
},
"/organization/{orgid}/v2/user/by-ci-user-id/{id}": {
"get": {
"tags": [
"Users"
],
"summary": "Get specific User by CI User ID",
"description": "Retrieve an existing User using the CI ID in a given organization.",
"operationId": "getUserByCiUserIdWithUserProfileGranularAccessUser",
"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": "CI ID of the User.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2"
},
{
"name": "includeUserProfile",
"in": "query",
"description": "Specifiy whether to include user profile data",
"required": false,
"schema": {
"type": "boolean"
},
"example": true
},
{
"name": "includeNames",
"in": "query",
"description": "Specifiy whether to include resource collection names",
"required": false,
"schema": {
"type": "boolean"
},
"example": true
},
{
"name": "includeSkillDetails",
"in": "query",
"description": "If set to true, the response includes skill information for each dynamic skill assignment.",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"type": "string",
"example": {
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"firstName": "John",
"lastName": "Wick",
"email": "johnwick@company.com",
"workPhone": "1234567890",
"mobile": "1234567890",
"ciUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"broadCloudUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"timezone": "America/New_York",
"xspVersion": "xsp-24.0",
"subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"userProfileId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"userProfileType": "PREMIUM_AGENT",
"contactCenterEnabled": true,
"siteId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"siteName": "bengaluru",
"teamIds": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"skillProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"agentProfileId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"multimediaProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"deafultDialledNumber": "1234567890",
"externalIdentifier": "121212",
"active": true,
"dbId": "1dq45f23-1234-6r18-9a83-2atuiy0d4bh1",
"userProfileGranularAccessData": {
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"name": "Contact Center Admin Profile",
"description": "This profile should be applied only to contact center admins.",
"profileType": "PREMIUM_AGENT",
"active": true,
"permissionAccessLevel": "ALL",
"resourceAccessLevel": "ALL",
"permissions": [
{
"id": "00734874-4732-43bb-bfff-d1e75d309eb1",
"name": "sites",
"access": "NONE"
}
],
"editableFolderIds": [
1,
2
],
"viewableFolderIds": [
1,
2
],
"nonViewableFolderIds": [
1,
2
],
"systemDefault": false,
"defaultResourceCollectionId": "80f49a6e-11d7-4651-b730-99ed2f726f61",
"resourceCollections": [
{
"id": "80f49a6e-11d7-4651-b730-99ed2f726f61",
"name": "Department1",
"description": "Department1 description.",
"resources": [
{
"name": "team",
"accessLevel": "SPECIFIC",
"ids": [
"00734874-4732-43bb-bfff-d1e75d309eb1",
"00734874-4732-43bb-bfff-d1e75d309eb2"
]
},
{
"name": "desktop-profile",
"accessLevel": "ALL"
},
{
"name": "desktop-layout",
"accessLevel": "NONE"
}
],
"resourceCount": 2
}
],
"createdTime": 0,
"lastUpdatedTime": 0
},
"imiUserCreated": true,
"preferredSupervisorTeamId": "e27d2b54-46ca-43g6-ba65-08426e46e23d",
"systemDefault": false,
"userLevelBurnoutInclusion": "INCLUDED",
"userLevelWellnessBreakReminders": "DISABLED",
"queuesCount": {
"teamBased": 0,
"skillBased": 0,
"agentBased": 0
},
"skillProfileUpdatedBy": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"dynamicSkills": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"skillId": "skill456",
"skillName": "CustomerService",
"textValue": "Credit card SME",
"booleanValue": true,
"proficiencyValue": 5,
"enumValue": "french",
"enumSkillValues": "FRENCH",
"createdTime": 123456789,
"lastUpdatedTime": 123456789
}
],
"dynamicSkillsLimitReached": true,
"dynamicSkillsUpdatedBy": "string",
"dynamicSkillsUpdatedTime": 1679394600000,
"dynamicSkillAssigned": true,
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"skillProfileUpdatedTime": 1679394600000
}
}
},
"application/json": {
"schema": {
"type": "string",
"example": {
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"firstName": "John",
"lastName": "Wick",
"email": "johnwick@company.com",
"workPhone": "1234567890",
"mobile": "1234567890",
"ciUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"broadCloudUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"timezone": "America/New_York",
"xspVersion": "xsp-24.0",
"subscriptionId": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"userProfileId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"userProfileType": "PREMIUM_AGENT",
"contactCenterEnabled": true,
"siteId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"siteName": "bengaluru",
"teamIds": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"skillProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"agentProfileId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"multimediaProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"deafultDialledNumber": "1234567890",
"externalIdentifier": "121212",
"active": true,
"dbId": "1dq45f23-1234-6r18-9a83-2atuiy0d4bh1",
"userProfileGranularAccessData": {
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"name": "Contact Center Admin Profile",
"description": "This profile should be applied only to contact center admins.",
"profileType": "PREMIUM_AGENT",
"active": true,
"permissionAccessLevel": "ALL",
"resourceAccessLevel": "ALL",
"permissions": [
{
"id": "00734874-4732-43bb-bfff-d1e75d309eb1",
"name": "sites",
"access": "NONE"
}
],
"editableFolderIds": [
1,
2
],
"viewableFolderIds": [
1,
2
],
"nonViewableFolderIds": [
1,
2
],
"systemDefault": false,
"defaultResourceCollectionId": "80f49a6e-11d7-4651-b730-99ed2f726f61",
"resourceCollections": [
{
"id": "80f49a6e-11d7-4651-b730-99ed2f726f61",
"name": "Department1",
"description": "Department1 description.",
"resources": [
{
"name": "team",
"accessLevel": "SPECIFIC",
"ids": [
"00734874-4732-43bb-bfff-d1e75d309eb1",
"00734874-4732-43bb-bfff-d1e75d309eb2"
]
},
{
"name": "desktop-profile",
"accessLevel": "ALL"
},
{
"name": "desktop-layout",
"accessLevel": "NONE"
}
],
"resourceCount": 2
}
],
"createdTime": 0,
"lastUpdatedTime": 0
},
"imiUserCreated": true,
"preferredSupervisorTeamId": "e27d2b54-46ca-43g6-ba65-08426e46e23d",
"systemDefault": false,
"userLevelBurnoutInclusion": "INCLUDED",
"userLevelWellnessBreakReminders": "DISABLED",
"queuesCount": {
"teamBased": 0,
"skillBased": 0,
"agentBased": 0
},
"skillProfileUpdatedBy": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"dynamicSkills": [
{
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"skillId": "skill456",
"skillName": "CustomerService",
"textValue": "Credit card SME",
"booleanValue": true,
"proficiencyValue": 5,
"enumValue": "french",
"enumSkillValues": "FRENCH",
"createdTime": 123456789,
"lastUpdatedTime": 123456789
}
],
"dynamicSkillsLimitReached": true,
"dynamicSkillsUpdatedBy": "string",
"dynamicSkillsUpdatedTime": 1679394600000,
"dynamicSkillAssigned": true,
"createdTime": 123456789,
"lastUpdatedTime": 123456789,
"skillProfileUpdatedTime": 1679394600000
}
}
}
}
},
"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}/work-type": {
"post": {
"tags": [
"Work Types"
],
"summary": "Create a new Work Type",
"description": "Create a new Work Type in a given organization.",
"operationId": "createConfig",
"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/WorkTypeDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkTypeDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/work-type/bulk": {
"post": {
"tags": [
"Work Types"
],
"summary": "Bulk save Work Type(s)",
"description": "Create, Update or delete Work Type(s) in bulk in a given organization.",
"operationId": "saveAllConfig",
"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/BulkRequestDTOWorkTypeDTO"
}
}
},
"required": true
},
"responses": {
"207": {
"description": "Multi-Status",
"content": {
"application/json": {
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/work-type/bulk-export": {
"get": {
"tags": [
"Work Types"
],
"summary": "Bulk export Work Type(s)",
"description": "Export all Work Type(s) in a given organization.",
"operationId": "bulkExport",
"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": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 50
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkExportDTOWorkTypeBulkExportDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": true
}
},
"/organization/{orgid}/work-type/purge-inactive-entities": {
"post": {
"tags": [
"Work Types"
],
"summary": "Purge inactive Work Type(s)",
"description": "Purge inactive Work Type(s) older than the configured interval for a given organization.",
"operationId": "purgeInactiveConfig",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "nextStartId",
"in": "query",
"description": "This is the entity ID from which items for the next purge batch with be selected.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Similar entity is already present",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/work-type/{id}": {
"get": {
"tags": [
"Work Types"
],
"summary": "Get specific Work Type by ID",
"description": "Retrieve an existing Work Type by ID in a given organization.",
"operationId": "getConfig",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of the work_type.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/WorkTypeDTO"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkTypeDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"put": {
"tags": [
"Work Types"
],
"summary": "Update specific Work Type by ID",
"description": "Update an existing Work Type by ID in a given organization.",
"operationId": "updateConfig",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of the work_type.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkTypeDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkTypeDTO"
}
}
}
},
"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"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
},
"delete": {
"tags": [
"Work Types"
],
"summary": "Delete specific Work Type by ID",
"description": "Delete an existing Work Type by ID in a given organization.",
"operationId": "deleteConfig",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of the work_type.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549"
}
],
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/work-type/{id}/incoming-references": {
"get": {
"tags": [
"Work Types"
],
"summary": "List references for a specific Work Type",
"description": "Retrieve a list of all entities that have reference to an existing Work Type by ID in a given organization.",
"operationId": "getIncomingReferences",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "id",
"in": "path",
"description": "ID of this contact center resource.",
"required": true,
"schema": {
"type": "string"
},
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
{
"name": "type",
"in": "query",
"description": "Entity type of the other entity that has a reference to this specific entity.",
"required": false,
"schema": {
"type": "string"
},
"example": "reference-entity"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EntityReferenceInfoDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/organization/{orgid}/v2/work-type": {
"get": {
"tags": [
"Work Types"
],
"summary": "List Work Type(s)",
"description": "Retrieve a list of Work Type(s) in a given organization.",
"operationId": "getAllConfigWithMetaData_3",
"parameters": [
{
"name": "orgid",
"in": "path",
"description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization.",
"required": true,
"schema": {
"type": "string"
},
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
{
"name": "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 space, and if so kindly bound it with quotes to apply 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.Default all attributes are returned along with specified columns. All Attributes are supported",
"required": false,
"schema": {
"type": "string",
"format": "string"
},
"example": "id"
},
{
"name": "search",
"in": "query",
"description": "Filter data based on the search keyword.Supported search columns(name)\n\nThe examples below show some search queries\n- \"Cisco\"\n- field==\"name\";value==\"Cisco\"\n- fields=in=(\"name\");value==\"Cisco\"\n",
"required": false,
"schema": {
"type": "string"
},
"example": "contact center"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"example": 0,
"default": 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",
"example": 100,
"default": 100
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseEnvelopeWorkTypeDTO"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Operation is forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Resource not found or URI is invalid",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"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"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
}
},
"deprecated": false
}
},
"/dataSources": {
"post": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"audience": "MedDocVirtualAgent",
"errorMessage": "down for maintenance",
"id": "f29bb291-5db0-411b-834a-e64f8dee0658",
"nonce": "jeieu38udue83u398",
"schemaId": "78efc775-dccb-45ca-9acf-989a4a59f788",
"status": "active",
"subject": "callAudioData",
"tokenLifetimeMinutes": 60,
"url": "https://www.byods.com/service1"
}
}
},
"schema": {
"properties": {
"audience": {
"description": "The audience field in the JWT token. Usually, the DAPs app name.",
"type": "string"
},
"errorMessage": {
"description": "Error Message shown in Control Hub when status is set to `disabled`.",
"type": "string"
},
"id": {
"description": "The Data Source Id.",
"type": "string"
},
"nonce": {
"description": "Unique nonce used in the encryption of the JWT token.",
"type": "string"
},
"schemaId": {
"description": "The schema id used for the data exchange.",
"type": "string"
},
"status": {
"description": "The status of the Data Source; `active` or `disabled`",
"type": "string"
},
"subject": {
"description": "Rhe subject field in the JWT token. Usually, an indication of the app's function",
"type": "string"
},
"tokenLifetimeMinutes": {
"description": "The validity of the created token in minutes. Before the token expiration time, a new token must be provided, or Webex will stop delivering data after the token expiration",
"type": "number"
},
"url": {
"description": "The URL of the endpoint where Webex will send the data.",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "OK",
"headers": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"tags": [
"Data Sources"
],
"description": "Register your data source to the Webex BYODS system. Authentication must happen via a Service App with the scope `spark-admin:datasource_write`.\nThe schema IDs determine what data types are sent from Webex to the DAP and the expected responses. The schemas can be inspected on developer.webex.com.",
"operationId": "Register a Data Source",
"requestBody": {
"content": {
"application/json": {
"schema": {
"example": {
"audience": "MedDocVirtualAgent",
"nonce": "jeieu38udue83u398",
"schemaId": "78efc775-dccb-45ca-9acf-989a4a59f788",
"subject": "callAudioData",
"tokenLifetimeMinutes": 60,
"url": "https://www.byods.com/service1"
},
"properties": {
"audience": {
"description": "The audience field in the JWT token. Usually, the DAPs app name.",
"type": "string"
},
"nonce": {
"description": "Unique nonce used in the encryption of the JWT token.",
"type": "string"
},
"schemaId": {
"description": "The schema id used for the data exchange.",
"type": "string"
},
"subject": {
"description": "Rhe subject field in the JWT token. Usually, an indication of the app's function",
"type": "string"
},
"tokenLifetimeMinutes": {
"description": "The validity of the created token in minutes. Before the token expiration time, a new token must be provided, or Webex will stop delivering data after the token expiration. Must be equal or less to 1440.",
"type": "number"
},
"url": {
"description": "The URL of the endpoint where Webex will send the data.",
"type": "string"
}
},
"type": "object"
}
}
}
},
"summary": "Register a Data Source"
}
},
"/dataSources/": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"DataSource": "",
"applicationId": "Cf2e954e018f2de8c1403e2618323551df65",
"createdAt": "2022-01-01T00:00:00Z",
"createdBy": "3e4d3b27-1bf1-4916-8d0c-d27fd765fa52",
"jwsToken": "eyJraWQiOiIxOWFmMzYxYS0zYWI0LTU0NzEtYTViMC03MmQxODQyOTRjMmYiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJNeUFwcDIiLCJzdWIiOiJNeUFwcHNQdXJwb3NlMiIsImlzcyI6Imh0dHBzOlwvXC9pZGJyb2tlci53ZWJleC5jb21cL2lkYiIsImV4cCI6MTcyOTIyMDUxNSwiY29tLmNpc2NvLmRhdGFzb3VyY2UudXJsIjoiaHR0cHM6XC9cL3NjaGlmZmVydC5tZVwvZHMyIiwiY29tLmNpc2NvLmRhdGFzb3VyY2Uuc2NoZW1hLnV1aWQiOiI3OGVmYzc3NS1kY2NiLTQ1Y2EtOWFjZi05ODlhNGE1OWY3ODgiLCJpYXQiOjE3MjkyMTMzMTUsImNvbS5jaXNjby5vcmcudXVpZCI6ImNlODYxZmJhLTZlMmYtNDlmOS05YTg0LWIzNTQwMDhmYWM5ZSIsImp0aSI6IjEyMzQ1NiJ9.QxWYQCXOTLTNBx1Mr8qtd1rpx5uqHYcow1l_oiqMQ_2LorPor3wnEW9_dmMFUs-yAizpayTB4XJpU0ga9E-GY3XaiXz4CGW0G5f3566j3AvmfviMVCFgQFnMd0LpwgPIHhQGX-z2Y6KgzjTCLqm76WpSylAomOPEpgs8dqChfuC9aVHyuB2FfV77J265q-pLp8RSJa_EoSZ_05tpQHxxrDrB-qnn-WQoCFFlb88f3kKdyzPqQhvdWQuouyaP4YyMd_C8a6N_F1dk3cBUjSOtnHDm9WoGwYd8wUcjtZVk5g-z7coc656OooRvDQ0-JRdh7TVUfkzdQS79d4UfmRAhYQ",
"orgId": "63b02f90-9cc6-43b8-aa6d-cad425ac554c"
}
]
}
}
},
"schema": {
"properties": {
"items": {
"items": {},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "OK",
"headers": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"tags": [
"Data Sources"
],
"description": "Show all data sources registered for this Service App with the scope `spark-admin:datasource_read`.",
"operationId": "Retrieve All Data Sources",
"summary": "Retrieve All Data Sources"
}
},
"/dataSources/schemas": {
"get": {
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"appType": "serviceApp",
"createdAt": "2024-09-05T01:35:04.772Z",
"id": "78efc775-dccb-45ca-9acf-989a4a59f788",
"protocol": "gRPC",
"serviceType": "webService",
"url": "/path/to/definition/file3"
}
]
}
}
},
"schema": {
"properties": {
"items": {
"items": {},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "OK",
"headers": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"tags": [
"Data Sources"
],
"description": "Show available schemas. No specific scope is needed to retrieve the dataSource schemas, but a valid API token should be presented.",
"operationId": "Retrieve Data Source Schemas",
"summary": "Retrieve Data Source Schemas"
}
},
"/dataSources/schemas/{schemaId}": {
"get": {
"parameters": [
{
"description": "The unique identifier for the schema.",
"example": "78efc775-dccb-45ca-9acf-989a4a59f788",
"in": "path",
"name": "schemaId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"appType": "serviceApp",
"createdAt": "2024-09-05T01:35:04.772Z",
"id": "78efc775-dccb-45ca-9acf-989a4a59f788",
"protocol": "gRPC",
"serviceType": "webService",
"url": "/path/to/definition/file3"
}
}
},
"schema": {
"properties": {
"appType": {
"description": "The app type used for this schema",
"type": "string"
},
"createdAt": {
"description": "datetime when the schema was created",
"type": "string"
},
"id": {
"description": "The Schema Id",
"type": "string"
},
"protocol": {
"description": "The connection protocol for this schema",
"type": "string"
},
"serviceType": {
"description": "The service type web or contact center",
"type": "string"
},
"url": {
"description": "the URL location where this schema can be inspected",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "OK",
"headers": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"tags": [
"Data Sources"
],
"description": "Retrieve details of a specific data source schema by schema id. No specific scope is needed to retrieve the dataSource schemas, but a valid API token should be presented.",
"operationId": "Retrieve Details of a Specific Data Source Schema",
"summary": "Retrieve Details of a Specific Data Source Schema"
}
},
"/dataSources/{dataSourceId}": {
"delete": {
"parameters": [
{
"description": "The unique identifier for the dataSource.",
"example": "f29bb291-5db0-411b-834a-e64f8dee0658",
"in": "path",
"name": "dataSourceId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"tags": [
"Data Sources"
],
"description": "Delete a Data Source, by Data Source ID.\n\nSpecify the Data Source ID in the `dataSourceId` parameter in the URI.",
"operationId": "Delete a Data Source",
"summary": "Delete a Data Source"
},
"get": {
"parameters": [
{
"description": "The unique identifier for the dataSource.",
"example": "f29bb291-5db0-411b-834a-e64f8dee0658",
"in": "path",
"name": "dataSourceId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"audience": "MedDocVirtualAgent",
"errorMessage": "down for maintenance",
"id": "f29bb291-5db0-411b-834a-e64f8dee0658",
"nonce": "jeieu38udue83u398",
"schemaId": "78efc775-dccb-45ca-9acf-989a4a59f788",
"status": "active",
"subject": "callAudioData",
"tokenLifetimeMinutes": 60,
"url": "https://www.byods.com/service1"
}
}
},
"schema": {
"properties": {
"audience": {
"description": "The audience field in the JWT token. Usually, the DAPs app name.",
"type": "string"
},
"errorMessage": {
"description": "Error Message shown in Control Hub when status is set to `disabled`.",
"type": "string"
},
"id": {
"description": "The Data Source Id.",
"type": "string"
},
"nonce": {
"description": "Unique nonce used in the encryption of the JWT token.",
"type": "string"
},
"schemaId": {
"description": "The schema id used for the data exchange.",
"type": "string"
},
"status": {
"description": "The status of the Data Source; `active` or `disabled`",
"type": "string"
},
"subject": {
"description": "Rhe subject field in the JWT token. Usually, an indication of the app's function",
"type": "string"
},
"tokenLifetimeMinutes": {
"description": "The validity of the created token in minutes. Before the token expiration time, a new token must be provided, or Webex will stop delivering data after the token expiration",
"type": "number"
},
"url": {
"description": "The URL of the endpoint where Webex will send the data.",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "OK",
"headers": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"tags": [
"Data Sources"
],
"description": "Show details for a data source, by dataSource id.\nTo see details for a data source, use the Service App token with the `spark-admin:datasource_read` scope.",
"operationId": "Retrieve Data Source Details",
"summary": "Retrieve Data Source Details"
},
"put": {
"parameters": [
{
"description": "The unique identifier for the data source.",
"example": "f29bb291-5db0-411b-834a-e64f8dee0658",
"in": "path",
"name": "dataSourceId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"audience": "MedDocVirtualAgent",
"errorMessage": "down for maintenance",
"id": "f29bb291-5db0-411b-834a-e64f8dee0658",
"nonce": "jeieu38udue83u398",
"schemaId": "78efc775-dccb-45ca-9acf-989a4a59f788",
"status": "active",
"subject": "callAudioData",
"tokenLifetimeMinutes": 60,
"url": "https://www.byods.com/service1"
}
}
},
"schema": {
"properties": {
"audience": {
"description": "The audience field in the JWT token. Usually, the DAPs app name.",
"type": "string"
},
"errorMessage": {
"description": "Error Message shown in Control Hub when status is set to `disabled`.",
"type": "string"
},
"id": {
"description": "The Data Source Id.",
"type": "string"
},
"nonce": {
"description": "Unique nonce used in the encryption of the JWT token.",
"type": "string"
},
"schemaId": {
"description": "The schema id used for the data exchange.",
"type": "string"
},
"status": {
"description": "The status of the Data Source; `active` or `disabled`",
"type": "string"
},
"subject": {
"description": "Rhe subject field in the JWT token. Usually, an indication of the app's function",
"type": "string"
},
"tokenLifetimeMinutes": {
"description": "The validity of the created token in minutes. Before the token expiration time, a new token must be provided, or Webex will stop delivering data after the token expiration",
"type": "number"
},
"url": {
"description": "The URL of the endpoint where Webex will send the data.",
"type": "string"
}
},
"type": "object"
}
}
},
"description": "OK",
"headers": {}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further."
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect."
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed."
},
"404": {
"description": "Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method."
},
"405": {
"description": "Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported."
},
"409": {
"description": "Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once."
},
"410": {
"description": "Gone: The requested resource is no longer available."
},
"415": {
"description": "Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported."
},
"423": {
"description": "Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again."
},
"428": {
"description": "Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded."
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made."
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support)."
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later."
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later."
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it."
}
},
"tags": [
"Data Sources"
],
"description": "Updates a Data Source. The updateable fields are the `audience,` `subject,` `nonce,` `url` and `tokenLifetimeMinutes.`\nYou can update the `status` from `active` to `disabled` only when providing an `errorMessage` that may be shown to the customer admin in Control Hub. \nTokens must be regularly updated before their expiration to maintain system uptime.",
"operationId": "Update a Data Source",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"audience": {
"description": "The audience field in the JWT token. Usually, the DAPs app name.",
"example": "MedDocVirtualAgent",
"type": "string"
},
"errorMessage": {
"description": "Error Message shown in Control Hub when status is set to `disabled`.",
"example": "down for maintenance",
"type": "string"
},
"nonce": {
"description": "Unique nonce used in the encryption of the JWT token.",
"example": "jeieu38udue83u398",
"type": "string"
},
"schemaId": {
"description": "The schema id used for the data exchange.",
"example": "78efc775-dccb-45ca-9acf-989a4a59f788",
"type": "string"
},
"status": {
"description": "The status of the Data Source; `active` or `disabled`.",
"example": "active",
"type": "string"
},
"subject": {
"description": "The subject field in the JWT token. Usually, an indication of the app's function",
"example": "callAudioData",
"type": "string"
},
"tokenLifetimeMinutes": {
"description": "The validity of the created token in minutes. Before the token expiration time, a new token must be provided, or Webex will stop delivering data after the token expiration. Must be equal or less to 1440.",
"example": 60,
"type": "number"
},
"url": {
"description": "The URL of the endpoint where Webex will send the data.",
"example": "https://www.byods.com/service1",
"type": "string"
}
},
"type": "object"
}
}
}
},
"summary": "Update a Data Source"
}
},
"/v1/ewt": {
"get": {
"tags": [
"Estimated Wait Time"
],
"summary": "Get Estimated Wait Time",
"description": "Retrieve Estimated Wait Time information for a specified look back interval for a specific orgId and queueId combination, with ability to customomize maxCV and minValidSamples (See description above).\n",
"operationId": "getEwt",
"parameters": [
{
"name": "queueId",
"in": "query",
"description": "Id of the queue for which the EWT is to be returned",
"required": true,
"schema": {
"type": "string"
},
"example": "AWpEGCi_SVK96XSm20PY"
},
{
"name": "lookbackMinutes",
"in": "query",
"description": "Integer between 5 and 240 (4 hours) signifying how long back to look at the data points to determine EWT for this queue",
"required": true,
"schema": {
"maximum": 240,
"minimum": 5,
"type": "integer",
"format": "int32"
},
"example": 15
},
{
"name": "maxCV",
"in": "query",
"description": "This an optional parameter. Maximum value of Coefficient of Variance in a subset of samples (wait times for tasks that got connected to agent in one minute interval) to determine whether the average of such values should be treated as a valid sample for EWT computation. If its not passed it takes the default value of 40 %",
"required": false,
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"example": 40
},
{
"name": "minValidSamples",
"in": "query",
"description": "This an optional parameter. Minimum value of percentage of valid samples (with respect to total number of samples) in the specified lookbackMinutes minutes. If its not passed it takes the default value of 40 %",
"required": false,
"schema": {
"maximum": 100,
"minimum": 1,
"type": "integer",
"format": "int32"
},
"example": 40
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ",
"required": false,
"schema": {
"type": "string"
},
"example": "INTEGRATION-9bcdc696-57fa-4e91-b5aa-57a66a347c23"
},
{
"name": "orgId",
"in": "query",
"description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.",
"required": false,
"schema": {
"type": "string"
},
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EWTApiResponse"
}
}
}
},
"204": {
"description": "Not enough valid samples were found to compute the estimate wait time. Refer the parameters, lookbackMinutes, maxCV and minValidSamples to tune the API behavior \n Note : For an Invalid queue value we return a 204",
"content": {
"application/json": {}
}
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"503": {
"description": "The service is currently unavailable to serve the requests",
"content": {
"application/json": {}
}
}
}
}
},
"/v1/notification/subscribe": {
"post": {
"tags": [
"Notification"
],
"summary": "Subscribe Notification",
"description": "Access this endpoint when the user has to register for a WebSocket Session. Requires 'cjp:user' scope or roles 'id_full_admin', 'id_readonly_admin', 'atlas-portal.partner.salesadmin', 'cjp.supervisor', 'cjp.admin', 'atlas-portal.partner.provision_admin', 'cloud-contact-center:pod_conv' for authorization",
"operationId": "subscribeNotificationRoute",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResponse"
}
}
},
"description": "OK"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/queues/statistics": {
"get": {
"tags": [
"Queues"
],
"summary": "Get Queue Statistics",
"description": "Retrieve Queue statistics for a given interval of time. \nAn important thing to note is that each stat produced is for a specified time window (last 15, 30, or 60 minutes etc) and is not cumulative. \nContacts that span across intervals will also have stats broken down across intervals. For example: A contact that starts at 12:05 and ends at 12:25 will have stats for Interval A (12:00-12:15) and Interval B (12:15-12:30) assuming the interval window is for 15 minutes. \nStats that only require the start time of the contact like 'totalOfferedTasks' and 'totalAcceptedTasks' will be counted only once and it will be present in the interval where the contact started i.e. Interval A. \nWhereas, stats that require the end time as well for calculations like 'averageHandledTime', will be present in the interval where the contact ended i.e. interval B. \n\nFor this API, response compression using gzip can be enabled by including 'Accept-Encoding' header in the request with its value as 'gzip'. \nThe response will be compressed only if its size exceeds 1 MB.\nIf the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma separated encodings), then API response will not be compressed and this can impact the latency as observed from clients. \n",
"operationId": "getDocumentByQueryParam_1",
"parameters": [
{
"name": "from",
"in": "query",
"description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"example": 1651395600000
},
{
"name": "to",
"in": "query",
"description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"example": 1651438800000
},
{
"name": "interval",
"in": "query",
"description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
},
"example": 15
},
{
"name": "queueIds",
"in": "query",
"description": "Comma-separated list of queue IDs. A maximum of 100 values is permitted. If values are not provided, all queues for an organization are returned.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": "89cf3b93-f020-42c6-84dc-87db6a92eae7, 89cf3b93-f020-42c6-84dc-87db6a92fae7, 89cf3b93-f020-42c6-84dc-87db4a92eae7"
},
{
"name": "orgId",
"in": "query",
"description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.",
"required": false,
"schema": {
"type": "string"
},
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ",
"required": false,
"schema": {
"type": "string"
},
"example": "INTEGRATION-9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/QueueApiResponse"
}
}
}
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"503": {
"description": "The service is currently unavailable to serve the requests",
"content": {
"application/json": {}
}
}
}
}
},
"/v1/realtime/subscribe": {
"post": {
"tags": [
"Realtime"
],
"summary": "Subscribe Realtime Notification",
"description": "Access this endpoint when the user has to register for a WebSocket Session to receive realtime events. Requires 'cjp:user' scope or roles 'id_full_admin', 'id_readonly_admin', 'atlas-portal.partner.salesadmin', 'atlas-portal.partner.helpdesk', 'cjp.supervisor', 'cjp.admin', 'atlas-portal.partner.provision_admin' for authorization",
"operationId": "subscribeRealtimeRoute",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RealtimeRequest"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RealtimeResponse"
}
}
},
"description": "OK"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/search": {
"post": {
"tags": [
"Search"
],
"summary": "Search tasks",
"description": "The /search API is a GraphQL endpoint that enables customers to fetch data from Webex Contact Center.\n\n**Authentication & Authorization:**\n- **Required Scopes:** `cjp:config` or `cjp:config_read`\n- **Required Roles:** Administrator or Supervisor\n\nMandatory parameters are FROM and TO, which accept datetime in epoch format. The FROM parameter cannot be older than 36 months from the current time. The TO parameter, if given as a future time, will be set to the current time. Optional parameters such as filter and aggregation are accepted for each query.\n\nResponse Compression: For this API, response compression using gzip can be enabled by including the 'Accept-Encoding' header in the request with its value as 'gzip'. The response will be compressed only if its size exceeds 1 MB. If the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma-separated encodings), then the API response will not be compressed, impacting latency as observed from clients.",
"operationId": "getSearchResults",
"parameters": [
{
"name": "orgId",
"in": "query",
"description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.",
"required": false,
"schema": {
"type": "string",
"example": null
},
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ",
"required": false,
"schema": {
"type": "string",
"example": null
},
"example": "INTEGRATION-9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string",
"example": {
"data": {
"task": {
"tasks": [
{
"id": "fb53f6d1-5535-4ac8-b081-53834e17d6f5",
"channelType": "telephony",
"createdTime": 1629450000000,
"endedTime": 1630380960406,
"captureRequested": true,
"isActive": false,
"status": "ended",
"queue": [
{
"id": "e434a654-df4c-42dc-908b-3d9d0206a616",
"name": "cb_outdial_queue"
}
],
"owner": {
"name": "callbackorg2user1 callbackorg2user1",
"id": "74ab6507-a32a-479c-bda7-15ff0b6c6c3c"
}
}
]
}
}
}
}
}
}
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"409": {
"description": "Conflict",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"413": {
"description": "Content Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"503": {
"description": "The service is currently unavailable to serve the requests",
"content": {
"application/json": {}
}
}
}
}
},
"/v1/subscriptions": {
"get": {
"tags": [
"Subscriptions"
],
"summary": "List Subscriptions",
"description": "Retrieve all subscriptions for a given organization. Requires `cjp:config_read` scope.\n\n\n Note: In the response JSON, the 'data' field only contains V1 based subscriptions, while the field 'meta.subscriptionCount' provides the total count encompassing all the created subscriptions in the organization.",
"operationId": "getSubscriptionByOrgId",
"parameters": [
{
"name": "orgId",
"in": "query",
"description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.",
"required": false,
"schema": {
"type": "string"
},
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.",
"required": false,
"schema": {
"type": "string"
},
"example": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionApiListResponse"
}
}
}
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"403": {
"description": "Forbidden Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
}
}
},
"post": {
"tags": [
"Subscriptions"
],
"summary": "Register Subscription",
"description": "Create a subscription which would allow consumers to listen to events. If creating a subscription causes the org-level limit to be exceeded, the subscription registration will be denied. Requires `cjp:config_write` scope.",
"operationId": "createSubscription",
"parameters": [
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.",
"required": false,
"schema": {
"type": "string"
},
"example": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionCreateApiResponse"
}
}
}
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"403": {
"description": "Forbidden Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
}
}
}
},
"/v1/subscriptions/{id}": {
"get": {
"tags": [
"Subscriptions"
],
"summary": "Get Subscription",
"description": "Retrieve a subscription for a given subscription ID. Requires `cjp:config_read` scope.",
"operationId": "getSubscriptionById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "ID by which to retrieve the subscription.",
"format": "uuid",
"example": "10b4079b-5162-4526-b6a4-4472734fb69b"
}
},
{
"name": "orgId",
"in": "query",
"description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.",
"required": false,
"schema": {
"type": "string"
},
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.",
"required": false,
"schema": {
"type": "string"
},
"example": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionApiResponse"
}
}
}
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"403": {
"description": "Forbidden Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
}
}
},
"delete": {
"tags": [
"Subscriptions"
],
"summary": "Delete Subscription",
"description": "Deletes a subscription for a given subscription ID. Requires `cjp:config_write` scope.",
"operationId": "deleteSubscriptionById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "ID of the subscription to be deleted.",
"format": "uuid",
"example": "10b4079b-5162-4526-b6a4-4472734fb69b"
}
},
{
"name": "orgId",
"in": "query",
"description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.",
"required": false,
"schema": {
"type": "string"
},
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.",
"required": false,
"schema": {
"type": "string"
},
"example": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"403": {
"description": "Forbidden Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
}
}
},
"patch": {
"tags": [
"Subscriptions"
],
"summary": "Update Subscription",
"description": "Updates some of the properties in a subscription, for a given subscription ID. Requires `cjp:config_write` scope.",
"operationId": "updateSubscriptionById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "ID of the subscription to be updated.",
"format": "uuid",
"example": "10b4079b-5162-4526-b6a4-4472734fb69b"
}
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.",
"required": false,
"schema": {
"type": "string"
},
"example": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionRequestUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionApiResponse"
}
}
}
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"403": {
"description": "Forbidden Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
}
}
}
},
"/v1/event-types": {
"get": {
"tags": [
"Subscriptions"
],
"summary": "List Event Types",
"description": "Retrieve all available event types for an organization. Requires `cjp:config_read` scope.",
"operationId": "getAllEventTypes",
"parameters": [
{
"name": "orgId",
"in": "query",
"description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.",
"required": false,
"schema": {
"type": "string"
},
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.",
"required": false,
"schema": {
"type": "string"
},
"example": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypesApiListResponse"
}
}
}
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"403": {
"description": "Forbidden Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
}
}
}
},
"/v2/subscriptions": {
"get": {
"tags": [
"Subscriptions"
],
"summary": "List Subscriptions",
"description": "Retrieve all subscriptions for a given organization. Requires `cjp:config_read` scope.\n\n\n Note: In the response JSON, the 'data' field only contains V2 based subscriptions, while the field 'meta.subscriptionCount' provides the total count encompassing all the created subscriptions in the organization.",
"operationId": "getSubscriptionByOrgIdV2",
"parameters": [
{
"name": "orgId",
"in": "query",
"description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.",
"required": false,
"schema": {
"type": "string"
},
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.",
"required": false,
"schema": {
"type": "string"
},
"example": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionApiListResponseEnhanced"
}
}
}
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"403": {
"description": "Forbidden Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
}
}
},
"post": {
"tags": [
"Subscriptions"
],
"summary": "Register Subscription",
"description": "Create a subscription which would allow consumers to listen to events. If creating a subscription causes the org-level limit to be exceeded, the subscription registration will be denied. Requires `cjp:config_write` scope.",
"operationId": "createSubscriptionWithV2",
"parameters": [
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.",
"required": false,
"schema": {
"type": "string"
},
"example": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionRequestEnhanced"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionCreateApiResponseEnhanced"
}
}
}
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"403": {
"description": "Forbidden Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
}
}
}
},
"/v2/subscriptions/{id}": {
"get": {
"tags": [
"Subscriptions"
],
"summary": "Get Subscription",
"description": "Retrieve a subscription for a given subscription ID. Requires `cjp:config_read` scope.",
"operationId": "getSubscriptionByIdV2",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "ID by which to retrieve the subscription.",
"format": "uuid",
"example": "10b4079b-5162-4526-b6a4-4472734fb69b"
}
},
{
"name": "orgId",
"in": "query",
"description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.",
"required": false,
"schema": {
"type": "string"
},
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.",
"required": false,
"schema": {
"type": "string"
},
"example": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionApiResponseEnhanced"
}
}
}
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"403": {
"description": "Forbidden Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
}
}
},
"delete": {
"tags": [
"Subscriptions"
],
"summary": "Delete Subscription",
"description": "Deletes a subscription for a given subscription ID. Requires `cjp:config_write` scope.",
"operationId": "deleteSubscriptionByIdV2",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "ID of the subscription to be deleted.",
"format": "uuid",
"example": "10b4079b-5162-4526-b6a4-4472734fb69b"
}
},
{
"name": "orgId",
"in": "query",
"description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.",
"required": false,
"schema": {
"type": "string"
},
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.",
"required": false,
"schema": {
"type": "string"
},
"example": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"403": {
"description": "Forbidden Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
}
}
},
"patch": {
"tags": [
"Subscriptions"
],
"summary": "Update Subscription",
"description": "Updates some of the properties in a subscription, for a given subscription ID. Requires `cjp:config_write` scope.",
"operationId": "updateSubscriptionByIdWithV2",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"description": "ID of the subscription to be updated.",
"format": "uuid",
"example": "10b4079b-5162-4526-b6a4-4472734fb69b"
}
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.",
"required": false,
"schema": {
"type": "string"
},
"example": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionRequestUpdateEnhanced"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionApiResponseEnhanced"
}
}
}
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"403": {
"description": "Forbidden Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
}
}
}
},
"/v2/event-types": {
"get": {
"tags": [
"Subscriptions"
],
"summary": "List Event Types",
"description": "Retrieve all available event types for an organization along with information about the currently supported resource versions. Requires `cjp:config_read` scope. ",
"operationId": "getAllEventTypesWithResourceVersionMetadata",
"parameters": [
{
"name": "orgId",
"in": "query",
"description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permissions to interact with the organization.",
"required": false,
"schema": {
"type": "string"
},
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. If not provided, we will generate one for you.",
"required": false,
"schema": {
"type": "string"
},
"example": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypesApiListResponseEnhanced"
}
}
}
},
"400": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"403": {
"description": "Forbidden Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResult"
}
}
}
}
}
}
},
"/v1/agents/login": {
"post": {
"tags": [
"Agents"
],
"summary": "Login",
"description": "Allows the user to login to their desktop. It does not allow a duplicate login and sends an error message over websocket, if an active session already exists. Requires 'cjp:user' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "loginRoute",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogInResourceRequest"
}
}
}
},
"responses": {
"202": {
"description": "The login request was accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/agents/logout": {
"put": {
"tags": [
"Agents"
],
"summary": "Logout",
"description": "Allows the user to logout from their Desktop. This API needs to be called once the WSS session has been successfully established. Requires 'cjp:user','id_full_admin','id_readonly_admin','atlas-portal.partner.salesadmin','cjp.admin','cjp.supervisor','atlas-portal.partner.provision_admin' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "logoutRoute",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogOutResourceRequest"
}
}
}
},
"responses": {
"202": {
"description": "The logout request was accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/agents/session/state": {
"put": {
"tags": [
"Agents"
],
"summary": "State Change",
"description": "Allows the user to toggle between the Idle and Available states. An Administrator within the organization having an Agent license can perform a self state change when they have an active agent session. Supervisors can perform a self state change as well as state changes for agents and admin users within their authorized teams when 'Change Agent States' module is enabled. Requires 'cjp:user' scope for authorization.For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "stateRoute",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StateResourceRequest"
}
}
}
},
"responses": {
"202": {
"description": "The state change request was accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/agents/reload": {
"post": {
"tags": [
"Agents"
],
"summary": "Reload",
"description": "Allows the user to receive all the contact assigned to particular agent and state. Requires 'cjp:user' scope for authorization.",
"operationId": "reloadRoute",
"parameters": [],
"responses": {
"202": {
"description": "The reload request was accepted for processing"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/agents/buddyList": {
"post": {
"tags": [
"Agents"
],
"summary": "Buddy Agents List",
"description": "Returns the list of agents in the given state and media according to agent profile settings. Requires 'cjp:user' scope for authorization.",
"operationId": "buddyAgentsRoute",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BuddyAgentRequest"
}
}
}
},
"responses": {
"202": {
"description": "The buddy agents request was accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/agents/activities": {
"get": {
"tags": [
"Agents"
],
"summary": "Get Agent Activities",
"description": "Retrieve agent activities. Sorted by start time ascending.\nMaximum number of records that can be fetched for the given from and to is 10,000. \nFor this API, response compression using gzip can be enabled by including 'Accept-Encoding' header in the request with its value as 'gzip'. \nThe response will be compressed only if its size exceeds 1 MB.\nIf the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma separated encodings), then API response will not be compressed and this can impact the latency as observed from clients.",
"operationId": "getAgentActivities",
"parameters": [
{
"name": "agentIds",
"in": "query",
"description": "Filter agent activities by agent ids separated with commas if more than one value (max 100). By default, there is no agent filtering.",
"required": false,
"schema": {
"maxItems": 100,
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"89cf3b93-f020-42c6-84dc-87db6a92eae7",
"89cf3b93-f020-42c6-84dc-87db6a92fae7",
"89cf3b93-f020-42c6-84dc-87db4a92eae7"
]
},
{
"name": "teamIds",
"in": "query",
"description": "Filter agent activities by team ids separated with commas if more than one value (max 100). By default, there is no team filtering.",
"required": false,
"schema": {
"maxItems": 100,
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"89cf3b93-f020-42c6-84dc-87db6a92eae7",
"89cf3b93-f020-42c6-84dc-87db6a92fae7",
"89cf3b93-f020-42c6-84dc-87db4a92eae7"
]
},
{
"name": "channelTypes",
"in": "query",
"description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering.",
"required": false,
"example": [
"email",
"chat",
"telephony"
],
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"email",
"chat",
"telephony",
"social",
"customMessaging"
]
}
}
},
{
"name": "from",
"in": "query",
"description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds).",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"example": 1591702170000
},
{
"name": "to",
"in": "query",
"description": "Filter agent activities created before given epoch timestamp in UTC (in milliseconds). If unspecified, queries up to the present.\n The difference between to and from timestamps must be less than 24 hours (86400000 milli seconds)",
"required": false,
"schema": {
"type": "integer",
"format": "int64"
},
"example": 1591802180000
},
{
"name": "pageSize",
"in": "query",
"description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page.",
"required": false,
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 100
},
"example": 100
},
{
"name": "page",
"in": "query",
"description": "Page number to be passed. Maximum number of records that can be fetched for the given from and to is 10,000. So maximum page number allowed is based on it. Defaults to 0.",
"required": false,
"schema": {
"minimum": 0,
"type": "integer",
"format": "int32",
"default": 0
},
"example": 1
},
{
"name": "orgId",
"in": "query",
"description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.",
"required": false,
"schema": {
"type": "string"
},
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ",
"required": false,
"schema": {
"type": "string"
},
"example": "INTEGRATION-9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentActivitiesApiResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"413": {
"description": "Content Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"503": {
"description": "The service is currently unavailable to serve the requests",
"content": {
"application/json": {}
}
}
}
}
},
"/v1/agents/statistics": {
"get": {
"tags": [
"Agents"
],
"summary": "Get Agent Statistics",
"description": "Retrieve Agent statistics information for specified time duration and interval.\nFor this API, response compression using gzip can be enabled by including 'Accept-Encoding' header in the request with its value as 'gzip'. \nThe response will be compressed only if its size exceeds 1 MB.\nIf the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma separated encodings), then API response will not be compressed and this can impact the latency as observed from clients.",
"operationId": "getDocumentByQueryParam",
"parameters": [
{
"name": "from",
"in": "query",
"description": "Start time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:05 will be rounded down to 12:00.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"example": 1651395600000
},
{
"name": "to",
"in": "query",
"description": "End time for the query (in epoch milliseconds). Any epoch time can be passed in the input, from date will be rounded down to nearest 15 minute window. For example, epoch time of 12:55 will be rounded down to 12:45.\n The difference between to and from time must be less than 24 hours (86400000 milliseconds).",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"example": 1651438800000
},
{
"name": "interval",
"in": "query",
"description": "Time interval (in minutes) to chunk statistics by i.e. break up the entire from-to timeframe by this interval amount so that statistics can be viewed incrementally. Supported values are 15, 30, or 60.",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
},
"example": 15
},
{
"name": "agentIds",
"in": "query",
"description": "Comma-separated list of agent IDs. A maximum of 100 values is permitted. If values are not provided, all agents of an organization are returned.",
"required": false,
"schema": {
"maxItems": 100,
"minItems": 0,
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"89cf3b93-f020-42c6-84dc-87db6a92eae7",
"89cf3b93-f020-42c6-84dc-87db6a92fae7",
"89cf3b93-f020-42c6-84dc-87db4a92eae7"
]
},
{
"name": "orgId",
"in": "query",
"description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.",
"required": false,
"schema": {
"type": "string"
},
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ",
"required": false,
"schema": {
"type": "string"
},
"example": "INTEGRATION-9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentApiResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"503": {
"description": "The service is currently unavailable to serve the requests",
"content": {
"application/json": {}
}
}
}
}
},
"/v2/agents/login": {
"post": {
"tags": [
"Agents"
],
"summary": "Login",
"description": "Allows the user to login to their desktop. It does not allow a duplicate login and sends an error message over websocket, if an active session already exists. Requires 'cjp:user' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/documentation/guides/contact-control-apis).",
"operationId": "LoginRoute",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "The bearer token would be sent to validate the active users.",
"required": true,
"schema": {
"type": "string"
},
"example": "Bearer "
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogInResourceRequest"
}
}
}
},
"responses": {
"202": {
"description": "The login request was accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v2/agents/logout": {
"put": {
"tags": [
"Agents"
],
"summary": "Logout",
"description": "Allows the user to logout from their Desktop. This API needs to be called once the WSS session has been successfully established. Requires 'cjp:user','id_full_admin','id_readonly_admin','atlas-portal.partner.salesadmin','cjp.admin','cjp.supervisor','atlas-portal.partner.provision_admin' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/documentation/guides/contact-control-apis).",
"operationId": "LogoutRoute",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "The bearer token would be sent to validate the active users.",
"required": true,
"schema": {
"type": "string"
},
"example": "Bearer "
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogOutResourceRequest"
}
}
}
},
"responses": {
"202": {
"description": "The logout request was accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v2/agents/session/state": {
"put": {
"tags": [
"Agents"
],
"summary": "State Change",
"description": "Allows the user to toggle between the Idle and Available states. An Administrator within the organization having an Agent license can perform a self state change when they have an active agent session. Supervisors can perform a self state change as well as state changes for agents and admin users within their authorized teams when 'Change Agent States' module is enabled. Requires 'cjp:user' scope for authorization.For a list of possible response messages, see the [Call Control API Guide](/documentation/guides/contact-control-apis).",
"operationId": "StateRoute",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "The bearer token would be sent to validate the active users.",
"required": true,
"schema": {
"type": "string"
},
"example": "Bearer "
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentChannelStateChangeResourceRequest"
}
}
}
},
"responses": {
"202": {
"description": "The state change request was accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v2/agents/reload": {
"post": {
"tags": [
"Agents"
],
"summary": "Reload",
"description": "Allows the user to receive all the contact assigned to particular agent and state. Requires 'cjp:user' scope for authorization.",
"operationId": "ReloadRoute",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "The bearer token would be sent to validate the active users.",
"required": true,
"schema": {
"type": "string"
},
"example": "Bearer "
}
],
"responses": {
"202": {
"description": "The reload request was accepted for processing"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/monitor": {
"post": {
"tags": [
"Call Monitoring"
],
"summary": "Create Monitoring Request",
"description": "Create a successful monitoring request. It can be done either on an on-going or next successful inbound/outbound call. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.",
"operationId": "createMonitoringRequest",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallMonitoringRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "The create request was accepted for processing"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"412": {
"description": "Precondition Failed"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/monitor/{taskId}/bargeIn": {
"post": {
"tags": [
"Call Monitoring"
],
"summary": "BargeIn Request",
"description": "Create a successful barge-in request for the supervisor to barge in the call that is being monitored already. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.",
"operationId": "bargeInRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID representing the task that needs to be barged by the supervisor.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"responses": {
"202": {
"description": "The bargeIn request was accepted for processing"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"412": {
"description": "Precondition Failed"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/monitor/{taskId}/end": {
"post": {
"tags": [
"Call Monitoring"
],
"summary": "End Monitoring Request",
"description": "Allows to successfully end the on-going monitoring request. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.",
"operationId": "endActiveMonitoringRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that needs to end.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"responses": {
"202": {
"description": "The end request was accepted for processing"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"412": {
"description": "Precondition Failed"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/monitor/{taskId}/hold": {
"post": {
"tags": [
"Call Monitoring"
],
"summary": "Hold Monitoring Request",
"description": "Place the monitoring session on hold for a particular call. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.",
"operationId": "supervisorHoldMonitoringRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID representing the task that needs to be held.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"responses": {
"202": {
"description": "The hold request was accepted for processing."
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"412": {
"description": "Precondition Failed"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/monitor/{taskId}/unhold": {
"post": {
"tags": [
"Call Monitoring"
],
"summary": "Unhold Monitoring Request",
"description": "Resume a particular monitoring request that was on hold already. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.",
"operationId": "supervisorUnHoldMonitoringRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID representing the task that needs to be resumed and was on hold already.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"responses": {
"202": {
"description": "The resume request was accepted for processing."
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"412": {
"description": "Precondition Failed"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/monitor/sessions": {
"get": {
"tags": [
"Call Monitoring"
],
"summary": "Fetch Monitoring Sessions",
"description": "Fetches all active subscriptions for a given clientID.",
"operationId": "fetchMonitoringSessionsRoute",
"parameters": [],
"responses": {
"202": {
"description": "The fetch session request was accepted for processing."
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"412": {
"description": "Precondition Failed"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/monitor/{requestId}": {
"delete": {
"tags": [
"Call Monitoring"
],
"summary": "Delete Monitoring Request",
"description": "Delete a particular monitoring request that was created. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'.",
"operationId": "deleteMonitoringRequestRoute",
"parameters": [
{
"name": "requestId",
"in": "path",
"description": "The id with which the monitoring request has been created.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"responses": {
"202": {
"description": "The delete request was accepted for processing"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"412": {
"description": "Precondition Failed"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/callbacks/organization/{orgId}/scheduled-callback": {
"post": {
"tags": [
"Callbacks"
],
"summary": "Schedule a Callback",
"description": "Creates a new callback request for a customer. Authorization requires the cjp:user scope. The callback default endpoint (EP) and default ANI must be configured as mandatory settings to successfully make API calls.",
"operationId": "ScheduleCallback",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The organization ID for which the callback is being scheduled. This should be a valid UUID.",
"required": true,
"schema": {
"type": "string"
},
"example": "123e4567-e89b-12d3-a456-426614174000"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleCallbackRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Callback successfully scheduled.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleCallbackResponse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"429": {
"description": "Too Many Requests"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
},
"get": {
"tags": [
"Callbacks"
],
"summary": "Get scheduled callbacks",
"description": "Allows the user to list scheduled callbacks for a given customer number or assignee agent, excluding those whose scheduled trigger time has already passed. Requires 'cjp:user' scope for authorization.",
"operationId": "GetScheduledCallbacks",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The organization ID for which the callback is being scheduled. This should be a valid UUID.",
"required": true,
"schema": {
"type": "string"
},
"example": "123e4567-e89b-12d3-a456-426614174000"
},
{
"name": "callbackNumber",
"in": "query",
"description": "The callback customer number to filter the scheduled callbacks. Only an exact match will yield the result. Allows an optional country code followed by digits (0-9) and the special characters: space, hyphen -, parentheses ( and ), and period ., ensuring the total length is between 7 and 15 characters.",
"required": false,
"schema": {
"type": "string"
},
"example": "+1234567890"
},
{
"name": "assigneeAgent",
"in": "query",
"description": "The unique identifier of the agent assigned to handle the callback. Must be in UUID format. This parameter is optional, but at least one of assigneeAgent or callbackNumber must be provided.",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
},
"example": "123e4567-e89b-12d3-a456-426614174001"
},
{
"name": "page",
"in": "query",
"description": "The page number to retrieve.",
"required": false,
"schema": {
"type": "integer",
"default": 0,
"minimum": 0
},
"example": 1
},
{
"name": "pageSize",
"in": "query",
"description": "The number of items per page.",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"minimum": 1,
"maximum": 100
},
"example": 10
},
{
"name": "sortBy",
"in": "query",
"description": "The field to sort the results by. If `sortBy` is set to `assignedTime`, the `assigneeAgent` parameter must also be provided.",
"required": false,
"schema": {
"type": "string",
"enum": [
"customerName",
"scheduledTime",
"assignedTime"
],
"default": "scheduledTime"
},
"example": "scheduledTime"
},
{
"name": "sortOrder",
"in": "query",
"description": "The order to sort the results in.",
"required": false,
"schema": {
"type": "string",
"enum": [
"asc",
"desc"
],
"default": "asc"
},
"example": "asc"
}
],
"responses": {
"200": {
"description": "The get scheduled callback request was successfully processed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallbackSchedulesResponse"
}
}
}
},
"400": {
"description": "Bad Request: Validation error. This can occur in the following cases:\n- Both `assigneeAgent` and `callbackNumber` are missing.\n- `assigneeAgent` is not in UUID format.\n- `sortBy` is set to `assignedTime` but `assigneeAgent` is not provided."
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"429": {
"description": "Too Many Requests"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/callbacks/organization/{orgId}/scheduled-callback/{id}": {
"get": {
"tags": [
"Callbacks"
],
"summary": "Get scheduled callback by Id",
"description": "Retrieve an existing scheduled callback by Id, excluding those whose scheduled trigger time has already passed. Requires 'cjp:user' scope for authorization.",
"operationId": "GetScheduledCallbackById",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The organization ID for which the callback is being scheduled. This should be a valid UUID.",
"required": true,
"schema": {
"type": "string"
},
"example": "123e4567-e89b-12d3-a456-426614174000"
},
{
"name": "id",
"in": "path",
"description": "The id with which the Scheduled Callback has been created.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "5C3E69AC-3695-4D51-899B-4B4CC3ED8ECF"
}
],
"responses": {
"200": {
"description": "The request was successfully processed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleCallbackResponse"
}
}
}
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"404": {
"description": "Not Found"
},
"429": {
"description": "Too Many Requests"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
},
"put": {
"tags": [
"Callbacks"
],
"summary": "Update scheduled callback by Id",
"description": "Update an existing scheduled callback by Id,those whose scheduled trigger time has already passed cannot be updated. Requires 'cjp:user' scope for authorization.",
"operationId": "UpdateScheduledCallbackById",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The organization ID for which the callback is being scheduled. This should be a valid UUID.",
"required": true,
"schema": {
"type": "string"
},
"example": "123e4567-e89b-12d3-a456-426614174000"
},
{
"name": "id",
"in": "path",
"description": "The id with which the Scheduled Callback has been created.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "5C3E69AC-3695-4D51-899B-4B4CC3ED8ECF"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CallbackScheduleUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "The request was successfully updated.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleCallbackResponse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"404": {
"description": "Not Found"
},
"429": {
"description": "Too Many Requests"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
},
"delete": {
"tags": [
"Callbacks"
],
"summary": "Delete scheduled callback by Id",
"description": "Delete an existing scheduled callback by Id, those whose scheduled trigger time has already passed cannot be deleted. Requires 'cjp:user' scope for authorization.",
"operationId": "DeleteScheduledCallbackById",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The organization ID for which the callback is being scheduled. This should be a valid UUID.",
"required": true,
"schema": {
"type": "string"
},
"example": "123e4567-e89b-12d3-a456-426614174000"
},
{
"name": "id",
"in": "path",
"description": "The id with which the Scheduled Callback has been created.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "5C3E69AC-3695-4D51-899B-4B4CC3ED8ECF"
}
],
"responses": {
"204": {
"description": "The request was successfully deleted."
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"404": {
"description": "Not Found"
},
"429": {
"description": "Too Many Requests"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks": {
"post": {
"tags": [
"Tasks"
],
"summary": "Create Task",
"description": "This API is to create a task for work or handling assignments. Represents both inbound tasks (originating from customer-facing channels) and outbound tasks (originating from contact center to customer-facing channel). Requires 'cjp:user' scope for authorization. For a list of possible response messages, see the Call Control API Guide.",
"operationId": "CreateTaskRoute",
"parameters": [],
"requestBody": {
"description": "Request body to create a task.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTaskRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "The new task was successfully requested for creation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTaskResponse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
},
"get": {
"tags": [
"Tasks"
],
"summary": "Get Tasks",
"description": "Retrieve open and closed tasks. Sorted by createdTime ascending. Uses offset-based pagination.\nFor this API, response compression using gzip can be enabled by including 'Accept-Encoding' header in the request with its value as 'gzip'. \nThe response will be compressed only if its size exceeds 1 MB.\nIf the header is not present in the request or if gzip is not listed as one of the encodings in the header's value (comma separated encodings), then API response will not be compressed and this can impact the latency as observed from clients.",
"operationId": "searchTasks",
"parameters": [
{
"name": "channelTypes",
"in": "query",
"description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering.",
"required": false,
"example": [
"email",
"telephony"
],
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"email",
"chat",
"telephony",
"social",
"customMessaging"
]
}
}
},
{
"name": "from",
"in": "query",
"description": "Filters tasks created after the given epoch timestamp (in milliseconds).",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"example": 1591702170000
},
{
"name": "to",
"in": "query",
"description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified.",
"required": false,
"schema": {
"type": "integer",
"format": "int64"
},
"example": 1591802180000
},
{
"name": "pageSize",
"in": "query",
"description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page.",
"required": false,
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int32",
"default": 100
},
"example": 100
},
{
"name": "orgId",
"in": "query",
"description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.",
"required": false,
"schema": {
"type": "string"
},
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
{
"name": "TrackingId",
"in": "header",
"description": "Tracking ID to use for this operation, for traceability, debugging, and error reporting purposes. ",
"required": false,
"schema": {
"type": "string"
},
"example": "INTEGRATION-9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskApiResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized Operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"413": {
"description": "Content Too Large",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {}
}
},
"500": {
"description": "An Unexpected Error Occurred",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"503": {
"description": "The service is currently unavailable to serve the requests",
"content": {
"application/json": {}
}
}
}
}
},
"/v1/tasks/{taskId}": {
"patch": {
"tags": [
"Tasks"
],
"summary": "Update Task",
"description": "This API is to update a task. Represents both inbound tasks (originating from customer-facing channels) and outbound tasks (originating from contact center to customer-facing channel). Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization.. For a list of possible response messages, see the Call Control API Guide.",
"operationId": "PatchTaskRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"requestBody": {
"description": "Request body for patching a task.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchTaskRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/accept": {
"post": {
"tags": [
"Tasks"
],
"summary": "Accept Task",
"description": "Access this endpoint when the user has to accept either an inbound or an outbound requests. The request can be social, a chat or an email. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "acceptTaskRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/end": {
"post": {
"tags": [
"Tasks"
],
"summary": "End Task",
"description": "Access this endpoint when the user has to end either an inbound or an outbound requests. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "endTaskRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/wrapup": {
"post": {
"tags": [
"Tasks"
],
"summary": "Wrap Up Task",
"description": "Access this endpoint when the user has to wrap up a call. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "agentWrapUpRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WrapUpResourceRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/hold": {
"post": {
"tags": [
"Tasks"
],
"summary": "Hold Task",
"description": "Access this endpoint when the user has to hold a call. When an user is in consulting state, the task will be put on hold. It is not applicable for chats and emails. Requires one of the following scopes 'cjp:user','cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "agentHoldRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaResourceRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/unhold": {
"post": {
"tags": [
"Tasks"
],
"summary": "Resume Task",
"description": "Access this endpoint when the user has to resume a call from hold. When an user is done consulting, the previously held interaction with the customer should be resumed. It is not applicable for chats and emails. Requires one of the following scopes 'cjp:user','cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "agentUnHoldRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaResourceRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/reject": {
"post": {
"tags": [
"Tasks"
],
"summary": "Reject Task",
"description": "Access this endpoint when the user has to reject a task. Once a task is rejected, the status of the user goes to idle from available. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "rejectTaskRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaResourceRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/record/pause": {
"post": {
"tags": [
"Tasks"
],
"summary": "Pause Recording Task",
"description": "When configured by the administrator, telephony tasks are often being recorded for various reasons. When an user is handling sensitive customer information, he/she might want to pause the recording and later on resume recording. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis). Requires OAuth scope cjp:user. The authenticated user must have a UserProfile of type Agent to access this API.",
"operationId": "pauseRecordingRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/record/resume": {
"post": {
"tags": [
"Tasks"
],
"summary": "Resume Recording Task",
"description": "When configured by the administrator, telephony tasks are often being recorded for various reasons. When an user is handling sensitive customer information, he/she might resume the recording after the pause. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis). Requires OAuth scope cjp:user. The authenticated user must have a UserProfile of type Agent to access this API.",
"operationId": "resumeRecordingRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResumeRecordingResourceRequest"
}
}
}
},
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/transfer": {
"post": {
"tags": [
"Tasks"
],
"summary": "Transfer Task",
"description": "Access this endpoint when the user has to transfer a call to another user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' scope for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "transferTaskRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransferResourceRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/consult": {
"post": {
"tags": [
"Tasks"
],
"summary": "Consult Task",
"description": "Access this endpoint when the user has to consult a call to another user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "consultRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsultResourceRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/consult/conference": {
"post": {
"tags": [
"Tasks"
],
"summary": "Consult Conference Task",
"description": "Access this endpoint when the user has to initiate a conference with the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "consultConferenceRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConferenceResourceRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/consult/transfer": {
"post": {
"tags": [
"Tasks"
],
"summary": "Consult Transfer Task",
"description": "Access this endpoint when the user has to transfer a call to the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "consultTransferRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConsultTransferResourceRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/consult/accept": {
"post": {
"tags": [
"Tasks"
],
"summary": "Consult Accept Task",
"description": "Access this endpoint when the user has to accept a call to the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "acceptConsultRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/assign": {
"post": {
"tags": [
"Tasks"
],
"summary": "Assign Task",
"description": "Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to assign tasks to themselves. Authorization requires the `cjp:user` scope. For a list of potential response messages, refer to the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "assignRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user want to assign.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/consult/end": {
"post": {
"tags": [
"Tasks"
],
"summary": "Consult End Task",
"description": "Access this endpoint when the user has to end a call with the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "endConsultRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EndConsultRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/tasks/{taskId}/conference/exit": {
"post": {
"tags": [
"Tasks"
],
"summary": "Exit Conference Task",
"description": "Access this endpoint when the user wants to exit from a conference call. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:pod_conv' for authorization. For a list of possible response messages, see the [Call Control API Guide](/docs/contact-control-apis).",
"operationId": "exitConferenceRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The taskId represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"402": {
"description": "Not Found"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/dialer/campaign/{campaignId}/preview-task/{taskId}/accept": {
"post": {
"tags": [
"Tasks"
],
"summary": "Accept Preview Task",
"description": "API to accept the preview campaign task offered to the agent.",
"operationId": "acceptPreviewCampaignTaskRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
},
{
"name": "campaignId",
"in": "path",
"description": "The unique ID represents the campaign that the user is currently working on.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Invalid or absent authorization header"
},
"403": {
"description": "Invalid OAuth 2.0 Bearer Token"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/dialer/campaign/{campaignId}/preview-task/{taskId}/skip": {
"post": {
"tags": [
"Tasks"
],
"summary": "Skip Preview Task",
"description": "API to skip the preview campaign task offered to the agent.",
"operationId": "skipPreviewCampaignTaskRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
},
{
"name": "campaignId",
"in": "path",
"description": "The unique ID represents the campaign that the user is currently working on.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Invalid or absent authorization header"
},
"403": {
"description": "Invalid OAuth 2.0 Bearer Token"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/dialer/campaign/{campaignId}/preview-task/{taskId}/remove": {
"post": {
"tags": [
"Tasks"
],
"summary": "Remove Preview Task",
"description": "API to remove the preview campaign task offered to the agent",
"operationId": "removePreviewCampaignTaskRoute",
"parameters": [
{
"name": "taskId",
"in": "path",
"description": "The unique ID represents the task that the user is currently working on. It will be generated automatically during the creation of a new task.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
},
{
"name": "campaignId",
"in": "path",
"description": "The unique ID represents the campaign that the user is currently working on.",
"required": true,
"schema": {
"type": "string",
"format": "UUID"
},
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
],
"responses": {
"202": {
"description": "The request is accepted for processing"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Invalid or absent authorization header"
},
"403": {
"description": "Invalid OAuth 2.0 Bearer Token"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v2/tasks": {
"post": {
"tags": [
"Tasks"
],
"summary": "Create Task",
"description": "This feature is currently in Beta. Contact your Cisco team if you want access to this feature.\n\nCreates a new contact center task using the v2 task contract. The request body must include a `channelType` discriminator to select the task variant \u2014 `workItem` for structured form tasks, `customMessaging` for conversational messaging tasks, or `telephony` for voice tasks.\n\nOn success, returns a `201` response containing the task ID, which can be used to track the task lifecycle.\n\nRequires `cjp:task_write` OAuth scope. For partner-initiated inbound tasks (`workItem`, `customMessaging`), the `cjp:task_write` scope must be present in the partner application's access token. When an authenticated agent initiates an outdial (`telephony`) task, ensure the `cjp:task_write` scope is included in the agent's access token.",
"operationId": "createTaskRouteV2",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer token used to authorize the request.",
"required": true,
"schema": {
"type": "string"
},
"example": "Bearer "
}
],
"requestBody": {
"description": "Request body to create a v2 task.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTaskRequestV2"
},
"examples": {
"workItem": {
"summary": "Create a workItem task",
"value": {
"origin": {
"id": "customer@domain.com",
"name": "Customer Name"
},
"destination": {
"id": "customer-support@biz.com",
"type": "businessAddress"
},
"channelType": "workItem",
"channel": "support-form",
"channelParams": {
"type": "work-item-form",
"message": {
"aliasId": "msg-001",
"workItemData": {
"name": "customer name",
"email": "customer@domain.com"
},
"timestamp": 1732786800000
}
}
}
},
"telephony": {
"summary": "Create a telephony (callback) task",
"value": {
"origin": {
"id": "+18000000000",
"name": null
},
"destination": {
"id": "+19780000000",
"type": "dialNumber"
},
"channelType": "telephony",
"channelParams": {
"type": "telephony",
"entryPointId": "aef6455f-ccd6-4261-bb00-e80f845c01b0",
"outboundType": "CALLBACK",
"callback": {
"type": "immediate",
"origin": "web",
"number": "+19780000000"
}
}
}
},
"customMessagingText": {
"summary": "Create a customMessaging task (text only)",
"value": {
"origin": {
"id": "customer@example.com",
"name": "Customer Name"
},
"destination": {
"id": "support@channel.biz",
"type": "businessAddress"
},
"channelType": "customMessaging",
"channel": "my-custom-channel",
"channelParams": {
"type": "text",
"message": {
"aliasId": "123e4567-e89b-12d3-a456-426614174000",
"text": "Hello, I need help with my order.",
"timestamp": 1732786800000
}
}
}
},
"customMessagingWithAttachments": {
"summary": "Create a customMessaging task (text with attachments)",
"value": {
"origin": {
"id": "customer@example.com",
"name": "Customer Name"
},
"destination": {
"id": "support@channel.biz",
"type": "businessAddress"
},
"channelType": "customMessaging",
"channel": "my-custom-channel",
"channelParams": {
"type": "text-with-attachments",
"message": {
"aliasId": "123e4567-e89b-12d3-a456-426614174001",
"text": "Please see the attached screenshot.",
"attachments": [
{
"fileName": "screenshot.png",
"mimeType": "image/png",
"fileUrl": "https://cdn.example.com/files/screenshot.png"
}
],
"timestamp": 1732786800000
}
}
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "The new task was successfully requested for creation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateTaskResponse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v2/tasks/{taskId}/messages": {
"post": {
"tags": [
"Tasks"
],
"summary": "Append Task Message",
"description": "This feature is currently in Beta. Contact your Cisco team if you want access to this feature.\n\nAppends an inbound message to an existing `workItem` or `customMessaging` task. Use this API after the initial task has been created through Create Task. Requires `cjp:task_write` OAuth scope. For partner-initiated inbound message appends, the `cjp:task_write` scope must be present in the partner application's access token.\n\nOn success, returns a `202` response containing the append event identifier as `data.id`. Partners can use this identifier to correlate subsequent webhook delivery for the appended message.",
"operationId": "appendTaskMessageV2",
"parameters": [
{
"name": "Authorization",
"in": "header",
"description": "Bearer token used to authorize the request.",
"required": true,
"schema": {
"type": "string"
},
"example": "Bearer "
},
{
"name": "taskId",
"in": "path",
"description": "UUID of the existing task to which the message will be appended.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"example": "044ea619-a0ad-41a3-9ed9-c2563a9bd6b7"
}
],
"requestBody": {
"description": "Request body to append a message to an existing `workItem` or `customMessaging` task.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskMessageRequest"
},
"examples": {
"workItem": {
"summary": "Append a workItem message",
"value": {
"mediaType": "workItem",
"channelParams": {
"type": "work-item-form",
"message": {
"aliasId": "alias-wi-001",
"workItemData": {
"name": "customer name",
"email": "customer@domain.com"
},
"timestamp": 1732786800000
}
}
}
},
"customMessagingText": {
"summary": "Append a customMessaging text message",
"value": {
"mediaType": "customMessaging",
"channelParams": {
"type": "text",
"message": {
"aliasId": "123e4567-e89b-12d3-a456-426614174000",
"text": "I have additional details to share.",
"timestamp": 1732786800000
}
}
}
},
"customMessagingWithAttachments": {
"summary": "Append a customMessaging message with attachments",
"value": {
"mediaType": "customMessaging",
"channelParams": {
"type": "text-with-attachments",
"message": {
"aliasId": "123e4567-e89b-12d3-a456-426614174001",
"text": "Please review the attached files.",
"attachments": [
{
"fileName": "details.pdf",
"mimeType": "application/pdf",
"fileUrl": "https://cdn.example.com/files/details.pdf"
}
],
"timestamp": 1732786800000
}
}
}
}
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted. The response returns the append event identifier in `data.id`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskMessageResponse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"429": {
"description": "Too Many Requests"
},
"500": {
"description": "Internal Server Error"
}
}
}
},
"/{orgId}/project/{projectId}/v2/activities": {
"get": {
"tags": [
"Activities"
],
"summary": "List Activity Definitions",
"description": "List all available activity types with their full schemas, including inputs, outputs, ports, and descriptions. The response is sufficient on its own to construct nodes \u2014 there is no separate schema endpoint.\n\nScope: `cjp:config_read`",
"operationId": "listActivityDefinitions",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
}
],
"responses": {
"200": {
"description": "Array of activity definitions.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActivityV2"
},
"example": [
{
"activityName": "play-message",
"displayName": "Play Message",
"category": "core",
"group": "action",
"activityType": "action"
}
]
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
}
},
"/{orgId}/project/{projectId}/v2/activities/{activityName}": {
"get": {
"tags": [
"Activities"
],
"summary": "Describe an Activity",
"description": "Retrieve a single activity's full definition, including inputs, outputs, named ports, and the JSON Schema for its inputs \u2014 all returned inline.\n\nScope: `cjp:config_read`",
"operationId": "describeActivity",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "activityName",
"in": "path",
"description": "Activity type name (e.g., `play-message`, `queue-contact`).",
"required": true,
"schema": {
"type": "string"
},
"example": "play-message"
}
],
"responses": {
"200": {
"description": "Activity definition.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivityV2"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
}
},
"/{orgId}/project/{projectId}/v2/activities/{activityName}/inputs/{inputName}/choices": {
"get": {
"tags": [
"Activities"
],
"summary": "Get Activity Input Choices",
"description": "Resolve choices for an activity input. Use this when an activity input requires a value from a predefined or dynamically resolved set (e.g., available queues, audio files, agents).\n\nThis endpoint is only valid for inputs that expose choices (an input whose definition includes `allowedValues` or a `choicesEndpoint`, as returned by `describeActivity`). Calling it for an input that does not support choices returns 400.\n\nPass `search` to filter the choices (type-ahead). Add `validate=true` together with `search` to do a point-lookup of a single value instead of filtering \u2014 the match is against the choice's `value` (its ID), not its display `name`. For a cascading input whose allowed values depend on a sibling input, supply the parent with `parentInputName` and `parentValue`; otherwise a cascading input returns 400.\n\nFiltering and validation apply only to dynamic (`choicesEndpoint`-backed) inputs. A static input always returns its full enumerated list regardless of `search`/`validate`.\n\nScope: `cjp:config_read`",
"operationId": "getActivityInputChoices",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "activityName",
"in": "path",
"description": "Activity type name.",
"required": true,
"schema": {
"type": "string"
},
"example": "queue-contact"
},
{
"name": "inputName",
"in": "path",
"description": "Input field name. Must be an input that exposes choices (has `allowedValues` or a `choicesEndpoint`).",
"required": true,
"schema": {
"type": "string"
},
"example": "channelType"
},
{
"name": "search",
"in": "query",
"description": "Search text used to filter the returned choices (type-ahead). When `validate=true`, this is instead the single value to look up.",
"required": false,
"schema": {
"type": "string"
},
"example": "support"
},
{
"name": "validate",
"in": "query",
"description": "When `true` and `search` is supplied, performs a point-lookup of the single value in `search` (matched against the choice's `value`/ID) instead of filtering.",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"example": false
},
{
"name": "parentValue",
"in": "query",
"description": "Parent input value for a cascading/dynamic input (for example, the selected `channelType`).",
"required": false,
"schema": {
"type": "string"
},
"example": "TELEPHONY"
},
{
"name": "parentInputName",
"in": "query",
"description": "Parent input name for a cascading/dynamic input. Required when `parentValue` is provided.",
"required": false,
"schema": {
"type": "string"
},
"example": "channelType"
}
],
"responses": {
"200": {
"description": "Resolved choices for the input, plus resolution metadata.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivityInputChoices"
}
}
}
},
"400": {
"description": "Bad Request \u2014 a cascading input was queried without its parent (`parentInputName`/`parentValue`), or the input does not support choices.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
}
},
"/{orgId}/project/{projectId}/v2/event-specifications": {
"get": {
"tags": [
"Events"
],
"summary": "List Event Specifications",
"description": "List the event types available for use in `event_flows[]`. Each entry describes the event name, payload schema, and any contextual metadata bound when the event fires.\n\nScope: `cjp:config_read`",
"operationId": "listEventSpecifications",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
}
],
"responses": {
"200": {
"description": "Available event specifications, plus ready-to-paste quick-start snippets.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventSpecificationsResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
}
},
"/{orgId}/project/{projectId}/flows": {
"get": {
"tags": [
"Flows"
],
"summary": "List Flows or Subflows",
"description": "Returns a list of flows in response. Channel-based filtering can be applied with the `searchBy` query parameter (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`). Channel visibility may be constrained by organization feature flags.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]",
"operationId": "findFlowsUsingGET",
"parameters": [
{
"name": "flowType",
"in": "query",
"description": "Either of 'FLOW' or 'SUBFLOW'.",
"schema": {
"type": "string",
"default": "FLOW"
},
"example": "FLOW"
},
{
"name": "ids",
"in": "query",
"description": "Filters results based on a comma-separated list of flow IDs. If provided, only flows with those IDs will be fetched in the response.",
"style": "form",
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"668e4b2d928d471e41da03d1",
"668e3ee2928d471e41da03cb"
]
},
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of the displayed page. The page number starts from 0.",
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"example": 0
},
{
"name": "partialNameSearch",
"in": "query",
"description": "Performs a partial string match on the name of the flow. If the flow name contains the given string it will be fetched in the response.",
"schema": {
"type": "string"
},
"example": "flow1"
},
{
"name": "searchBy",
"in": "query",
"description": "Filter expression in the format `|`. Supports searching by `channelType` (for example, `channelType|telephony`, `channelType|workItem`, `channelType|customMessaging`, `channelType|genericAction`).",
"schema": {
"type": "string"
},
"example": "channelType|customMessaging"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "size",
"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",
"format": "int32",
"default": 10
},
"example": 10
},
{
"name": "includePagination",
"in": "query",
"description": "If set to true then a different paginated response object containing the page metadata (currentPage, totalRecords, pageSize, totalPages) will be returned. The flow objects will be in an array named \"data\".",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"example": false
},
{
"name": "isValidation",
"in": "query",
"description": "If true, validates the existence of flows by ID regardless of the caller's RBAC access. Intended for internal Task Management use cases.",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"example": false
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BasicFlow"
},
"example": [
{
"id": "65c28d9db2a2375974066579",
"name": "TestFlow",
"flowType": "FLOW",
"status": "Draft",
"orgId": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8",
"version": 1
}
]
}
}
}
},
"400": {
"description": "Bad request",
"content": {}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
}
}
},
"/{orgId}/project/{projectId}/flows:search": {
"get": {
"tags": [
"Flows"
],
"summary": "Search Flows",
"description": "Returns a list of flows in response. The search is case-sensitive.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]",
"operationId": "searchFlows",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "query",
"in": "query",
"description": "Searches for flows with the given query. The search is case-sensitive.",
"required": true,
"schema": {
"type": "string"
},
"example": "flow1"
},
{
"name": "flowType",
"in": "query",
"description": "Either of 'FLOW' or 'SUBFLOW' or 'ALL'. Default value is 'ALL'.",
"required": false,
"schema": {
"type": "string",
"default": "ALL"
},
"example": "FLOW"
},
{
"name": "page",
"in": "query",
"description": "Defines the number of the displayed page. The page number starts from 0.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"example": 0
},
{
"name": "size",
"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.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"example": 10
},
{
"name": "keyValueFilter",
"in": "query",
"description": "Filters results based on key-value pairs. Format: 'key1|value1,key2|value2'. This will add a filter on normalizedFlow collection directly instead of running query on atlas.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"example": "activityName|Queue,flowType|FLOW"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowSearchResponse"
}
}
}
},
"400": {
"description": "Bad request",
"content": {}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
}
}
},
"/{orgId}/project/{projectId}/flows/{flowId}": {
"delete": {
"tags": [
"Flows"
],
"summary": "Delete a Flow or Subflow",
"description": "Permanently deletes a flow or subflow. Flows deleted via this API are removed permanently and cannot be recovered.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]",
"operationId": "deleteFlowUsingDELETE",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "flowId",
"in": "path",
"description": "ID of the flow/subflow to delete.",
"required": true,
"schema": {
"type": "string"
},
"example": "661c7bc712eaf357de7e4aeb"
},
{
"name": "force",
"in": "query",
"description": "If 'yes', the flow is deleted even if it is still referenced by other entities. Defaults to 'no'.",
"required": false,
"schema": {
"type": "string",
"default": "no"
},
"example": "no"
},
{
"name": "skipRsEPCheck",
"in": "query",
"description": "If true, skips the check for routing strategy and entry point associations before deleting the flow.",
"required": false,
"schema": {
"type": "boolean",
"default": true
},
"example": true
},
{
"name": "flowType",
"in": "query",
"description": "Either of 'FLOW' or 'SUBFLOW'.",
"required": false,
"schema": {
"type": "string",
"default": "FLOW"
},
"example": "FLOW"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "string",
"example": "OK"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
}
}
},
"/{orgId}/project/{projectId}/flows/{flowId}:publish": {
"post": {
"tags": [
"Flows"
],
"summary": "Publish a Flow or Subflow",
"description": "Returns the published flow in response.\n\nThe Publish API validates the basic structure of the flows. We recommend manually verifying the published flows before proceeding with live traffic.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]",
"operationId": "publishFlowVersionUsingPOST",
"parameters": [
{
"name": "flowId",
"in": "path",
"description": "ID of the flow/subflow to publish.",
"required": true,
"schema": {
"type": "string"
},
"example": "661c7bc712eaf357de7e4aeb"
},
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "TrackingId",
"in": "header",
"description": "ID for tracking.",
"schema": {
"type": "string"
},
"example": "491fed1e-de7f-11ef-9cd2-0242ac120002"
},
{
"name": "skipValidation",
"in": "query",
"description": "If true, the flow's pre-publish validation is skipped. Use with care.",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"example": false
},
{
"name": "flowType",
"in": "query",
"description": "Either of 'FLOW' or 'SUBFLOW'.",
"required": false,
"schema": {
"type": "string",
"default": "FLOW"
},
"example": "FLOW"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishParameters"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowRes"
}
}
}
},
"201": {
"description": "Created",
"content": {}
},
"400": {
"description": "Bad request",
"content": {}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"x-codegen-request-body-name": "PublishParameters"
}
},
"/{orgId}/project/{projectId}/flows/{flowId}:lock": {
"post": {
"tags": [
"Flows"
],
"summary": "Lock a Flow or Subflow",
"description": "Lock a flow to prevent concurrent edits by other users. Locks expire after 15 minutes of inactivity.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]",
"operationId": "lockFlowUsingPOST",
"parameters": [
{
"name": "flowId",
"in": "path",
"description": "Flow ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "661c7bc712eaf357de7e4aeb"
},
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "flowType",
"in": "query",
"description": "Either of 'FLOW' or 'SUBFLOW'.",
"required": false,
"schema": {
"type": "string",
"default": "FLOW"
},
"example": "FLOW"
}
],
"responses": {
"200": {
"description": "Lock confirmation with expiry information.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowLockResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"409": {
"description": "Conflict \u2014 the flow is already locked by another user.",
"content": {}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
}
},
"/{orgId}/project/{projectId}/flows/{flowId}:unlock": {
"post": {
"tags": [
"Flows"
],
"summary": "Unlock a Flow or Subflow",
"description": "Release the lock on a flow to allow other users to edit it.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Contact Center Service Admin`]",
"operationId": "unlockFlowUsingPOST",
"parameters": [
{
"name": "flowId",
"in": "path",
"description": "Flow ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "661c7bc712eaf357de7e4aeb"
},
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "flowType",
"in": "query",
"description": "Either of 'FLOW' or 'SUBFLOW'.",
"required": false,
"schema": {
"type": "string",
"default": "FLOW"
},
"example": "FLOW"
}
],
"responses": {
"200": {
"description": "Unlock confirmation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowLockResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
}
},
"/{orgId}/project/{projectId}/v2/flows:validate": {
"post": {
"tags": [
"Flows"
],
"summary": "Validate a Flow",
"description": "Dry-run validate a flow definition without persisting it. Use this to check correctness before importing.\n\nNote: validation is more lenient than import. A flow that passes `:validate` can still be rejected by `:import` (for example, a missing start activity), so a successful validation does not guarantee a successful import.\n\nScope: `cjp:config_write`",
"operationId": "validateFlowV2",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
}
],
"requestBody": {
"description": "Flow JSON document to validate.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Validation result.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2ValidationResult"
}
}
}
},
"400": {
"description": "Bad Request \u2014 Invalid flow schema or missing required fields.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
}
},
"/{orgId}/project/{projectId}/v2/flows:import": {
"post": {
"tags": [
"Flows"
],
"summary": "Import a Flow",
"description": "Import a new flow from a flow definition. Creates the flow in draft state and returns the assigned flow metadata, including `flowId`.\n\nScope: `cjp:config_write`",
"operationId": "importFlowV2",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "overwrite",
"in": "query",
"description": "If true, replaces an existing flow with the same name. Defaults to false.",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"example": false
},
{
"name": "flowType",
"in": "query",
"description": "Either of 'FLOW' or 'SUBFLOW'.",
"required": false,
"schema": {
"type": "string",
"default": "FLOW"
},
"example": "FLOW"
}
],
"requestBody": {
"description": "Flow JSON document to import.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created \u2014 flow metadata including the assigned `flowId`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2Metadata"
}
}
}
},
"400": {
"description": "Bad Request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"409": {
"description": "Conflict \u2014 a flow with the same name already exists and `overwrite` is false.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2ErrorResponse"
}
}
}
},
"422": {
"description": "Unprocessable Entity \u2014 flow document failed validation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2ValidationResult"
}
}
}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
}
},
"/{orgId}/project/{projectId}/v2/flows/{flowId}": {
"get": {
"tags": [
"Flows"
],
"summary": "Get a Flow",
"description": "Retrieve the current draft of a flow as a flow document. To fetch a specific published version, use the `:export` endpoint.\n\nScope: `cjp:config_read`",
"operationId": "getFlowV2",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "flowId",
"in": "path",
"description": "Flow ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "661c7bc712eaf357de7e4aeb"
},
{
"name": "flowType",
"in": "query",
"description": "Either of 'FLOW' or 'SUBFLOW'.",
"required": false,
"schema": {
"type": "string",
"default": "FLOW"
},
"example": "FLOW"
}
],
"responses": {
"200": {
"description": "Flow JSON document.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
},
"post": {
"tags": [
"Flows"
],
"summary": "Save a Flow Draft",
"description": "Save a complete flow document as the current draft, replacing the existing draft. Pass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`",
"operationId": "saveFlowV2Draft",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "flowId",
"in": "path",
"description": "Flow ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "661c7bc712eaf357de7e4aeb"
},
{
"name": "expectedVersion",
"in": "query",
"description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
},
"example": 3
},
{
"name": "flowType",
"in": "query",
"description": "Either of 'FLOW' or 'SUBFLOW'.",
"required": false,
"schema": {
"type": "string",
"default": "FLOW"
},
"example": "FLOW"
}
],
"requestBody": {
"description": "Complete Flow JSON document.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Updated flow metadata, including the new `version`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2Metadata"
}
}
}
},
"400": {
"description": "Bad Request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"409": {
"description": "Conflict \u2014 `expectedVersion` does not match the current draft version.",
"content": {}
},
"422": {
"description": "Unprocessable Entity \u2014 flow document failed validation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2ValidationResult"
}
}
}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
},
"patch": {
"tags": [
"Flows"
],
"summary": "Patch a Flow Draft",
"description": "Apply partial updates to an existing flow draft without replacing the entire document. The patch body is a Patch Draft Contract \u2014 server-side merge, idempotent, and re-validated after the merge. The patch is rejected if the merged document fails validation, so the draft is never left in a broken state. The body may also include top-level overrides such as `name` and `description`.\n\nPass `expectedVersion` as a query parameter to enable optimistic locking; the request fails with `409 Conflict` if the server-side version does not match. Omit `expectedVersion` to skip the check.\n\nScope: `cjp:config_write`",
"operationId": "patchFlowV2Draft",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "flowId",
"in": "path",
"description": "Flow ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "661c7bc712eaf357de7e4aeb"
},
{
"name": "expectedVersion",
"in": "query",
"description": "Expected current draft version for optimistic locking. The request fails with 409 Conflict if the server-side version does not match. Omit to skip the check.",
"required": false,
"schema": {
"type": "integer",
"format": "int32"
},
"example": 3
},
{
"name": "flowType",
"in": "query",
"description": "Either of 'FLOW' or 'SUBFLOW'.",
"required": false,
"schema": {
"type": "string",
"default": "FLOW"
},
"example": "FLOW"
}
],
"requestBody": {
"description": "Patch Draft Contract document.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchDraftContract"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Updated flow metadata, including the new `version`.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2Metadata"
}
}
}
},
"400": {
"description": "Bad Request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"409": {
"description": "Conflict \u2014 `expectedVersion` does not match the current draft version.",
"content": {}
},
"422": {
"description": "Unprocessable Entity \u2014 merged flow document failed validation.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2ValidationResult"
}
}
}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
}
},
"/{orgId}/project/{projectId}/v2/flows/{flowId}:validate": {
"get": {
"tags": [
"Flows"
],
"summary": "Validate an Existing Flow Draft",
"description": "Validate the current draft of an existing flow (read-only operation).\n\nScope: `cjp:config_read`",
"operationId": "validateExistingFlowV2",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "flowId",
"in": "path",
"description": "Flow ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "661c7bc712eaf357de7e4aeb"
},
{
"name": "versionId",
"in": "query",
"description": "Version to validate. Use 'draft' for the current draft, or a specific version ObjectId.",
"required": false,
"schema": {
"type": "string",
"default": "draft"
},
"example": "draft"
},
{
"name": "flowType",
"in": "query",
"description": "Either of 'FLOW' or 'SUBFLOW'.",
"required": false,
"schema": {
"type": "string",
"default": "FLOW"
},
"example": "FLOW"
}
],
"responses": {
"200": {
"description": "Validation result.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2DraftValidationResult"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
}
},
"/{orgId}/project/{projectId}/v2/flows/{flowId}:export": {
"get": {
"tags": [
"Flows"
],
"summary": "Export a Flow",
"description": "Export a flow as a flow document for backup, migration, or version control.\n\nScope: `cjp:config_read`",
"operationId": "exportFlowV2",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "flowId",
"in": "path",
"description": "Flow ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "661c7bc712eaf357de7e4aeb"
},
{
"name": "version",
"in": "query",
"description": "Version to export. Use 'latest' for the most recent published version, 'draft' for the working copy, or a specific version ObjectId.",
"required": false,
"schema": {
"type": "string",
"default": "latest"
},
"example": "latest"
},
{
"name": "flowType",
"in": "query",
"description": "Either of 'FLOW' or 'SUBFLOW'.",
"required": false,
"schema": {
"type": "string",
"default": "FLOW"
},
"example": "FLOW"
}
],
"responses": {
"200": {
"description": "Flow JSON document.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowV2"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
}
},
"/v1/{orgId}/functions": {
"get": {
"tags": [
"Functions"
],
"summary": "List Custom Functions",
"description": "List or search custom functions in the organization. Without filters, returns all custom functions. Supports filtering by name, language, and status, plus sorting and pagination.\n\nScope: `cjp:config_read`",
"operationId": "findAll",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "isPartialMatch",
"in": "query",
"description": "Whether to search with partial matches. If `false`, search/filter is based on exact match.",
"required": false,
"schema": {
"type": "boolean",
"default": true
},
"example": true
},
{
"name": "isCaseSensitive",
"in": "query",
"description": "Whether the search should be case-sensitive. Currently applicable only to the `name` field.",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"example": false
},
{
"name": "name",
"in": "query",
"description": "Filter by function name.",
"required": false,
"schema": {
"type": "string"
},
"example": "validateZipCode"
},
{
"name": "language",
"in": "query",
"description": "Filter by programming language.",
"required": false,
"schema": {
"type": "string",
"enum": [
"js",
"py"
]
},
"example": "js"
},
{
"name": "status",
"in": "query",
"description": "Filter by one or more function statuses (comma-separated, no spaces). Case-sensitive.",
"required": false,
"schema": {
"type": "string"
},
"example": "Draft,Published"
},
{
"name": "sortBy",
"in": "query",
"description": "Comma-separated fields with order. Supported fields (case-sensitive): `name`, `language`, `status`, `lastModifiedDate`. Prefix a field with `-` for descending order; no prefix means ascending.",
"required": false,
"schema": {
"type": "string"
},
"example": "name,-lastModifiedDate"
},
{
"name": "page",
"in": "query",
"description": "Zero-based page number for the paginated query.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 0
},
"example": 0
},
{
"name": "size",
"in": "query",
"description": "Number of results per page.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 100
},
"example": 100
},
{
"name": "ids",
"in": "query",
"description": "Comma-separated list of function IDs to fetch.",
"required": false,
"schema": {
"type": "string"
},
"example": "64f1b2c3d4e5f6a7b8c9d0e1,64f1b2c3d4e5f6a7b8c9d0e2"
},
{
"name": "fields",
"in": "query",
"description": "Comma-separated list of function fields to include in the response.",
"required": false,
"schema": {
"type": "string"
},
"example": "id,name,status"
},
{
"name": "isValidation",
"in": "query",
"description": "Used by the Tenant Management team to validate the existence of functions with given IDs regardless of the user's RBAC access.",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"example": false
}
],
"responses": {
"200": {
"description": "Custom functions retrieved successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FnListResponse"
}
}
}
},
"400": {
"description": "Bad Request. A required parameter was missing or had an invalid format.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"404": {
"description": "No records found matching the supplied filters.",
"content": {}
},
"500": {
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Functions"
],
"summary": "Create a Custom Function",
"description": "Create a new custom function. The source code is provided as an escaped string and the runtime defaults to the highest supported runtime for the given language.\n\nScope: `cjp:config_write`",
"operationId": "create",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FnCreateReq"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Custom function created successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FnDataResp"
}
}
}
},
"400": {
"description": "Bad Request. Causes include: function body missing or malformed payload.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"409": {
"description": "Conflict. A function with the same name already exists in the org.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FnConflictResponse"
}
}
}
},
"500": {
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1/{orgId}/functions/{id}": {
"get": {
"tags": [
"Functions"
],
"summary": "Get a Custom Function",
"description": "Retrieve a custom function by its ID. Use `versionOrTag` to fetch a specific published version, or omit it to get the draft.\n\nScope: `cjp:config_read`",
"operationId": "findById",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "id",
"in": "path",
"description": "Custom function ID. Hexadecimal ObjectId returned by the create or list APIs.",
"required": true,
"schema": {
"type": "string"
},
"example": "64f1b2c3d4e5f6a7b8c9d0e1"
},
{
"name": "versionOrTag",
"in": "query",
"description": "Version number or publish tag of the source code to return (for example, `Dev`, `Live`, or `2`). If omitted, the draft version is returned.",
"required": false,
"schema": {
"type": "string"
},
"example": "Live"
},
{
"name": "metaDataOnly",
"in": "query",
"description": "If `true`, returns only metadata and excludes source code. If `false` or omitted, returns both metadata and source code.",
"required": false,
"schema": {
"type": "string",
"default": "false"
},
"example": "false"
}
],
"responses": {
"200": {
"description": "Custom function retrieved successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FnDataResp"
}
}
}
},
"400": {
"description": "Bad Request. A required parameter was missing or had an invalid format.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"404": {
"description": "No function found for the supplied ID.",
"content": {}
},
"500": {
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"put": {
"tags": [
"Functions"
],
"summary": "Update a Custom Function",
"description": "Update an existing custom function by ID. Replaces the draft source code and metadata with the supplied body.\n\nScope: `cjp:config_write`",
"operationId": "update",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "id",
"in": "path",
"description": "Custom function ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "64f1b2c3d4e5f6a7b8c9d0e1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FnCreateReq"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Custom function updated successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FnDataResp"
}
}
}
},
"400": {
"description": "Bad Request. Causes include: function body missing, malformed payload, or duplicate function name.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"500": {
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
},
"delete": {
"tags": [
"Functions"
],
"summary": "Delete a Custom Function",
"description": "Delete a custom function by ID. Use `isForceDeletion=true` to delete even when the function is referenced by one or more flows.\n\nScope: `cjp:config_write`",
"operationId": "delete",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "id",
"in": "path",
"description": "Custom function ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "64f1b2c3d4e5f6a7b8c9d0e1"
},
{
"name": "isForceDeletion",
"in": "query",
"description": "If `true`, deletes the function regardless of its usage in flows.",
"required": false,
"example": false,
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"204": {
"description": "Custom function deleted successfully.",
"content": {}
},
"400": {
"description": "Bad Request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"404": {
"description": "No function found for the supplied ID.",
"content": {}
},
"500": {
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1/{orgId}/functions:import": {
"post": {
"tags": [
"Functions"
],
"summary": "Import a Custom Function",
"description": "Import a custom function from a previously exported function-definition JSON file, uploaded as the multipart `file` part (not a zip or base64 envelope). Use `overwrite=true` to replace any existing function with the same name.\n\nScope: `cjp:config_write`",
"operationId": "importFn",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "overwrite",
"in": "query",
"description": "If `true`, overwrites a function with the same name if one already exists.",
"required": false,
"schema": {
"type": "boolean",
"default": false
},
"example": false
},
{
"name": "associatedRcs",
"in": "query",
"description": "Optional list of associated routing-context IDs.",
"required": false,
"example": [
"rc-1",
"rc-2"
],
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "Function-definition JSON document produced by the export API, uploaded as the multipart file part (not a zip or base64 envelope)."
}
},
"required": [
"file"
]
}
}
}
},
"responses": {
"201": {
"description": "Custom function imported successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FnDataResp"
}
}
}
},
"400": {
"description": "Bad Request. The supplied function-definition file is corrupted or malformed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"500": {
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1/{orgId}/functions/{id}:unlock": {
"post": {
"tags": [
"Functions"
],
"summary": "Unlock a Custom Function",
"description": "Release the edit lock on a custom function so that other users can edit it.\n\nScope: `cjp:config_write`",
"operationId": "unlockFnById",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "id",
"in": "path",
"description": "Custom function ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "64f1b2c3d4e5f6a7b8c9d0e1"
}
],
"responses": {
"200": {
"description": "Custom function unlocked successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FnStatusResponse"
}
}
}
},
"400": {
"description": "Bad Request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"404": {
"description": "No function found for the supplied ID.",
"content": {}
},
"500": {
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1/{orgId}/functions/{id}:lock": {
"post": {
"tags": [
"Functions"
],
"summary": "Lock a Custom Function",
"description": "Acquire an edit lock on a custom function to prevent concurrent writes by other users.\n\nScope: `cjp:config_write`",
"operationId": "lockFnById",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "id",
"in": "path",
"description": "Custom function ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "64f1b2c3d4e5f6a7b8c9d0e1"
}
],
"responses": {
"200": {
"description": "Custom function locked successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FnStatusResponse"
}
}
}
},
"400": {
"description": "Bad Request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"404": {
"description": "No function found for the supplied ID.",
"content": {}
},
"500": {
"description": "Internal Server Error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1/{orgId}/functions/{id}:publish": {
"post": {
"tags": [
"Functions"
],
"summary": "Publish a Custom Function",
"description": "Publish the latest draft of a custom function under one or more tags (`Dev`, `Test`, `Latest`, `Live`). Ensure the function has been created or updated before calling this API.\n\nScope: `cjp:config_write`",
"operationId": "publish",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "id",
"in": "path",
"description": "Custom function ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "64f1b2c3d4e5f6a7b8c9d0e1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FnPublishReq"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Custom function published successfully.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FnDataResp"
}
}
}
},
"400": {
"description": "Bad Request. The function ID is missing or has an invalid format.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"500": {
"description": "Publish failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v1/{orgId}/functions/{id}:export": {
"post": {
"tags": [
"Functions"
],
"summary": "Export a Custom Function",
"description": "Export a custom function for the given version or publish tag. Returns the plain function-definition JSON (name, language, runtime, description, source code, inputs, and outputs), suitable for re-importing via the import API.\n\nScope: `cjp:config_read`",
"operationId": "exportFn",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "id",
"in": "path",
"description": "Custom function ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "64f1b2c3d4e5f6a7b8c9d0e1"
},
{
"name": "versionOrTag",
"in": "query",
"description": "Version number or publish tag of the source code to export. If omitted, the latest published version is exported.",
"required": false,
"schema": {
"type": "string"
},
"example": "Live"
}
],
"responses": {
"200": {
"description": "Export succeeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FnExport"
}
}
}
},
"400": {
"description": "Bad Request. The function ID has an invalid format.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"500": {
"description": "Export failed.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/flow-store/{orgId}/project/{projectId}/flows/{flowId}:export": {
"get": {
"tags": [
"Legacy Flows"
],
"summary": "Export a Flow or Subflow",
"description": "**Deprecated.** Use the Flow export endpoint (`GET /flow-store/{orgId}/project/{projectId}/v2/flows/{flowId}:export`, operationId `exportFlowV2`) instead. The V1 Flow APIs operate on the raw FDL format and will continue to function but will not receive new features.\n\nReturns the exported flow/subflow in response, including associated channel metadata used to preserve channel-specific activity behavior during export and re-import.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]",
"operationId": "exportFlowVersionUsingGET",
"deprecated": true,
"parameters": [
{
"name": "flowId",
"in": "path",
"description": "ID of the flow/subflow to export.",
"required": true,
"schema": {
"type": "string"
},
"example": "661c7bc712eaf357de7e4aeb"
},
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "version",
"in": "query",
"description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'.",
"schema": {
"type": "string",
"default": "latest"
},
"example": "Version ID: 6679cb15f3398d4d1070a1e6."
},
{
"name": "flowType",
"in": "query",
"description": "Either of 'FLOW' or 'SUBFLOW'.",
"required": false,
"schema": {
"type": "string",
"default": "FLOW"
},
"example": "FLOW"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowVersionRes"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
}
}
}
},
"/flow-store/{orgId}/project/{projectId}/flows:import": {
"post": {
"tags": [
"Legacy Flows"
],
"summary": "Import a Flow or Subflow",
"description": "**Deprecated.** Use the Flow import endpoint (`POST /flow-store/{orgId}/project/{projectId}/v2/flows:import`, operationId `importFlowV2`) instead. The V1 Flow APIs operate on the raw FDL format and will continue to function but will not receive new features.\n\nReturns the imported flow/subflow in response.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]",
"operationId": "importFlowVersionUsingPOST",
"deprecated": true,
"parameters": [
{
"name": "Content-Length",
"in": "header",
"description": "Content length value in number of bytes.",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
},
"example": 10
},
{
"name": "orgId",
"in": "path",
"description": "Organization ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
{
"name": "projectId",
"in": "path",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b.",
"required": true,
"schema": {
"type": "string"
},
"example": "5e5c9ad6d61f870d6d778c1b"
},
{
"name": "overwrite",
"in": "query",
"description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no.",
"required": false,
"schema": {
"type": "string"
},
"example": "yes"
},
{
"name": "flowType",
"in": "query",
"description": "Either of 'FLOW' or 'SUBFLOW'.",
"schema": {
"type": "string"
},
"example": "FLOW"
},
{
"name": "associatedRcs",
"in": "query",
"description": "IDs of Resource Collections to associate with the imported flow.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"example": [
"rc-id-1",
"rc-id-2"
]
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file"
],
"type": "object",
"description": "Upload a file containing a `FlowVersionRes` object.",
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "Upload a file containing a `FlowVersionRes` object.",
"example": "{\"orgId\":\"8eb7da9a-c81c-4d13-b08b-38fdeb7330d8\",\"version\":4,\"id\":\"61b8fdac5c6e4644796f3fd0\",\"name\":\"GT_custom_messaging_1\",\"description\":\"\",\"comment\":null,\"variables\":[{\"name\":\"FlowVar1\",\"description\":\"\",\"type\":\"STRING\",\"value\":\"var1\",\"isCAD\":true,\"desktopLabel\":\"FlowVar1\",\"isAgentEditable\":true,\"source\":\"\",\"isReportable\":false,\"overwrite\":false,\"isSecure\":false}],\"process\":{\"activities\":{\"6c9cf7f2-ca5b-40ec-9ef5-58101cbe0747\":{\"id\":\"6c9cf7f2-ca5b-40ec-9ef5-58101cbe0747\",\"name\":\"NewPhoneContact\",\"group\":\"start\",\"properties\":{\"name\":\"NewPhoneContact\",\"event\":\"NewPhoneContact\",\"flowType\":{\"eventSourceId\":\"5f0ed8452c6b937a6789c13a\",\"eventClassificationId\":\"5f0ed85f2c6b937a6789c13b\",\"eventSpecificationId\":\"5f0ed8ea2c6b937a6789c13c\"},\"_renderRequestTimestamp\":1639513486589,\"activityId\":\"start\"}},\"e1ae108d-cceb-47c1-91c2-7e2e79ea4cba\":{\"id\":\"e1ae108d-cceb-47c1-91c2-7e2e79ea4cba\",\"name\":\"ReceiveMessage_1\",\"group\":\"action\",\"properties\":{\"name\":\"ReceiveMessage_1\",\"activityName\":\"ReceiveMessage\",\"activityId\":\"receive-message-placeholder\",\"channelName\":\"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\"timeout\":\"5\"}},\"aeb22031-294c-42bf-baeb-4106cefdfcdc\":{\"id\":\"aeb22031-294c-42bf-baeb-4106cefdfcdc\",\"name\":\"SendCustomMessage_1\",\"group\":\"action\",\"properties\":{\"name\":\"SendCustomMessage_1\",\"activityName\":\"SendCustomMessage\",\"activityId\":\"send-custom-message-placeholder\",\"channelName\":\"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\"messageType\":\"text\",\"messageText\":\"Hello from import example\",\"appendToTranscript\":false}}},\"links\":[{\"id\":\"749cfc4d-2974-4d56-aa49-bded95639c63\",\"sourceActivityId\":\"6c9cf7f2-ca5b-40ec-9ef5-58101cbe0747\",\"targetActivityId\":\"e1ae108d-cceb-47c1-91c2-7e2e79ea4cba\",\"conditionExpr\":\"out\",\"properties\":{\"value\":\"out\"}},{\"id\":\"d2b40dd9-0f09-4e9d-a9a6-d9eeea6ff8c0\",\"sourceActivityId\":\"e1ae108d-cceb-47c1-91c2-7e2e79ea4cba\",\"targetActivityId\":\"aeb22031-294c-42bf-baeb-4106cefdfcdc\",\"conditionExpr\":\"default\",\"properties\":{\"value\":\"default\"}}]},\"diagram\":{\"widgets\":{},\"properties\":{\"offsetX\":0,\"offsetY\":0,\"zoom\":100,\"gridSize\":20}},\"flowId\":\"617b6dbdf4ca106768181aad\",\"eventFlows\":{\"eventsMap\":{\"GLOBAL_EVENTS\":{\"id\":\"GLOBAL_EVENTS\",\"name\":\"name\",\"description\":\"description\",\"process\":{\"activities\":{},\"links\":[]},\"onEvents\":{},\"diagram\":{\"widgets\":{},\"properties\":{}}}},\"properties\":{\"offsetX\":0,\"offsetY\":0,\"zoom\":100,\"gridSize\":20}},\"runtimeVariables\":[],\"associatedChannels\":[{\"channelType\":\"customMessaging\",\"id\":\"f47ac10b-58cc-4372-a567-0e02b2c3d479\",\"name\":\"Task Queue 1\"}],\"validating\":true,\"validationResults\":[],\"createdBy\":\"user@company.com\",\"createdDate\":\"2021-12-14T20:25:16.792\",\"lastModifiedDate\":\"2021-12-14T20:25:16.792\",\"lastModifiedBy\":\"user@company.com\"}"
}
}
}
}
}
},
"responses": {
"201": {
"description": "CREATED: Flow or Subflow is created.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BasicFlow"
}
}
}
},
"400": {
"description": "BAD REQUEST: Possible causes - Import file size exceeded the limit. File parse error. Flow name is empty. Invalid flow type. Invalid activity.",
"content": {}
},
"401": {
"description": "Unauthorized",
"content": {}
},
"403": {
"description": "Forbidden",
"content": {}
},
"404": {
"description": "Not Found",
"content": {}
},
"409": {
"description": "CONFLICT: A flow/subflow with the same name already exists.",
"content": {}
},
"500": {
"description": "Internal Server Error",
"content": {}
}
},
"x-codegen-request-body-name": "file"
}
},
"/templates": {
"get": {
"tags": [
"Templates"
],
"summary": "List Flow Templates",
"description": "List available flow templates that can be used to create new flows.\n\nScope: `cjp:config_read`",
"operationId": "listFlowTemplates",
"parameters": [
{
"name": "type",
"in": "query",
"description": "Filter by flow or subflow.",
"required": false,
"schema": {
"type": "string",
"enum": [
"flow",
"subflow"
]
},
"example": "flow"
}
],
"responses": {
"200": {
"description": "Array of template metadata with IDs, names, and descriptions.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowTemplate"
},
"example": [
{
"id": "tmpl-customer-callback",
"name": "Customer Callback",
"description": "Offers a callback when estimated wait time exceeds a threshold.",
"type": "flow"
}
]
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
}
},
"/templates/{id}": {
"get": {
"tags": [
"Templates"
],
"summary": "Get a Flow Template",
"description": "Retrieve a specific flow template by its ID. Use this to inspect a template's flow structure before creating a flow from it.\n\nScope: `cjp:config_read`",
"operationId": "getFlowTemplate",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Template ID.",
"required": true,
"schema": {
"type": "string"
},
"example": "tmpl-customer-callback"
}
],
"responses": {
"200": {
"description": "Template metadata and flow structure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FlowTemplate"
}
}
}
},
"401": {
"description": "Unauthorized.",
"content": {}
},
"403": {
"description": "Forbidden.",
"content": {}
},
"404": {
"description": "Not Found.",
"content": {}
},
"429": {
"description": "Too Many Requests.",
"content": {}
}
}
}
},
"/admin/v1/api/person/workspace-id/{workspaceId}/person-id/{personId}": {
"delete": {
"tags": [
"Journey - Customer Identification API"
],
"summary": "Delete specific Person by id",
"description": "Delete Person Details searched by Person id in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope",
"operationId": "deletePersonbyId",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "personId",
"in": "path",
"description": "Person ID",
"required": true,
"schema": {
"type": "string"
},
"example": "638844db13272c52239c525d"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonResponse"
}
}
}
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"patch": {
"tags": [
"Journey - Customer Identification API"
],
"summary": "Add/Remove/Replace details of a Person",
"description": "The Patch Api can be used to add/remove identities(email, phone, customerId) or replace firstName and lastName of an Individual. We support only add, replace and remove operations. \n\nFor a more information on Patch Requests, see this [JSON PATCH guide](https://jsonpatch.com). \n\nRole and Scope: Requires id full admin role with cjp:config_write or any role with cjp:user or cjp:config_write scope.",
"operationId": "addRemoveAliases",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "personId",
"in": "path",
"description": "Person ID",
"required": true,
"schema": {
"type": "string"
},
"example": "638844db13272c52239c525d"
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/PatchRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonResponse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/person/add-identities/workspace-id/{workspaceId}/person-id/{personId}": {
"patch": {
"tags": [
"Journey - Customer Identification API"
],
"summary": "Add one/more Identities to a person",
"description": "This Patch Api can be used to add identities(email, phone, customerId) to a person.\n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope.",
"operationId": "addIdentitiesToPerson",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "personId",
"in": "path",
"description": "Person ID",
"required": true,
"schema": {
"type": "string"
},
"example": "638844db13272c52239c525d"
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AddIdentitiesToPersonRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError400"
}
}
}
},
"401": {
"description": "UnAuthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError401"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/person/remove-identities/workspace-id/{workspaceId}/person-id/{personId}": {
"patch": {
"tags": [
"Journey - Customer Identification API"
],
"summary": "Remove one/more Identities from a person",
"description": "This Patch Api can be used to remove identities(email, phone, customerId) from a person.\n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope.",
"operationId": "removeIdentitiesFromPerson",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "personId",
"in": "path",
"description": "Person ID",
"required": true,
"schema": {
"type": "string"
},
"example": "638844db13272c52239c525d"
}
],
"requestBody": {
"description": "List Of Identities",
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
},
"example": [
"ram@cisco.com",
"1e4qre2g7"
]
}
},
"required": true
},
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError400"
}
}
}
},
"401": {
"description": "UnAuthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError401"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/person/workspace-id/{workspaceId}": {
"get": {
"tags": [
"Journey - Customer Identification API"
],
"summary": "Get all or a specific Person Details",
"description": "Get Person Details in JDS. If personId is provided by query parameter, this returns the Person whose personId matches the parameter.\nIf not, this will return ALL the Persons within the organization and workspace. \n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or it requires any role with cjp:user, cjp:config_write or cjp:config_read scope.",
"operationId": "getPersonDetails",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "personId",
"in": "query",
"description": "Person ID",
"required": false,
"schema": {
"type": "string"
},
"example": "1eb65fdfsadw34ae0e10f"
},
{
"name": "filter",
"in": "query",
"description": "Optional filter which can be applied to the elements to be fetched. \n\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](https://developer.here.com/documentation/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).",
"required": false,
"schema": {
"type": "string"
},
"example": "firstName==Ram"
},
{
"name": "sortBy",
"in": "query",
"description": "Sort By Field",
"required": false,
"schema": {
"type": "string"
},
"example": "firstName"
},
{
"name": "sort",
"in": "query",
"description": "Sort direction",
"required": false,
"schema": {
"type": "string"
},
"example": "DESC"
},
{
"name": "page",
"in": "query",
"description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.",
"required": false,
"schema": {
"type": "integer"
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items to be displayed on a page",
"required": false,
"schema": {
"type": "integer"
},
"example": 10
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonGetResponse"
}
}
}
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"Journey - Customer Identification API"
],
"summary": "Create a Person",
"description": "This API helps to create a Person in JDS.\n\nRole and Scope: Requires id full admin OR any role with cjp:config_write scope.",
"operationId": "createPerson",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOrUpdatePersonRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError400"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/person/merge/workspace-id/{workspaceId}/primary-person-id/{primaryPersonId}": {
"post": {
"tags": [
"Journey - Customer Identification API"
],
"summary": "Merges Identities to a Primary Identity",
"description": "Merges one/more Identities to a **Primary** Individual in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write scope.",
"operationId": "mergeAliases",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "primaryPersonId",
"in": "path",
"description": "Primary Person ID",
"required": true,
"schema": {
"type": "string"
},
"example": "638844db13272c52239c525d"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MergePersonsRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonResponse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/person/merge-identities/workspace-id/{workspaceId}": {
"post": {
"tags": [
"Journey - Customer Identification API"
],
"summary": "Creates or merges aliases to an Individual in JDS",
"description": "This API enables you to consolidate multiple customer identifiers into a single, unified profile effortlessly. By integrating it with your Flow Designer, you can automatically retrieve and merge customer identifiers from various systems, such as your CRM or other third-party tools. This integration ensures all relevant data is consolidated into one profile, enhancing personalization and streamlining customer interactions. \n\n**Adding a New Alias** - To associate an additional alias (e.g., a new phone number) with an existing customer profile, simply update the API with the new identifier while leaving the existing identifiers intact. The system will automatically merge the new alias into the current profile, maintaining a comprehensive view of the customer.\n\n**Removing an Alias** - If you need to delete an alias from a customer\u2019s profile, set the override flag to true in your API request. Include only the identifiers you wish to retain in the payload. The system will remove any identifiers not included in the updated payload, keeping the profile streamlined and up-to-date.\n\nRole and Scope: Requires id full admin OR any role with cjp:config_write scope.",
"operationId": "mergeIdentities",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MergePersonRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonResponse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/person/workspace-id/{workspaceId}/aliases/{aliases}": {
"get": {
"tags": [
"Journey - Customer Identification API"
],
"summary": "Search for an Identity via aliases",
"description": "Get one or more Person Details searched by aliases in JDS. Multiple aliases should be separated by a comma.\n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or it requires any role with cjp:user, cjp:config_write or cjp:config_read scope.",
"operationId": "getPersonbyAliases",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "aliases",
"in": "path",
"description": "Aliases to search for. Multiple aliases should be separated by a comma. \n\n In case the alias(es) contain(s) non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.",
"required": true,
"schema": {
"type": "string"
},
"example": "johndoe@domain1.com,2771154"
},
{
"name": "sortBy",
"in": "query",
"description": "Sort By Field",
"required": false,
"schema": {
"type": "string"
},
"example": "firstName"
},
{
"name": "sort",
"in": "query",
"description": "Sort direction",
"required": false,
"schema": {
"type": "string"
},
"example": "DESC"
},
{
"name": "page",
"in": "query",
"description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.",
"required": false,
"schema": {
"type": "integer"
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items to be displayed on a page.",
"required": false,
"schema": {
"type": "integer"
},
"example": 10
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonGetResponse"
}
}
}
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/publish/v1/api/event": {
"post": {
"tags": [
"Journey - Data Ingestion API"
],
"summary": "Journey Event Posting",
"description": "Journey Event Posting API accepts events that describe what occurred, when, and by whom on every interaction across touch points and applications. Data Ingestion is based on Cloud Events specification for describing event data in a common way. API accepts data in the form of POST with support for Header based authorization. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or any role with cjp:config_write scope.",
"operationId": "journeyEventPosting",
"parameters": [
{
"name": "workspaceId",
"in": "query",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyCloudEventModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyEventPostingResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"409": {
"description": "Resource already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError409"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError429"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/profile-view-template/workspace-id/{workspaceId}/template-id/{templateId}": {
"get": {
"tags": [
"Journey - Profile Creation & Insights API"
],
"summary": "Get A specific Template searched by template id",
"description": "Get Template details by template Id in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_write scope.",
"operationId": "getTemplatebyId",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "templateId",
"in": "path",
"description": "Template ID",
"required": true,
"schema": {
"type": "string"
},
"example": "638844db13272c52239c525d"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileResponse"
}
}
}
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"Journey - Profile Creation & Insights API"
],
"summary": "Update existing ProfileViewTemplate",
"description": "Update existing Profile View Template in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope.",
"operationId": "updateProfileViewTemplate",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "templateId",
"in": "path",
"description": "Template ID",
"required": true,
"schema": {
"type": "string"
},
"example": "638844db13272c52239c525d"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOrUpdateTemplateModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError400"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"Journey - Profile Creation & Insights API"
],
"summary": "Delete Template by template Id",
"description": "Delete Template By template id in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope.",
"operationId": "deleteTemplatebyId",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "templateId",
"in": "path",
"description": "Template ID",
"required": true,
"schema": {
"type": "string"
},
"example": "638844db13272c52239c525d"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateResponseModel"
}
}
}
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/profile-view-template/workspace-id/{workspaceId}": {
"get": {
"tags": [
"Journey - Profile Creation & Insights API"
],
"summary": "Get All Template Details",
"description": "Get Template details by Organization Id and workspaceId in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.",
"operationId": "getAllTemplates",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "filter",
"in": "query",
"description": "Optional filter which can be applied to the elements to be fetched. \n\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](https://developer.here.com/documentation/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).",
"required": false,
"schema": {
"type": "string"
},
"example": "createdBy==satjonna@cisco.com"
},
{
"name": "sort",
"in": "query",
"description": "Sort direction",
"required": false,
"schema": {
"type": "string"
},
"example": "DESC"
},
{
"name": "sortBy",
"in": "query",
"description": "Sort By Field",
"required": false,
"schema": {
"type": "string"
},
"example": "updatedAt"
},
{
"name": "page",
"in": "query",
"description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.",
"required": false,
"schema": {
"type": "integer"
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items to be displayed on a page.",
"required": false,
"schema": {
"type": "integer"
},
"example": 10
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileGetResponse"
}
}
}
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"Journey - Profile Creation & Insights API"
],
"summary": "Create Template",
"description": "Creates a Profile View Template in JDS. \n\n **Role and Scope**: Requires id full admin or any role with cjp:config_write scope.\n\n **Template with single rule**: \n ```\n {\n \"name\": \"ClosedCaller\",\n \"attributes\": [\n {\n \"version\": \"0.1\",\n \"event\": \"Closed Queue\",\n \"metaDataType\": \"string\",\n \"metaData\": \"category\",\n \"limit\": 100,\n \"displayName\": \"ClosedCaller\",\n \"lookBackDurationType\": \"minutes\",\n \"lookBackPeriod\": 5,\n \"aggregationMode\": \"Count\",\n \"rules\": {\n \"logic\": \"SINGLE\",\n \"condition\": \"Closed Queue,category,string,Value EQ Closed\"\n },\n \"widgetAttributes\": {\n \"type\": \"table\"\n },\n \"verbose\": false\n }\n ]\n }\n ```\n\n\n **Example Event:** \n ```\n {\n \"id\": \"{{$guid}}\",\n \"specversion\": \"1.0\",\n \"type\": \"Closed Queue\",\n \"source\": \"Voice%20Contact\",\n \"identity\": \"jes@gmail.com\",\n \"identitytype\": \"email\",\n \"datacontenttype\": \"application/json\",\n \"data\": {\n \"Email\": \"jes@gmail.com\",\n \"CallsQueuedNow\": \"Use GetQueueInfoNode Values\",\n \"OldestCallTime\": \"Use GetQueueInfoNode Values\",\n \"LoggedOnAgents\": \"Use GetQueueInfoNode Values\",\n \"PIQ\": \"Use GetQueueInfoNode Values\",\n \"EWT\": \"Use GetQueueInfoNode Values\",\n \"category\": \"Closed\",\n \"origin\": \"Past Due - 1st Notification\",\n \"channelType\": \"QueueCall\",\n \"channelBreakout\": \"voice\"\n }\n }\n ```\n\n\n **Key components of the rule:** \n * template.event: This refers to the specific event type you want to match (e.g., \"Closed Queue\").\n * event.type: This refers to the actual event type present in the event data.\n * event.data: This is the dictionary/object containing all the metadata associated with the event.\n * template.rules.condition - category: This is the specific metadata field you want to compare within event.data.\n * template.rules.condition - string: This indicates that the category metadata is a string type.\n * template.rules.condition - Value EQ Closed: This defines the condition: the value of the category field (as a string) must be equal to \"Closed\".\n\n\n **Evaluation process:** \n 1. The rule checks if template.event matches the event.type in the incoming event.\n 2. If they match, the rule retrieves the value of the category field from event.data.\n 3. It then compares the value of category (treated as a string) to \"Closed\" using an equality operator (EQ).\n 4. If the values are equal, the condition evaluates to True and creates a progressive profile for the identity. Otherwise, it evaluates to False.\n \n The template has lookBackPeriod and lookBackDurationType which decide how long to look back for the calculation. In the above template, it fetches events triggered in the last 5 minutes and performs the aggregation mode on the data received from rules.\n \n * When the aggregation mode is Value, the profile result will have the value of the rule as the output.\n * When the aggregation mode is Count, the profile will have the count of events with category closed in the past 5 minutes.\n * When the aggregation mode is Distinct, the profile will have the value closed.\n * When aggregation mode is Sum, the data type should be Integer or double and it will be the sum of all matching values in the last 5 minutes.\n * When aggregation mode is Max, the data type should be Integer or double and it will be the max of all matching values in the last 5 minutes.\n * When aggregation mode is Min, the data type should be Integer or double and it will be the min of all matching values in the last 5 minutes.\n * When aggregation mode is Average, the data type should be Integer or double and it will be the average of all matching values in the last 5 minutes.\n\n\n **Example template with multiple rules :** \n ```\n1. {\n2. \"name\": \"sample-template-multi-condition\",\n3. \"attributes\": [\n4. {\n5. \"version\": \"0.1\",\n6. \"event\": \"Quote\",\n7. \"metaDataType\": \"string\",\n8. \"metaData\": \"email\",\n9. \"limit\": 1,\n10. \"displayName\": \"Email\",\n11. \"lookBackDurationType\": \"days\",\n12. \"lookBackPeriod\": 50,\n13. \"aggregationMode\": \"Value\",\n14. \"rules\": {\n15. \"args\": [\n16. \"Quote,isEV,string,Value EQ Yes\",\n17. \"Quote,isEV,string,Value EQ No\",\n18. {\n19. \"args\": [\n20. \"Quote,make,string,Value EQ Honda\",\n21. \"Quote,model,string,Value EQ CR-V\"\n22. ],\n23. \"logic\": \"AND\"\n24. }\n25. ],\n26. \"logic\": \"OR\"\n27. },\n28. \"widgetAttributes\": {\n29. \"type\": \"table\"\n30. },\n31. \"verbose\": false\n32. }\n33. ]\n34. }\n ```\n1. In the above template we have multiple rules.\n2. The arguments in line 20 and 21 are evaluated with logical AND condition.\n3. Then arguments in line 16 and 17 along with the result for 20 AND 21 are evaluated with logical OR (line 26).\n",
"operationId": "createTemplate",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOrUpdateTemplateModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError400"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/profile-view-template/workspace-id/{workspaceId}/template-name/{templateName}": {
"get": {
"tags": [
"Journey - Profile Creation & Insights API"
],
"summary": "Get A specific Template searched by template name",
"description": "Get Template details by template Name in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write or cjp:config_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.",
"operationId": "getTemplatebyName",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "templateName",
"in": "path",
"description": "Template Name",
"required": true,
"schema": {
"type": "string"
},
"example": "sample-template"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileResponse"
}
}
}
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/v1/api/progressive-profile-view/workspace-id/{workspaceId}/person-id/{personId}/template-name/{templateName}": {
"get": {
"tags": [
"Journey - Profile Creation & Insights API"
],
"summary": "Historic Progressive Profile View by Template Name",
"description": "Get Historic Progressive Profile View in JDS. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.",
"operationId": "getProgressiveProfileViewByTemplateName",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "6377dafe02e7cc19b03a71b7"
},
{
"name": "personId",
"in": "path",
"description": "Person ID",
"required": true,
"schema": {
"type": "string"
},
"example": "56fghn344678defjs878"
},
{
"name": "templateName",
"in": "path",
"description": "Template Name",
"required": true,
"schema": {
"type": "string"
},
"example": "insurance-template"
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProgressiveProfileViewStreamModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError400"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/v1/api/progressive-profile-view/workspace-id/{workspaceId}/person-id/{personId}/template-id/{templateId}": {
"get": {
"tags": [
"Journey - Profile Creation & Insights API"
],
"summary": "Historic Progressive Profile View",
"description": "Get Historic Progressive Profile View in JDS. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.",
"operationId": "getProgressiveProfileView",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "6377dafe02e7cc19b03a71b7"
},
{
"name": "personId",
"in": "path",
"description": "Person ID",
"required": true,
"schema": {
"type": "string"
},
"example": "56fghn344678defjs878"
},
{
"name": "templateId",
"in": "path",
"description": "Template ID",
"required": true,
"schema": {
"type": "string"
},
"example": "56fghn344678defjs878"
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProgressiveProfileViewStreamModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError400"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/v1/api/progressive-profile-view/workspace-id/{workspaceId}/identity/{identity}/template-name/{templateName}": {
"get": {
"tags": [
"Journey - Profile Creation & Insights API"
],
"summary": "Historic Progressive Profile View By Template Name",
"description": "Get Historic Progressive Profile View in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes",
"operationId": "getProgressiveProfileViewByIdentityAndTemplateName",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "6377dafe02e7cc19b03a71b7"
},
{
"name": "identity",
"in": "path",
"description": "Identity",
"required": true,
"schema": {
"type": "string"
},
"example": "ram@cisco.com"
},
{
"name": "templateName",
"in": "path",
"description": "Template Name",
"required": true,
"schema": {
"type": "string"
},
"example": "insurance-template"
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProgressiveProfileViewStreamModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError400"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/v1/api/progressive-profile-view/workspace-id/{workspaceId}/identity/{identity}/template-id/{templateId}": {
"get": {
"tags": [
"Journey - Profile Creation & Insights API"
],
"summary": "Historic Progressive Profile View By Template Id",
"description": "Get Historic Progressive Profile View in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes",
"operationId": "getProgressiveProfileViewByIdentityAndTemplateId",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "6377dafe02e7cc19b03a71b7"
},
{
"name": "identity",
"in": "path",
"description": "identity",
"required": true,
"schema": {
"type": "string"
},
"example": "ram@cisco.com"
},
{
"name": "templateId",
"in": "path",
"description": "Template ID",
"required": true,
"schema": {
"type": "string"
},
"example": "56fghn344678defjs878"
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProgressiveProfileViewStreamModel"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError400"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/v1/api/progressive-profile-view/stream/workspace-id/{workspaceId}/identity/{identity}/template-name/{templateName}": {
"get": {
"tags": [
"Journey - Profile Creation & Insights API"
],
"summary": "Stream Progressive profile Views By Template Name",
"description": "Real-time streaming enables API consumers to listen for Progressive profile Views as it created/updated as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.",
"operationId": "streamProgressiveProfileViewsByTemplateName",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "6377dafe02e7cc19b03a71b7"
},
{
"name": "identity",
"in": "path",
"description": "Identity to search Progressive Profile View for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.",
"required": true,
"schema": {
"type": "string"
},
"example": "srindura@gmail.com"
},
{
"name": "templateName",
"in": "path",
"description": "Template Name",
"required": true,
"schema": {
"type": "string"
},
"example": "insurance-template"
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProgressiveProfileViewModel"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"409": {
"description": "Resource already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError409"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError429"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/v1/api/progressive-profile-view/stream/workspace-id/{workspaceId}/identity/{identity}/template-id/{templateId}": {
"get": {
"tags": [
"Journey - Profile Creation & Insights API"
],
"summary": "Stream Progressive profile Views By Template Id",
"description": "Real-time streaming enables API consumers to listen for Progressive profile Views as it created/updated as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.",
"operationId": "streamProgressiveProfileViews",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "6377dafe02e7cc19b03a71b7"
},
{
"name": "identity",
"in": "path",
"description": "Identity to search Progressive Profile View for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.",
"required": true,
"schema": {
"type": "string"
},
"example": "srindura@gmail.com"
},
{
"name": "templateId",
"in": "path",
"description": "Template ID",
"required": true,
"schema": {
"type": "string"
},
"example": "56fghn344678defjs878"
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProgressiveProfileViewModel"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"409": {
"description": "Resource already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError409"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError429"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/v1/api/events/workspace-id/{workspaceId}": {
"get": {
"tags": [
"Journey - Profile Creation & Insights API"
],
"summary": "Historic Journey Events",
"description": "Getting Historic Customer Journey Events from Pinot. These events are append-only, immutable data ledger that can be queried to retrieve snapshot of latest events that moment in time or historically to play-back events as they occurred to understand or analyze Journeys using ML/AI models. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.",
"operationId": "historicEvents",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "6377dafe02e7cc19b03a71b7"
},
{
"name": "identity",
"in": "query",
"description": "Identity to search events for. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.",
"required": false,
"schema": {
"type": "string"
},
"example": "ram@cisco.com"
},
{
"name": "sortBy",
"in": "query",
"description": "sort By Field",
"required": false,
"schema": {
"type": "string"
},
"example": "identity"
},
{
"name": "sort",
"in": "query",
"description": "sort direction",
"required": false,
"schema": {
"type": "string"
},
"example": "desc"
},
{
"name": "filter",
"in": "query",
"description": "Optional filter which can be applied to the elements to be fetched.\n\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](https://developer.here.com/documentation/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).",
"required": false,
"schema": {
"type": "string"
},
"example": "identityType=='phone'"
},
{
"name": "data",
"in": "query",
"description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\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](https://developer.here.com/documentation/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).",
"required": false,
"schema": {
"type": "string"
},
"example": "agentid=='3224343fddfdfdf'"
},
{
"name": "page",
"in": "query",
"description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.",
"required": false,
"schema": {
"type": "integer"
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items to be displayed on a page.",
"required": false,
"schema": {
"type": "integer"
},
"example": 10
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyEventStreamModel"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"409": {
"description": "Resource already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError409"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError429"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/v1/api/events/stream/workspace-id/{workspaceId}/identity/{identity}": {
"get": {
"tags": [
"Journey - Profile Creation & Insights API"
],
"summary": "Stream Events By Identity",
"description": "Real-time streaming enables API consumers to listen for events as it arrives as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination. Optionally accepts filter and data parameters slice/dice further. \n\nRole and Scope: Requires id full admin role with cjds:admin_org_write or cjds:admin_org_read scope. Or requires any role with cjp:user, cjp:config_write or cjp:config_read scope.",
"operationId": "streamEventsByIdentity",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "6377dafe02e7cc19b03a71b7"
},
{
"name": "identity",
"in": "path",
"description": "Person Identity. \n\n In case the identity contains non-uri-encodable characters, eg: '+', '>' etc, you can URL-encode the same and then pass it as parameter.",
"required": true,
"schema": {
"type": "string"
},
"example": "ram@cisco.com"
},
{
"name": "filter",
"in": "query",
"description": "Optional filter which can be applied to the elements to be fetched.\n\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](https://developer.here.com/documentation/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).",
"required": false,
"schema": {
"type": "string"
},
"example": "identityType=='phone'"
},
{
"name": "data",
"in": "query",
"description": "Optional filter on data filed which can be applied to the elements to be fetched.\n\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](https://developer.here.com/documentation/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).",
"required": false,
"schema": {
"type": "string"
},
"example": "agentid=='3224343fddfdfdf'"
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyCloudEventModel"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"409": {
"description": "Resource already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError409"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError429"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/wxcc-subscription/workspace-id/{workspaceId}": {
"get": {
"tags": [
"Journey - Subscription API"
],
"summary": "Get WXCC Subscription",
"description": "Get WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes",
"operationId": "getWXCCSubscription",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "6377dafe02e7cc19b03a71b7"
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WXCCSubscriptionResponseList"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"409": {
"description": "Resource already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError409"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError429"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"Journey - Subscription API"
],
"summary": "Create WXCC Subscription",
"description": "Create WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes",
"operationId": "createWXCCSubscription",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "6377dafe02e7cc19b03a71b7"
}
],
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WXCCSubscriptionResponseList"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"409": {
"description": "Resource already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError409"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError429"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"Journey - Subscription API"
],
"summary": "Delete WXCC Subscription",
"description": "Delete WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes",
"operationId": "deleteWXCCSubscription",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "6377dafe02e7cc19b03a71b7"
}
],
"responses": {
"200": {
"description": "No Content",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"409": {
"description": "Resource already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError409"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError429"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/journey-actions/workspace-id/{workspaceId}": {
"get": {
"tags": [
"Journey - Trigger Actions API"
],
"summary": "Get all Journey Actions",
"description": "Get all Journey Actions in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write or cjp:config_read scope.",
"operationId": "getAllJourneyActions",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "sortBy",
"in": "query",
"description": "Sort By Field",
"required": false,
"schema": {
"type": "string"
},
"example": "updatedAt"
},
{
"name": "sort",
"in": "query",
"description": "Sort direction",
"required": false,
"schema": {
"type": "string"
},
"example": "ASC"
},
{
"name": "page",
"in": "query",
"description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve. The page numbering starts with 0.",
"required": false,
"schema": {
"type": "integer"
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items to be displayed on a page.",
"required": false,
"schema": {
"type": "integer"
},
"example": 10
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyActionGetResponse"
}
}
}
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/journey-actions/workspace-id/{workspaceId}/template-id/{templateId}": {
"get": {
"tags": [
"Journey - Trigger Actions API"
],
"summary": "Get all Journey Actions for a template",
"description": "Get all Journey Actions for a template in JDS. \n\nRole and Scope: It requires id full admin or any role with cjp:config_read or cjp:config_write scope.",
"operationId": "getAllJourneyActionsForATemplate",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "templateId",
"in": "path",
"description": "Template ID",
"required": true,
"schema": {
"type": "string"
},
"example": "56n3ugx44678998djs878"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyActionGetResponse"
}
}
}
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"Journey - Trigger Actions API"
],
"summary": "Create a new Journey Action",
"description": "Create a new Journey Action in JDS. \n\n **Role and Scope**: It requires id full admin or any role with cjp:config_write scope.\n\n **Sample Input for Creating new Journey action**: \n ```\n {\n \"name\": \"Closed Queue Action\",\n \"cooldownPeriodInMinutes\": 1,\n \"rules\": {\n \"logic\": \"SINGLE\",\n \"condition\": \"Closed Queue,category,string,Value GTE 2\"\n },\n \"actionTriggers\": [\n {\n \"type\": \"Webhook\",\n \"webhookURL\": \"https://hooks.us.webexconnect.io/events/6M347NJ6\",\n \"attributes\": {\n \"httpverb\": \"post\",\n \"requestbody\": \"{\\\"SMS\\\":\\\"12263762551\\\",\\\"callID\\\":\\\"\\\",\\\"MessageToSend\\\":\\\"Hello there!\\\"}\"\n }\n }\n ],\n \"isActive\": true\n }\n ```\nThe action trigger's evaluation process is predicated on the progressive profile that has been established. \nIn this specific action trigger, the rule assessment verifies whether the progressive profile value from the prior template evaluation was in excess of 2. \nIf this condition is met, the webhook is subsequently activated.\n\n\nPrior to rule evaluation for actions, several conditions must be satisfied. \nFirstly, the event associated with the template must align with the rule event, which, in this case, is 'Closed Queue'. \nSecondly, the metadata assigned to the template must correspond with the metadata set by the rules, which in this context, is 'category'. \nThirdly, the aggregation mode of the template must be equivalent to the rules' aggregation mode, which is 'value' in this instance. \nFinally, the operator of the template's aggregation mode must match those defined for 'value'. \nIn this scenario, it is 'GTE' (greater than or equal), which is an accepted value for 'value'.\n",
"operationId": "createJourneyActionConfiguration",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "templateId",
"in": "path",
"description": "Template ID",
"required": true,
"schema": {
"type": "string"
},
"example": "56n3ugx44678998djs878"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyActionConfigurationUpsertRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyActionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError400"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/journey-actions/workspace-id/{workspaceId}/template-id/{templateId}/action-name/{actionName}": {
"get": {
"tags": [
"Journey - Trigger Actions API"
],
"summary": "Get specific Journey Action By Name",
"description": "Get specific Journey Action By Name in JDS. \n\nRole and Scope:It requires id full admin or any role with cjp:config_read or cjp:config_write scope.",
"operationId": "getJourneyActionDetailsByName",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "templateId",
"in": "path",
"description": "Template ID",
"required": true,
"schema": {
"type": "string"
},
"example": "56n3ugx44678998djs878"
},
{
"name": "actionName",
"in": "path",
"description": "Action Name",
"required": true,
"schema": {
"type": "string"
},
"example": "demo action"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyActionResponse"
}
}
}
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/journey-actions/workspace-id/{workspaceId}/template-id/{templateId}/action-id/{actionId}": {
"get": {
"tags": [
"Journey - Trigger Actions API"
],
"summary": "Get specific Journey Action By ActionId",
"description": "Get specific Journey Action By ActionId in JDS. \n\nRole and Scope: It requires id full admin role with cjp:config_read or cjp:config_write scope.",
"operationId": "getJourneyActionDetailsById",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "templateId",
"in": "path",
"description": "Template ID",
"required": true,
"schema": {
"type": "string"
},
"example": "56n3ugx44678998djs878"
},
{
"name": "actionId",
"in": "path",
"description": "Action ID",
"required": true,
"schema": {
"type": "string"
},
"example": "73n3ugx12678998djs878"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyActionResponse"
}
}
}
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"Journey - Trigger Actions API"
],
"summary": "Update existing Journey Action",
"description": "Update existing Journey Action in JDS. \n\nRole and Scope: It requires id full admin or any role with cjp:config_write scope.",
"operationId": "updateJourneyActionConfiguration",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "templateId",
"in": "path",
"description": "Template ID",
"required": true,
"schema": {
"type": "string"
},
"example": "56n3ugx44678998djs878"
},
{
"name": "actionId",
"in": "path",
"description": "Action ID",
"required": true,
"schema": {
"type": "string"
},
"example": "73n3ugx12678998djs878"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyActionConfigurationUpsertRequestModel"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyActionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError400"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"Journey - Trigger Actions API"
],
"summary": "Delete Journey Action configuration By ActionId",
"description": "Delete Journey Action configuration By ActionId in JDS. \n\nRole and Scope: It requires id full admin role with cjp:config_write scope.",
"operationId": "deleteJourneyActionById",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "63feryn344678998djs878"
},
{
"name": "templateId",
"in": "path",
"description": "Template ID",
"required": true,
"schema": {
"type": "string"
},
"example": "56n3ugx44678998djs878"
},
{
"name": "actionId",
"in": "path",
"description": "Action ID",
"required": true,
"schema": {
"type": "string"
},
"example": "73n3ugx12678998djs878"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JourneyActionConfigResponseModel"
}
}
}
},
"404": {
"description": "Not found"
},
"500": {
"description": "Internal error"
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/workspace/workspace-id/{workspaceId}": {
"get": {
"tags": [
"Journey - Workspace management API"
],
"summary": "Get Workspace",
"description": "Get workspace details. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes",
"operationId": "getWorkspaceById",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "6377dafe02e7cc19b03a71b7"
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"409": {
"description": "Resource already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError409"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError429"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
},
"put": {
"tags": [
"Journey - Workspace management API"
],
"summary": "Update Workspace",
"description": "Update workspace by Id. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes",
"operationId": "updateWorkspaceById",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "6377dafe02e7cc19b03a71b7"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"409": {
"description": "Resource already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError409"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError429"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
},
"delete": {
"tags": [
"Journey - Workspace management API"
],
"summary": "Delete Workspace",
"description": "Delete Workspace By Id. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_write or cjp:config_write scopes",
"operationId": "deleteWorkspaceById",
"parameters": [
{
"name": "workspaceId",
"in": "path",
"description": "Workspace ID",
"required": true,
"schema": {
"type": "string"
},
"example": "6377dafe02e7cc19b03a71b7"
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"409": {
"description": "Resource already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError409"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError429"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/admin/v1/api/workspace": {
"get": {
"tags": [
"Journey - Workspace management API"
],
"summary": "Get All Workspaces",
"description": "Get All Workspaces. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:admin_org_read or cjds:admin_org_write scopes or cjp:config_read or cjp:config_write scopes",
"operationId": "getAllWorkspaces",
"parameters": [
{
"name": "filter",
"in": "query",
"description": "Optional filter which can be applied to the elements to be fetched. \n\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](https://developer.here.com/documentation/data-client-library/dev_guide/client/rsql.html). For a list of supported operators, see this [syntax guide](https://github.com/perplexhub/rsql-jpa-specification#rsql-syntax-reference).",
"required": false,
"schema": {
"type": "string"
},
"example": "workspaces.name==Customer-Journey-Widget"
},
{
"name": "sortBy",
"in": "query",
"description": "Sort By Field",
"required": false,
"schema": {
"type": "string"
},
"example": "name"
},
{
"name": "sort",
"in": "query",
"description": "Sort direction",
"required": false,
"schema": {
"type": "string"
},
"example": "DESC"
},
{
"name": "page",
"in": "query",
"description": "Index of the page of results to be fetched.\n\nResults are returned in blocks of pageSize elements. This parameter specifies which page number to retrieve.The page numbering starts with 0.",
"required": false,
"schema": {
"type": "integer"
},
"example": 0
},
{
"name": "pageSize",
"in": "query",
"description": "Number of items to be displayed on a page.",
"required": false,
"schema": {
"type": "integer"
},
"example": 10
}
],
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceResponseList"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"409": {
"description": "Resource already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError409"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError429"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
},
"post": {
"tags": [
"Journey - Workspace management API"
],
"summary": "Create Workspace",
"description": "Create Workspace in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope.It requires the appropriate cjds:admin_org_write or cjp:config_write scopes",
"operationId": "createWorkspace",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkspaceRequestModel"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Ok",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationResponse"
}
}
}
},
"404": {
"description": "Resource not found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError404"
}
}
}
},
"409": {
"description": "Resource already exists",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError409"
}
}
}
},
"429": {
"description": "Too many requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError429"
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiError500"
}
}
}
}
},
"security": [
{
"bearerAuth": []
}
]
}
},
"/v1/dialer/campaign": {
"post": {
"tags": [
"Campaign Manager"
],
"summary": "Start Campaign Request",
"description": "A start campaign API allows businesses to programmatically start outbound campaigns using their own software applications. This type of API typically allows businesses to set up the parameters for a campaign, such as the list of phone numbers to call, the message or script to deliver, and the time of day or day of the week to call. Requires 'cjp.config_write' scope and one of the following roles: 'cjp.admin','id_full_admin','atlas-portal.partner.salesadmin','atlas-portal.partner.provision_admin' for authorization.",
"operationId": "startCampaignRoute",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartCampaignRequest"
}
}
}
},
"responses": {
"202": {
"description": "The campaign was started for processing.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignListResponse"
}
}
}
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/organization/{orgId}/getValidCampaignTimes": {
"get": {
"tags": [
"Campaign Manager"
],
"summary": "Get Valid Campaign Times",
"description": "Gets valid campaign times for a campaign and agent. This request is accepted for asynchronous processing. Requires 'cjp:user','cjp.config_write' scope and one of the following roles: 'cjp.admin','id_full_admin','atlas-portal.partner.salesadmin','atlas-portal.partner.provision_admin' for authorization.",
"operationId": "getValidCampaignTimesRoute",
"parameters": [
{
"name": "orgId",
"in": "path",
"description": "The organization ID for which valid campaign times are being requested.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"example": "123e4567-e89b-12d3-a456-426614174000"
},
{
"name": "campaignId",
"in": "query",
"description": "The campaign ID for which valid campaign times are being requested.",
"required": true,
"schema": {
"type": "string"
},
"example": "SalesCampaign_Prog"
},
{
"name": "agentId",
"in": "query",
"description": "The agent ID for whom valid campaign times are being requested.",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
},
"example": "123e4567-e89b-12d3-a456-426614174001"
},
{
"name": "trackingId",
"in": "query",
"description": "Optional tracking identifier for request tracing.",
"required": false,
"schema": {
"type": "string",
"format": "uuid"
},
"example": "123e4567-e89b-12d3-a456-426614174002"
}
],
"responses": {
"200": {
"description": "The valid campaign times request was accepted for processing."
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/dialer/campaign/{campaignId}": {
"put": {
"tags": [
"Campaign Manager"
],
"summary": "Update Campaign Request",
"description": "By using an update campaign API, businesses can automate the process of modifying and managing outbound campaigns, and integrate campaign updates into their existing workflows or applications. This can help to improve efficiency and reduce errors, as well as allow for greater flexibility and control over outbound campaigns. Requires 'cjp.config_write' scope and one of the following roles: 'cjp.admin','id_full_admin','atlas-portal.partner.salesadmin','atlas-portal.partner.provision_admin' for authorization.",
"operationId": "updateCampaignRoute",
"parameters": [
{
"name": "campaignId",
"in": "path",
"description": "The unique request id of the campaign that needs to be updated",
"required": true,
"schema": {
"type": "string"
},
"example": "Campaign1"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateCampaignRequest"
}
}
}
},
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CampaignListResponse"
}
}
},
"description": "The campaign was updated successfully"
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
},
"delete": {
"tags": [
"Campaign Manager"
],
"summary": "Stop Campaign Request",
"description": "The stop campaign API enables businesses to automate the process of managing outbound campaigns and integrate campaign deletion into their existing workflows or applications. Requires 'cjp.config_write' scope and one of the following roles: 'cjp.admin','id_full_admin','atlas-portal.partner.salesadmin','atlas-portal.partner.provision_admin' for authorization.",
"operationId": "stopCampaignRoute",
"parameters": [
{
"name": "campaignId",
"in": "path",
"description": "The unique request id of the campaign that needs to be stopped",
"required": true,
"schema": {
"type": "string"
},
"example": "Campaign1"
}
],
"responses": {
"204": {
"description": "The campaign was stopped."
},
"400": {
"description": "Bad Request"
},
"401": {
"description": "Unauthorized, Token is Invalid"
},
"403": {
"description": "Forbidden Request"
},
"500": {
"description": "Internal Server Error"
},
"503": {
"description": "Service Unavailable"
}
}
}
},
"/v1/captures/query": {
"post": {
"tags": [
"Captures"
],
"summary": "List Captures",
"description": "Retrieve a list of Captures given a set of task IDs.\n\n### Captures Availability\n\nNot all tasks will have captures by default and they will be available based on the organization's configurations and retention policy. Querying closed tasks is recommended, as open tasks may return incomplete data.\n\nTranscripts retrieved through this API are post-interaction artifacts.\n- For voice, transcripts are available when at least one transcript based configuration/feature is enabled such as Auto CSAT, Agent Well Being, Call Drop Summary, Topics Analytics.\n\n- For digital channels such as Chat, Email, Social, Work Item, and Custom Messaging, transcripts are generated from the conversation messages. Please refer [guide for digital transcripts](/docs/guide-for-digital-transcripts) for more details\n\n### URL Expiry\n\nThe maximum duration of validity of pre signed URL or default value when no value is passed for urlExpiration is 60 minutes.\n\n### Authentication & Authorization\n\nThis API requires a valid bearer token. The caller must satisfy the scope and role requirements for one of the following:\n\n#### Service App\n- **Required Scope:** `cjp:config_read`\n- The `orgId` must be provided in the request body and must match the token's org.\n- For service app setup, refer to [Contact Center Service Apps](/docs/contact-center-service-apps).\n\n#### Org Admin\n- **Required Scopes:** `Identity:SCIM` and `Identity:Organization`\n- **Required Role (one of):** `id_full_admin`, `id_readonly_admin`, `cjp.admin`, or `atlas-portal.partner.provision_admin`\n- The user must belong to the organization being queried. If `orgId` is provided in the request body, it must match the token's org. If `orgId` is omitted, it is inferred from the token.\n\n#### Partner Admin\n- **Required Scope:** `Identity:SCIM` for the managed org\n- **Required Role:** `atlas-portal.partner.salesadmin`\n- The org ID must be included in the managed org list. This is accomplished by adding the org to the `Managed customer orgs` list in control hub.\n\n#### Supervisor\n- **Required Role:** `cjp.supervisor`\n- The user must belong to the organization being queried. If `orgId` is provided in the request body, it must match the token's org. If `orgId` is omitted, it is inferred from the token.\n\n**Note:** Please refer to the contact center setup documentation for the configuration details.\n\n",
"operationId": "downloadMultiRecordingPath",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecordingBodyParams"
}
}
}
},
"responses": {
"200": {
"description": "Returns Recording and Transcription details. If a provided taskId is not found for the specified organization, the API will return a 200 OK response with empty recording and transcription fields for that task.\nThis behavior is intentional to allow partial results when multiple taskIds are provided; unmatched taskIds do not result in a 4xx error.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DownloadMultipleInteractionsResponse"
}
}
}
},
"400": {
"description": "Error: urlExpiration should be greater than 0."
},
"401": {
"description": "Unauthorized, token is invalid"
},
"403": {
"description": "Forbidden From Accessing Resources"
},
"404": {
"description": "Not Found"
},
"429": {
"description": "Too many requests have been sent in a given amount of time and the request has been rate limited"
},
"500": {
"description": "An Unexpected Error Occurred"
}
}
}
},
"/v3/campaign-management/dncList/{dncListName}/phoneNumber": {
"post": {
"tags": [
"DNC Management"
],
"summary": "Add Phone Number to DNC List",
"operationId": "addPhoneNumberToDncList",
"description": "Adds a phone number to the specified Do Not Contact (DNC) list. This operation helps ensure compliance with applicable rules & regulations by preventing outbound calls to specific numbers.\n\n**Note:** Phone numbers must be in E.164 format (e.g., +1234567890). Duplicate entries will be rejected with a 409 error.",
"parameters": [
{
"name": "dncListName",
"in": "path",
"description": "This is the Name of the DNC list to which you want to add a phone number. List names are case-sensitive and must be URL-encoded if they contain special characters.",
"required": true,
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]+$",
"minLength": 1,
"maxLength": 100
},
"example": "corporate-dnc-list"
}
],
"requestBody": {
"required": true,
"description": "Phone number details to add to the DNC list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DncEntryRequest"
},
"examples": {
"basic": {
"summary": "Basic phone number entry",
"value": {
"phoneNumber": "+1234567890",
"source": "customer-request"
}
},
"with-metadata": {
"summary": "Entry with additional metadata",
"value": {
"phoneNumber": "+1987654321",
"source": "regulatory-compliance",
"reason": "Customer opted out via email"
}
}
}
}
}
},
"responses": {
"201": {
"description": "Phone number successfully added to the DNC list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DncEntryResponse"
},
"example": {
"phoneNumber": "+1234567890",
"source": "customer-request",
"addedDate": "2024-01-15T10:30:00Z",
"addedBy": "admin@example.com"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed. User lacks required permissions to manage DNC lists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenError"
}
}
}
},
"404": {
"description": "Not Found: The specified DNC list does not exist or the user does not have access to it.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
},
"409": {
"description": "Conflict: The phone number already exists in the specified DNC list.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConflictError"
}
}
}
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.",
"headers": {
"Retry-After": {
"schema": {
"type": "integer"
},
"description": "Number of seconds to wait before retrying"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TooManyRequestsError"
}
}
}
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
}
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadGatewayError"
}
}
}
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailableError"
}
}
}
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayTimeoutError"
}
}
}
}
}
}
},
"/v3/campaign-management/dncList/{dncListName}/phoneNumber/{phoneNumber}": {
"get": {
"tags": [
"DNC Management"
],
"summary": "Get Phone Number from DNC List",
"operationId": "getPhoneNumberFromDncList",
"description": "Retrieves details of a specific phone number from the specified Do Not Contact (DNC) list. This operation allows you to check if a number is present in the list and view associated metadata.\n\n**Note:** Phone numbers must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).",
"parameters": [
{
"name": "dncListName",
"in": "path",
"description": "The name of the DNC list to search in. List names are case-sensitive and must be URL-encoded if they contain special characters.",
"required": true,
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]+$",
"minLength": 1,
"maxLength": 100
},
"example": "corporate-dnc-list"
},
{
"name": "phoneNumber",
"in": "path",
"description": "The phone number to retrieve from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).",
"required": true,
"schema": {
"type": "string",
"pattern": "^\\+[1-9]\\d{1,14}$"
},
"example": "+1234567890"
}
],
"responses": {
"200": {
"description": "Phone number details successfully retrieved from the DNC list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DncEntryResponse"
},
"example": {
"phoneNumber": "+1234567890",
"source": "customer-request",
"addedDate": "2024-01-15T10:30:00Z",
"addedBy": "admin@example.com",
"reason": "Customer opted out via phone"
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed. User lacks required permissions to view DNC lists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenError"
}
}
}
},
"404": {
"description": "Not Found: The specified DNC list does not exist, the phone number is not found in the list, or the user does not have access to it.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
},
"example": {
"code": 1001,
"message": "Phone number +1234567890 not found in DNC list 'corporate-dnc-list'",
"trackingId": "WXC-12345-67892"
}
}
}
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.",
"headers": {
"Retry-After": {
"schema": {
"type": "integer"
},
"description": "Number of seconds to wait before retrying"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TooManyRequestsError"
}
}
}
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
}
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadGatewayError"
}
}
}
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailableError"
}
}
}
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayTimeoutError"
}
}
}
}
}
},
"delete": {
"tags": [
"DNC Management"
],
"summary": "Remove Phone Number from DNC List",
"operationId": "removePhoneNumberFromDncList",
"description": "Removes a phone number from the specified Do Not Contact (DNC) list. This operation allows administrators to remove numbers that should no longer be blocked from receiving calls.\n\n**Note:** Phone numbers must be URL-encoded and in E.164 format (e.g., +1234567890 for +1234567890). If the number doesn't exist in the list, a 404 error will be returned.",
"parameters": [
{
"name": "dncListName",
"in": "path",
"description": "The name of the DNC list to remove the phone number from. List names are case-sensitive and must be URL-encoded if they contain special characters.",
"required": true,
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9_-]+$",
"minLength": 1,
"maxLength": 100
},
"example": "corporate-dnc-list"
},
{
"name": "phoneNumber",
"in": "path",
"description": "The phone number to remove from the DNC list. Must be URL-encoded and in E.164 format (e.g., %2B1234567890 for +1234567890).",
"required": true,
"schema": {
"type": "string",
"pattern": "^\\+[1-9]\\d{1,14}$"
},
"example": "+1234567890"
}
],
"responses": {
"204": {
"description": "Phone number successfully removed from the DNC list. No content is returned."
},
"400": {
"description": "Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed. User lacks required permissions to manage DNC lists.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenError"
}
}
}
},
"404": {
"description": "Not Found: The specified DNC list does not exist, the phone number is not found in the list, or the user does not have access to it.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
},
"example": {
"code": 1001,
"message": "Phone number +1234567890 not found in DNC list 'corporate-dnc-list'",
"trackingId": "WXC-12345-67893"
}
}
}
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.",
"headers": {
"Retry-After": {
"schema": {
"type": "integer"
},
"description": "Number of seconds to wait before retrying"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TooManyRequestsError"
}
}
}
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
}
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadGatewayError"
}
}
}
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailableError"
}
}
}
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayTimeoutError"
}
}
}
}
}
}
},
"/v3/campaign-management/campaign-groups/{campaignGroupName}/campaigns": {
"get": {
"tags": [
"Campaign Group"
],
"summary": "List Campaigns by Campaign Group",
"operationId": "getCampaignsByCampaignGroup",
"description": "Retrieves the list of campaigns that belong to the specified campaign group. Results are paginated and can optionally be filtered by campaign status.\n\n**Note:** The `campaignStatus` filter is case-insensitive. Allowed values are `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`. Unknown values will result in a 400 response.",
"parameters": [
{
"name": "campaignGroupName",
"in": "path",
"description": "The name of the campaign group whose campaigns are to be retrieved. Case-insensitive matching.\n\n **Allowed characters:** - `A-Z`, `a-z`, `0-9`, `_` (underscore), space \n**Allowed Length** `1..64`",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[A-Za-z0-9_ ]{1,64}$"
},
"example": "Campaign Group Name_123"
},
{
"name": "page",
"in": "query",
"description": "The page number of the result set to retrieve (1-based).",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"default": 1
},
"example": 1
},
{
"name": "pageSize",
"in": "query",
"description": "The number of campaigns to return per page. Must be between 1 and 100.",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50
},
"example": 20
},
{
"name": "campaignStatus",
"in": "query",
"description": "Optional filter for campaign status. Case-insensitive. Allowed values: `Draft`, `Running`, `Pending`, `Paused`, `Completed`, `Ended`.",
"required": false,
"schema": {
"type": "string",
"enum": [
"Draft",
"Running",
"Pending",
"Paused",
"Completed",
"Ended"
]
},
"example": "Draft"
}
],
"responses": {
"200": {
"description": "Campaigns successfully retrieved for the specified campaign group.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetCampaignListResponse"
},
"example": {
"outcome": "Success",
"statusCode": 0,
"campaigns": [
{
"campaignId": "CCV_1780403367475",
"campaignName": "Auto_Loan_Collection Campaigns",
"campaignGroupName": "Debt_Collection Campaigns",
"channel": "Voice",
"campaignType": "Basic",
"campaignDialingMode": "StandardPreview",
"status": "Running",
"createdTime": "2026-06-02T07:59:27Z",
"lastUpdatedTime": "2026-06-02T07:57:58Z",
"startDate": "2026-06-01",
"endDate": "2026-12-31",
"fieldMapping": "Auto_Loans_Field_Mapping",
"timezone": "UTC - 06:00 / USA / Central Time / Chicago, Dallas, Memphis, Nashville",
"scheduleType": "Advanced",
"scheduleInfo": [
{
"name": "Monday",
"day": "2",
"slots": [
{
"startTime": "08:00",
"endTime": "12:00"
},
{
"startTime": "13:00",
"endTime": "17:00"
},
{
"startTime": "18:00",
"endTime": "20:00"
}
]
},
{
"name": "Tuesday",
"day": "3",
"slots": [
{
"startTime": "08:00",
"endTime": "13:00"
},
{
"startTime": "14:00",
"endTime": "20:00"
}
]
},
{
"name": "Wednesday",
"day": "4",
"slots": [
{
"startTime": "08:00",
"endTime": "20:00"
}
]
},
{
"name": "Thursday",
"day": "5",
"slots": [
{
"startTime": "08:00",
"endTime": "20:00"
}
]
},
{
"name": "Friday",
"day": "6",
"slots": [
{
"startTime": "08:00",
"endTime": "20:00"
}
]
},
{
"name": "Saturday",
"day": "7",
"slots": [
{
"startTime": "08:00",
"endTime": "14:00"
}
]
}
],
"safeCallingWindow": [
{
"scwStartTime": "08:00",
"scwEndTime": "20:00"
}
],
"contactAttemptsStrategy": {
"maxAttempts": [
{
"interval": "CLE",
"maxCount": "40"
},
{
"interval": "1D",
"maxCount": "4"
}
],
"contactModesPriority": [
{
"mode": "Home",
"priority": 1,
"maxCount": null
},
{
"mode": "Office",
"priority": 2,
"maxCount": null
}
],
"sequentialDialing": {
"enabled": 1,
"noOfCycles": 5,
"cycleInterval": {
"days": 0,
"hours": 0,
"minutes": 30
}
},
"wrapUpCodesSet": "Auto_Loans_WrapUpCodes_Set",
"telephonyOutcomeSet": "Auto_Loans_TelephonyOutcomes_Set"
},
"contactFlowPriority": {
"priorityBasedOn": "Contact Attribute",
"attributes": [
"Outstanding_Balance"
],
"orderBy": "Descending"
},
"campaignCreatedBy": "John Smith",
"controlHubChannelEntryPointID": "a62231af-866b-404c-bc74-b8db98b76e6c",
"outdialANI": "+1512345678",
"dncLists": [
"Auto_Loans_DNC",
"Debt_Collections_DNC"
],
"purposeTags": [
"Debt_Collection",
"AutoLoanCollection"
],
"pAndLTag": "Auto_Loans",
"cpaEnabled": "Yes",
"numberOfSFTPContactLists": 0,
"numberOfAPIContactLists": 10,
"numberOfManualFileContactLists": 2
}
],
"pagination": {
"page": 1,
"pageSize": 10,
"totalCount": 50,
"totalPages": 5
}
}
}
}
},
"400": {
"description": "Bad Request: The request was invalid (e.g., invalid `page`, `pageSize`, or `campaignStatus`).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"401": {
"description": "Unauthorized: Authentication credentials were missing or incorrect.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"403": {
"description": "Forbidden: The request is understood, but it has been refused or access is not allowed. The feature may not be enabled for this organization or the user lacks required permissions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenError"
}
}
}
},
"404": {
"description": "Not Found: The specified campaign group does not exist.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
},
"429": {
"description": "Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.",
"headers": {
"Retry-After": {
"schema": {
"type": "integer"
},
"description": "Number of seconds to wait before retrying"
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TooManyRequestsError"
}
}
}
},
"500": {
"description": "Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
}
},
"502": {
"description": "Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadGatewayError"
}
}
}
},
"503": {
"description": "Service Unavailable: Server is overloaded with requests. Try again later.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServiceUnavailableError"
}
}
}
},
"504": {
"description": "Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GatewayTimeoutError"
}
}
}
}
}
}
},
"/v3/campaign-management/campaigns/{campaignId}/contact-list": {
"post": {
"tags": [
"Contact List Management"
],
"summary": "Create contact list",
"operationId": "createContactList",
"description": "Creates and activates a contact list for a campaign. The system can activate a contact list even if there are no contact records within it.",
"parameters": [
{
"name": "campaignId",
"in": "path",
"required": true,
"description": "Campaign ID to which the contact list belongs.",
"schema": {
"type": "string"
},
"example": "CCV_123456789"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateContactListRequest"
},
"examples": {
"basic": {
"value": {
"supportedChannels": [
"Voice",
"SMS"
],
"activationTimeLagMinutes": 180
}
},
"withTimestamp": {
"value": {
"supportedChannels": [
"Email"
],
"activationDateTime": "2025-09-24T18:47:00Z"
}
}
}
}
}
},
"responses": {
"201": {
"description": "Contact list created successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateContactListResponse"
},
"examples": {
"success": {
"value": {
"outcome": "Success",
"statusCode": 0,
"contactListId": "501"
}
}
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v3/campaign-management/campaigns/{campaignId}/contact-list/{contactListId}/contacts": {
"post": {
"tags": [
"Contact List Management"
],
"summary": "Create contacts within a contact list",
"operationId": "createContactsInContactList",
"description": "Creates contacts within a contact list (only if that contact list was created using API method). If the contact record is invalid, it will be added as INVALID and reflected in the 'Processed' and 'Invalid' counts. This is an Asynchronous operation. The values within the 'contactAttributes' param should conform to datatypes of the contact attributes as specified in the 'Field mapping' associated with the campaign.",
"parameters": [
{
"name": "campaignId",
"in": "path",
"required": true,
"description": "Campaign ID to which the contact list belongs.",
"schema": {
"type": "string"
},
"example": "CCV_123456789"
},
{
"name": "contactListId",
"in": "path",
"required": true,
"description": "Contact List ID (as a number string).",
"schema": {
"type": "string",
"pattern": "^\\d+$"
},
"example": "501"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateContactRequest"
}
}
}
},
"responses": {
"202": {
"description": "Request accepted",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateContactResponse"
},
"example": {
"outcome": "Queued",
"statusCode": 0,
"summary": "Queued for adding to the contact list"
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v3/campaign-management/campaigns/{campaignId}/contact-list/{contactListId}/contacts/{contactId}": {
"patch": {
"tags": [
"Contact List Management"
],
"summary": "Update a contact's status within a contact list",
"operationId": "updateContactStatusInContactList",
"description": "Updates a contact's status within a contact list. After update, system overwrites 'Latest Telephony Outcome' to blank and 'Latest Business Outcome' to 'Closed via API call' if status is CLOSED. This is an Asynchronous operation.",
"parameters": [
{
"name": "campaignId",
"in": "path",
"required": true,
"description": "Campaign ID.",
"schema": {
"type": "string"
},
"example": "CCV_123456789"
},
{
"name": "contactListId",
"in": "path",
"required": true,
"description": "Contact List ID (as a number string).",
"schema": {
"type": "string",
"pattern": "^\\d+$"
},
"example": "501"
},
{
"name": "contactId",
"in": "path",
"required": true,
"description": "Contact Unique ID (Contact Phone or Customer Unique ID or Account Unique ID)",
"schema": {
"type": "string"
},
"example": "CUST12345"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContactRequest"
},
"example": {
"contactStatus": "CLOSED"
}
}
}
},
"responses": {
"202": {
"description": "Request queued",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContactResponse"
},
"example": {
"outcome": "Queued",
"statusCode": 0,
"summary": "Queued for updating the contact status"
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v3/campaign-management/campaigns/{campaignId}/contacts/{contactId}": {
"patch": {
"tags": [
"Contact List Management"
],
"summary": "Update contact status across the campaign chain",
"operationId": "updateContactStatusInCampaignChain",
"description": "Synchronously closes the specified contacts and returns the outcome in the same response. Contacts are identified using the same unique identifiers configured in your campaign field mappings, such as Contact Phone (format as per the associated field mapping) or Customer Unique ID or Account Unique ID (For more info, please refer to the [global variables help documentation](https://docs-campaign-for-contact-centers.webexcampaign.com/docs/global-variables)).\n\n By default, the API searches the specified campaign and any of its downstream target campaigns in the chain (across all active contact-lists associated with these campaigns), and closes the contact wherever it is found in a closeable state. Set `searchAcrossTheCampaignChain` to `no` to close the contact only in the campaign specified in the request path.\n\n**Optional query parameters**\n\n- `contactListId` - Search only the specific contact-list within the campaign specified in the request path. If `searchAcrossTheCampaignChain` is set to `yes` then all active contact-lists in the other downstream target campaigns in the chain are also searched.\n- `fields` - Return specified contact field values in the response for the matching contact records (for example: FirstName, LastName, AmountDue).",
"parameters": [
{
"name": "campaignId",
"in": "path",
"required": true,
"description": "Campaign ID (as a string). All downstream target campaigns in the chain are included in the search.",
"schema": {
"type": "string"
},
"example": "CCV_1234567890"
},
{
"name": "contactId",
"in": "path",
"required": true,
"description": "Contact Unique ID (Contact Phone or Customer Unique ID or Account Unique ID)",
"schema": {
"type": "string"
},
"example": "2125550199 or CUST1234 or ACC1234"
},
{
"name": "contactListId",
"in": "query",
"required": false,
"description": "Optional. Search only the specific contact-list within the campaign specified in the request path. If `searchAcrossTheCampaignChain` is set to `yes`, then all active contact-lists in the other downstream target campaigns in the chain are also searched. When omitted, all active contact lists in that campaign are searched.",
"schema": {
"type": "string",
"pattern": "^\\d+$"
},
"example": "501"
},
{
"name": "fields",
"in": "query",
"required": false,
"description": "Optional. Contact field names to include in the response (comma-separated names).",
"schema": {
"type": "string"
},
"examples": {
"csv": {
"value": "FirstName, LastName, AmountDue"
}
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContactStatusWithinCampaignChainRequest"
}
}
}
},
"responses": {
"200": {
"description": "Contact closed. See `outcome` and `records` for per-campaign details.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContactStatusResponse"
},
"examples": {
"Success": {
"summary": "Closed in every campaign in the chain",
"value": {
"outcome": "Success",
"statusCode": 0,
"records": [
{
"updated": true,
"campaignId": "CCV_1001",
"campaignName": "Renewals",
"contactListId": "501",
"matchedBy": {
"ContactHome": "+12125550199"
},
"fields": {
"FirstName": "John",
"LastName": "Doe",
"AmountDue": "100.00"
},
"comment": "Closed."
},
{
"updated": true,
"campaignId": "CCV_1002",
"campaignName": "Renewals Outreach",
"contactListId": "601",
"matchedBy": {
"ContactHome": "+12125550199"
},
"fields": {
"FirstName": "John",
"LastName": "Doe",
"AmountDue": "100.00"
},
"comment": "Closed."
}
]
}
},
"PartialSuccess": {
"summary": "Closed in some campaigns; non-closeable in others",
"value": {
"outcome": "PartialSuccess",
"statusCode": 0,
"records": [
{
"updated": true,
"campaignId": "CCV_1001",
"campaignName": "Renewals",
"contactListId": "501",
"matchedBy": {
"ContactHome": "+12125550199"
},
"comment": "Closed."
},
{
"updated": false,
"campaignId": "CCV_1002",
"campaignName": "Renewals Outreach",
"contactListId": "601",
"matchedBy": {
"ContactHome": "+12125550199"
},
"comment": "Cannot close; already sent to dialer."
}
]
}
},
"NoChange": {
"summary": "Matched but not closeable in every campaign",
"value": {
"outcome": "NoChange",
"statusCode": 0,
"records": [
{
"updated": false,
"campaignId": "CCV_1001",
"campaignName": "Renewals",
"contactListId": "501",
"matchedBy": {
"ContactHome": "+12125550199"
},
"comment": "Cannot close; already sent to dialer."
}
]
}
}
}
}
}
},
"400": {
"description": "Invalid request (for example, unsupported contactStatus, missing contactStatus, invalid contactListId, or malformed fields query parameter).",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"code": "InvalidRequest",
"message": "Unsupported contact status: OPEN"
}
}
}
},
"403": {
"description": "This operation is not enabled for your organization.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"code": "Forbidden",
"message": "Feature is not enabled for this organization."
}
}
}
},
"404": {
"description": "No matching contact record found in any campaign in scope.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContactStatusResponse"
},
"example": {
"outcome": "Matching contact record not found.",
"statusCode": 0,
"records": []
}
}
}
},
"429": {
"description": "Rate limit exceeded.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
},
"example": {
"code": "1007",
"message": "Too many requests. Throttle limit reached for the time window. Retry after 30 seconds."
}
}
}
}
}
}
},
"/v3/campaign-management/campaigns/{campaignId}/contact-list/{contactListId}/status": {
"patch": {
"tags": [
"Contact List Management"
],
"summary": "Update contact list status",
"operationId": "updateContactListStatus",
"description": "Updates the status of a contact list (e.g., EXPIRED). Note: This value is not case-sensitive.",
"parameters": [
{
"name": "campaignId",
"in": "path",
"required": true,
"description": "Campaign ID.",
"schema": {
"type": "string"
},
"example": "CCV_1234567890"
},
{
"name": "contactListId",
"in": "path",
"required": true,
"description": "Contact List ID (as a number string).",
"schema": {
"type": "string",
"pattern": "^\\d+$"
},
"example": "501"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContactListStatusRequest"
},
"example": {
"contactListStatus": "EXPIRED"
}
}
}
},
"responses": {
"200": {
"description": "Contact list status updated successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateContactListStatusResponse"
},
"example": {
"outcome": "Success",
"statusCode": 0,
"summary": "Contact list status updated successfully"
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v3/campaign-management/campaigns/{campaignId}/contact-lists": {
"get": {
"tags": [
"Contact List Management"
],
"summary": "Get Contact Lists within a Campaign",
"operationId": "getContactListsInCampaign",
"description": "Retrieves all contact lists within a campaign, with optional filters for status and source.\n\nThis is the **v3** endpoint. Each contact list entry includes `contactListRecordsProcessed` (total processed records). For dialer counts, source file name, and per-status contact counts, use the **v4** endpoint (`GET /v4/campaign-management/campaigns/{campaignId}/contact-lists`).\n\n**Caching:** Responses are cached for up to 30 seconds per campaign and filter combination.",
"parameters": [
{
"name": "campaignId",
"in": "path",
"required": true,
"description": "Campaign ID.",
"schema": {
"type": "string"
},
"example": "CCV_123456789"
},
{
"name": "status",
"in": "query",
"required": false,
"description": "Contact List Status filter (Active, Expired, UploadFailed, etc.)",
"schema": {
"type": "string",
"enum": [
"Active",
"Expired",
"UploadFailed"
]
},
"example": "Active"
},
{
"name": "source",
"in": "query",
"required": false,
"description": "Contact List Source filter (API, SFTP, ManualFile)",
"schema": {
"type": "string",
"enum": [
"API",
"SFTP",
"ManualFile"
]
},
"example": "API"
}
],
"responses": {
"200": {
"description": "Contact lists retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetContactListsResponse"
},
"example": {
"outcome": "Success",
"statusCode": 0,
"contactLists": [
{
"contactListId": "501",
"contactListStatus": "Active",
"contactListRecordsProcessed": 100,
"contactListSource": "API",
"dateOfCreation": "2025-08-01T10:00:00",
"dateOfActivation": "2025-08-01T12:00:00",
"dateOfExpiry": "2025-09-01T00:00:00"
}
]
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
},
"/v4/campaign-management/campaigns/{campaignId}/contact-lists": {
"get": {
"tags": [
"Contact List Management"
],
"summary": "Get Contact Lists within a Campaign",
"operationId": "getContactListsInACampaign",
"description": "Retrieves all contact lists within a campaign. Use the optional `status` and `source` query parameters to filter results.\n\nEach contact list in the response includes the source file name, the time contact counts were last updated, and a breakdown of contact counts by processing and dialer status (for example, processed, invalid, valid, eligible, fresh, open, closed, and ready for dialer).\n\nResponses may reflect the same data for up to 30 seconds when the same campaign and filters are requested repeatedly.",
"parameters": [
{
"name": "campaignId",
"in": "path",
"required": true,
"description": "Campaign ID.",
"schema": {
"type": "string"
},
"example": "CCV_123456789"
},
{
"name": "status",
"in": "query",
"required": false,
"description": "Contact List Status filter (Active, Expired, UploadFailed, etc.)",
"schema": {
"type": "string",
"enum": [
"Active",
"Expired",
"UploadFailed"
]
},
"example": "Active"
},
{
"name": "source",
"in": "query",
"required": false,
"description": "Contact List Source filter (API, SFTP, ManualFile)",
"schema": {
"type": "string",
"enum": [
"API",
"SFTP",
"ManualFile"
]
},
"example": "API"
}
],
"responses": {
"200": {
"description": "Contact lists retrieved successfully",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetContactListsResponse"
},
"example": {
"outcome": "Success",
"statusCode": 0,
"contactLists": [
{
"contactListId": "501",
"contactListStatus": "Active",
"contactListSource": "API",
"contactListSourceFileName": "contacts.csv",
"contactListCountsTimestampUtc": "2025-08-01T14:30:00Z",
"processedContactsCount": 100,
"invalidContactsCount": 2,
"validContactsCount": 98,
"eligibleContactsCount": 95,
"freshContactsCount": 40,
"openContactsCount": 30,
"closedContactsCount": 20,
"errorsContactsCount": 0,
"readyForDialerContactsCount": 5,
"sentToDialerAwaitingOutcomeContactsCount": 3,
"expiredContactsCount": 0,
"blockedContactsCount": 0,
"closedTransferredToChainedCampaignContactsCount": 0,
"dateOfCreation": "2025-08-01T10:00:00",
"dateOfActivation": "2025-08-01T12:00:00",
"dateOfExpiry": "2025-09-01T00:00:00"
}
]
}
}
}
},
"400": {
"description": "Invalid request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AcdObject": {
"type": "object",
"required": [
"enabled",
"displayCallqueueAgentSoftkeys"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the ACD object is enabled."
},
"displayCallqueueAgentSoftkeys": {
"$ref": "#/components/schemas/DisplayCallqueueAgentSoftkeysObject",
"description": "Indicates the call queue agent soft key value of an ACD object."
}
}
},
"AcdObjectDevice": {
"type": "object",
"required": [
"enabled",
"displayCallqueueAgentSoftkeys"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the ACD object is enabled."
},
"displayCallqueueAgentSoftkeys": {
"$ref": "#/components/schemas/DisplayCallqueueAgentSoftkeysObject",
"description": "Indicates the call queue agent soft key value of an ACD object."
}
}
},
"ActivationStates": {
"type": "string",
"enum": [
"activating",
"activated",
"deactivated"
],
"description": " * `activating` - Device is activating using an activation code.\n * `activated` - Device has been activated using an activation code.\n * `deactivated` - Device has not been activated using an activation code.\n"
},
"AdminBatchStartJobObjectLocationCustomizations": {
"type": "object",
"properties": {
"locationId": {
"type": "string",
"example": "'Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA'",
"description": "Location within an organization where changes of device setings will be applied to all the devices within it."
},
"locationCustomizationsEnabled": {
"type": "boolean",
"description": "Indicates if all the devices within this location will be customized with new requested customizations(if set to `true`) or will be overridden with the one at organization level (if set to `false` or any other value). This field has no effect when the job is being triggered at organization level."
},
"customizations": {
"$ref": "#/components/schemas/CustomizationObject",
"description": "Indicates the settings for ATA devices, DECT devices and MPP devices."
}
}
},
"AtaDtmfMethodObject": {
"type": "string",
"enum": [
"INBAND",
"AVT",
"AUTO"
],
"description": " * `INBAND` - Sends DTMF by using the audio path.\n * `AVT` - Audio video transport. Sends DTMF as AVT events.\n * `AUTO` - Uses InBand or AVT based on the outcome of codec negotiation.\n"
},
"AtaDtmfModeObject": {
"type": "string",
"enum": [
"STRICT",
"NORMAL"
],
"description": " * `STRICT` - A DTMF digit requires an extra hold time after detection and the DTMF level threshold is raised to -20 dBm.\n * `NORMAL` - Normal threshold mode.\n"
},
"AudioCodecPriorityObject": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of an Audio Codec Priority Object."
},
"primary": {
"type": "string",
"example": "G711a",
"description": "Indicates the primary Audio Codec."
},
"secondary": {
"type": "string",
"example": "G711u",
"description": "Indicates the secondary Audio Codec."
},
"tertiary": {
"type": "string",
"example": "G729a",
"description": "Indicates the tertiary Audio Codec."
}
}
},
"AudioCodecPriorityObjectDevice": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of an Audio Codec Priority Object."
},
"primary": {
"type": "string",
"example": "G711a",
"description": "Indicates the primary Audio Codec."
},
"secondary": {
"type": "string",
"example": "G711u",
"description": "Indicates the secondary Audio Codec."
},
"tertiary": {
"type": "string",
"example": "G729a",
"description": "Indicates the tertiary Audio Codec."
}
}
},
"AuthenticationMethodObject": {
"type": "string",
"enum": [
"NONE",
"EAP_FAST",
"PEAP_GTC",
"PEAP_MSCHAPV2",
"PSK",
"WEP"
],
"description": " * `NONE` - No authentication.\n * `EAP_FAST` - Extensible Authentication Protocol-Flexible Authentication via Secure Tunneling. Requires username and password authentication.\n * `PEAP_GTC` - Protected Extensible Authentication Protocol - Generic Token Card. Requires username and password authentication.\n * `PEAP_MSCHAPV2` - Protected Extensible Authentication Protocol - Microsoft Challenge Handshake Authentication Protocol version 2. Requires username and password authentication.\n * `PSK` - Pre-Shared Key. Requires shared passphrase for authentication.\n * `WEP` - Wired Equivalent Privacy. Requires encryption key for authentication.\n"
},
"BackgroundImage": {
"type": "string",
"enum": [
"NONE",
"DARK_BLUE",
"CISCO_DARK_BLUE",
"WEBEX_DARK_BLUE",
"CUSTOM_BACKGROUND"
],
"description": " * `NONE` - Indicates that there will be no background image set for the devices.\n * `DARK_BLUE` - Indicates that dark blue background image will be set for the devices.\n * `CISCO_DARK_BLUE` - Indicates that Cisco themed dark blue background image will be set for the devices.\n * `WEBEX_DARK_BLUE` - Indicates that Cisco Webex dark blue background image will be set for the devices.\n * `CUSTOM_BACKGROUND` - Indicates that a custom background image will be set for the devices.\n * `customUrl` - When this option is selected, a field 'Custom Background URL' needs to be added with the image url. URLs provided must link directly to an image file and be in HTTP, HTTPS, or filepath format.\n"
},
"BackgroundImageColor": {
"type": "string",
"enum": [
"CYAN_DARK",
"PURPLE_DARK",
"BLUE_DARK",
"VIOLET_DARK",
"BLUE_LIGHT",
"VIOLET_LIGHT"
],
"description": " * `CYAN_DARK` - Indicates that dark cyan background image will be set for the devices.\n * `PURPLE_DARK` - Indicates the dark purple background image will be set for the devices.\n * `BLUE_DARK` - Indicates the dark blue background image will be set for the devices.\n * `VIOLET_DARK` - Indicates the dark violet background image will be set for the devices.\n * `BLUE_LIGHT` - Indicates the light blue background image will be set for the devices.\n * `VIOLET_LIGHT` - Indicates the light violet background image will be set for the devices.\n"
},
"BacklightTimer68XX": {
"type": "string",
"enum": [
"ALWAYS_ON",
"TEN_SEC",
"TWENTY_SEC",
"THIRTY_SEC",
"OFF"
],
"description": " * `ALWAYS_ON` - Keep the phone's backlight always on.\n * `TEN_SEC` - Set the phone's backlight to be on for ten seconds.\n * `TWENTY_SEC` - Set the phone's backlight to be on for twenty seconds.\n * `THIRTY_SEC` - Set the phone's backlight to be on for thirty seconds.\n * `OFF` - Keep the phone's backlight off.\n"
},
"BacklightTimer68XXDevice": {
"type": "string",
"enum": [
"ALWAYS_ON",
"TEN_SEC",
"TWENTY_SEC",
"THIRTY_SEC",
"OFF"
],
"description": " * `ALWAYS_ON` - Keep the phone's backlight always on.\n * `TEN_SEC` - Set the phone's backlight to be on for ten seconds.\n * `TWENTY_SEC` - Set the phone's backlight to be on for twenty seconds.\n * `THIRTY_SEC` - Set the phone's backlight to be on for thirty seconds.\n * `OFF` - Keep the phone's backlight off.\n"
},
"BacklightTimerObject": {
"type": "string",
"enum": [
"ONE_MIN",
"FIVE_MIN",
"THIRTY_MIN",
"ALWAYS_ON"
],
"description": " * `ONE_MIN` - Set the phone's backlight to be on for one minute.\n * `FIVE_MIN` - Set the phone's backlight to be on for five minutes.\n * `THIRTY_MIN` - Set the phone's backlight to be on for thirty minutes.\n * `ALWAYS_ON` - Keep the phone's backlight always on.\n"
},
"BacklightTimerObjectDevice": {
"type": "string",
"enum": [
"ONE_MIN",
"FIVE_MIN",
"THIRTY_MIN",
"ALWAYS_ON"
],
"description": " * `ONE_MIN` - Set the phone's backlight to be on for one minute.\n * `FIVE_MIN` - Set the phone's backlight to be on for five minutes.\n * `THIRTY_MIN` - Set the phone's backlight to be on for thirty minutes.\n * `ALWAYS_ON` - Keep the phone's backlight always on.\n"
},
"BluetoothObject": {
"type": "object",
"required": [
"enabled",
"mode"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Bluetooth."
},
"mode": {
"type": "string",
"enum": [
"PHONE"
],
"description": "Select a Bluetooth mode."
},
"PHONE": {
"type": "string"
},
"HANDS_FREE": {
"type": "string"
},
"BOTH": {
"type": "string"
}
}
},
"BluetoothObjectDevice": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Bluetooth."
},
"mode": {
"type": "string",
"enum": [
"PHONE",
"HANDS_FREE",
"BOTH"
],
"description": "Select a Bluetooth mode."
}
}
},
"CallForwardExpandedSoftKey": {
"type": "string",
"enum": [
"ONLY_THE_CALL_FORWARD_ALL",
"ALL_CALL_FORWARDS"
],
"description": " * `ONLY_THE_CALL_FORWARD_ALL` - Set the default call forward expanded soft key behavior to single option.\n * `ALL_CALL_FORWARDS` - Set the default call forward expanded soft key behavior to multiple menu option.\n"
},
"CallHistoryMethod": {
"type": "string",
"enum": [
"WEBEX_UNIFIED_CALL_HISTORY",
"LOCAL_CALL_HISTORY"
],
"description": " * `WEBEX_UNIFIED_CALL_HISTORY` - Set call history to use the unified call history from all of the end user's devices.\n * `LOCAL_CALL_HISTORY` - Set call history to use local device information only.\n"
},
"CommSecurityType": {
"type": "string",
"enum": [
"NONE",
"SSL",
"STARTTLS"
],
"description": " * `NONE` - Sets the LDAP server security protocol to None.\n * `SSL` - Sets the LDAP server security protocol to SSL.\n * `STARTTLS` - Sets the LDAP server security protocol to STARTTLS.\n"
},
"Compression": {
"type": "string",
"enum": [
"ON",
"OFF"
],
"description": " * `ON` - Minimize data use during compression.\n * `OFF` - Ignore data use during compression.\n"
},
"CountObject": {
"type": "object",
"required": [
"totalNumbers",
"numbersDeleted",
"numbersMoved",
"numbersFailed"
],
"properties": {
"totalNumbers": {
"type": "number",
"description": "Indicates the total number of phone numbers requested to be moved."
},
"numbersDeleted": {
"type": "number",
"description": "Indicates the total number of phone numbers successfully deleted."
},
"numbersMoved": {
"type": "number",
"description": "Indicates the total number of phone numbers successfully moved."
},
"numbersFailed": {
"type": "number",
"description": "Indicates the total number of phone numbers failed."
}
}
},
"CustomizationDeviceLevelObject": {
"type": "object",
"properties": {
"ata": {
"$ref": "#/components/schemas/ataObject",
"description": "Applicable device settings for an ATA device."
},
"mpp": {
"$ref": "#/components/schemas/mppObject",
"description": "Applicable device settings for an MPP device."
},
"wifi": {
"$ref": "#/components/schemas/wifiObject",
"description": "Applicable device settings for a WiFi device."
}
}
},
"CustomizationDeviceLevelObjectDevice": {
"type": "object",
"properties": {
"ata": {
"$ref": "#/components/schemas/ataObjectDevice",
"description": "Applicable device settings for an ATA device."
},
"mpp": {
"$ref": "#/components/schemas/mppObjectDevice",
"description": "Applicable device settings for an MPP device."
},
"wifi": {
"$ref": "#/components/schemas/wifiObjectDevice",
"description": "Applicable device settings for a WiFi device."
}
}
},
"CustomizationObject": {
"type": "object",
"properties": {
"ata": {
"$ref": "#/components/schemas/ataObject",
"description": "Settings that are applicable to ATA devices."
},
"dect": {
"$ref": "#/components/schemas/dectObject",
"description": "Settings that are applicable to DECT devices."
},
"mpp": {
"$ref": "#/components/schemas/mppObject",
"description": "Settings that are applicable to MPP devices."
},
"wifi": {
"$ref": "#/components/schemas/wifiObject",
"description": "Settings that are applicable to WiFi."
}
}
},
"DectAudioCodecPriorityObject": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of an Audio Codec Priority Object."
},
"primary": {
"type": "string",
"example": "G729",
"description": "Indicates the primary Audio Codec."
},
"secondary": {
"type": "string",
"example": "G711u",
"description": "Indicates the secondary Audio Codec."
},
"tertiary": {
"type": "string",
"example": "G711a",
"description": "Indicates the tertiary Audio Codec."
}
}
},
"DectDeviceList": {
"type": "object",
"required": [
"model",
"displayName"
],
"properties": {
"model": {
"type": "string",
"example": "DMS Cisco DBS110",
"description": "Model name of the device."
},
"displayName": {
"type": "string",
"example": "Cisco DECT 210 Base",
"description": "Display name of the device."
},
"numberOfBaseStations": {
"type": "number",
"example": 250,
"description": "Indicates number of base stations."
},
"numberOfLinePorts": {
"type": "number",
"example": 1000,
"description": "Indicates number of port lines,"
},
"numberOfRegistrationsSupported": {
"type": "number",
"example": 30,
"description": "Indicates number of supported registrations."
}
}
},
"DectVlanObject": {
"type": "object",
"required": [
"enabled",
"value"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Denotes whether the VLAN object of DECT is enabled."
},
"value": {
"type": "number",
"description": "Value of the VLAN Object of DECT."
}
}
},
"DefaultLoggingLevelObject": {
"type": "string",
"enum": [
"STANDARD",
"DEBUGGING"
],
"description": " * `STANDARD` - Enables standard logging.\n * `DEBUGGING` - Enables detailed debugging logging.\n"
},
"DeviceActivationStates": {
"type": "string",
"enum": [
"ACTIVATING",
"ACTIVATED",
"DEACTIVATED"
],
"description": " * `ACTIVATING` - Indicates a device is activating.\n * `ACTIVATED` - Indicates a device is activated.\n * `DEACTIVATED` - Indicates a device is deactivated.\n"
},
"DeviceSettingsObject": {
"type": "object",
"required": [
"customizations",
"customEnabled",
"updateInProgress",
"deviceCount",
"lastUpdateTime"
],
"properties": {
"customizations": {
"$ref": "#/components/schemas/CustomizationDeviceLevelObject",
"description": "Indicates the customization object of the device settings."
},
"customEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates if customization is allowed at a location level. If `true`, customized at a location level. If `false`, not customized; uses customer-level configuration."
},
"updateInProgress": {
"type": "boolean",
"example": true,
"description": "Customer devices setting update status. If `true`, an update is in progress (no further changes are allowed). `If false`, no update in progress (changes are allowed)."
},
"deviceCount": {
"type": "number",
"example": 9,
"description": "Number of devices that will be updated."
},
"lastUpdateTime": {
"type": "number",
"example": 1659624763665,
"description": "Indicates the last updated time."
}
}
},
"DeviceSettingsObjectForDeviceLevel": {
"type": "object",
"required": [
"customizations",
"customEnabled",
"updateInProgress",
"deviceCount",
"lastUpdateTime"
],
"properties": {
"customizations": {
"$ref": "#/components/schemas/CustomizationDeviceLevelObjectDevice",
"description": "Indicates the customization object of the device settings."
},
"customEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates if customization is allowed at a device level. If `true`, customized at a device level. If `false`, not customized; uses customer-level configuration."
},
"updateInProgress": {
"type": "boolean",
"example": true,
"description": "Customer devices setting update status. If `true`, an update is in progress (no further changes are allowed). `If false`, no update in progress (changes are allowed)."
},
"deviceCount": {
"type": "number",
"example": 9,
"description": "Number of devices that will be updated."
},
"lastUpdateTime": {
"type": "number",
"example": 1659624763665,
"description": "Indicates the last updated time."
}
}
},
"DirectoryMethod": {
"type": "string",
"enum": [
"XSI_DIRECTORY",
"WEBEX_DIRECTORY"
],
"description": " * `XSI_DIRECTORY` - Set directory services to use standard XSI query method from the device.\n * `WEBEX_DIRECTORY` - Set directory services to use the Webex Enterprise directory.\n"
},
"DisplayCallqueueAgentSoftkeysObject": {
"type": "string",
"enum": [
"FRONT_PAGE",
"LAST_PAGE"
]
},
"DisplayNameSelection": {
"type": "string",
"enum": [
"PERSON_NUMBER",
"PERSON_FIRST_THEN_LAST_NAME",
"PERSON_LAST_THEN_FIRST_NAME"
],
"description": " * `PERSON_NUMBER` - Indicates that devices will display the person's phone number, or if a person doesn't have a phone number, the location number will be displayed.\n * `PERSON_FIRST_THEN_LAST_NAME` - Indicates that devices will display the name in first name then last name format.\n * `PERSON_LAST_THEN_FIRST_NAME` - Indicates that devices will display the name in last name then first name format.\n"
},
"GetMemberResponse": {
"type": "object",
"required": [
"model",
"maxLineCount"
],
"properties": {
"model": {
"type": "string",
"example": "DMS Cisco 192",
"description": "Model type of the device."
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberObject"
},
"description": "List of members that appear on the device."
},
"maxLineCount": {
"type": "number",
"example": 10,
"description": "Maximum number of lines available for the device."
}
}
},
"Hoteling": {
"type": "object",
"required": [
"enabled",
"limitGuestUse"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable/Disable hoteling Host. Enabling the device for hoteling means that a guest(end user) can log into this host(workspace device) and use this device\n\nas if it were their own. This is useful when traveling to a remote office but still needing to place/receive calls with their telephone number and access features normally available to them on their office phone."
},
"limitGuestUse": {
"type": "boolean",
"description": "Enable limiting the time a guest can use the device. The time limit is configured via `guestHoursLimit`."
},
"guestHoursLimit": {
"type": "number",
"description": "Time Limit in hours until hoteling is enabled. Mandatory if `limitGuestUse` is enabled."
}
}
},
"UserHotelingRequestPatch": {
"type": "object",
"required": [
"hoteling"
],
"properties": {
"hoteling": {
"$ref": "#/components/schemas/HotelingRequest",
"description": "Modify person Device Hoteling Setting."
}
}
},
"HotelingRequest": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable/Disable hoteling Host. Enabling the device for hoteling means that a guest(end user) can log into this host(workspace device) and use this device\n\nas if it were their own. This is useful when traveling to a remote office but still needing to place/receive calls with their telephone number and access features normally available to them on their office phone."
},
"limitGuestUse": {
"type": "boolean",
"description": "Enable limiting the time a guest can use the device. The time limit is configured via `guestHoursLimit`."
},
"guestHoursLimit": {
"type": "number",
"description": "Time Limit in hours until hoteling is enabled. Mandatory if `limitGuestUse` is enabled."
}
}
},
"HttpProxyObject": {
"type": "object",
"required": [
"mode",
"autoDiscoveryEnabled",
"host",
"port",
"packUrl",
"authSettingsEnabled",
"username",
"password"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"OFF",
"AUTO",
"MANUAL"
],
"description": "Mode of the HTTP proxy."
},
"autoDiscoveryEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable auto discovery of the URL."
},
"host": {
"type": "string",
"example": "www.example.wxc",
"description": "Specify the host URL if the HTTP mode is set to `MANUAL`."
},
"port": {
"type": "string",
"example": "3128",
"description": "Specify the port if the HTTP mode is set to `MANUAL`."
},
"packUrl": {
"type": "string",
"example": "www.example.wxc",
"description": "Specify PAC URL if auto discovery is disabled."
},
"authSettingsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable authentication settings."
},
"username": {
"type": "string",
"example": "john",
"description": "Specify a username if authentication settings are enabled."
},
"password": {
"type": "string",
"example": "private",
"description": "Specify a password if authentication settings are enabled."
}
}
},
"HttpProxyObjectDevice": {
"type": "object",
"required": [
"mode",
"autoDiscoveryEnabled"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"OFF",
"AUTO",
"MANUAL"
],
"description": "Mode of the HTTP proxy."
},
"autoDiscoveryEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable auto discovery of the URL."
},
"host": {
"type": "string",
"example": "www.example.wxc",
"description": "Specify the host URL if the HTTP mode is set to `MANUAL`."
},
"port": {
"type": "string",
"example": "3128",
"description": "Specify the port if the HTTP mode is set to `MANUAL`."
},
"packUrl": {
"type": "string",
"example": "www.example.wxc",
"description": "Specify PAC URL if auto discovery is disabled."
},
"authSettingsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable authentication settings."
},
"username": {
"type": "string",
"example": "john",
"description": "Specify a username if authentication settings are enabled."
},
"password": {
"type": "string",
"example": "private",
"description": "Specify a password if authentication settings are enabled."
}
}
},
"JobListResponse": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StartJobResponse"
},
"description": "Lists all jobs for the customer in order of most recent one to oldest one irrespective of its status."
}
}
},
"LdapObject": {
"type": "object",
"required": [
"enabled",
"serverAddress",
"serverPort",
"commSecurityType",
"bindDn",
"bindPw",
"baseDn",
"primaryEmailAttribute",
"alternateEmailAttribute"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"serverAddress": {
"type": "string",
"example": "localhost",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"serverPort": {
"type": "number",
"example": 8080,
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"commSecurityType": {
"$ref": "#/components/schemas/CommSecurityType",
"description": "Indicates the selection of the protocol for LDAP service on the phone."
},
"bindDn": {
"type": "string",
"example": "bindDn",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"bindPw": {
"type": "string",
"example": "bindPw",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"baseDn": {
"type": "string",
"example": "baseDn",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"primaryEmailAttribute": {
"type": "string",
"example": "primaryEmailAttribute",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"alternateEmailAttribute": {
"type": "string",
"example": "alternateEmailAttribute",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
}
}
},
"LdapObjectDevice": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"serverAddress": {
"type": "string",
"example": "localhost",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"serverPort": {
"type": "number",
"example": 8080,
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"commSecurityType": {
"$ref": "#/components/schemas/CommSecurityType",
"description": "Indicates the selection of the protocol for LDAP service on the phone."
},
"bindDn": {
"type": "string",
"example": "bindDn",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"bindPw": {
"type": "string",
"example": "bindPw",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"baseDn": {
"type": "string",
"example": "baseDn",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"primaryEmailAttribute": {
"type": "string",
"example": "primaryEmailAttribute",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
},
"alternateEmailAttribute": {
"type": "string",
"example": "alternateEmailAttribute",
"description": "Sets the values needed to enable use of the LDAP service on the phone."
}
}
},
"LineKeyLEDPattern": {
"type": "string",
"enum": [
"DEFAULT",
"PRESET_1"
]
},
"LineKeyLabelSelection": {
"type": "string",
"enum": [
"PERSON_EXTENSION",
"PERSON_FIRST_THEN_LAST_NAME",
"PERSON_LAST_THEN_FIRST_NAME"
],
"description": " * `PERSON_EXTENSION` - This will display the person extension, or if a person doesn't have an extension, the person's first name will be displayed.\n * `PERSON_FIRST_THEN_LAST_NAME` - Indicates that devices will display the name in first name then last name format.\n * `PERSON_LAST_THEN_FIRST_NAME` - Indicates that devices will display the name in last name then first name format.\n"
},
"LineType": {
"type": "string",
"enum": [
"PRIMARY",
"SHARED_CALL_APPEARANCE"
],
"description": " * `PRIMARY` - Primary line for the member.\n * `SHARED_CALL_APPEARANCE` - Shared line for the member. A shared line allows users to receive and place calls to and from another user's extension, using their own device.\n"
},
"DeviceLineType": {
"type": "string",
"enum": [
"PRIMARY",
"SHARED_CALL_APPEARANCE",
"MOBILITY",
"HOTDESKING_GUEST"
],
"description": " * `PRIMARY` - Primary line for the member.\n * `SHARED_CALL_APPEARANCE` - Shared line for the member. A shared line allows users to receive and place calls to and from another user's extension, using their own device.\n * `MOBILITY` - Device is a shared line.\n * `HOTDESKING_GUEST` - Device is a hotdesking guest.\n"
},
"ListDectDeviceType": {
"type": "object",
"required": [
"devices"
],
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DectDeviceList"
},
"description": "Contains a list of devices."
}
}
},
"ListDeviceSettingsObject": {
"type": "object",
"required": [
"customizations",
"updateInProgress",
"deviceCount",
"lastUpdateTime"
],
"properties": {
"customizations": {
"$ref": "#/components/schemas/CustomizationObject",
"description": "Customization object of the device settings."
},
"updateInProgress": {
"type": "boolean",
"description": "Progress of the device update."
},
"deviceCount": {
"type": "number",
"example": 22,
"description": "Device count."
},
"lastUpdateTime": {
"type": "number",
"example": 1659624763665,
"description": "Last updated time."
}
}
},
"MACAddressResponse": {
"type": "object",
"required": [
"status",
"macStatus"
],
"properties": {
"status": {
"type": "string",
"enum": [
"OK",
"ERRORS"
],
"description": "Status of MAC address."
},
"macStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MacStatusObject"
},
"description": "Contains an array of all the MAC address provided and their statuses."
}
}
},
"MacStatusObject": {
"type": "object",
"required": [
"mac",
"state"
],
"properties": {
"mac": {
"type": "string",
"example": "00005E0053B4",
"description": "MAC address."
},
"state": {
"type": "string",
"enum": [
"AVAILABLE",
"UNAVAILABLE",
"DUPLICATE_IN_LIST",
"INVALID"
],
"description": "State of the MAC address.\n * `AVAILABLE` - The requested MAC address is available.\n * `UNAVAILABLE` - The requested MAC address is unavailable.\n * `DUPLICATE_IN_LIST` - The requested MAC address is duplicated.\n * `INVALID` - The requested MAC address is invalid.\n"
},
"errorCode": {
"type": "number",
"example": 5675,
"description": "MAC address validation error code."
},
"message": {
"type": "string",
"example": "[Error 5675] MAC Address is in use.",
"description": "Provides a status message about the MAC address."
}
}
},
"MemberObject": {
"type": "object",
"required": [
"id",
"primaryOwner",
"port",
"lineType",
"lineWeight",
"hotlineEnabled",
"hotlineDestination",
"allowCallDeclineEnabled",
"memberType"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
"description": "Unique identifier for the member."
},
"firstName": {
"type": "string",
"example": "John",
"description": "First name of a person or workspace."
},
"lastName": {
"type": "string",
"example": "Smith",
"description": "Last name of a person or workspace."
},
"phoneNumber": {
"type": "string",
"example": "2055552221",
"description": "Phone Number of a person or workspace. In some regions phone numbers are not returned in E.164 format. This will be supported in a future update."
},
"extension": {
"type": "string",
"example": "000",
"description": "Extension of a person or workspace."
},
"routingPrefix": {
"type": "string",
"example": "1234",
"description": "Routing prefix of location."
},
"esn": {
"type": "string",
"example": "1234000",
"description": "Routing prefix + extension of a person or workspace."
},
"primaryOwner": {
"type": "boolean",
"example": true,
"description": "This field indicates whether the person or the workspace is the owner of the device, and points to a primary Line/Port of the device."
},
"port": {
"type": "number",
"example": 1,
"description": "Port number assigned to person or workspace."
},
"t38FaxCompressionEnabled": {
"type": "boolean",
"description": "T.38 Fax Compression setting and is available only for ATA Devices. Choose T.38 fax compression if the device requires this option. This will override user level compression options."
},
"lineType": {
"$ref": "#/components/schemas/LineType",
"description": "Line type is used to differentiate Primary and SCA, at which endpoint it is assigned."
},
"lineWeight": {
"type": "number",
"example": 1,
"description": "Number of lines that have been configured for the person on the device."
},
"hostIP": {
"type": "string",
"example": "10.0.0.45",
"description": "Registration Host IP address for the line port."
},
"remoteIP": {
"type": "string",
"example": "192.102.12.84",
"description": "Registration Remote IP address for the line port."
},
"hotlineEnabled": {
"type": "boolean",
"example": true,
"description": "Enable Hotline. Configure this line to automatically call a predefined number whenever taken off-hook. Once enabled, the line can only make calls to the predefined number set in hotlineDestination."
},
"hotlineDestination": {
"type": "string",
"example": "+12055552222",
"description": "The preconfigured number for Hotline. Required only if `hotlineEnabled` is set to true."
},
"allowCallDeclineEnabled": {
"type": "boolean",
"example": true,
"description": "Set how a person's device behaves when a call is declined. When set to true, a call decline request is extended to all the endpoints on the device. When set to false, a call decline request only declines the current endpoint."
},
"lineLabel": {
"type": "string",
"example": "share line label",
"description": "Device line label."
},
"linePort": {
"type": "string",
"example": "evypzco5ds@55552222.int10.bcld.webex.com",
"description": "SIP username used in SIP signaling, for example, in registration."
},
"memberType": {
"$ref": "#/components/schemas/MemberType",
"description": "Indicates if the member is of type `PEOPLE` or `PLACE`."
},
"location": {
"$ref": "#/components/schemas/location",
"description": "Location object having a unique identifier for the location and its name."
}
}
},
"MemberType": {
"type": "string",
"enum": [
"PEOPLE",
"PLACE",
"VIRTUAL_LINE"
],
"description": " * `PEOPLE` - Indicates the associated member is a person.\n * `PLACE` - Indicates the associated member is a workspace.\n * `VIRTUAL_LINE` - Indicates the associated member is a virtual line.\n"
},
"MppAudioCodecPriorityObject": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"type": "string",
"example": "CUSTOM",
"description": "Indicates the selection of the Audio Codec Priority Object for an MPP object."
},
"primary": {
"type": "string",
"example": "OPUS",
"description": "Indicates the primary Audio Codec for an MPP object."
},
"secondary": {
"type": "string",
"example": "G722",
"description": "Indicates the secondary Audio Codec for an MPP object."
},
"tertiary": {
"type": "string",
"example": "G711u",
"description": "Indicates the tertiary Audio Codec for an MPP object."
}
}
},
"MppAudioCodecPriorityObjectDevice": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of the Audio Codec Priority Object for an MPP object."
},
"primary": {
"type": "string",
"example": "OPUS",
"description": "Indicates the primary Audio Codec for an MPP object."
},
"secondary": {
"type": "string",
"example": "G722",
"description": "Indicates the secondary Audio Codec for an MPP object."
},
"tertiary": {
"type": "string",
"example": "G711u",
"description": "Indicates the tertiary Audio Codec for an MPP object."
}
}
},
"MppVlanObject": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether the VLAN object of an MPP is enabled."
},
"value": {
"type": "number",
"example": 1,
"description": "Indicates the value of a VLAN object for an MPP object."
},
"pcPort": {
"type": "number",
"example": 1,
"description": "Indicates the PC port value of a VLAN object for an MPP object."
}
}
},
"MppVlanObjectDevice": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether the VLAN object of an MPP is enabled."
},
"value": {
"type": "number",
"example": 1,
"description": "Indicates the value of a VLAN object for an MPP object."
},
"pcPort": {
"type": "number",
"example": 1,
"description": "Indicates the PC port value of a VLAN object for an MPP object."
}
}
},
"NoiseCancellationObject": {
"type": "object",
"required": [
"enabled",
"allowEndUserOverrideEnabled"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the Noise Cancellation."
},
"allowEndUserOverrideEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable to preserve the existing values on the phone and not the value defined for the device setting."
}
}
},
"PhoneLanguage": {
"type": "string",
"enum": [
"PERSON_LANGUAGE",
"ARABIC",
"BULGARIAN",
"CATALAN",
"CHINESE_SIMPLIFIED",
"CHINESE_TRADITIONAL",
"CROATIAN",
"CZECH",
"DANISH",
"DUTCH",
"ENGLISH_UNITED_STATES",
"ENGLISH_UNITED_KINGDOM",
"FINNISH",
"FRENCH_CANADA",
"FRENCH_FRANCE",
"GERMAN",
"GREEK",
"HEBREW",
"HUNGARIAN",
"ITALIAN",
"JAPANESE",
"KOREAN",
"NORWEGIAN",
"POLISH",
"PORTUGUESE_PORTUGAL",
"RUSSIAN",
"SPANISH_COLOMBIA",
"SPANISH_SPAIN",
"SLOVAK",
"SWEDISH",
"SLOVENIAN",
"TURKISH",
"UKRAINE"
],
"description": " * `PERSON_LANGUAGE` - Indicates a person's announcement language.\n"
},
"PoeMode": {
"type": "string",
"enum": [
"NORMAL",
"MAXIMUM"
],
"description": " * `NORMAL` - Use normal power consumption.\n * `MAXIMUM` - Use maximum power consumption.\n"
},
"PskObject": {
"type": "object",
"required": [
"psk1",
"psk4"
],
"properties": {
"psk1": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK1."
},
"psk2": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK2."
},
"psk3": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK3."
},
"psk4": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK4."
},
"psk5": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK5."
},
"psk6": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK6."
},
"psk7": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK7."
},
"psk8": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK8."
},
"psk9": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK9."
},
"psk10": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK10."
},
"psk11": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK11."
},
"psk12": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK12."
},
"psk13": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK13."
},
"psk14": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK14."
},
"psk15": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK15."
},
"psk16": {
"type": "string",
"example": "fnc=sd;ext=*11;nme=Call Pull",
"description": "Specify PSK16."
}
}
},
"PutDeviceSettingsRequest": {
"type": "object",
"required": [
"customizations",
"customEnabled"
],
"properties": {
"customizations": {
"$ref": "#/components/schemas/CustomizationDeviceLevelObjectDevice",
"description": "Indicates the customization object of the device settings."
},
"customEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates if customization is allowed at a device level. If true, customized at a device level. If false, not customized; uses customer-level configuration."
}
}
},
"PutMemberObject": {
"type": "object",
"required": [
"port",
"id",
"primaryOwner",
"lineType",
"lineWeight",
"hotlineEnabled",
"hotlineDestination",
"allowCallDeclineEnabled"
],
"properties": {
"port": {
"type": "number",
"example": 1,
"description": "Person's assigned port number."
},
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
"description": "Unique identifier for the member."
},
"t38FaxCompressionEnabled": {
"type": "boolean",
"description": "T.38 Fax Compression setting and is available only for ATA Devices. Choose T.38 fax compression if the device requires this option. This will override user level compression options."
},
"primaryOwner": {
"type": "boolean",
"example": true,
"description": "Whether the user is the owner of the device or not, and points to a primary Line/Port of device."
},
"lineType": {
"$ref": "#/components/schemas/LineType",
"description": "Line type is used to differentiate Primary and SCA, at which endpoint it is assigned."
},
"lineWeight": {
"type": "number",
"example": 1,
"description": "Number of lines that have been configured for the person on the device."
},
"hotlineEnabled": {
"type": "boolean",
"example": true,
"description": "Enable Hotline. Configure this line to automatically call a predefined number whenever taken off-hook. Once enabled, the line can only make calls to the predefined number set in hotlineDestination."
},
"hotlineDestination": {
"type": "string",
"example": "+12055552222",
"description": "The preconfigured number for Hotline. Required only if `hotlineEnabled` is set to true."
},
"allowCallDeclineEnabled": {
"type": "boolean",
"example": true,
"description": "Set how a person's device behaves when a call is declined. When set to true, a call decline request is extended to all the endpoints on the device. When set to false, a call decline request only declines the current endpoint."
},
"lineLabel": {
"type": "string",
"example": "share line label",
"description": "Device line label."
}
}
},
"PutMembersRequest": {
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PutMemberObject"
},
"description": "This specifies the new list of device members, completely replacing the existing device members. If the member's list is omitted then all the users are removed except the primary user."
}
}
},
"ScreenTimeoutObject": {
"type": "object",
"required": [
"enabled",
"value"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the Screen Time object is enabled."
},
"value": {
"type": "number",
"example": 400,
"description": "Indicates the value of screen timeout."
}
}
},
"SearchMemberObject": {
"type": "object",
"required": [
"id",
"lineType",
"allowCallDeclineEnabled",
"memberType"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk",
"description": "Unique identifier for the member."
},
"firstName": {
"type": "string",
"example": "John",
"description": "First name of a person or workspace."
},
"lastName": {
"type": "string",
"example": "Smith",
"description": "Last name of a person or workspace."
},
"phoneNumber": {
"type": "string",
"example": "+12055552221",
"description": "Phone Number of a person or workspace."
},
"t38FaxCompressionEnabled": {
"type": "boolean",
"description": "T.38 Fax Compression setting and available only for ATA Devices. Choose T.38 fax compression if the device requires this option. this will override user level compression options."
},
"lineType": {
"$ref": "#/components/schemas/LineType",
"description": "Line type is used to differentiate Primary and SCA, at which endpoint it is assigned."
},
"allowCallDeclineEnabled": {
"type": "boolean",
"example": true,
"description": "Set how a person's device behaves when a call is declined. When set to true, a call decline request is extended to all the endpoints on the device. When set to false, a call decline request only declines the current endpoint."
},
"memberType": {
"$ref": "#/components/schemas/MemberType",
"description": "Indicates if member is of type `PEOPLE` or `PLACE`."
},
"location": {
"$ref": "#/components/schemas/location",
"description": "Location object having a unique identifier for the location and its name."
}
}
},
"SearchMemberResponse": {
"type": "object",
"properties": {
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SearchMemberObject"
},
"description": "List of members available for the device."
}
}
},
"SelectionType": {
"type": "string",
"enum": [
"REGIONAL",
"CUSTOM"
],
"description": " * `REGIONAL` - Indicates the regional selection type for audio codec priority.\n * `CUSTOM` - Indicates the custom selection type for audio codec priority.\n"
},
"SnmpObject": {
"type": "object",
"required": [
"enabled",
"trustedIP",
"getCommunity",
"setCommunity",
"snmpV3Enabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Denotes whether the Simple Network Management Protocol of an ATA is enabled."
},
"trustedIP": {
"type": "string",
"example": "10.0.0.45",
"description": "Trusted IPv4 address and subnet mask in this order: 0.0.0.0/0.0.0.0."
},
"getCommunity": {
"type": "string",
"example": "public",
"description": "Read-only community string that allows/denies access to other device's statistics. Default value is `public`."
},
"setCommunity": {
"type": "string",
"example": "private",
"description": "Read-write community string that protects the device against unauthorized changes. Must never be set to `public`."
},
"snmpV3Enabled": {
"type": "boolean",
"description": "Denotes whether the SNMPv3 security is enabled."
}
}
},
"SoftKeyLayoutObject": {
"type": "object",
"required": [
"softKeyMenu",
"psk",
"softKeyMenuDefaults",
"pskDefaults"
],
"properties": {
"softKeyMenu": {
"$ref": "#/components/schemas/SoftKeyMenuObject",
"description": "Customize SoftKey menu settings."
},
"psk": {
"$ref": "#/components/schemas/PskObject",
"description": "Customize PSK."
},
"softKeyMenuDefaults": {
"$ref": "#/components/schemas/SoftKeyMenuObject",
"description": "Default SoftKey menu settings."
},
"pskDefaults": {
"$ref": "#/components/schemas/PskObject",
"description": "Default PSK."
}
}
},
"SoftKeyMenuObject": {
"type": "object",
"required": [
"idleKeyList",
"offHookKeyList",
"dialingInputKeyList",
"progressingKeyList",
"connectedKeyList",
"connectedVideoKeyList",
"startTransferKeyList",
"startConferenceKeyList",
"conferencingKeyList",
"releasingKeyList",
"holdKeyList",
"ringingKeyList",
"sharedActiveKeyList",
"sharedHeldKeyList"
],
"properties": {
"idleKeyList": {
"type": "string",
"example": "guestin|;guestout|;acd_login|;acd_logout|;astate|;redial|;newcall|;cfwd|;recents|;dnd|;unpark|;psk1|;gpickup|;pickup|;dir|4;miss|5;selfview|;messages",
"description": "Specify the idle key list."
},
"offHookKeyList": {
"type": "string",
"example": "endcall|1;redial|2;dir|3;lcr|4;unpark|5;pickup|6;gpickup|7",
"description": "Specify the off hook key list."
},
"dialingInputKeyList": {
"type": "string",
"example": "dial|1;cancel|2;delchar|3;left|5;right|6",
"description": "Specify the dialing input key list."
},
"progressingKeyList": {
"type": "string",
"example": "endcall|2",
"description": "Specify the progressing key list."
},
"connectedKeyList": {
"type": "string",
"example": "hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume",
"description": "Specify the connected key list."
},
"connectedVideoKeyList": {
"type": "string",
"example": "hold;endcall;xfer;conf;xferLx;confLx;bxfer;phold;redial;dir;park;crdstart;crdstop;crdpause;crdresume",
"description": "Specify the connected video key list."
},
"startTransferKeyList": {
"type": "string",
"example": "endcall|2;xfer|3",
"description": "Start the transfer key list."
},
"startConferenceKeyList": {
"type": "string",
"example": "endcall|2;conf|3",
"description": "Start the conference key list."
},
"conferencingKeyList": {
"type": "string",
"example": "endcall;join;crdstart;crdstop;crdpause;crdresume",
"description": "Specify the conferencing key list."
},
"releasingKeyList": {
"type": "string",
"example": "endcall|2",
"description": "Specify the releasing key list."
},
"holdKeyList": {
"type": "string",
"example": "resume|1;endcall|2;newcall|3;redial|4;dir|5",
"description": "Specify the hold key list."
},
"ringingKeyList": {
"type": "string",
"example": "answer|1;ignore|2",
"description": "Specify the ringing key list."
},
"sharedActiveKeyList": {
"type": "string",
"example": "newcall|1;psk1|2;dir|3;back|4",
"description": "Specify the shared active key list."
},
"sharedHeldKeyList": {
"type": "string",
"example": "resume|1;dir|4",
"description": "Specify the shared held key list."
}
}
},
"StartJobResponse": {
"type": "object",
"required": [
"name",
"id",
"jobType",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"latestExecutionStatus",
"operationType",
"sourceLocationId",
"targetLocationId",
"counts"
],
"properties": {
"name": {
"type": "string",
"description": "Job name."
},
"id": {
"type": "string",
"description": "Unique identifier of the job."
},
"jobType": {
"type": "string",
"description": "Job type."
},
"trackingId": {
"type": "string",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"description": "Unique identifier to identify which user has run the job."
},
"sourceCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer for which the job was run."
},
"instanceId": {
"type": "number",
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject1"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"type": "string",
"description": "Indicates the most recent status (STARTING, STARTED, COMPLETED, FAILED) of the job at the time of invocation."
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"operationType": {
"type": "string",
"description": "Indicates operation type that was carried out."
},
"sourceLocationId": {
"type": "string",
"description": "Unique location identifier for which the job was run."
},
"targetLocationId": {
"type": "string",
"description": "Unique location identifier for which the numbers have been moved."
},
"counts": {
"$ref": "#/components/schemas/CountObject",
"description": "Job statistics."
}
}
},
"UsbPortsObject": {
"type": "object",
"required": [
"enabled",
"sideUsbEnabled",
"rearUsbEnabled"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "New Control to Enable/Disable the side USB port."
},
"sideUsbEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable use of the side USB port on the MPP device. Enabled by default."
},
"rearUsbEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable use of the rear USB port on the MPP device."
}
}
},
"ValidateMACRequest": {
"type": "object",
"required": [
"macs"
],
"properties": {
"macs": {
"type": "array",
"items": {
"type": "string",
"example": "ab125678cdef,00005E0053B4"
},
"description": "MAC addresses to be validated."
}
}
},
"VlanObject": {
"type": "object",
"required": [
"enabled",
"value"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Denotes whether the VLAN object of an ATA is enabled."
},
"value": {
"type": "number",
"example": 1,
"description": "The value of the VLAN Object of an ATA object."
}
}
},
"VlanObjectDevice": {
"type": "object",
"required": [
"enabled",
"value"
],
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Denotes whether the VLAN object of an ATA is enabled."
},
"value": {
"type": "number",
"example": 1,
"description": "The value of the VLAN Object of an ATA object."
}
}
},
"VolumeSettingsObject": {
"type": "object",
"required": [
"ringerVolume",
"speakerVolume",
"handsetVolume",
"headsetVolume",
"eHookEnabled",
"allowEndUserOverrideEnabled"
],
"properties": {
"ringerVolume": {
"type": "number",
"example": 9,
"description": "Specify a ringer volume level through a numeric value between 0 and 15."
},
"speakerVolume": {
"type": "number",
"example": 11,
"description": "Specify a speaker volume level through a numeric value between 0 and 15."
},
"handsetVolume": {
"type": "number",
"example": 10,
"description": "Specify a handset volume level through a numeric value between 0 and 15."
},
"headsetVolume": {
"type": "number",
"example": 10,
"description": "Specify a headset volume level through a numeric value between 0 and 15."
},
"eHookEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the wireless headset hookswitch control."
},
"allowEndUserOverrideEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable to preserve the existing values on the phone and not the values defined for the device settings."
}
}
},
"WebAccessObject": {
"type": "object",
"required": [
"enabled",
"password"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Ability to enable or disable the web browser access for the 840/860."
},
"password": {
"type": "string",
"example": "password",
"description": "Ability to set a Web Server Password."
}
}
},
"WifiAudioCodecPriorityObject": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"$ref": "#/components/schemas/SelectionType",
"description": "Indicates the selection of the Audio Codec Priority Object for an WiFi object."
},
"primary": {
"type": "string",
"example": "OPUS",
"description": "Indicates the primary Audio Codec for an WiFi object."
},
"secondary": {
"type": "string",
"example": "G722",
"description": "Indicates the secondary Audio Codec for an WiFi object."
},
"tertiary": {
"type": "string",
"example": "G711u",
"description": "Indicates the tertiary Audio Codec for an WiFi object."
}
}
},
"WifiAudioCodecPriorityObjectDevice": {
"type": "object",
"required": [
"selection",
"primary",
"secondary",
"tertiary"
],
"properties": {
"selection": {
"type": "string",
"example": "CUSTOM",
"description": "Indicates the selection of the Audio Codec Priority Object for an WiFi object."
},
"primary": {
"type": "string",
"example": "OPUS",
"description": "Indicates the primary Audio Codec for an WiFi object."
},
"secondary": {
"type": "string",
"example": "G722",
"description": "Indicates the secondary Audio Codec for an WiFi object."
},
"tertiary": {
"type": "string",
"example": "G711u",
"description": "Indicates the tertiary Audio Codec for an WiFi object."
}
}
},
"WifiNetworkObject": {
"type": "object",
"required": [
"enabled",
"authenticationMethod",
"ssidName",
"userId"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether the wifi network is enabled."
},
"authenticationMethod": {
"$ref": "#/components/schemas/AuthenticationMethodObject",
"description": "Authentication method of wifi network."
},
"ssidName": {
"type": "string",
"example": "my_wifi_network",
"description": "SSID name of the wifi network."
},
"userId": {
"type": "string",
"example": "test-user",
"description": "User Id of the wifi network."
}
}
},
"WifiNetworkObjectDevice": {
"type": "object",
"required": [
"enabled",
"authenticationMethod",
"ssidName",
"userId"
],
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether the wifi network is enabled."
},
"authenticationMethod": {
"$ref": "#/components/schemas/AuthenticationMethodObject",
"description": "Authentication method of the WiFi network."
},
"ssidName": {
"type": "string",
"example": "my_wifi_network",
"description": "SSID name of the wifi network."
},
"userId": {
"type": "string",
"example": "test-user",
"description": "User ID for the WiFi network."
}
}
},
"ataObject": {
"type": "object",
"required": [
"audioCodecPriority",
"ataDtmfMode",
"ataDtmfMethod",
"cdpEnabled",
"lldpEnabled",
"qosEnabled",
"vlan",
"webAccessEnabled",
"nightlyResyncEnabled",
"snmp"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/AudioCodecPriorityObject",
"description": "Choose up to three predefined codec priority options available for your region."
},
"ataDtmfMode": {
"$ref": "#/components/schemas/AtaDtmfModeObject",
"description": "DTMF Detection Tx Mode selection for Cisco ATA devices."
},
"ataDtmfMethod": {
"$ref": "#/components/schemas/AtaDtmfMethodObject",
"description": "Method for transmitting DTMF signals to the far end."
},
"cdpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Cisco Discovery Protocol for local devices."
},
"lldpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform."
},
"vlan": {
"$ref": "#/components/schemas/VlanObject",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"webAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user level web access to the local device."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the automatic nightly configuration resync of the MPP device."
},
"snmp": {
"$ref": "#/components/schemas/SnmpObject",
"description": "Specify values needed to enable use of the SNMP service from the phone."
}
}
},
"ataObjectDevice": {
"type": "object",
"required": [
"audioCodecPriority",
"ataDtmfMode",
"ataDtmfMethod",
"cdpEnabled",
"lldpEnabled",
"qosEnabled",
"vlan",
"webAccessEnabled",
"nightlyResyncEnabled",
"snmp"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/AudioCodecPriorityObjectDevice",
"description": "Choose up to three predefined codec priority options available for your region."
},
"ataDtmfMode": {
"$ref": "#/components/schemas/AtaDtmfModeObject",
"description": "DTMF Detection Tx Mode selection for Cisco ATA devices."
},
"ataDtmfMethod": {
"$ref": "#/components/schemas/AtaDtmfMethodObject",
"description": "Method for transmitting DTMF signals to the far end."
},
"cdpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Cisco Discovery Protocol for local devices."
},
"lldpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform."
},
"vlan": {
"$ref": "#/components/schemas/VlanObjectDevice",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"webAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user level web access to the local device."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the automatic nightly configuration resync of the MPP device."
},
"snmp": {
"$ref": "#/components/schemas/SnmpObject",
"description": "Specify values needed to enable use of the SNMP service from the phone."
}
}
},
"dectObject": {
"type": "object",
"required": [
"audioCodecPriority",
"cdpEnabled",
"dect6825HandsetEmergencyNumber",
"lldpEnabled",
"multicast",
"qosEnabled",
"vlan",
"webAccessEnabled",
"nightlyResyncEnabled"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/DectAudioCodecPriorityObject",
"description": "Choose up to three predefined codec priority options available for your region."
},
"cdpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Cisco Discovery Protocol for local devices."
},
"dect6825HandsetEmergencyNumber": {
"type": "string",
"description": "Specify the destination number to be dialled from the DECT Handset top button when pressed."
},
"lldpEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"multicast": {
"type": "string",
"description": "Specify up to 3 multicast group URLs each with a unique listening port."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable quality of service tagging of packets from the local device to the Webex Calling platform."
},
"vlan": {
"$ref": "#/components/schemas/DectVlanObject",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"webAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user level web access to the local device."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable phone's default behavior regarding the nightly maintenance synchronization with the Webex Calling platform."
}
}
},
"deviceList": {
"type": "object",
"required": [
"devices",
"maxDeviceCount",
"maxOwnedDeviceCount"
],
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/devices"
},
"description": "Array of devices available to person."
},
"maxDeviceCount": {
"type": "number",
"description": "Maximum number of devices a person can be assigned to."
},
"maxOwnedDeviceCount": {
"type": "number",
"description": "Maximum number of devices a person can own."
}
}
},
"deviceOwner": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of a person or a workspace."
},
"type": {
"$ref": "#/components/schemas/MemberType",
"description": "Enumeration that indicates if the member is of type `PEOPLE` or `PLACE`."
},
"firstName": {
"type": "string",
"description": "First name of the device owner. This field is not returned when the value is a placeholder such as `.` or `-`."
},
"lastName": {
"type": "string",
"description": "Last name of the device owner. This field is not returned when the value is a placeholder such as `.` or `-`."
}
}
},
"devices": {
"type": "object",
"required": [
"id",
"model",
"primaryOwner",
"type",
"hoteling",
"owner",
"activationState"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for a device."
},
"description": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma separated array of tags used to describe device."
},
"model": {
"type": "string",
"description": "Identifier for device model."
},
"modelType": {
"$ref": "#/components/schemas/DeviceType",
"description": "Identifier for device model type."
},
"mac": {
"type": "string",
"description": "MAC address of device."
},
"ipAddress": {
"type": "string",
"description": "IP address of device."
},
"primaryOwner": {
"type": "boolean",
"description": "Indicates whether the person or the workspace is the owner of the device, and points to a primary Line/Port of the device."
},
"type": {
"$ref": "#/components/schemas/DeviceLineType",
"description": "Indicates if the line is acting as a primary line or a shared line for this device."
},
"hoteling": {
"$ref": "#/components/schemas/HotelingRequest",
"description": "Hoteling login settings, which are available when the device is the owner's primary device and device type is PRIMARY. Hoteling login settings are set at the owner level."
},
"owner": {
"$ref": "#/components/schemas/deviceOwner",
"description": "Owner of device."
},
"activationState": {
"$ref": "#/components/schemas/ActivationStates",
"description": "Activation state of device."
}
}
},
"DeviceType": {
"type": "string",
"enum": [
"MPP",
"ATA",
"GENERIC_SIP",
"ESIM",
"ROOM_OS",
"MOBILE",
"DESK_PHONE"
],
"description": " * `MPP` - Cisco Multiplatform Phone\n * `ATA` - Analog Telephone Adapters\n * `GENERIC_SIP` - GENERIC Session Initiation Protocol\n * `ESIM` - Esim Supported Webex Go\n * `ROOM_OS` - Cisco Webex Room OS and the Room Series device\n * `MOBILE` - Mobile\n * `DESK_PHONE` - Desk Phone\n"
},
"jobIdResponseObject": {
"type": "object",
"required": [
"name",
"id",
"jobType",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"latestExecutionStatus",
"operationType",
"sourceLocationId",
"targetLocationId",
"sourceLocationName",
"targetLocationName",
"counts"
],
"properties": {
"name": {
"type": "string",
"description": "Job name."
},
"id": {
"type": "string",
"description": "Unique identifier of the job."
},
"jobType": {
"type": "string",
"description": "Job type."
},
"trackingId": {
"type": "string",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"description": "Unique identifier to identify which user has run the job."
},
"sourceCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer for which the job was run."
},
"instanceId": {
"type": "number",
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"type": "string",
"description": "Indicates the most recent status (STARTING, STARTED, COMPLETED, FAILED) of the job at the time of invocation."
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"operationType": {
"type": "string",
"description": "Indicates the operation type that was carried out."
},
"sourceLocationId": {
"type": "string",
"description": "Unique location identifier for which the job was run."
},
"targetLocationId": {
"type": "string",
"description": "Unique location identifier for which the numbers have been moved."
},
"sourceLocationName": {
"type": "string",
"description": "The location name for which the job was run."
},
"targetLocationName": {
"type": "string",
"description": "The location name for which the numbers have been moved."
},
"counts": {
"$ref": "#/components/schemas/CountObject",
"description": "Job statistics."
}
}
},
"location": {
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzJiNDkyZmZkLTRjNGItNGVmNS04YzAzLWE1MDYyYzM4NDA5Mw",
"description": "Location identifier associated with the members."
},
"name": {
"type": "string",
"example": "MainOffice",
"description": "Location name associated with the member."
}
}
},
"mppObject": {
"type": "object",
"required": [
"pnacEnabled",
"audioCodecPriority",
"backlightTimer",
"background",
"cdpEnabled",
"defaultLoggingLevel",
"dndServicesEnabled",
"acd",
"shortInterdigitTimer",
"longInterdigitTimer",
"lineKeyLabelFormat",
"lineKeyLEDPattern",
"lldpEnabled",
"mppUserWebAccessEnabled",
"multicast",
"enhancedMulticast",
"offHookTimer",
"phoneLanguage",
"poeMode",
"qosEnabled",
"screenTimeout",
"usbPortsEnabled",
"vlan",
"wifiNetwork",
"callHistory",
"contacts",
"webexMeetingsEnabled",
"volumeSettings",
"cfExpandedSoftKey",
"httpProxy",
"bluetooth",
"passThroughPortEnabled",
"userPasswordOverrideEnabled",
"activeCallFocusEnabled",
"peerFirmwareEnabled",
"noiseCancellation",
"voiceFeedbackAccessibilityEnabled",
"dialAssistEnabled",
"callsPerLine",
"nightlyResyncEnabled",
"missedCallNotificationEnabled",
"softKeyLayout",
"backgroundImage8875",
"backlightTimer68XX78XX",
"allowMonitorLinesEnabled"
],
"properties": {
"pnacEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the PNAC of MPP object is enabled or not."
},
"audioCodecPriority": {
"$ref": "#/components/schemas/MppAudioCodecPriorityObject",
"description": "Choose up to three predefined codec priority options available for your region."
},
"backlightTimer": {
"$ref": "#/components/schemas/BacklightTimerObject",
"description": "Choose the length of time (in minutes) for the phone's backlight to remain on."
},
"background": {
"type": "object",
"properties": {
"image": {
"$ref": "#/components/schemas/BackgroundImage"
},
"customUrl": {
"type": "string"
}
}
},
"displayNameFormat": {
"$ref": "#/components/schemas/DisplayNameSelection",
"description": "The display name that appears on the phone screen."
},
"cdpEnabled": {
"type": "boolean",
"description": "Allows you to enable/disable CDP for local devices."
},
"defaultLoggingLevel": {
"$ref": "#/components/schemas/DefaultLoggingLevelObject",
"description": "Choose the desired logging level for an MPP devices."
},
"dndServicesEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Do-Not-Disturb capabilities for Multi-Platform Phones."
},
"acd": {
"$ref": "#/components/schemas/AcdObject",
"description": "Holds the Acd object value."
},
"shortInterdigitTimer": {
"type": "number",
"example": 14,
"description": "Indicates the short inter digit timer value."
},
"longInterdigitTimer": {
"type": "number",
"example": 16,
"description": "Indicates the long inter digit timer value.."
},
"lineKeyLabelFormat": {
"$ref": "#/components/schemas/LineKeyLabelSelection",
"description": "Line key labels define the format of what's shown next to line keys."
},
"lineKeyLEDPattern": {
"$ref": "#/components/schemas/LineKeyLEDPattern",
"description": "LED patterns define lighting schemes for the line keys on the MPP devices. Note that this parameter is not supported on the MPP 8875"
},
"lldpEnabled": {
"type": "boolean",
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"mppUserWebAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user-level access to the web interface of Multi-Platform Phones."
},
"multicast": {
"type": "array",
"items": {
"type": "string",
"example": "[\"192.86.108.226:22\"]"
},
"description": "Select up to 10 Multicast Group URLs (each with a unique Listening Port)."
},
"enhancedMulticast": {
"$ref": "#/components/schemas/EnhancedMulticastObject",
"description": "Specify the enhanced multicast settings for the MPP device."
},
"offHookTimer": {
"type": "number",
"example": 30,
"description": "Specify the amount of time (in seconds) that a phone can remain off-hook."
},
"phoneLanguage": {
"$ref": "#/components/schemas/PhoneLanguage",
"description": "Select the language for your MPP phone. Setting this overrides the default language setting in place for your provisioned location."
},
"poeMode": {
"$ref": "#/components/schemas/PoeMode",
"description": "Enable/disable the Power-Over-Ethernet mode for Multi-Platform Phones."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Allows you to enable/disable tagging of packets from the local device to the Webex Calling platform."
},
"screenTimeout": {
"$ref": "#/components/schemas/ScreenTimeoutObject",
"description": "Specify the amount of inactive time needed (in seconds) before the phone's screen saver activates."
},
"usbPortsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the use of the USB ports on Multi-Platform phones."
},
"vlan": {
"$ref": "#/components/schemas/MppVlanObject",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"wifiNetwork": {
"$ref": "#/components/schemas/WifiNetworkObject",
"description": "Specify the Wi-Fi SSID and password for wireless-enabled MPP phones."
},
"callHistory": {
"$ref": "#/components/schemas/CallHistoryMethod",
"description": "Specify the call history information to use. Only applies to user devices."
},
"contacts": {
"$ref": "#/components/schemas/DirectoryMethod",
"description": "Specify the directory services to use."
},
"webexMeetingsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the availability of the webex meetings functionality from the phone."
},
"volumeSettings": {
"$ref": "#/components/schemas/VolumeSettingsObject",
"description": "Specify all volume level values on the phone."
},
"cfExpandedSoftKey": {
"$ref": "#/components/schemas/CallForwardExpandedSoftKey",
"description": "Specify the call forward expanded soft key behavior."
},
"httpProxy": {
"$ref": "#/components/schemas/HttpProxyObject",
"description": "Specify HTTP Proxy values."
},
"bluetooth": {
"$ref": "#/components/schemas/BluetoothObject",
"description": "Enable/disable the visibility of the bluetooth menu on the MPP device."
},
"passThroughPortEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the use of the PC passthrough ethernet port on supported phone models."
},
"userPasswordOverrideEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the ability for an end user to set a local password on the phone to restrict local access to the device."
},
"activeCallFocusEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the default screen behavior when inbound calls are received."
},
"peerFirmwareEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable peer firmware sharing."
},
"noiseCancellation": {
"$ref": "#/components/schemas/NoiseCancellationObject",
"description": "Enable/disable local noise cancellation on active calls from the device."
},
"voiceFeedbackAccessibilityEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable visibility of the Accessibility Voice Feedback menu on the MPP device."
},
"dialAssistEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable availability of dial assist feature on the phone."
},
"callsPerLine": {
"type": "number",
"example": 9,
"description": "Specify the number of calls per unique line appearance on the phone."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable automatic nightly configuration resync of the MPP device."
},
"missedCallNotificationEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the visual indication of missed calls."
},
"softKeyLayout": {
"$ref": "#/components/schemas/SoftKeyLayoutObject",
"description": "Specify the softkey layout per phone menu state."
},
"backgroundImage8875": {
"$ref": "#/components/schemas/BackgroundImageColor",
"description": "Specify the image option for the MPP 8875 phone background."
},
"backlightTimer68XX78XX": {
"$ref": "#/components/schemas/BacklightTimer68XX",
"description": "Specify the use of the backlight feature on 6800 nad 7800 series devices."
},
"allowMonitorLinesEnabled": {
"type": "boolean",
"description": "Enable/disable monitoring for MPP non-primary device."
},
"iceEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable SIP media streams to go directly between phones on the same local network."
}
}
},
"mppObjectDevice": {
"type": "object",
"required": [
"pnacEnabled",
"audioCodecPriority",
"backlightTimer",
"background",
"cdpEnabled",
"defaultLoggingLevel",
"dndServicesEnabled",
"acd",
"shortInterdigitTimer",
"longInterdigitTimer",
"lineKeyLabelFormat",
"lineKeyLEDPattern",
"lldpEnabled",
"mppUserWebAccessEnabled",
"multicast",
"enhancedMulticast",
"offHookTimer",
"phoneLanguage",
"poeMode",
"qosEnabled",
"screenTimeout",
"usbPortsEnabled",
"usbPorts",
"vlan",
"wifiNetwork",
"callHistory",
"contacts",
"webexMeetingsEnabled",
"volumeSettings",
"cfExpandedSoftKey",
"httpProxy",
"bluetooth",
"passThroughPortEnabled",
"userPasswordOverrideEnabled",
"activeCallFocusEnabled",
"peerFirmwareEnabled",
"noiseCancellation",
"voiceFeedbackAccessibilityEnabled",
"dialAssistEnabled",
"callsPerLine",
"nightlyResyncEnabled",
"missedCallNotificationEnabled",
"softKeyLayout",
"backgroundImage8875",
"backlightTimer68XX78XX",
"allowMonitorLinesEnabled"
],
"properties": {
"pnacEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the PNAC of MPP object is enabled or not."
},
"audioCodecPriority": {
"$ref": "#/components/schemas/MppAudioCodecPriorityObjectDevice",
"description": "Choose up to three predefined codec priority options available for your region."
},
"backlightTimer": {
"$ref": "#/components/schemas/BacklightTimerObjectDevice",
"description": "Choose the length of time (in minutes) for the phone's backlight to remain on."
},
"background": {
"type": "object",
"properties": {
"image": {
"$ref": "#/components/schemas/BackgroundImage"
},
"customUrl": {
"type": "string"
}
}
},
"displayNameFormat": {
"$ref": "#/components/schemas/DisplayNameSelection",
"description": "The display name that appears on the phone screen."
},
"cdpEnabled": {
"type": "boolean",
"description": "Allows you to enable/disable CDP for local devices."
},
"defaultLoggingLevel": {
"$ref": "#/components/schemas/DefaultLoggingLevelObject",
"description": "Choose the desired logging level for an MPP devices."
},
"dndServicesEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable Do-Not-Disturb capabilities for Multi-Platform Phones."
},
"acd": {
"$ref": "#/components/schemas/AcdObjectDevice",
"description": "Holds the Acd object value."
},
"shortInterdigitTimer": {
"type": "number",
"example": 14,
"description": "Indicates the short inter digit timer value."
},
"longInterdigitTimer": {
"type": "number",
"example": 16,
"description": "Indicates the long inter digit timer value.."
},
"lineKeyLabelFormat": {
"$ref": "#/components/schemas/LineKeyLabelSelection",
"description": "Line key labels define the format of what's shown next to line keys."
},
"lineKeyLEDPattern": {
"$ref": "#/components/schemas/LineKeyLEDPattern",
"description": "LED patterns define lighting schemes for the line keys on the MPP devices. Note that this parameter is not supported on the MPP 8875"
},
"lldpEnabled": {
"type": "boolean",
"description": "Enable/disable Link Layer Discovery Protocol for local devices."
},
"mppUserWebAccessEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable user-level access to the web interface of Multi-Platform Phones."
},
"multicast": {
"type": "array",
"items": {
"type": "string",
"example": "[\"192.86.108.226:22\"]"
},
"description": "Select up to 10 Multicast Group URLs (each with a unique Listening Port)."
},
"enhancedMulticast": {
"$ref": "#/components/schemas/EnhancedMulticastObject",
"description": "Specify the enhanced multicast settings for the MPP device."
},
"offHookTimer": {
"type": "number",
"example": 30,
"description": "Specify the amount of time (in seconds) that a phone can remain off-hook."
},
"phoneLanguage": {
"$ref": "#/components/schemas/PhoneLanguage",
"description": "Select the language for your MPP phone. Setting this overrides the default language setting in place for your provisioned location."
},
"poeMode": {
"$ref": "#/components/schemas/PoeMode",
"description": "Enable/disable the Power-Over-Ethernet mode for Multi-Platform Phones."
},
"qosEnabled": {
"type": "boolean",
"example": true,
"description": "Allows you to enable/disable tagging of packets from the local device to the Webex Calling platform."
},
"screenTimeout": {
"$ref": "#/components/schemas/ScreenTimeoutObject",
"description": "Specify the amount of inactive time needed (in seconds) before the phone's screen saver activates."
},
"usbPortsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the use of the USB ports on Multi-Platform phones."
},
"usbPorts": {
"$ref": "#/components/schemas/UsbPortsObject",
"description": "By default the Side USB port is enabled to support KEMs and other peripheral devices. Use the option to disable use of this port."
},
"vlan": {
"$ref": "#/components/schemas/MppVlanObjectDevice",
"description": "Specify a numeric Virtual LAN ID for devices."
},
"wifiNetwork": {
"$ref": "#/components/schemas/WifiNetworkObjectDevice",
"description": "Specify the Wi-Fi SSID and password for wireless-enabled MPP phones."
},
"callHistory": {
"$ref": "#/components/schemas/CallHistoryMethod",
"description": "Specify the call history information to use. Only applies to user devices."
},
"contacts": {
"$ref": "#/components/schemas/DirectoryMethod",
"description": "Specify the directory services to use."
},
"webexMeetingsEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the availability of the webex meetings functionality from the phone."
},
"volumeSettings": {
"$ref": "#/components/schemas/VolumeSettingsObject",
"description": "Specify all volume level values on the phone."
},
"cfExpandedSoftKey": {
"$ref": "#/components/schemas/CallForwardExpandedSoftKey",
"description": "Specify the call forward expanded soft key behavior."
},
"httpProxy": {
"$ref": "#/components/schemas/HttpProxyObjectDevice",
"description": "Specify HTTP Proxy values."
},
"bluetooth": {
"$ref": "#/components/schemas/BluetoothObjectDevice",
"description": "Enable/disable the visibility of the bluetooth menu on the MPP device."
},
"passThroughPortEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the use of the PC passthrough ethernet port on supported phone models."
},
"userPasswordOverrideEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the ability for an end user to set a local password on the phone to restrict local access to the device."
},
"activeCallFocusEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the default screen behavior when inbound calls are received."
},
"peerFirmwareEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable peer firmware sharing."
},
"noiseCancellation": {
"$ref": "#/components/schemas/NoiseCancellationObject",
"description": "Enable/disable local noise cancellation on active calls from the device."
},
"voiceFeedbackAccessibilityEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable visibility of the Accessibility Voice Feedback menu on the MPP device."
},
"dialAssistEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable availability of dial assist feature on the phone."
},
"callsPerLine": {
"type": "number",
"example": 9,
"description": "Specify the number of calls per unique line appearance on the phone."
},
"nightlyResyncEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable automatic nightly configuration resync of the MPP device."
},
"missedCallNotificationEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable the visual indication of missed calls."
},
"softKeyLayout": {
"$ref": "#/components/schemas/SoftKeyLayoutObject",
"description": "Specify the softkey layout per phone menu state."
},
"backgroundImage8875": {
"$ref": "#/components/schemas/BackgroundImageColor",
"description": "Specify the image option for the MPP 8875 phone background."
},
"backlightTimer68XX78XX": {
"$ref": "#/components/schemas/BacklightTimer68XXDevice",
"description": "Specify the use of the backlight feature on 6800 nad 7800 series devices."
},
"allowMonitorLinesEnabled": {
"type": "boolean",
"description": "Enable/disable monitoring for MPP non-primary device."
},
"iceEnabled": {
"type": "boolean",
"example": true,
"description": "Enable/disable SIP media streams to go directly between phones on the same local network."
}
}
},
"placeDeviceList": {
"type": "object",
"required": [
"devices",
"maxDeviceCount",
"maxOwnedDeviceCount"
],
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/placeDevices"
},
"description": "Array of devices associated with a workspace."
},
"maxDeviceCount": {
"type": "number",
"description": "Maximum number of devices a workspace can be assigned to."
},
"maxOwnedDeviceCount": {
"type": "number",
"description": "Maximum number of devices a workspace can own."
}
}
},
"placeDevices": {
"type": "object",
"required": [
"id",
"model",
"primaryOwner",
"type",
"hoteling",
"owner",
"activationState"
],
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for a device."
},
"description": {
"type": "array",
"items": {
"type": "string"
},
"description": "Comma separated array of tags used to describe device."
},
"model": {
"type": "string",
"description": "Identifier for device model."
},
"mac": {
"type": "string",
"description": "MAC address of device."
},
"ipAddress": {
"type": "string",
"description": "IP address of device."
},
"primaryOwner": {
"type": "boolean",
"description": "Indicates whether the person or the workspace is the owner of the device and points to a primary Line/Port of the device."
},
"type": {
"$ref": "#/components/schemas/LineType",
"description": "Indicates if the line is acting as a primary line or a shared line for this device."
},
"hoteling": {
"$ref": "#/components/schemas/Hoteling",
"description": "Indicates Hoteling details of a device."
},
"owner": {
"$ref": "#/components/schemas/deviceOwner",
"description": "Owner of the device."
},
"activationState": {
"$ref": "#/components/schemas/DeviceActivationStates",
"description": "Activation state of a device."
}
}
},
"wifiObject": {
"type": "object",
"required": [
"audioCodecPriority",
"ldap",
"webAccess",
"phoneSecurityPwd"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/WifiAudioCodecPriorityObject",
"description": "Choose up to three predefined codec priority options available for your region."
},
"ldap": {
"$ref": "#/components/schemas/LdapObject",
"description": "Set the values needed to enable use of the LDAP service on the phone."
},
"webAccess": {
"$ref": "#/components/schemas/WebAccessObject",
"description": "Set the availability of the local end user web access for an 840/860 WiFi phone."
},
"phoneSecurityPwd": {
"type": "string",
"example": "phoneSecurityPwd",
"description": "Set the local security password on an 840/860 WiFi phone."
}
}
},
"wifiObjectDevice": {
"type": "object",
"required": [
"audioCodecPriority",
"ldap",
"webAccess",
"phoneSecurityPwd"
],
"properties": {
"audioCodecPriority": {
"$ref": "#/components/schemas/WifiAudioCodecPriorityObjectDevice",
"description": "Choose up to three predefined codec priority options available for your region."
},
"ldap": {
"$ref": "#/components/schemas/LdapObjectDevice",
"description": "Set the values needed to enable use of the LDAP service on the phone."
},
"webAccess": {
"$ref": "#/components/schemas/WebAccessObject",
"description": "Set the availability of the local end user web access for an 840/860 WiFi phone."
},
"phoneSecurityPwd": {
"type": "string",
"example": "phoneSecurityPwd",
"description": "Set the local security password on an 840/860 WiFi phone."
}
}
},
"GetLineKeyTemplateResponse": {
"type": "object",
"required": [
"id",
"templateName",
"deviceModel",
"modelDisplayName",
"userReorderEnabled",
"lineKeys"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS81NzVhMWY3Zi03MjRkLTRmZGUtODk4NC1mNjNhNDljMzYxZmQ",
"description": "Unique identifier for the Line Key Template."
},
"templateName": {
"type": "string",
"example": "Basic Template",
"description": "Name of the Line Key Template."
},
"deviceModel": {
"type": "string",
"example": "'DMS Cisco 6821'",
"description": "The Device Model for which the Line Key Template is applicable."
},
"modelDisplayName": {
"type": "string",
"example": "Cisco 6821",
"description": "The friendly display name used to represent the device model in Control Hub."
},
"userReorderEnabled": {
"type": "boolean",
"description": "Indicates whether user can reorder the line keys."
},
"lineKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgrammableLineKeys"
},
"description": "Contains a mapping of Line Keys and their corresponding actions."
}
}
},
"LineKeyType": {
"type": "string",
"enum": [
"PRIMARY_LINE",
"SHARED_LINE",
"MONITOR",
"CALL_PARK_EXTENSION",
"SPEED_DIAL",
"OPEN",
"CLOSED",
"MODE_MANAGEMENT"
],
"description": " * `PRIMARY_LINE` - PRIMARY_LINE is the user's primary extension. This is the default assignment for Line Key Index 1 and cannot be modified.\n * `SHARED_LINE` - Shows the appearance of other users on the owner's phone.\n * `MONITOR` - Enables User and Call Park monitoring.\n * `CALL_PARK_EXTENSION` - Enables the configure layout feature in Control Hub to set call park extension implicitly.\n * `SPEED_DIAL` - Allows users to reach a telephone number, extension or a SIP URI.\n * `OPEN` - An open key will automatically take the configuration of a monitor button starting with the first open key. These buttons are also usable by the user to configure speed dial numbers on these keys.\n * `CLOSED` - Button not usable but reserved for future features.\n * `MODE_MANAGEMENT` - Allows users to manage call forwarding for features via schedule-based routing.\n"
},
"ApplyLineKeyTemplateJobList": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApplyLineKeyTemplateJobDetails"
},
"description": "List of Apply Line Key Template jobs."
}
}
},
"ApplyLineKeyTemplateJobDetails": {
"type": "object",
"required": [
"name",
"id",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"latestExecutionStatus",
"percentageComplete",
"updatedCount",
"advisoryCount"
],
"properties": {
"name": {
"type": "string",
"description": "Job name."
},
"id": {
"type": "string",
"description": "Unique identifier of the job."
},
"trackingId": {
"type": "string",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"description": "Unique identifier to identify which user has run the job."
},
"sourceCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"description": "Unique identifier to identify the customer for which the job was run."
},
"instanceId": {
"type": "number",
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"type": "string",
"description": "Indicates the most recent status (`STARTING`, `STARTED`, `COMPLETED`, `FAILED`) of the job at the time of invocation."
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"percentageComplete": {
"type": "integer",
"description": "Indicates the progress of the job."
},
"updatedCount": {
"type": "integer",
"description": "Number of job steps completed."
},
"advisoryCount": {
"type": "integer",
"description": "Number of job steps completed with advisories."
}
}
},
"ApplyLineKeyTemplateJobErrors": {
"type": "object",
"required": [
"trackingId"
],
"properties": {
"trackingId": {
"type": "string",
"description": "Unique identifier to track the HTTP requests."
},
"error": {
"$ref": "#/components/schemas/ErrorMessageObject",
"description": "Description of errors in the job."
}
}
},
"LineKeyTemplateAdvisoryTypes": {
"type": "object",
"properties": {
"moreSharedAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More shared/virtual line appearances than shared/virtual lines requested\"."
},
"fewSharedAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More shared/virtual lines requested than shared/virtual line appearances\"."
},
"moreMonitorAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More monitored line appearances than monitored lines in the user's monitoring list\"."
},
"moreCPEAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More call park extension line appearances than call park extensions in user's monitoring list\"."
},
"moreModeManagementAppearancesEnabled": {
"type": "boolean",
"example": true,
"description": "Refine search to apply changes to devices that contain the warning \"More mode management lines configured for the device\". The default value is false."
}
}
},
"PostApplyLineKeyTemplateRequest": {
"type": "object",
"required": [
"action",
"templateId"
],
"properties": {
"action": {
"type": "string",
"enum": [
"APPLY_TEMPLATE",
"APPLY_DEFAULT_TEMPLATES"
],
"description": "Line key Template action to perform.\n * `APPLY_TEMPLATE` - Used to apply LinekeyTemplate to devices.\n * `APPLY_DEFAULT_TEMPLATES` - Used to reset devices to its default Linekey Template configurations.\n"
},
"templateId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL1VTL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM=",
"description": "`templateId` is required for `APPLY_TEMPLATE` action."
},
"locationIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Used to search for devices only in the given locations."
},
"excludeDevicesWithCustomLayout": {
"type": "boolean",
"description": "Indicates whether to exclude devices with custom layout."
},
"includeDeviceTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Include devices only with these tags."
},
"excludeDeviceTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Exclude devices with these tags."
},
"advisoryTypes": {
"$ref": "#/components/schemas/LineKeyTemplateAdvisoryTypes",
"description": "Refine search with advisories."
}
}
},
"PostLineKeyTemplateRequest": {
"type": "object",
"required": [
"templateName",
"deviceModel",
"lineKeys"
],
"properties": {
"templateName": {
"type": "string",
"example": "template for 8845",
"description": "Name of the Line Key Template."
},
"deviceModel": {
"type": "string",
"example": "DMS Cisco 8845",
"description": "The model of the device for which the Line Key Template is applicable. The corresponding device model display name sometimes called the product name, can also be used to specify the model."
},
"userReorderEnabled": {
"type": "boolean",
"example": true,
"description": "User Customization Enabled."
},
"lineKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgrammableLineKeys"
},
"description": "Contains a mapping of Line Keys and their corresponding actions."
}
}
},
"ProgrammableLineKeys": {
"type": "object",
"required": [
"lineKeyIndex",
"lineKeyType",
"sharedLineIndex"
],
"properties": {
"lineKeyIndex": {
"type": "number",
"example": 2,
"description": "An index representing a Line Key. Index starts from 1 representing the first key on the left side of the phone."
},
"lineKeyType": {
"$ref": "#/components/schemas/LineKeyType",
"description": "The action that would be performed when the Line Key is pressed."
},
"lineKeyLabel": {
"type": "string",
"example": "Help Line",
"description": "This is applicable only when the lineKeyType is `SPEED_DIAL`."
},
"lineKeyValue": {
"type": "string",
"example": "5646",
"description": "Applicable only when the `lineKeyType` is `SPEED_DIAL`. Value must be a valid telephone number, ext, or SIP URI (format: `user@host` using A-Z,a-z,0-9,-_ .+ for `user` and `host`)."
},
"sharedLineIndex": {
"type": "number",
"example": 4,
"description": "Shared line index is the line label number of the shared or virtual line assigned in the configured lines. Since you can add multiple appearances of the same shared or virtual line on a phone, entering the index number assigns the respective line to a line key. This is applicable only when the `lineKeyType` is SHARED_LINE. `sharedLineIndex` starts at 1 and increments by one for each shared line."
}
}
},
"PutLineKeyTemplateRequest": {
"type": "object",
"required": [
"lineKeys"
],
"properties": {
"userReorderEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether the user can reorder the line keys."
},
"lineKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgrammableLineKeys"
},
"description": "List of line keys that are being updated."
}
}
},
"lineKeyTemplatesResponse": {
"type": "object",
"required": [
"id",
"templateName",
"deviceModel",
"modelDisplayName"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL1VTL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM=",
"description": "Unique identifier for the Line Key Template."
},
"templateName": {
"type": "string",
"example": "template for 8845",
"description": "Name of the Line Key Template."
},
"deviceModel": {
"type": "string",
"example": "DMS Cisco 8845",
"description": "The Device Model for which the Line Key Template is applicable."
},
"modelDisplayName": {
"type": "string",
"example": "Cisco 8845",
"description": "The friendly display name used to represent the device model in Control Hub."
}
}
},
"GetThirdPartyDeviceObject": {
"type": "object",
"required": [
"manufacturer",
"managedBy",
"id",
"ip",
"model",
"upgradeChannelEnabled"
],
"properties": {
"manufacturer": {
"type": "string",
"example": "THIRD_PARTY",
"description": "Manufacturer of the device."
},
"managedBy": {
"type": "string",
"example": "CUSTOMER",
"description": "Device manager(s)."
},
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
"description": "A unique identifier for the device."
},
"ip": {
"type": "string",
"example": "100.110.120.130",
"description": "The current IP address of the device."
},
"mac": {
"type": "string",
"example": "11223344AAFF",
"description": "The unique address for the network adapter."
},
"model": {
"type": "string",
"example": "DMS Cisco 8811",
"description": "A model type of the device."
},
"activationState": {
"$ref": "#/components/schemas/ActivationStates",
"description": "Activation state of the device. This field is only populated for a device added by a unique activation code generated by Control Hub for use with Webex."
},
"description": {
"type": "array",
"items": {
"type": "string",
"example": "device description"
},
"description": "Comma-separated array of tags used to describe the device."
},
"upgradeChannelEnabled": {
"type": "boolean",
"example": true,
"description": "Enabled / disabled status of the upgrade channel."
},
"owner": {
"type": "object",
"required": [
"sipUserName"
],
"properties": {
"sipUserName": {
"type": "string",
"example": "392829",
"description": "SIP authentication user name for the owner of the device."
},
"linePort": {
"type": "string",
"example": "lg1_sias10_cpapi16004_LGU@64941297.int10.bcld.webex.com",
"description": "Identifies a device endpoint in standalone mode or a SIP URI public identity in IMS mode."
}
}
},
"proxy": {
"type": "object",
"properties": {
"outboundProxy": {
"type": "string",
"example": "hs17.hosted-int.bcld.webex.com",
"description": "Outgoing server which the phone should use for all SIP requests. Not set if the response has no body."
}
}
}
}
},
"PutThirdPartyDevice": {
"type": "object",
"required": [
"sipPassword"
],
"properties": {
"sipPassword": {
"type": "string",
"example": "Test4Password123&",
"description": "Password to be updated."
}
}
},
"DeviceLayout": {
"type": "object",
"required": [
"layoutMode",
"lineKeys"
],
"properties": {
"layoutMode": {
"$ref": "#/components/schemas/LayoutMode",
"description": "Defines the layout mode of the device, i.e. DEFAULT or CUSTOM."
},
"userReorderEnabled": {
"type": "boolean",
"example": true,
"description": "If `true`, user customization is enabled."
},
"lineKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgrammableLineKeys"
},
"description": "Contains a mapping of Line Keys and their corresponding actions."
},
"kemModuleType": {
"$ref": "#/components/schemas/KemModuleType",
"description": "Type of KEM module."
},
"kemKeys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KEMKeys"
},
"description": "Contains a mapping of KEM Keys and their corresponding actions. For KEM keys not included in the request, they will be set to OPEN."
}
}
},
"KEMKeys": {
"type": "object",
"required": [
"kemModuleIndex",
"kemKeyIndex",
"kemKeyType",
"sharedLineIndex"
],
"properties": {
"kemModuleIndex": {
"type": "number",
"example": 1,
"description": "An index representing a KEM Module. The Index starts from 1 representing the first KEM Module."
},
"kemKeyIndex": {
"type": "number",
"example": 1,
"description": "An index representing a KEM Key. The Index starts from 1 representing the first key on the left side of the phone."
},
"kemKeyType": {
"$ref": "#/components/schemas/LineKeyType",
"description": "The action that would be performed when the KEM Key is pressed."
},
"kemKeyLabel": {
"type": "string",
"example": "Office",
"description": "Applicable only when the kemKeyType is `SPEED_DIAL`."
},
"kemKeyValue": {
"type": "string",
"example": "213457",
"description": "Applicable only when the `lineKeyType` is `SPEED_DIAL`. Value must be a valid telephone number, ext, or SIP URI (format: `user@host` using A-Z,a-z,0-9,-_ .+ for `user` and `host`)."
},
"sharedLineIndex": {
"type": "number",
"example": 4,
"description": "Shared line index is the line label number of the shared or virtual line assigned in the configured lines. Since you can add multiple appearances of the same shared or virtual line on a phone, entering the index number assigns the respective line to a line key. This is applicable only when the `lineKeyType` is SHARED_LINE. `sharedLineIndex` starts at 1 and increments by one for each shared line."
}
}
},
"LayoutMode": {
"type": "string",
"enum": [
"DEFAULT",
"CUSTOM"
],
"description": " * `DEFAULT` - Default layout mode when a new device is added.\n * `CUSTOM` - Enables a device to have its custom layout.\n"
},
"RebuildPhonesPostRequest": {
"type": "object",
"required": [
"locationId"
],
"properties": {
"locationId": {
"type": "string",
"description": "Unique identifier of the location."
}
}
},
"RebuildPhonesList": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RebuildPhonesJob"
},
"description": "List of rebuild phones jobs."
}
}
},
"RebuildPhonesJob": {
"type": "object",
"required": [
"name",
"id",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"latestExecutionStatus",
"target",
"percentageComplete"
],
"properties": {
"name": {
"type": "string",
"example": "rebuildphones",
"description": "Name of the job which in this case, is `rebuildphones`."
},
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wNjZkOTQzNC1kODEyLTQzODItODVhMC00MjBlOTFlODg3ZTY",
"description": "Unique identifier of the job."
},
"trackingId": {
"type": "string",
"example": "ROUTERGW_1d458245-ee34-48c8-8ed6-92ea16ed48aa",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81MDRhZmQ1YS0zODRiLTQ0NjYtYTJlNC05Y2ExZjUwMDRlYWQ",
"description": "Unique identifier of the user who has run the job."
},
"sourceCustomerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"description": "Unique identifier of the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"description": "Unique identifier of the customer for which the job was run."
},
"instanceId": {
"type": "number",
"example": 428989,
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"$ref": "#/components/schemas/LatestExecutionStatus",
"description": "Indicates the most recent status of the job at the time of invocation."
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"target": {
"type": "string",
"example": "LOCATION",
"description": "Indicates the target entity, i.e. LOCATION."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzQ0Y2UwNDBhLTEzNmMtNDc3NS1hMjIzLTY5OTczYmEyYWNhYw",
"description": "Unique identifier of a location."
},
"percentageComplete": {
"type": "integer",
"example": 10,
"description": "Indicates the progress of the job."
},
"deviceCount": {
"type": "number",
"example": 10,
"description": "Count of number of devices rebuilt."
}
}
},
"EnhancedMulticastObject": {
"type": "object",
"required": [
"multicastList"
],
"properties": {
"xmlAppUrl": {
"type": "string",
"example": "http://127.0.0.1:8080/",
"description": "Specify the URL for the XML application."
},
"multicastList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MulticastObject"
},
"description": "Specify up to 10 multicast group URLs each with a unique listening port, an XML application URL, and a timeout."
}
}
},
"MulticastObject": {
"type": "object",
"required": [
"hostAndPort",
"hasXmlAppUrl"
],
"properties": {
"hostAndPort": {
"type": "string",
"example": "224.0.0.0:22",
"description": "Specify the multicast group URL and listening port."
},
"hasXmlAppUrl": {
"type": "boolean",
"example": true,
"description": "Specify whether the multicast group URL has an XML application URL."
},
"xmlAppTimeout": {
"type": "number",
"example": 10,
"description": "Specify the timeout for the XML application."
}
}
},
"listBackgroundImagesObject": {
"type": "object",
"required": [
"backgroundImageUrl",
"fileName"
],
"properties": {
"backgroundImageUrl": {
"type": "string",
"example": "\"/dms/Cisco_Phone_Background/background001\"",
"description": "The URL of the image file."
},
"fileName": {
"type": "string",
"example": "CompanyLogoBlue",
"description": "The name of the image file."
}
}
},
"deleteImageResponseObject": {
"type": "object",
"required": [
"fileName",
"result"
],
"properties": {
"fileName": {
"type": "string",
"example": "CompanyLogoBlue",
"description": "The name of the image file."
},
"result": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "number",
"example": 400,
"description": "The status of the deletion."
},
"error": {
"type": "object",
"required": [
"message",
"errorCode"
],
"properties": {
"message": {
"type": "string",
"example": "The image could not be deleted.",
"description": "The error message."
},
"errorCode": {
"type": "number",
"example": 4305,
"description": "The error code."
}
},
"description": "The error message if the deletion failed."
}
},
"description": "The result of the deletion."
}
}
},
"deleteImageResponseSuccessObject": {
"type": "object",
"required": [
"fileName",
"result"
],
"properties": {
"fileName": {
"type": "string",
"example": "CompanyLogoBlue",
"description": "The name of the image file."
},
"result": {
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"type": "number",
"example": 200,
"description": "The status of the deletion."
}
},
"description": "The result of the deletion."
}
}
},
"deleteImageRequestObject": {
"type": "object",
"required": [
"fileName"
],
"properties": {
"fileName": {
"type": "string",
"example": "CompanyLogoBlue",
"description": "The name of the image file to be deleted."
},
"forceDelete": {
"type": "boolean",
"example": true,
"description": "Flag to force delete the image. When `forceDelete` = true, if any device, location, or org level custom background URL is configured with the `backgroundImageURL` containing the filename being deleted, the background image is set to `None`."
}
}
},
"userDeviceCount": {
"type": "object",
"required": [
"totalDeviceCount",
"applicationsCount"
],
"properties": {
"totalDeviceCount": {
"type": "number",
"example": 3,
"description": "The total count of devices associated with the user as a sum of:\n\n- Count of total primary physical devices.\n\n- Count of Webex-Team system device endpoints.\n\n- Count of 1 for any or all applications present."
},
"applicationsCount": {
"type": "number",
"example": 4,
"description": "The total count of applications associated with the user."
}
}
},
"DeviceDynamicSettingsValidationSchemaGet": {
"type": "object",
"example": {
"tags": [
{
"familyOrModelDisplayName": "Poly",
"tag": "%G711U_ORDER%",
"friendlyName": "voice.codecPref.G711Mu",
"tooltip": "Tag tooltip.",
"level": [
"location",
"device"
],
"validationRule": {
"type": "int",
"min": 0,
"max": 10,
"increment": 1
}
}
]
},
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceTag"
},
"description": "Array of device settings tags with their validation rules."
}
}
},
"DeviceDynamicSettingsSettingsGroupsGet": {
"type": "object",
"example": {
"settingsGroups": [
{
"path": "Voice.Codec Preferences",
"friendlyName": "voice.codecPref.G711Mu",
"tab": "Poly",
"familyOrModelDisplayName": "Poly",
"tags": [
{
"tagBlock": [
"%G711U_ORDER%"
]
}
]
}
],
"settingsTabs": [
"Poly",
"MPP"
]
},
"properties": {
"settingsGroups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceSettingsGroup"
},
"description": "Array of settings groups defining structure and association of tags."
},
"settingsTabs": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of settings tabs names. Can be filtered using the `includeSettingsType` parameter."
}
}
},
"DeviceTag": {
"type": "object",
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The family or model name of the device to which these settings apply.",
"example": "Poly"
},
"tag": {
"type": "string",
"description": "The unique identifier for the setting.",
"example": "%G711U_ORDER%"
},
"friendlyName": {
"type": "string",
"description": "A user-friendly name for the setting. It helps to correlate the tag with the UI in settings groups.",
"example": "voice.codecPref.G711Mu"
},
"tooltip": {
"type": "string",
"description": "Explanatory text for the setting.",
"example": "Tag tooltip."
},
"alert": {
"type": "string",
"description": "Alert message related to this setting, if applicable.",
"example": "Alert text."
},
"level": {
"type": "array",
"items": {
"type": "string"
},
"description": "The levels at which this setting can be configured. When fetching tags or updating tags, the tag should be allowed at the level the request is made for.",
"example": [
"organization",
"location",
"device"
]
},
"validationRule": {
"$ref": "#/components/schemas/ValidationRule"
}
}
},
"DeviceSettingsGroup": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Path of the settings group. Creates an easily navigable settings hierarchy.",
"example": "Voice.Codec Preferences"
},
"friendlyName": {
"type": "string",
"description": "Friendly name of the settings group.",
"example": "voice.codecPref.G711Mu"
},
"tab": {
"type": "string",
"description": "Tab name associated with the settings group.",
"example": "Poly"
},
"familyOrModelDisplayName": {
"type": "string",
"description": "Family or model display name associated with the settings group.",
"example": "Poly"
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceSettingsGroupTag"
},
"description": "List of `tagBlock` objects associated with the settings group."
}
}
},
"DeviceSettingsGroupTag": {
"type": "object",
"properties": {
"tagBlock": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of tags associated with the settings group.",
"example": [
"%G711U_ORDER%"
]
}
}
},
"ValidationRule": {
"type": "object",
"description": "Validation rules and constraints for device setting values.",
"properties": {
"type": {
"type": "string",
"description": "The data type of the setting. Possible values are `string`, `integer`, `boolean`, `enum` , `password` or `network`.",
"example": "\"int\""
},
"values": {
"type": "array",
"items": {
"type": "string"
},
"description": "Possible values for `enum` or `boolean` types.",
"example": [
"0",
"1",
"2",
"NumberOnly"
]
},
"min": {
"type": "integer",
"description": "Minimum value for numeric types.",
"example": 0
},
"max": {
"type": "integer",
"description": "Maximum value for numeric types.",
"example": 10
},
"increment": {
"type": "integer",
"description": "Increment value for numeric types.",
"example": 1
},
"regex": {
"type": "string",
"description": "Regular expression pattern for string validation.",
"example": "[A-Za-z0-9]+"
},
"maxLength": {
"type": "integer",
"description": "Maximum length for string values.",
"example": 255
},
"validationHint": {
"type": "string",
"description": "Hint to display to users about validation requirements.",
"example": "5-60"
}
}
},
"CustomerDeviceDynamicSettingsListPostRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"description": "Optional array of device tag identifiers to request settings for. Each identifier must have a length between 1 and 64 characters.",
"minItems": 0
}
}
},
"CustomerDeviceDynamicSettingsListPostResponse": {
"type": "object",
"example": {
"tags": [
{
"familyOrModelDisplayName": "Poly",
"tag": "%DO_MENU_ITEM_BACKGROUND%",
"value": "#RRGGBB",
"parentValue": "#FFFFFF",
"parentLevel": "ORGANIZATION"
}
],
"lastUpdateTime": 1651396800000,
"updateInProgress": false
},
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerDevicePostTag"
},
"description": "Array of device setting values matching the requested tags."
},
"lastUpdateTime": {
"type": "integer",
"format": "int64",
"description": "Timestamp of the last update to these settings."
},
"updateInProgress": {
"type": "boolean",
"description": "Flag indicating if an update to these settings is currently in progress."
}
}
},
"CustomerDevicePostTag": {
"type": "object",
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The `familyOrModelDisplayName` of the device.",
"example": "Poly"
},
"tag": {
"type": "string",
"description": "The unique identifier for the setting.",
"example": "%G711U_ORDER%"
},
"value": {
"type": "string",
"description": "The current value of the setting at `ORGANIZATION` level. If the tag value is not set at the `ORGANIZATION` level, this field will not be included in the response.",
"example": "4"
},
"parentValue": {
"type": "string",
"description": "The value inherited from the immediate parent level above `ORGANIZATION`. It can be `SYSTEM_DEFAULT`, `REGIONAL_DEFAULT`, or `ORGANIZATION`, depending on which level the setting is actually configured at. If there is no parent level for this tag, this field will not be included in the response.",
"example": "3"
},
"parentLevel": {
"$ref": "#/components/schemas/DynamicDeviceSettingsCustomerParentLevel"
}
}
},
"DynamicDeviceSettingsCustomerParentLevel": {
"type": "string",
"enum": [
"SYSTEM_DEFAULT",
"REGIONAL_DEFAULT",
"ORGANIZATION"
],
"description": "The level from which the tag's parent value is inherited. If there is no parent level for this tag, this field will not be included in the response."
},
"LocationDeviceDynamicSettingsListPostRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"description": "Optional array of device tag identifiers to request settings for. Each identifier must have a length between 1 and 64 characters.",
"minItems": 0
}
}
},
"LocationDeviceDynamicSettingsListPostResponse": {
"type": "object",
"example": {
"tags": [
{
"familyOrModelDisplayName": "Poly",
"tag": "%G711U_ORDER%",
"value": "4",
"parentValue": "3",
"parentLevel": "ORGANIZATION"
}
],
"lastUpdateTime": 1651396800000,
"updateInProgress": false
},
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LocationDevicePostResponseTag"
},
"description": "Array of device setting values matching the requested tags."
},
"lastUpdateTime": {
"type": "integer",
"format": "int64",
"description": "Timestamp of the last update to these settings."
},
"updateInProgress": {
"type": "boolean",
"description": "Flag indicating if an update to these settings is currently in progress."
}
}
},
"LocationDevicePostResponseTag": {
"type": "object",
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The `familyOrModelDisplayName` of the device.",
"example": "Poly"
},
"tag": {
"type": "string",
"description": "The unique identifier for the setting.",
"example": "%G711U_ORDER%"
},
"value": {
"type": "string",
"description": "The current value of the setting at `LOCATION` level. If the tag value is not set at the `LOCATION` level, this field will not be included in the response.",
"example": "4"
},
"parentValue": {
"type": "string",
"description": "The value inherited from the immediate parent level above `LOCATION`. It can be `SYSTEM_DEFAULT`, `REGIONAL_DEFAULT`, `ORGANIZATION`, or `LOCATION`, depending on which level the setting is actually configured at. If there is no parent level for this tag, this field will not be included in the response.",
"example": "3"
},
"parentLevel": {
"$ref": "#/components/schemas/LocationParentLevel"
}
}
},
"LocationParentLevel": {
"type": "string",
"enum": [
"SYSTEM_DEFAULT",
"REGIONAL_DEFAULT",
"ORGANIZATION",
"LOCATION"
],
"description": "The level from which the tag's parent value is inherited. If there is no parent level for this tag, this field will not be included in the response."
},
"DeviceDynamicSettingsListPostRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional array of tag identifiers representing specific settings to fetch. If omitted or provided as an empty array, all settings for the device will be returned.",
"minItems": 0
}
}
},
"DeviceDynamicSettingsListPostResponse": {
"type": "object",
"required": [
"tags"
],
"example": {
"tags": [
{
"familyOrModelDisplayName": "Poly",
"tag": "%G711U_ORDER%",
"value": "4",
"parentValue": "3",
"parentLevel": "ORGANIZATION"
}
],
"lastUpdateTime": 1651396800000
},
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DevicePostResponseTag"
},
"description": "Array of device setting values matching the requested tags."
},
"lastUpdateTime": {
"type": "integer",
"format": "int64",
"description": "Timestamp of the last update to these settings."
}
}
},
"DeviceDynamicSettingsPutRequest": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DevicePutItem"
},
"description": "Optional array of `tag` identifiers representing specific settings to update. If omitted or provided as an empty array, the request will have no effect.",
"minItems": 0
}
}
},
"DevicePostResponseTag": {
"type": "object",
"required": [
"familyOrModelDisplayName",
"tag"
],
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The display name of the device family or model associated with the returned tag.",
"example": "Poly"
},
"tag": {
"type": "string",
"description": "The unique identifier for the device setting.",
"example": "%G711U_ORDER%"
},
"value": {
"type": "string",
"description": "The current value of the setting at device level. If the tag value is not set at the device level, this field will not be included in the response.",
"example": "4"
},
"parentValue": {
"type": "string",
"description": "The setting value at the next available `parentLevel`. It is used if `value` is not set and is omitted when no parent level exists for the tag.",
"example": "3"
},
"parentLevel": {
"$ref": "#/components/schemas/DeviceParentLevel"
}
}
},
"DeviceParentLevel": {
"type": "string",
"enum": [
"SYSTEM_DEFAULT",
"REGIONAL_DEFAULT",
"ORGANIZATION",
"LOCATION"
],
"description": "The level from which the tag's parent value is inherited. If there is no parent level for this tag, this field will not be included in the response."
},
"DevicePutItem": {
"type": "object",
"required": [
"tag",
"action"
],
"properties": {
"tag": {
"type": "string",
"description": "The unique identifier for the setting to be updated.",
"example": "%G711U_ORDER%",
"minLength": 1,
"maxLength": 64
},
"action": {
"$ref": "#/components/schemas/Action"
},
"value": {
"type": "string",
"description": "The new value to set for the setting. This field is required when `action` is `SET` and ignored otherwise.",
"example": "4",
"minLength": 1,
"maxLength": 256
}
}
},
"Action": {
"type": "string",
"enum": [
"SET",
"CLEAR"
],
"description": "The action to perform on the setting. When action is `SET`, `tag` is updated to specified value. When action is `CLEAR`, the `tag` value at device level is removed, and the device will inherit the value from the parent level, if it exists.",
"example": "SET"
},
"PostDynamicDeviceSettingsJobResponse": {
"type": "object",
"required": [
"name",
"id",
"trackingId",
"sourceUserId",
"sourceCustomerId",
"targetCustomerId",
"instanceId",
"jobExecutionStatus",
"latestExecutionStatus",
"latestExecutionExitCode",
"target",
"percentageComplete"
],
"example": {
"name": "dynamicdevicesettings",
"id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wNjZkOTQzNC1kODEyLTQzODItODVhMC00MjBlOTFlODg3ZTY",
"trackingId": "ROUTERGW_1d458245-ee34-48c8-8ed6-92ea16ed48aa",
"sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81MDRhZmQ1YS0zODRiLTQ0NjYtYTJlNC05Y2ExZjUwMDRlYWQ",
"sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"instanceId": 428989,
"jobExecutionStatus": [
{
"id": 0,
"startTime": "2025-05-13T10:59:44.106Z",
"lastUpdated": "2025-05-13T10:59:44.106Z",
"statusMessage": "STARTED",
"exitCode": "UNKNOWN",
"createdTime": "2025-05-13T10:50:01.352Z",
"timeElapsed": "PT11.476S"
}
],
"latestExecutionStatus": "STARTED",
"latestExecutionExitCode": "UNKNOWN",
"target": "CUSTOMER",
"locationId": "",
"percentageComplete": 100
},
"properties": {
"name": {
"type": "string",
"example": "dynamicdevicesettings",
"description": "Name of the job which in this case, is `dynamicdevicesettings`."
},
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wNjZkOTQzNC1kODEyLTQzODItODVhMC00MjBlOTFlODg3ZTY",
"description": "Unique identifier of the job."
},
"trackingId": {
"type": "string",
"example": "ROUTERGW_1d458245-ee34-48c8-8ed6-92ea16ed48aa",
"description": "Unique identifier to track the flow of HTTP requests."
},
"sourceUserId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81MDRhZmQ1YS0zODRiLTQ0NjYtYTJlNC05Y2ExZjUwMDRlYWQ",
"description": "Unique identifier of the user who has run the job."
},
"sourceCustomerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"description": "Unique identifier of the customer who has run the job."
},
"targetCustomerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lYTRiZTEyNS00Y2ZjLTQ5OTItOGMwNi00Y2U4Mzc2ZDU4MmE",
"description": "Unique identifier of the customer for which the job was run."
},
"instanceId": {
"type": "number",
"example": 428989,
"description": "Unique identifier to identify the instance of the job."
},
"jobExecutionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JobExecutionStatusObject"
},
"description": "Displays the most recent step's execution status. Contains execution statuses of all the steps involved in the execution of the job."
},
"latestExecutionStatus": {
"$ref": "#/components/schemas/LatestExecutionStatus"
},
"latestExecutionExitCode": {
"type": "string",
"enum": [
"UNKNOWN",
"COMPLETED",
"FAILED",
"STOPPED",
"COMPLETED_WITH_ERRORS"
],
"description": "Most recent exit code of the job at the time of invocation.\n * `UNKNOWN` - Job is in progress.\n * `COMPLETED` - Job has completed successfully.\n * `FAILED` - Job has failed.\n * `STOPPED` - Job has been stopped.\n * `COMPLETED_WITH_ERRORS` - Job has completed with errors.\n"
},
"target": {
"type": "string",
"enum": [
"CUSTOMER",
"LOCATION"
],
"example": "LOCATION",
"description": "Indicates the target entity."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzQ0Y2UwNDBhLTEzNmMtNDc3NS1hMjIzLTY5OTczYmEyYWNhYw",
"description": "Unique identifier of a location."
},
"locationName": {
"type": "string",
"example": "Brampton",
"description": "Name of the location. Included only when `target` is `LOCATION`."
},
"percentageComplete": {
"type": "integer",
"example": 10,
"description": "Indicates the progress of the job."
}
}
},
"LatestExecutionStatus": {
"type": "string",
"enum": [
"STARTING",
"STARTED",
"COMPLETED",
"FAILED"
],
"description": " * `STARTING` - Indicates the job has started.\n * `STARTED` - Indicates the job is in progress.\n * `COMPLETED` - Indicates the job has completed.\n * `FAILED` - Indicates the job has failed.\n"
},
"JobExecutionStatusObject": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"example": 436272,
"description": "Unique identifier that identifies each instance of the job."
},
"startTime": {
"type": "string",
"example": "2025-05-13T10:59:44.106Z",
"description": "Step execution start time in UTC format."
},
"endTime": {
"type": "string",
"example": "2025-05-13T10:59:44.692Z",
"description": "Step execution end time in UTC format."
},
"lastUpdated": {
"type": "string",
"example": "2025-05-13T10:59:44.854Z",
"description": "Last updated time (in UTC format) post one of the step execution completion."
},
"statusMessage": {
"type": "string",
"example": "STARTING",
"description": "Displays status for overall steps that are part of the job."
},
"exitCode": {
"type": "string",
"example": "UNKNOWN",
"description": "Exit Code for a job."
},
"createdTime": {
"type": "string",
"example": "2024-03-13T14:57:04.678Z",
"description": "Job creation time in UTC format."
},
"timeElapsed": {
"type": "string",
"example": "PT0S",
"description": "Time lapsed since the job execution started."
},
"stepExecutionStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/stepExecutionStatusesObject"
},
"description": "Status of each step within a job."
}
}
},
"JobExecutionStatusObject1": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"description": "Unique identifier that identifies each instance of the job."
},
"lastUpdated": {
"type": "string",
"description": "Last updated time (in UTC format) post one of the step execution completion."
},
"statusMessage": {
"type": "string",
"description": "Displays status for overall steps that are part of the job."
},
"exitCode": {
"type": "string",
"description": "Exit Code for a job."
},
"createdTime": {
"type": "string",
"description": "Job creation time in UTC format."
},
"timeElapsed": {
"type": "string",
"description": "Time lapsed since the job execution started."
}
}
},
"stepExecutionStatusesObject": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "number",
"example": 1998857,
"description": "Unique identifier that identifies each step in a job."
},
"startTime": {
"type": "string",
"example": "2024-03-13T03:58:36.886Z",
"description": "Step execution start time in UTC format."
},
"endTime": {
"type": "string",
"example": "2024-03-13T03:58:48.471Z",
"description": "Step execution end time in UTC format."
},
"lastUpdated": {
"type": "string",
"example": "2024-03-13T03:58:48.472Z",
"description": "Last updated time for a step in UTC format."
},
"statusMessage": {
"type": "string",
"example": "COMPLETED",
"description": "Displays the status of a step."
},
"exitCode": {
"type": "string",
"example": "COMPLETED",
"description": "Exit Code for a step."
},
"name": {
"type": "string",
"example": "dynamicdevicesettingsUpdate",
"description": "Name of different steps the job goes through."
},
"timeElapsed": {
"type": "string",
"example": "PT11.585S",
"description": "Time lapsed since the step execution started."
}
}
},
"PostDynamicSettingsUpdateStartJobRequest": {
"type": "object",
"required": [
"tags"
],
"properties": {
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"description": "If present, the requested settings will be updated to devices under this location."
},
"tags": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DynamicSettingsUpdateJobDevicePostItem"
},
"description": "Array of tag identifiers for settings to be updated. Each setting is identified by a `familyOrModelDisplayName` and `tag`. Supports updating multiple settings across different device families in a single request.",
"minItems": 1
}
}
},
"DynamicSettingsUpdateJobDevicePostItem": {
"type": "object",
"required": [
"familyOrModelDisplayName",
"tag",
"action"
],
"properties": {
"familyOrModelDisplayName": {
"type": "string",
"description": "The `familyOrModelDisplayName` of the device to which the tag applies. This value must exist in the validation schema.",
"example": "Poly",
"minLength": 1,
"maxLength": 40
},
"tag": {
"type": "string",
"description": "The unique identifier for the setting to be updated.",
"example": "%G711U_ORDER%",
"minLength": 1,
"maxLength": 64
},
"action": {
"$ref": "#/components/schemas/Action"
},
"value": {
"type": "string",
"description": "The new value to set for the setting. This field is required when `action` is `SET` and ignored otherwise.",
"example": "4",
"minLength": 1,
"maxLength": 256
}
}
},
"DynamicDeviceSettingsJobListResponse": {
"type": "object",
"required": [
"items"
],
"example": {
"items": [
{
"name": "dynamicdevicesettings",
"id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wZTJjNmI5NC1hNDdlLTQxZGUtODE5ZS04YTcwNTZjMTc5MDk",
"trackingId": "NA_a9ef6908-60cf-40e6-b56f-461abffd6fa3",
"sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
"targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
"instanceId": 0,
"jobExecutionStatus": [],
"latestExecutionStatus": "COMPLETED",
"latestExecutionExitCode": "COMPLETED",
"target": "LOCATION",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzgwZmUxMzdkLTg5NDgtNDlhYS1iODdiLTk4MGMxN2I2YzdiYg",
"percentageComplete": 100
}
]
},
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PostDynamicDeviceSettingsJobResponse"
},
"description": "Lists all jobs for the customer of type `dynamicdevicesettings` in order of most recent one to oldest one irrespective of its status."
}
}
},
"ErrorResponseObject": {
"type": "object",
"example": {
"items": [
{
"itemNumber": 0,
"error": {
"key": "error.key",
"message": [
{
"description": "Error description",
"code": "1001",
"locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMzZjBlZDFiLWQ1YjctNGI4Mi1iMzIzLTg4ZTFmODMzNGNmMw"
}
]
},
"trackingId": "ROUTER_62F66055-8D70-01BB-0137-AC10A8310137"
}
]
},
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemObject"
},
"description": "Array of error items for failed operations.",
"example": [
{
"itemNumber": 0,
"trackingId": "ROUTER_62F66055-8D70-01BB-0137-AC10A8310137"
}
]
}
}
},
"ItemObject": {
"type": "object",
"properties": {
"itemNumber": {
"type": "number",
"description": "Index of error number."
},
"trackingId": {
"type": "string",
"description": "Unique identifier to track the HTTP requests."
},
"error": {
"$ref": "#/components/schemas/ErrorObject"
}
}
},
"ErrorObject": {
"type": "object",
"description": "Error details object containing error information.",
"properties": {
"key": {
"type": "string",
"description": "HTTP error code."
},
"message": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ErrorMessageObject"
},
"description": "Message string with further error information."
}
}
},
"ErrorMessageObject": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Error message."
},
"code": {
"type": "string",
"description": "Internal error code."
},
"locationId": {
"type": "string",
"description": "Error messages describing the location ID in which the error occurs."
}
}
},
"supportedDevicesObject": {
"type": "object",
"required": [
"devices",
"upgradeChannelList"
],
"example": {
"upgradeChannelList": [
"STABLE",
"STABLE_DELAY",
"PREVIEW",
"BETA",
"TESTING"
],
"devices": [
{
"model": "2N Customer Managed",
"displayName": "2N Customer Managed",
"type": "GENERIC_SIP",
"manufacturer": "THIRD_PARTY",
"managedBy": "CUSTOMER",
"supportedFor": [
"PEOPLE",
"PLACE"
],
"onboardingMethod": [
"MAC_ADDRESS"
],
"allowConfigureLayoutEnabled": false,
"numberOfLinePorts": 20,
"kemSupportEnabled": true,
"kemModuleCount": 1,
"kemLinesSupportEnabled": false,
"kemModuleType": [
"KEM_20_KEYS"
],
"upgradeChannelEnabled": false,
"additionalPrimaryLineAppearancesEnabled": false,
"basicEmergencyNomadicEnabled": false,
"customizedBehaviorsEnabled": false,
"allowConfigurePortsEnabled": false,
"customizableLineLabelEnabled": false,
"supportsLinePortReorderingEnabled": false,
"portNumberSupportEnabled": false,
"t38Enabled": false,
"callDeclinedEnabled": false,
"touchScreenPhone": false,
"numberOfLineKeyButtons": 0,
"deviceSettingsConfiguration": "NONE",
"allowHotelingHostEnabled": false,
"supportsLogCollection": "NONE",
"supportsApplyChangesEnabled": false,
"allowConfigureLinesEnabled": true,
"allowConfigurePhoneSettingsEnabled": false,
"supportsHotlineEnabled": false
},
{
"model": "DMS Polycom EE400",
"displayName": "Polycom EE400",
"familyDisplayName": "Poly",
"type": "GENERIC_SIP",
"manufacturer": "THIRD_PARTY",
"managedBy": "CISCO",
"supportedFor": [
"PEOPLE",
"PLACE"
],
"onboardingMethod": [
"MAC_ADDRESS"
],
"allowConfigureLayoutEnabled": false,
"numberOfLinePorts": 14,
"kemSupportEnabled": false,
"kemLinesSupportEnabled": false,
"upgradeChannelEnabled": false,
"additionalPrimaryLineAppearancesEnabled": true,
"basicEmergencyNomadicEnabled": false,
"customizedBehaviorsEnabled": true,
"allowConfigurePortsEnabled": false,
"customizableLineLabelEnabled": false,
"supportsLinePortReorderingEnabled": true,
"portNumberSupportEnabled": false,
"t38Enabled": false,
"callDeclinedEnabled": true,
"touchScreenPhone": false,
"numberOfLineKeyButtons": 0,
"deviceSettingsConfiguration": "WEBEX_CALLING_DYNAMIC_DEVICE_CONFIGURATION",
"allowHotelingHostEnabled": true,
"supportsLogCollection": "NONE",
"supportsApplyChangesEnabled": true,
"allowConfigureLinesEnabled": true,
"allowConfigurePhoneSettingsEnabled": true,
"supportsHotlineEnabled": true
}
]
},
"properties": {
"upgradeChannelList": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UpgradeChannelObject"
},
"description": "List of available upgrade channels.\n * `STABLE` - These are standard stable releases.\n * `STABLE_DELAY` - These are delayed stable releases.\n * `PREVIEW` - These are Preview/pre-release versions.\n * `BETA` - These are Beta testing versions.\n * `TESTING` - These are testing versions.\n"
},
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceObject"
},
"description": "List of supported devices."
}
}
},
"UpgradeChannelObject": {
"type": "string",
"enum": [
"STABLE",
"STABLE_DELAY",
"PREVIEW",
"BETA",
"TESTING"
]
},
"DeviceObject": {
"type": "object",
"required": [
"model",
"displayName",
"type",
"manufacturer",
"managedBy",
"supportedFor",
"onboardingMethod",
"allowConfigureLayoutEnabled",
"numberOfLinePorts",
"kemSupportEnabled",
"kemLinesSupportEnabled",
"upgradeChannelEnabled",
"additionalPrimaryLineAppearancesEnabled",
"basicEmergencyNomadicEnabled",
"customizedBehaviorsEnabled",
"allowConfigurePortsEnabled",
"customizableLineLabelEnabled",
"supportsLinePortReorderingEnabled",
"portNumberSupportEnabled",
"t38Enabled",
"callDeclinedEnabled",
"touchScreenPhone",
"numberOfLineKeyButtons",
"allowHotelingHostEnabled",
"supportsApplyChangesEnabled",
"allowConfigureLinesEnabled",
"allowConfigurePhoneSettingsEnabled",
"supportsHotlineEnabled"
],
"properties": {
"model": {
"type": "string",
"example": "2N Customer Managed",
"description": "Model name of the device."
},
"displayName": {
"type": "string",
"example": "2N Customer Managed",
"description": "Display name of the device."
},
"familyDisplayName": {
"type": "string",
"example": "Poly",
"description": "The display name of the device family."
},
"type": {
"$ref": "#/components/schemas/TypeObject"
},
"manufacturer": {
"$ref": "#/components/schemas/ManufacturerObject"
},
"managedBy": {
"$ref": "#/components/schemas/ManagedByObject"
},
"supportedFor": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SupportedForObject"
},
"description": "List of places the device is supported for."
},
"onboardingMethod": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OnboardingMethodObject"
},
"description": "Onboarding method."
},
"allowConfigureLayoutEnabled": {
"type": "boolean",
"description": "Enables / Disables layout configuration for devices."
},
"numberOfLinePorts": {
"type": "number",
"description": "Number of port lines."
},
"kemSupportEnabled": {
"type": "boolean",
"example": true,
"description": "Indicates whether Kem support is enabled or not."
},
"kemModuleCount": {
"type": "number",
"description": "Module count."
},
"kemLinesSupportEnabled": {
"type": "boolean",
"description": "Enables / disables Kem lines support."
},
"kemModuleType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KemModuleType"
},
"description": "Key expansion module type of the device."
},
"upgradeChannelEnabled": {
"type": "boolean",
"description": "Enables / Disables the upgrade channel."
},
"defaultUpgradeChannel": {
"type": "string",
"description": "The default upgrade channel."
},
"additionalPrimaryLineAppearancesEnabled": {
"type": "boolean",
"description": "Enables / disables the additional primary line appearances."
},
"basicEmergencyNomadicEnabled": {
"type": "boolean",
"description": "Enables / disables Basic emergency nomadic."
},
"customizedBehaviorsEnabled": {
"type": "boolean",
"description": "Enables / disables customized behavior support on devices."
},
"allowConfigurePortsEnabled": {
"type": "boolean",
"description": "Enables / disables configuring port support on device."
},
"customizableLineLabelEnabled": {
"type": "boolean",
"description": "Enables / disables customizable line label."
},
"supportsLinePortReorderingEnabled": {
"type": "boolean",
"description": "Enables / disables support line port reordering."
},
"portNumberSupportEnabled": {
"type": "boolean",
"description": "Enables / disables port number support."
},
"t38Enabled": {
"type": "boolean",
"description": "Enables / disables T.38."
},
"callDeclinedEnabled": {
"type": "boolean",
"description": "Enables / disables call declined."
},
"touchScreenPhone": {
"type": "boolean",
"description": "Supports touch screen on device."
},
"numberOfLineKeyButtons": {
"type": "number",
"description": "Number of line key buttons for a device."
},
"deviceSettingsConfiguration": {
"$ref": "#/components/schemas/DeviceSettingsConfigurationObject"
},
"allowHotelingHostEnabled": {
"type": "boolean",
"description": "Enables / disables hoteling host."
},
"supportsLogCollection": {
"$ref": "#/components/schemas/SupportsLogCollectionObject"
},
"supportsApplyChangesEnabled": {
"type": "boolean",
"description": "Enables / disables apply changes."
},
"allowConfigureLinesEnabled": {
"type": "boolean",
"description": "Enables / disables configure lines."
},
"allowConfigurePhoneSettingsEnabled": {
"type": "boolean",
"description": "Enables / disables configure phone settings."
},
"supportsHotlineEnabled": {
"type": "boolean",
"description": "Enables / disables hotline support."
},
"maxNumberOfLineAppearances": {
"type": "number",
"description": "Maximum number of line appearances available on the device."
}
}
},
"TypeObject": {
"type": "string",
"enum": [
"MPP",
"ATA",
"GENERIC_SIP",
"ESIM",
"DESK_PHONE"
],
"description": " * `MPP` - Cisco Multiplatform Phone\n * `ATA` - Analog Telephone Adapters\n * `GENERIC_SIP` - GENERIC Session Initiation Protocol\n * `ESIM` - Esim Supported Webex Go\n * `DESK_PHONE` - Desk Phone\n"
},
"ManagedByObject": {
"type": "string",
"enum": [
"CISCO",
"CUSTOMER"
],
"description": " * `CISCO` - Devices managed by Cisco.\n * `CUSTOMER` - Devices managed by a customer that are approved by a Cisco account manager to be enabled for provisioning in the control hub.\n"
},
"ManufacturerObject": {
"type": "string",
"enum": [
"CISCO",
"THIRD_PARTY"
],
"description": " * `CISCO` - Devices manufactured by Cisco.\n * `THIRD_PARTY` - Devices manufactured by a third-party that are approved by a Cisco account manager to be enabled for provisioning in the control hub.\n"
},
"SupportedForObject": {
"type": "string",
"enum": [
"PEOPLE",
"PLACE"
]
},
"OnboardingMethodObject": {
"type": "string",
"enum": [
"MAC_ADDRESS",
"ACTIVATION_CODE",
"NONE"
]
},
"SupportsLogCollectionObject": {
"type": "string",
"enum": [
"NONE",
"CISCO_PRT",
"CISCO_ROOMOS"
],
"description": " * `NONE` - Devices which does not support log collection.\n * `CISCO_PRT` - Devices which supports Cisco PRT log collection.\n * `CISCO_ROOMOS` - Devices which supports Cisco RoomOS log collection.\n"
},
"DeviceSettingsConfigurationObject": {
"type": "string",
"enum": [
"WEBEX_CALLING_DEVICE_CONFIGURATION",
"WEBEX_DEVICE_CONFIGURATION",
"WEBEX_CALLING_DYNAMIC_DEVICE_CONFIGURATION",
"NONE"
],
"description": " * `WEBEX_CALLING_DEVICE_CONFIGURATION` - Devices which supports Webex Calling Device Settings Configuration.\n * `WEBEX_DEVICE_CONFIGURATION` - Devices which supports Webex Device Settings Configuration.\n * `WEBEX_CALLING_DYNAMIC_DEVICE_CONFIGURATION` - Devices which supports Webex Calling dynamic Settings Configuration.\n * `NONE` - Devices does not support any configuration.\n"
},
"KemModuleType": {
"type": "string",
"enum": [
"KEM_14_KEYS",
"KEM_18_KEYS",
"KEM_20_KEYS"
],
"description": " * `KEM_14_KEYS` - Extension module has 14 line keys that can be configured.\n * `KEM_18_KEYS` - Extension module has 18 line keys that can be configured.\n * `KEM_20_KEYS` - Extension module has 20 line keys that can be configured.\n"
},
"ActivationCode": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "5414011256173816",
"description": "The activation code."
},
"expiryTime": {
"type": "string",
"example": "2017-11-16T23:38:03.215Z",
"description": "The date and time the activation code expires."
}
}
},
"Device": {
"type": "object",
"required": [
"created"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
"description": "A unique identifier for the device."
},
"displayName": {
"type": "string",
"example": "SFO12-3-PanHandle",
"description": "A friendly name for the device."
},
"placeId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"description": "The `placeId` field has been deprecated. Please use `workspaceId` instead."
},
"workspaceId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"description": "The workspace associated with the device."
},
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"description": "The person associated with the device."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The organization associated with the device."
},
"capabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DeviceCapabilities"
},
"description": "The capabilities of the device.",
"example": [
"xapi"
]
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DevicePermissions"
},
"description": "The permissions the user has for this device. For example, `xapi` means this user is entitled to using the `xapi` against this device.",
"example": [
"xapi:readonly",
"xapi:all"
]
},
"connectionStatus": {
"$ref": "#/components/schemas/DeviceConnectionStatus"
},
"product": {
"type": "string",
"example": "Cisco Webex DX80",
"description": "The product name. A display friendly version of the device's `model`."
},
"type": {
"type": "string",
"example": "roomdesk",
"description": "The product type."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"example": "First Tag, Second Tag"
},
"description": "Tags assigned to the device.",
"example": [
"First Tag",
"Second Tag"
]
},
"ip": {
"type": "string",
"example": "100.110.120.130",
"description": "The current IP address of the device."
},
"activeInterface": {
"$ref": "#/components/schemas/NetworkConnectivityType"
},
"mac": {
"type": "string",
"example": "11:22:33:44:AA:FF",
"description": "The unique address for the network adapter."
},
"primarySipUrl": {
"type": "string",
"example": "sample_device@sample_workspacename.orgname.org",
"description": "The primary SIP address to dial this device."
},
"sipUrls": {
"example": [
"sample_device@sample_workspacename.orgname.org",
"another_device@sample_workspacename.orgname.org"
],
"type": "array",
"items": {
"type": "string",
"example": "sample_device@sample_workspacename.orgname.org, another_device@sample_workspacename.orgname.org"
},
"description": "All SIP addresses to dial this device."
},
"serial": {
"type": "string",
"example": "FOC1923NVVN",
"description": "Serial number for the device."
},
"software": {
"type": "string",
"example": "RoomOS 2018-06-01 608dcdbb6e1",
"description": "The operating system name data and version tag."
},
"upgradeChannel": {
"type": "string",
"example": "beta",
"description": "The upgrade channel the device is assigned to."
},
"created": {
"type": "string",
"example": "2016-04-21T17:00:00.000Z",
"description": "The date and time that the device was registered, in ISO8601 format."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The location associated with the device."
},
"workspaceLocationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The workspace location associated with the device. Deprecated, prefer `locationId`."
},
"errorCodes": {
"example": [
"sipprofileregistration"
],
"type": "array",
"items": {
"type": "string",
"example": "sipprofileregistration"
},
"description": "Error codes coming from the device."
},
"firstSeen": {
"type": "string",
"example": "2021-02-24T09:08:38.822Z",
"description": "Timestamp of the first time device sent a status post."
},
"lastSeen": {
"type": "string",
"example": "2023-08-15T14:04:00.444Z",
"description": "Timestamp of the last time device sent a status post."
},
"managedBy": {
"$ref": "#/components/schemas/ManagedBy"
},
"devicePlatform": {
"$ref": "#/components/schemas/DevicePlatform"
},
"plannedMaintenance": {
"type": "object",
"description": "The planned maintenance for the device.",
"properties": {
"mode": {
"type": "string",
"enum": [
"off",
"on",
"upcoming"
],
"description": "The planned maintenance mode for the device"
}
}
}
}
},
"DeviceCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device"
}
}
}
},
"NetworkConnectivityType": {
"type": "string",
"enum": [
"wired"
],
"description": "The current network connectivity for the device.",
"example": "wired"
},
"DeviceConnectionStatus": {
"type": "string",
"enum": [
"connected",
"disconnected",
"connected_with_issues",
"offline_expired",
"activating",
"pending",
"unknown",
"offline_deep_sleep"
],
"description": "The connection status of the device.",
"example": "connected"
},
"DevicePermissions": {
"type": "string",
"enum": [
"xapi:readonly",
"xapi:all"
]
},
"DeviceCapabilities": {
"type": "string",
"enum": [
"xapi"
]
},
"ManagedBy": {
"type": "string",
"enum": [
"CISCO",
"CUSTOMER",
"PARTNER"
],
"description": "Entity managing the device configuration.",
"example": "CISCO"
},
"DevicePlatform": {
"type": "string",
"enum": [
"cisco",
"microsoftTeamsRoom"
],
"description": "Device platform",
"example": "cisco"
},
"MaintenanceMode": {
"type": "string",
"enum": [
"off",
"on",
"upcoming"
],
"example": "off",
"description": "The maintenance mode of the device."
},
"Event": {
"type": "object",
"required": [
"id",
"resource",
"type",
"actorId",
"orgId",
"created",
"data"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0VWRU5UL2JiY2ViMWFkLTQzZjEtM2I1OC05MTQ3LWYxNGJiMGM0ZDE1NAo",
"description": "The unique identifier for the event."
},
"resource": {
"$ref": "#/components/schemas/EventResourceEnum",
"description": "The type of resource in the event."
},
"type": {
"$ref": "#/components/schemas/EventTypeEnum",
"description": "The action which took place in the event."
},
"appId": {
"type": "string",
"example": "null",
"description": "The ID of the application for the event."
},
"actorId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "The ID of the person who performed the action."
},
"orgId": {
"type": "string",
"example": "OTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"description": "The ID of the organization for the event."
},
"created": {
"type": "string",
"example": "2016-05-16T21:34:59.324Z",
"description": "The date and time of the event."
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL01FU1NBR0UvOTJkYjNiZTAtNDNiZC0xMWU2LThhZTktZGQ1YjNkZmM1NjVk"
},
"roomId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0"
},
"roomType": {
"type": "string",
"example": "group"
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jZTg2MWZiYS02ZTJmLTQ5ZjktOWE4NC1iMzU0MDA4ZmFjOWU"
},
"text": {
"type": "string",
"example": "PROJECT UPDATE - A new project plan has been published on Box: http://box.com/s/lf5vj. The PM for this project is Mike C. and the Engineering Manager is Jane W."
},
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY"
},
"personEmail": {
"type": "string",
"example": "matt@example.com"
},
"meetingId": {
"type": "string",
"example": "16ce696f75844d24b2d4fab04b4419af_I_183979003076423608"
},
"creatorId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS82YWE2ZGE5OS0xYzdlLTQ4MWItODY3YS03MWY2NTIwNDk0MzM"
},
"host": {
"type": "object",
"properties": {},
"description": "The meeting's host data."
},
"attendees": {
"type": "array",
"items": {},
"description": "Common Identity (CI) authenticated meeting attendees."
},
"transcriptionEnabled": {
"type": "string",
"example": "yes",
"description": "Indicates whether or not the Voice Assistant was enabled during the meeting. If `true` a transcript should be available a couple minutes after the meeting ended at the [meetingTranscripts resource](/docs/api/v1/meeting-transcripts)."
},
"recordingEnabled": {
"type": "string",
"example": "yes",
"description": "Indicates if recording was enabled for all or parts of the meeting. If `true` a recording should be available shortly after the meeting ended at the [recordings resource](/docs/api/v1/recordings)."
},
"hasPostMeetingsChat": {
"type": "string",
"example": "yes",
"description": "Indicates if chat messages were exchanged during the meeting in the meetings client (not the unified client). If `true` these messages can be accessed by a compliance officer at the [postMeetingsChat](/docs/api/v1/meetings-chat) resource. Meetings chat collection must be custom enabled."
},
"corelationId": {
"type": "string",
"example": "fdda8613-d34b-424c-8c6a-44ff2e19379c",
"description": "Telephony; The corelation id."
},
"callType": {
"type": "string",
"example": "SIP_ENTERPRISE",
"description": "Telephony; call types (examples `VIDEO_DIALIN`,`VIDEO_DIALOUT`,`CASCADE`,`HYBRID_CASCADE`,`PSTN_SIP`,`PSTN_DIALIN`,`PSTN_DIALOUT`,`PSTN_ONLY_DIALIN`,`PSTN_ONLY_DIALOUT`,`H323`,`H323_IP`,`SIP_ENTERPRISE`,`SIP_MOBILE`,`SIP_NATIONAL`,`SIP_INTERNATIONAL`,`SIP_EMERGENCY`,`SIP_OPERATOR`,`SIP_SHORTCODE`,`SIP_TOLLFREE`,`SIP_PREMIUM`,`SIP_URI`,`SIP_INBOUND`,`UNKNOWN`,`ZTM`,`SIP_MEETING`)."
},
"userId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZjEwMTU1NC04ZGJjLTQyMmUtOGEzZC1kYTk1YTI3NWZlNzU",
"description": "Telephony; user id of the CDR owner."
},
"userType": {
"type": "string",
"example": "User",
"description": "Telephony; The type of user (`User`,`Anchor`,`AutomatedAttendantBasic`,`AutomatedAttendantStandard`,`AutomatedAttendantVideo`,`BroadworksAnywhere`,`CallCenterBasic`,`CallCenterPremium`,`CallCenterStandard`,`CollaborateBridge`,`ContactCenterAdaptor`,`FindMeFollowMe`,`FlexibleSeatingHost`,`GroupCall`,`GroupPaging`,`HuntGroup`,`LocalGateway`,`MeetMeConference`,`Place`,`RoutePoint`,`SystemVoicePortal`,`VoiceMailGroup`,`VoiceMailRetrieval`,`VoiceXML`,`VirtualLine`,`Unknown`)."
},
"callDirection": {
"type": "string",
"example": "ORIGINTATING",
"description": "Telephony; `ORIGINATING` or `TERMINATING`."
},
"isCallAnswered": {
"type": "string",
"example": "true",
"description": "Telephony; indicates if the call was answered."
},
"callDurationSeconds": {
"type": "string",
"example": "192",
"description": "Telephony; duration of call in seconds."
},
"callStartTime": {
"type": "string",
"example": "2023-02-08T06:12:43.976Z",
"description": "Telephony; ISO 8601."
},
"callAnswerTime": {
"type": "string",
"example": "2023-02-08T06:12:47.012Z",
"description": "Telephony; ISO 8601."
},
"callTransferTime": {
"type": "string",
"example": "2023-02-08T06:15:19.112Z",
"description": "Telephony; ISO 8601."
},
"callingNumber": {
"type": "string",
"example": "910481234",
"description": "Telephony; originating number."
},
"callingLineId": {
"type": "string",
"example": "211",
"description": "Telephony."
},
"calledNumber": {
"type": "string",
"example": "4089671221",
"description": "Telephony; destination number."
},
"calledLineId": {
"type": "string",
"example": "219",
"description": "Telephony"
},
"dialedDigits": {
"type": "string",
"example": "123",
"description": "Telephony"
},
"callRedirectingNumber": {
"type": "string",
"description": "Telephony"
},
"callRedirectedReason": {
"type": "string",
"description": "Telephony"
},
"created": {
"type": "string",
"example": "2016-05-16T21:34:59.324Z"
},
"type": {
"type": "string",
"example": "direct",
"description": "Message type `direct` or `group` message."
},
"breakoutSessionId": {
"type": "string",
"example": "d66a4a90-4f50-11ef-bc94-f5c71646dc71",
"description": "The breakout session Id in cases where the action happened in a meeting's brakout session, for example a `meetingMessage`."
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Recipient"
},
"description": "The recipients list for directed meetingMessages."
}
},
"description": "The event's data representation. This object will contain the event's `resource`, such as [memberships](/docs/api/v1/memberships/get-membership-details), [messages](/docs/api/v1/messages/get-message-details), [meetings](/docs/api/v1/meetings), [meetingMessages](/docs/api/v1/meetingMessages), [tabs](/docs/api/v1/room-tabs), [rooms](/docs/api/v1/space-classifications) or [attachmentActions](/docs/api/v1/attachment-actions) at the time the event took place."
}
}
},
"EventCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Event"
}
}
}
},
"EventResourceEnum": {
"type": "string",
"enum": [
"attachmentActions",
"businessTexts",
"call_records",
"convergedRecordings",
"file_transcodings",
"files",
"meetingMessages",
"meetings",
"meetingTranscripts",
"memberships",
"messages",
"rooms",
"tabs"
],
"description": " * `attachmentActions` - State changed on a card attachment\n * `businessTexts` - A user sent or received a SMS message\n * `call_records` - A Webex call was made to/from a user\n * `convergedRecordings` - A Webex call was recorded for a user\n * `file_transcodings` - State change on a file preview\n * `files` - State changed on a file download\n * `meetingMessages` - State changed on a meeting message, i.e. message exchanged as part of a meeting\n * `meetings` - State change on a meeting ( here combined with type = 'ended' )\n * `meetingTranscripts` - State change on a automatic transcript resource for Webex Assistant\n * `memberships` - State changed on a memberships resource\n * `messages` - State changed on a messages resource\n * `rooms` - State changed on a space classification\n * `tabs` - State changed on a room tabs in a space\n"
},
"EventTypeEnum": {
"type": "string",
"enum": [
"created",
"updated",
"deleted",
"ended"
],
"description": " * `created` - The resource has been created\n * `updated` - A property on the resource has been updated\n * `deleted` - The resource has been deleted\n * `ended` - The meeting has ended\n"
},
"Recipient": {
"type": "object",
"properties": {
"personId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lOGYwOTIwOC00ZjUxLTExZWYtOTQ4My1iYTA3NjE2MzY4NmQ",
"description": "The personId of the recipient"
},
"personEmail": {
"type": "string",
"example": "johndoe@simplistic.com",
"description": "The personEmail"
},
"guestDisplayName": {
"type": "string",
"example": "John Wayne",
"description": "Guests, who are unauthenticated users, have a guestDisplayName"
},
"guestEmail": {
"type": "string",
"example": "jwayne@mailinator.com",
"description": "Guests, who are unauthenticated users, have a guestEmail"
}
}
},
"HotDeskSessionsResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HotDesk"
}
}
}
},
"HotDesk": {
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"example": "Y2lzY29...",
"description": "A unique identifier for a hot desk session."
},
"workspaceId": {
"type": "string",
"example": "YL34EmB...",
"description": "The workspace where the hot desk session is active."
},
"personId": {
"type": "string",
"example": "YL34EmA...",
"description": "The id of the person who initiated the hot desk session."
},
"bookingStartTime": {
"type": "string",
"example": "2024-08-29T12:00:00Z",
"description": "The start time of the booking."
},
"bookingEndTime": {
"type": "string",
"example": "2024-08-29T20:00:00Z",
"description": "The end time of the booking."
}
}
},
"Location": {
"type": "object",
"required": [
"address",
"countryCode",
"latitude",
"longitude"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"description": "Unique identifier for the location."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzA2OWEzMDY2LTgwNjMtNDI0Zi05YmE0LTBhZDdhMmYxMzNjNQ",
"description": "The ID to use for this location in the [/locations API](/docs/api/v1/locations)"
},
"displayName": {
"type": "string",
"example": "Cisco Barcelona",
"description": "A friendly name for the location."
},
"address": {
"type": "string",
"example": "Carrer de Pere IV, Barcelona, Spain",
"description": "The location address."
},
"countryCode": {
"type": "string",
"example": "ES",
"description": "The location country code (ISO 3166-1)."
},
"cityName": {
"type": "string",
"example": "Barcelona",
"description": "The location city name."
},
"latitude": {
"type": "number",
"example": 41.406615,
"description": "The location latitude."
},
"longitude": {
"type": "number",
"example": 2.200717,
"description": "The location longitude."
},
"notes": {
"type": "string",
"example": "A note about the location",
"description": "Notes associated with the location."
}
}
},
"PutCommonLocationObject": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Denver",
"description": "The name of the location. Supports up to 256 characters, but locations enabled for Webex Calling are limited to 80 characters maximum."
},
"timeZone": {
"type": "string",
"example": "America/Chicago",
"description": "Time zone associated with this location, refer to this link (https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide#webex-meetings-site-timezone) for format."
},
"preferredLanguage": {
"type": "string",
"example": "en_us",
"description": "Default email language."
},
"address": {
"type": "object",
"properties": {
"address1": {
"type": "string",
"example": "123 Some St.",
"description": "Address 1"
},
"address2": {
"type": "string",
"example": "Suite 456",
"description": "Address 2"
},
"city": {
"type": "string",
"example": "Supercity",
"description": "City"
},
"state": {
"type": "string",
"example": "Goodstate",
"description": "State code"
},
"postalCode": {
"type": "string",
"example": "12345",
"description": "Postal Code"
},
"country": {
"type": "string",
"example": "US",
"description": "ISO-3166 2-Letter Country Code."
}
},
"description": "The address of the location."
}
}
},
"PostCommonLocationObject": {
"type": "object",
"required": [
"name",
"timeZone",
"preferredLanguage",
"announcementLanguage",
"address"
],
"properties": {
"name": {
"type": "string",
"example": "Denver",
"description": "The name of the location. Supports up to 256 characters, but locations enabled for Webex Calling are limited to 80 characters maximum."
},
"timeZone": {
"type": "string",
"example": "America/Chicago",
"description": "Time zone associated with this location, refer to this link (https://developer.webex.com/docs/api/guides/webex-for-broadworks-developers-guide#webex-meetings-site-timezone) for format."
},
"preferredLanguage": {
"type": "string",
"example": "en_us",
"description": "Default email language."
},
"announcementLanguage": {
"type": "string",
"example": "fr_fr",
"description": "Location's phone announcement language."
},
"address": {
"type": "object",
"required": [
"address1",
"city",
"state",
"postalCode",
"country"
],
"properties": {
"address1": {
"type": "string",
"example": "123 Some St.",
"description": "Address 1"
},
"address2": {
"type": "string",
"example": "Suite 456",
"description": "Address 2"
},
"city": {
"type": "string",
"example": "Supercity",
"description": "City"
},
"state": {
"type": "string",
"example": "Goodstate",
"description": "State code"
},
"postalCode": {
"type": "string",
"example": "12345",
"description": "Postal Code"
},
"country": {
"type": "string",
"example": "US",
"description": "ISO-3166 2-Letter Country Code."
}
},
"description": "The address of the location."
},
"latitude": {
"type": "string",
"example": "12.935784",
"description": "Latitude"
},
"longitude": {
"type": "string",
"example": "77.697332",
"description": "Longitude"
},
"notes": {
"type": "string",
"example": "123 Some St. Denver Location",
"description": "Notes"
}
}
},
"LocationsCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
}
}
}
},
"Floor": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"id": {
"type": "string",
"example": "xxx==",
"description": "Unique identifier for the floor."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"description": "Unique identifier for the location."
},
"floorNumber": {
"type": "number",
"example": -1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "The basement",
"description": "The floor display name."
}
}
},
"FloorUpdated": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"id": {
"type": "string",
"example": "xxx==",
"description": "Unique identifier for the floor."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"description": "Unique identifier for the location."
},
"floorNumber": {
"type": "number",
"example": 1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "My custom name",
"description": "The floor display name."
}
}
},
"FloorCreationRequest": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"floorNumber": {
"type": "number",
"example": -1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "The basement",
"description": "The floor display name."
}
}
},
"FloorUpdateRequest": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"floorNumber": {
"type": "number",
"example": 1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "My custom name",
"description": "The floor display name."
}
}
},
"FloorCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Floor"
},
"description": "An array of floor objects."
}
}
},
"MeetingQualitiesResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaSessionQuality"
}
}
}
},
"MediaSessionQuality": {
"type": "object",
"required": [
"meetingInstanceId"
],
"properties": {
"meetingInstanceId": {
"type": "string",
"example": "e5dba9613a9d455aa49f6ffdafb6e7db_I_191395283063545470",
"description": "The meeting identifier for the specific meeting instance."
},
"webexUserName": {
"type": "string",
"example": "John Andersen",
"description": "The display name of the participant of this media session."
},
"webexUserEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "The email address of the participant of this media session."
},
"joinTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this participant joined the meeting."
},
"leaveTime": {
"type": "string",
"example": "2020-04-10T17:02:00.000Z",
"description": "The date and time when this participant left the meeting."
},
"joinMeetingTime": {
"type": "string",
"example": "5.793",
"description": "The join meeting time of the participant. "
},
"clientType": {
"type": "string",
"example": "Teams_Mobile_Client (iOS)",
"description": "The type of the client (and OS) used by this media session."
},
"clientVersion": {
"type": "string",
"example": "40.5.0.210",
"description": "The version of the client used by this media session."
},
"osType": {
"type": "string",
"example": "mac",
"description": "The operating system used for the client."
},
"osVersion": {
"type": "string",
"example": "Version 10.14.6 (Build 18G3020)",
"description": "The version of the operating system used for the client."
},
"hardwareType": {
"type": "string",
"example": "mac book",
"description": "The type of hardware used to attend the meeting"
},
"speakerName": {
"type": "string",
"example": "MacBook Pro Speakers",
"description": "A description of the speaker used in the meeting."
},
"networkType": {
"type": "string",
"enum": [
"wifi",
"cellular",
"ethernet",
"unknown"
],
"description": "The type of network."
},
"localIP": {
"type": "string",
"example": "10.24.72.54",
"description": "The local IP address of the client."
},
"publicIP": {
"type": "string",
"example": "10.24.72.54",
"description": "The public IP address of the client."
},
"maskedLocalIP": {
"type": "string",
"example": "10.24.72.54",
"description": "The masked local IP address of the client."
},
"maskedPublicIP": {
"type": "string",
"example": "10.24.72.54",
"description": "The masked public IP address of the client."
},
"camera": {
"type": "string",
"example": "FaceTime HD Camera",
"description": "A description of the camera used in the meeting."
},
"microphone": {
"type": "string",
"example": "External Microphone",
"description": "A description of the microphone used in the meeting."
},
"serverRegion": {
"type": "string",
"example": "San Jose, USA",
"description": "The server region."
},
"videoMeshCluster": {
"type": "string",
"example": "Mesh Cluster One",
"description": "The video mesh cluster name."
},
"videoMeshServer": {
"type": "string",
"example": "server.example.com",
"description": "The video mesh server name."
},
"participantId": {
"type": "string",
"example": "8635cbf0ca1a4573b27348e560679b25_I_158174534545967299_57",
"description": "Identifies the participant."
},
"participantSessionId": {
"type": "string",
"example": "3324C9D0-9EA7-45A2-B249-5B62A384AFEF",
"description": "Identifies a specific session the participant has in a given meeting."
},
"videoIn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VideoIn"
},
"description": "The collection of downstream (sent to the client) video quality data."
},
"videoOut": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VideoOut"
},
"description": "The collection of upstream (sent from the client) video quality data."
},
"audioIn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudioIn"
},
"description": "The collection of downstream (sent to the client) audio quality data."
},
"audioOut": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudioOut"
},
"description": "The collection of upstream (sent from the client) audio quality data."
},
"shareIn": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareIn"
},
"description": "The collection of downstream (sent to the client) share quality data."
},
"shareOut": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShareOut"
},
"description": "The collection of upstream (sent from the client) share quality data."
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Resources"
},
"description": "Device resources such as CPU and memory."
}
}
},
"VideoIn": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the downstream video quality data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this video session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this video session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of video packet loss, as a float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "The pixel height of the incoming video."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "The frames per second of the incoming video."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate of the incoming video."
},
"codec": {
"type": "string",
"example": "H.264 BP",
"description": "The incoming video codec."
},
"jitter": {
"type": "array",
"items": {
"type": "number",
"example": 170
},
"description": "The incoming video jitter."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"VideoOut": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the upstream video quality data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this video session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this video session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of video packet loss, in float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "The pixel height of the outgoing video."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "The frames per second of the outgoing video."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate of the outgoing video."
},
"codec": {
"type": "string",
"example": "H.264 BP",
"description": "The outgoing video codec."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The outgoing video jitter."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"AudioIn": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the downstream audio quality data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this audio session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this audio session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of audio packet loss, as a float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "Not applicable to audio."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "Not applicable to audio."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bitrate of the incoming audio."
},
"codec": {
"type": "string",
"example": "Opus",
"description": "The codec of the incoming audio."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The incoming audio jitter."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"AudioOut": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the upstream audio quality data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this audio session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this audio session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of audio packet loss, as a float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "Not applicable to audio out."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "Not applicable to audio out."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate of the outgoing audio."
},
"codec": {
"type": "string",
"example": "Opus",
"description": "The audio codec."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The outgoing audio jitter."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"ShareIn": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the downstream content sharing data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this content sharing session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this content sharing session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of content sharing packet loss, as a float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "The height in pixels of the incoming share video."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "The frame rate of the incoming share video."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate for the incoming share video."
},
"codec": {
"type": "string",
"example": "H.264 BP",
"description": "The codec for the incoming share video."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The jitter for the incoming share video."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"ShareOut": {
"type": "object",
"properties": {
"samplingInterval": {
"type": "number",
"example": 60,
"description": "The sampling interval, in seconds, of the upstream content sharing data."
},
"startTime": {
"type": "string",
"example": "2020-04-10T17:00:00.000Z",
"description": "The date and time when this content sharing session started."
},
"endTime": {
"type": "string",
"example": "2020-04-10T18:00:00.000Z",
"description": "The date and time when this content sharing session ended."
},
"packetLoss": {
"type": "array",
"items": {
"type": "number"
},
"description": "The percentage of content sharing packet loss, in float between 0.0 and 100.0, during each sampling interval."
},
"latency": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average latency, in milliseconds, during each sampling interval."
},
"resolutionHeight": {
"type": "array",
"items": {
"type": "number"
},
"description": "The height in pixels of the outgoing share video."
},
"frameRate": {
"type": "array",
"items": {
"type": "number",
"example": 25.940001
},
"description": "The frame rate of the outgoing share video."
},
"mediaBitRate": {
"type": "array",
"items": {
"type": "number"
},
"description": "The bit rate of the outgoing share video."
},
"codec": {
"type": "string",
"example": "H.264 BP",
"description": "The codec of the outgoing share video."
},
"jitter": {
"type": "array",
"items": {
"type": "number"
},
"description": "The jitter for the outgoing share video."
},
"transportType": {
"type": "string",
"enum": [
"UDP",
"TCP"
],
"description": "The network protocol used for video transmission."
}
}
},
"Resources": {
"type": "object",
"properties": {
"processAverageCPU": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average percent CPU for the process."
},
"processMaxCPU": {
"type": "array",
"items": {
"type": "number"
},
"description": "The max percent CPU for the process."
},
"systemAverageCPU": {
"type": "array",
"items": {
"type": "number"
},
"description": "The average percent CPU for the system."
},
"systemMaxCPU": {
"type": "array",
"items": {
"type": "number"
},
"description": "The max percent CPU for the system."
}
}
},
"Report": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"description": "Unique identifier for the report."
},
"title": {
"type": "string",
"example": "Bots Activity",
"description": "Name of the template to which this report belongs."
},
"service": {
"type": "string",
"example": "Teams",
"description": "The service to which the report belongs."
},
"startDate": {
"type": "string",
"example": "2020-02-23",
"description": "The data in this report belongs to dates greater than or equal to this."
},
"endDate": {
"type": "string",
"example": "2020-03-24",
"description": "The data in this report belongs to dates smaller than or equal to this."
},
"siteList": {
"type": "string",
"example": "cisco.webex.com",
"description": "The site to which this report belongs to. This only exists if the report belongs to service `Webex`."
},
"timeZone": {
"type": "string",
"example": "Asia/Shanghai",
"description": "Time zone used for report date and time values. Use an IANA time zone name. The default value is `UTC` when not specified."
},
"created": {
"type": "string",
"example": "2020-03-24 17:13:39",
"description": "Time of creation for this report."
},
"createdBy": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"description": "The person who created the report."
},
"scheduledFrom": {
"type": "string",
"example": "API",
"description": "Whether this report was scheduled from API or Control Hub."
},
"status": {
"type": "string",
"example": "done",
"description": "Completion status of this report."
},
"downloadURL": {
"type": "string",
"example": "https://downloadservicebts.webex.com/api?reportId=Y2lzY29zcGFyazovL3VzL1JFUE9SVC9hZDBkMjA1NzVkYTA0NWE0OGZhZDQ3ZDk3NGFiNDFmMg",
"description": "The link from which the report can be downloaded."
}
}
},
"ReportCollectionResponse": {
"type": "object",
"properties": {
"Report Attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Report"
},
"description": "An array of report objects."
}
}
},
"Template": {
"type": "object",
"properties": {
"templateId": {
"type": "string",
"example": "130",
"description": "Unique identifier representing a report."
},
"title": {
"type": "string",
"example": "Calling Usage",
"description": "Name of the template."
},
"service": {
"type": "string",
"example": "Teams",
"description": "The service to which the report belongs."
},
"category": {
"type": "string",
"example": "Partner",
"description": "Generated reports belong to which category."
},
"maxDays": {
"type": "number",
"example": 31,
"description": "Maximum date range for reports belonging to this template."
},
"dataStartDate": {
"type": "string",
"example": "2024-01-01",
"description": "Start date of the data in the reports belonging to this template."
},
"dataEndDate": {
"type": "string",
"example": "2024-01-31",
"description": "End date of the data in the reports belonging to this template."
}
}
},
"TemplateCollectionResponse": {
"type": "object",
"properties": {
"Template Collection": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Template"
},
"description": "An array of template objects."
}
}
},
"Person": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"description": "A unique identifier for the person."
},
"emails": {
"type": "array",
"items": {
"type": "string",
"example": "john.andersen@example.com"
},
"description": "The email addresses of the person."
},
"phoneNumbers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"work",
"work_extension",
"mobile",
"fax"
],
"description": "The type of phone number.\n * `work` - Work phone number of the person.\n * `work_extension` - Work extension of the person. For the Webex Calling person, the value will have a routing prefix along with the extension.\n * `mobile` - Mobile number of the person.\n * `fax` - FAX number of the person.\n"
},
"value": {
"type": "string",
"example": "+1 408 526 7209",
"description": "The phone number."
},
"primary": {
"type": "boolean",
"example": true,
"description": "Primary number for the person."
}
}
},
"description": "Phone numbers for the person."
},
"extension": {
"type": "string",
"example": "133",
"description": "The Webex Calling extension for the person. Only applies to a person with a Webex Calling license."
},
"locationId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"description": "The ID of the location for this person retrieved from BroadCloud."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The full name of the person."
},
"nickName": {
"type": "string",
"example": "John",
"description": "The nickname of the person if configured. If no nickname is configured for the person, this field will not be present."
},
"firstName": {
"type": "string",
"example": "John",
"description": "The first name of the person."
},
"lastName": {
"type": "string",
"example": "Andersen",
"description": "The last name of the person."
},
"avatar": {
"type": "string",
"example": "https://1efa7a94ed21783e352-c62266528714497a17239ececf39e9e2.ssl.cf1.rackcdn.com/V1~54c844c89e678e5a7b16a306bc2897b9~wx29yGtlTpilEFlYzqPKag==~1600",
"description": "The URL to the person's avatar in PNG format."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"description": "The ID of the organization to which this person belongs."
},
"roles": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL1JPTEUvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
},
"description": "An array of role strings representing the roles to which this admin user belongs."
},
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh,Y2lzY29zcGFyazovL3VzL0xJQ0VOU0UvOTZhYmMyYWEtM2RjYy0xMWU1LWIyNjMtMGY0NTkyYWRlZmFi"
},
"description": "An array of license strings allocated to this person."
},
"department": {
"type": "string",
"example": "Sales",
"description": "The business department the user belongs to."
},
"manager": {
"type": "string",
"example": "John Duarte",
"description": "A manager identifier."
},
"managerId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80ZGEzYTI0OC05YjBhLTQxMDgtODU0NC1iNTQwMzEyZTU2M2E",
"description": "Person ID of the manager."
},
"title": {
"type": "string",
"example": "GM",
"description": "The person's title."
},
"addresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "work",
"description": "The type of address."
},
"country": {
"type": "string",
"example": "US",
"description": "The user's country."
},
"locality": {
"type": "string",
"example": "Milpitas",
"description": "The user's locality, often city."
},
"region": {
"type": "string",
"example": "California",
"description": "The user's region, often state."
},
"streetAddress": {
"type": "string",
"example": "1099 Bird Ave.",
"description": "The user's street."
},
"postalCode": {
"type": "string",
"example": "99212",
"description": "The user's postal or zip code."
}
}
},
"description": "A person's addresses."
},
"created": {
"type": "string",
"example": "2015-10-18T14:26:16.000Z",
"description": "The date and time the person was created."
},
"lastModified": {
"type": "string",
"example": "2015-10-18T14:26:16.000Z",
"description": "The date and time the person was last changed."
},
"timezone": {
"type": "string",
"example": "America/Denver",
"description": "The time zone of the person if configured. If no timezone is configured on the account, this field will not be present."
},
"lastActivity": {
"type": "string",
"example": "2015-10-18T14:26:16.028Z",
"description": "The date and time of the person's last activity within Webex. This will only be returned for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/)."
},
"siteUrls": {
"type": "array",
"items": {
"type": "string",
"example": "mysite.webex.com#attendee"
},
"description": "One or several site names where this user has a role (host or attendee)."
},
"sipAddresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"personal-room",
"enterprise",
"cloud-calling"
],
"description": "The type of SIP address.\n * `personal-room` - Personal room address.\n * `enterprise` - Enterprise address.\n * `cloud-calling` - Cloud calling address.\n"
},
"value": {
"type": "string",
"example": "testuser5@mycompany.webex.com",
"description": "The SIP address."
},
"primary": {
"type": "boolean",
"description": "Primary SIP address of the person."
}
}
},
"description": "The user's SIP addresses. Read-only."
},
"xmppFederationJid": {
"type": "string",
"example": "user@example.com",
"description": "Identifier for intra-domain federation with other XMPP based messenger systems."
},
"status": {
"type": "string",
"enum": [
"active",
"call",
"DoNotDisturb",
"inactive",
"meeting",
"OutOfOffice",
"pending",
"presenting",
"unknown"
],
"description": "The current presence status of the person. This will only be returned for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/). Presence status is different from Control Hub's \"Last Service Access Time\" which indicates the last time an oAuth token was issued for this user.\n * `active` - Active within the last 10 minutes.\n * `call` - The user is in a call.\n * `DoNotDisturb` - The user has manually set their status to \"Do Not Disturb\".\n * `inactive` - Last activity occurred more than 10 minutes ago.\n * `meeting` - The user is in a meeting.\n * `OutOfOffice` - The user or a Hybrid Calendar service has indicated that they are \"Out of Office\".\n * `pending` - The user has never logged in; a status cannot be determined.\n * `presenting` - The user is sharing content.\n * `unknown` - The user\u2019s status could not be determined.\n"
},
"invitePending": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Whether or not an invite is pending for the user to complete account activation. This property is only returned if the authenticated user is an admin user for the person's organization.\n * `true` - The person has been invited to Webex but has not created an account.\n * `false` - An invite is not pending for this person.\n"
},
"loginEnabled": {
"type": "string",
"enum": [
"true",
"false"
],
"description": "Whether or not the user is allowed to use Webex. This property is only returned if the authenticated user is an admin user for the person's organization.\n * `true` - The person _can_ log into Webex.\n * `false` - The person _cannot_ log into Webex.\n"
},
"type": {
"type": "string",
"enum": [
"person",
"bot",
"appuser"
],
"description": "The type of person account, such as person or bot.\n * `person` - Account belongs to a person.\n * `bot` - Account is a bot user.\n * `appuser` - Account is a [guest user](/docs/guest-issuer).\n"
}
}
},
"PersonCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Person"
},
"description": "An array of person objects."
},
"notFoundIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of person IDs that could not be found."
}
}
},
"RecordingReportSummaryObject": {
"type": "object",
"properties": {
"recordingId": {
"type": "string",
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"description": "A unique identifier for the recording."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"timeRecorded": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time the recording started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. the time is the record button was clicked in the meeting."
},
"siteUrl": {
"type": "string",
"example": "site4-example.webex.com",
"description": "Site URL for the recording."
},
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host."
},
"viewCount": {
"type": "number",
"example": 7,
"description": "The number of times the recording was viewed."
},
"downloadCount": {
"type": "number",
"example": 20,
"description": "The number of times the recording was downloaded."
}
}
},
"RecordingReportObject": {
"type": "object",
"properties": {
"recordingId": {
"type": "string",
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"description": "A unique identifier for the recording."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"name": {
"type": "string",
"example": "John Andersen",
"description": "The name of the person who accessed the recording."
},
"email": {
"type": "string",
"example": "john.andersen@example.com",
"description": "The email address of the person who accessed the recording."
},
"accessTime": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time the recording was accessed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"viewed": {
"type": "boolean",
"example": true,
"description": "Whether or not the recording was viewed by the person."
},
"downloaded": {
"type": "boolean",
"example": true,
"description": "Whether or not the recording was downloaded by the person."
}
}
},
"RecordingAchriveSummaryObject": {
"type": "object",
"properties": {
"archiveId": {
"type": "string",
"example": "7d7ea5f42b921eace05386ca24ad730e_R_1000634462",
"description": "A unique identifier for the meeting archive summary."
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": "Recording achrive summary's service-type."
},
"title": {
"type": "string",
"example": "John's Meeting",
"description": "Meeting title."
},
"createTime": {
"type": "string",
"example": "2019-01-27T17:43:24Z",
"description": "The date and time in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format that when the archive was created by the system."
}
}
},
"RecordingArchiveReportObject": {
"type": "object",
"properties": {
"archiveId": {
"type": "string",
"example": "7d7ea5f42b921eace05386ca24ad730e_R_1000634462",
"description": "A unique identifier for the meeting archive summary."
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": "Recording achrive report's service-type."
},
"title": {
"type": "string",
"example": "John's Meeting",
"description": "Meeting title."
},
"start": {
"type": "string",
"example": "2019-03-18T11:26:30Z",
"description": "Start time for meeting in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"end": {
"type": "string",
"example": "2019-03-18T12:26:30Z",
"description": "End time for a meeting in ISO 8601 compliant format."
},
"hostDisplayName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the meeting host."
},
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host."
},
"participants": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveParticipant"
},
"description": "The participants of the meeting archive."
},
"chats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveChat"
},
"description": "The chats of the meeting archive."
},
"polls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchivePoll"
},
"description": "The polls of the meeting archive."
},
"qas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveQA"
},
"description": "Meeting meeting archive's Q and A."
},
"systemInfos": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveSystemInfo"
},
"description": "The system Information of the meeting archive, which can be only supported when serviceType is `SupportCenter`."
}
}
},
"MeetingRecordingArchiveParticipant": {
"type": "object",
"properties": {
"correlationId": {
"type": "number",
"example": 28208023,
"description": "An internal ID that is associated with each join."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the meeting participant."
},
"joinedTime": {
"type": "string",
"example": "2022-07-20T07:01:31Z",
"description": "The time the participant joined the meeting."
},
"leftTime": {
"type": "string",
"example": "2022-07-20T07:01:31Z",
"description": "The time the participant left the meeting."
},
"email": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting participant."
}
}
},
"MeetingRecordingArchiveChat": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "private",
"description": "Whether the type of the chat is private, public or group. Private chat is for the 1:1 chat. Public chat is for the message which is sent to all the people in the meeting. Group chat is for the message which is sent to a small group of people, like a message to the \"host and presenter\"."
},
"senderName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the sender of the chat snippet."
},
"chatTime": {
"type": "string",
"example": "2021-07-06T09:22:34Z",
"description": "Chat time for the chat snippet in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"target": {
"type": "string",
"example": "All Participants",
"description": "Information of the receivers of the chat snippet."
},
"text": {
"type": "string",
"example": "It's nice to meet you",
"description": "The text of the chat snippet."
}
}
},
"MeetingRecordingArchivePoll": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "single",
"description": "The type of the question."
},
"startTime": {
"type": "string",
"example": "2021-07-06T09:25:34Z",
"description": "The date and time the poll started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"endTime": {
"type": "string",
"example": "2021-07-06T09:28:34Z",
"description": "The date and time the poll ended in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"content": {
"type": "object",
"properties": {
"questionCount": {
"type": "number",
"example": 10,
"description": "The total number of questions."
},
"userCount": {
"type": "number",
"example": 10,
"description": "The total number of users."
},
"votedUserCount": {
"type": "number",
"example": 3,
"description": "The number of voters among users."
},
"questions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchivePollQuestion"
},
"description": "Poll's questions."
}
},
"description": "The content of the meeting archive poll;"
}
}
},
"MeetingRecordingArchivePollQuestion": {
"type": "object",
"properties": {
"voteUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveUser"
},
"description": "The voters among users."
},
"question": {
"type": "object",
"properties": {
"choiceCount": {
"type": "number",
"example": 3,
"description": "The number of choices in the questions."
},
"type": {
"type": "string",
"example": "single",
"description": "The type of the question."
},
"text": {
"type": "string",
"example": "Do you like this API?",
"description": "The text of the question."
}
},
"description": "The poll's question."
},
"answerSummary": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchivePollAnswerSummary"
},
"description": "The answer summary of the archive poll."
},
"respondents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchivePollRespondent"
},
"description": "The question's respondents."
}
}
},
"MeetingRecordingArchiveUser": {
"type": "object",
"properties": {
"correlationId": {
"type": "number",
"example": 28208023,
"description": "An internal ID that is associated with each join."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the meeting participant."
},
"email": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting participant."
}
}
},
"MeetingRecordingArchivePollAnswerSummary": {
"type": "object",
"properties": {
"totalRespondents": {
"type": "number",
"example": 10,
"description": "The total number of people who selected this answer."
},
"isCorrect": {
"type": "boolean",
"example": true,
"description": "Whether the answer is correct."
},
"text": {
"type": "string",
"example": "Yes, I do.",
"description": "The text of the answer."
},
"voteUsers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveUser"
},
"description": "The voters among users."
}
}
},
"MeetingRecordingArchivePollRespondent": {
"type": "object",
"properties": {
"correlationId": {
"type": "number",
"example": 28208023,
"description": "An internal ID that is associated with the respondent's each join."
},
"displayName": {
"type": "string",
"example": "Alex Green",
"description": "Display name for the poll respondent."
},
"email": {
"type": "string",
"example": "alex.green@example.com",
"description": "Email address for the poll respondent."
},
"answers": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of answers to the question."
}
}
},
"MeetingRecordingArchiveQA": {
"type": "object",
"properties": {
"priority": {
"type": "string",
"example": "NA",
"description": "The priority of the Q and A."
},
"type": {
"type": "string",
"example": "private",
"description": "Whether the type of the Q and A is private, public, or group. Private Q and A is for the 1:1 chat. Public Q and A are for the message which is sent to all the people in the meeting. Group Q and A are for the message which is sent to a small group of people, like a Q and A to \"host and presenter\"."
},
"displayName": {
"type": "string",
"example": "john.andersen@example.com`",
"description": "The email of the user who asked the question."
},
"questionTime": {
"type": "string",
"example": "2021-07-06T09:22:34Z",
"description": "The date and time the question was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"target": {
"type": "string",
"example": "All Participants",
"description": "Information of the user who asked the question."
},
"question": {
"type": "string",
"example": "Are you ok?",
"description": "The question that was asked."
},
"answers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MeetingRecordingArchiveQAAnswer"
},
"description": "Question's answers."
}
}
},
"MeetingRecordingArchiveQAAnswer": {
"type": "object",
"properties": {
"responseMode": {
"type": "string",
"example": "private",
"description": "The answer's response mode."
},
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The name of the person who answered the question."
},
"correlationId": {
"type": "number",
"example": 10947662,
"description": "An internal ID that is associated with the answer's each join."
},
"email": {
"type": "string",
"example": "alex.green@example.com",
"description": "The email of the person who answered the question."
},
"answerTime": {
"type": "string",
"example": "2021-07-06T09:52:34Z",
"description": "The date and time the question answered in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
},
"text": {
"type": "string",
"example": "Yes, I am.",
"description": "The text of the answer."
}
}
},
"MeetingRecordingArchiveSystemInfo": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"example": "John Andersen",
"description": "The name of the person who accessed the meeting archive."
},
"catalogs": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SystemInfoCatalog"
},
"description": "The catalogs of system information."
}
}
},
"SystemInfoCatalog": {
"type": "object",
"properties": {
"systemSummary": {
"type": "string",
"example": "User Name: John{*}Operating System: Mac OS X 12.6{*}User Home Directory: /Users/John{*}Date and Time: Tue Oct 18 10:38:17 CST 2022{*}",
"description": "System summary."
},
"browser": {
"type": "string",
"example": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36",
"description": "The browser user agent of the person who acted."
},
"hardware": {
"type": "string",
"example": "mac book",
"description": "The type of hardware that the user used to attend the meeting."
},
"installedSoftware": {
"type": "string",
"example": "webex",
"description": "The software that the user used to attend the meeting."
},
"runningSoftware": {
"type": "string",
"example": "webex",
"description": "The software the user used that is running."
},
"startupPrograms": {
"type": "string",
"example": "Macintosh HD",
"description": "Startup Programs."
},
"storage": {
"type": "string",
"example": "16 GB 2667 MHz DDR4",
"description": "The storage information of the user's device."
},
"video": {
"type": "string",
"example": "AirPlay",
"description": "The video of the user's device."
},
"network": {
"type": "string",
"example": "Wi-Fi",
"description": "The network of the user's device."
},
"operatingSystem": {
"type": "string",
"example": "Mac OS X 10.0",
"description": "The operating system of the user's device."
},
"environmentVariables": {
"type": "string",
"example": "/usr/local/bin:$PATH",
"description": "The environment variables of the user's device."
},
"processes": {
"type": "string",
"example": "2.6 GHz 6-Core Intel Core i7",
"description": "The processes of the user's device."
},
"logicalDrives": {
"type": "string",
"example": "webapp",
"description": "The logical drives of the user's device."
},
"devices": {
"type": "string",
"example": "device1",
"description": "The device of the user."
},
"services": {
"type": "string",
"example": "Firewall",
"description": "The service of the user's device."
},
"systemDrivers": {
"type": "string",
"example": "32drivers",
"description": "The system driver of the user's device."
},
"signedDrivers": {
"type": "string",
"example": "32drivers",
"description": "The sign driver system of the user's device."
},
"eventViewer": {
"type": "string",
"example": "Screen Sharing",
"description": "The event viewer of the user's device."
},
"bios": {
"type": "string",
"example": "AwardBIOS",
"description": "The basic input and output system."
}
}
},
"RecordingObject": {
"type": "object",
"required": [
"id",
"meetingId",
"topic",
"createTime",
"timeRecorded",
"siteUrl",
"downloadUrl",
"playbackUrl",
"password",
"format",
"serviceType",
"durationSeconds",
"sizeBytes",
"shareToMe",
"status"
],
"properties": {
"id": {
"type": "string",
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"description": "A unique identifier for the recording."
},
"meetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's ended meeting instance."
},
"scheduledMeetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's scheduled meeting instance."
},
"meetingSeriesId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291",
"description": "Unique identifier for the recording's meeting series."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"createTime": {
"type": "string",
"example": "2019-01-27T17:43:24Z",
"description": "The date and time recording was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. Please note that it's not the time the record button was clicked in meeting but the time the recording file was generated offline."
},
"timeRecorded": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time recording started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. It indicates when the record button was clicked in the meeting."
},
"siteUrl": {
"type": "string",
"example": "site4-example.webex.com",
"description": "Site URL for the recording."
},
"downloadUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/lsr.php?RCID=60b864cc80aa5b44fc9769c8305b98b7",
"description": "The download link for recording. This attribute is not available if **Prevent downloading** has been turned on for the recording being requested. The **Prevent downloading** option can be viewed and set by a site admin on [Control Hub](https://help.webex.com/en-us/article/sxdj4ab/Manage-Security-for-a-Cisco-Webex-Site-in-Cisco-Webex-Control-Hub)."
},
"playbackUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/ldr.php?RCID=7a8a476b29a32cd1e06dfa6c81970f19",
"description": "The playback link for recording."
},
"password": {
"type": "string",
"example": "********",
"description": "The recording's password."
},
"format": {
"type": "string",
"enum": [
"MP4",
"ARF",
"UPLOADED"
],
"description": " * `MP4` - Recording file format is MP4.\n * `ARF` - Recording file format is ARF, a proprietary Webex recording format.\n * `UPLOADED` - The recording file is uploaded manually.\n"
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": "The service type for the recording.\n * `MeetingCenter` - The service type for the recording is meeting.\n * `EventCenter` - The service type for the recording is the event.\n * `TrainingCenter` - The service type for the recording is the training session.\n * `SupportCenter` - The service type for the recording is the support meeting.\n"
},
"durationSeconds": {
"type": "number",
"example": 4472,
"description": "The duration of the recording, in seconds."
},
"sizeBytes": {
"type": "number",
"example": 248023188,
"description": "The size of the recording file, in bytes."
},
"shareToMe": {
"type": "boolean",
"description": "Whether or not the recording has been shared to the current user. This attribute is hidden if the user calling the API is a Compliance Officer and `hostEmail` is not specified."
},
"integrationTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "External keys of the parent meeting created by an integration application. They could be Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries recordings by a key in its own domain."
},
"status": {
"type": "string",
"enum": [
"available",
"deleted",
"purged"
],
"description": " * `available` - Recording is available.\n * `deleted` - Recording has been moved into recycle bin.\n * `purged` - Recording has been purged from the recycle bin. Only applies if the user calling the API is a Compliance Officer and `meetingId` is specified.\n"
}
}
},
"RecordingObjectForAdminAndCO": {
"type": "object",
"required": [
"id",
"meetingId",
"topic",
"createTime",
"timeRecorded",
"hostDisplayName",
"hostEmail",
"siteUrl",
"downloadUrl",
"playbackUrl",
"format",
"serviceType",
"durationSeconds",
"sizeBytes",
"status"
],
"properties": {
"id": {
"type": "string",
"example": "4f914b1dfe3c4d11a61730f18c0f5387",
"description": "A unique identifier for the recording."
},
"meetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's ended meeting instance."
},
"scheduledMeetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's scheduled meeting instance."
},
"meetingSeriesId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291",
"description": "Unique identifier for the recording's meeting series."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"createTime": {
"type": "string",
"example": "2019-01-27T17:43:24Z",
"description": "The date and time recording was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. Please note that it's not the time the record button was clicked in meeting but the time the recording file was generated offline."
},
"timeRecorded": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time recording started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. It indicates when the record button was clicked in the meeting."
},
"hostDisplayName": {
"type": "string",
"example": "John Andersen",
"description": "Display name for the meeting host."
},
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host."
},
"siteUrl": {
"type": "string",
"example": "site4-example.webex.com",
"description": "Site URL for the recording."
},
"downloadUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/lsr.php?RCID=60b864cc80aa5b44fc9769c8305b98b7",
"description": "The download link for recording. This attribute is not available if **Prevent downloading** has been turned on for the recording being requested. The **Prevent downloading** option can be viewed and set by a site admin on [Control Hub](https://help.webex.com/en-us/article/sxdj4ab/Manage-Security-for-a-Cisco-Webex-Site-in-Cisco-Webex-Control-Hub)."
},
"playbackUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/ldr.php?RCID=7a8a476b29a32cd1e06dfa6c81970f19",
"description": "The playback link for recording."
},
"format": {
"type": "string",
"enum": [
"MP4",
"ARF",
"UPLOADED"
],
"description": " * `MP4` - Recording file format is MP4.\n * `ARF` - Recording file format is ARF, a proprietary Webex recording format.\n * `UPLOADED` - The recording file is uploaded manually.\n"
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": "The service type for the recording.\n * `MeetingCenter` - The service type for the recording is meeting.\n * `EventCenter` - The service type for the recording is the event.\n * `TrainingCenter` - The service type for the recording is the training session.\n * `SupportCenter` - The service type for the recording is the support meeting.\n"
},
"durationSeconds": {
"type": "number",
"example": 4472,
"description": "The duration of the recording, in seconds."
},
"sizeBytes": {
"type": "number",
"example": 248023188,
"description": "The size of the recording file, in bytes."
},
"integrationTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "External keys of the parent meeting created by an integration application. They could be Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries recordings by a key in its own domain."
},
"status": {
"type": "string",
"enum": [
"available",
"deleted",
"purged"
],
"description": " * `available` - Recording is available.\n * `deleted` - Recording has been moved into recycle bin.\n * `purged` - Recording has been purged from the recycle bin. Please note that only a compliance officer can access recordings with a `purged` status.\n"
}
}
},
"RecordingObjectWithDirectDownloadLinks": {
"type": "object",
"required": [
"id",
"meetingId",
"topic",
"createTime",
"timeRecorded",
"siteUrl",
"downloadUrl",
"playbackUrl",
"password",
"format",
"serviceType",
"durationSeconds",
"sizeBytes",
"shareToMe",
"status"
],
"properties": {
"id": {
"type": "string",
"example": "7ee40776779243b4b3da448d941b34dc",
"description": "A unique identifier for recording."
},
"meetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's ended meeting instance."
},
"scheduledMeetingId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291_I_166641849979635652",
"description": "Unique identifier for the recording's scheduled meeting instance."
},
"meetingSeriesId": {
"type": "string",
"example": "f91b6edce9864428af084977b7c68291",
"description": "Unique identifier for the recording's meeting series."
},
"topic": {
"type": "string",
"example": "John's Meeting",
"description": "The recording's topic."
},
"createTime": {
"type": "string",
"example": "2019-01-27T17:43:24Z",
"description": "The date and time recording was created in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. Please note that it's not the time the record button was clicked in meeting but the time the recording file was generated offline."
},
"timeRecorded": {
"type": "string",
"example": "2019-01-27T17:40:20Z",
"description": "The date and time recording started in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. It indicates when the record button was clicked in the meeting."
},
"siteUrl": {
"type": "string",
"example": "site4-example.webex.com",
"description": "Site URL for the recording."
},
"downloadUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/lsr.php?RCID=60b864cc80aa5b44fc9769c8305b98b7",
"description": "The download link for the recording. This attribute is not available if `prevent downloading` has been turned on for the recording being requested. The `prevent downloading` option can be viewed and set on page when editing a recording."
},
"playbackUrl": {
"type": "string",
"example": "https://site4-example.webex.com/site4/ldr.php?RCID=7a8a476b29a32cd1e06dfa6c81970f19",
"description": "The playback link for recording."
},
"password": {
"type": "string",
"example": "********",
"description": "The recording's password."
},
"format": {
"type": "string",
"enum": [
"MP4",
"ARF",
"UPLOADED"
],
"description": " * `MP4` - Recording file format is MP4.\n * `ARF` - Recording file format is ARF, a proprietary Webex recording format.\n * `UPLOADED` - The recording file is uploaded manually.\n"
},
"serviceType": {
"type": "string",
"enum": [
"MeetingCenter",
"EventCenter",
"TrainingCenter",
"SupportCenter"
],
"description": " * `MeetingCenter` - The service type for the recording is meeting.\n * `EventCenter` - The service type for the recording is the event.\n * `TrainingCenter` - The service type for the recording is the training session.\n * `SupportCenter` - The service type for the recording is the support meeting.\n"
},
"durationSeconds": {
"type": "number",
"example": 4472,
"description": "The duration of the recording in seconds."
},
"sizeBytes": {
"type": "number",
"example": 248023188,
"description": "The size of the recording file in bytes."
},
"shareToMe": {
"type": "boolean",
"description": "Whether or not the recording has been shared to the current user."
},
"temporaryDirectDownloadLinks": {
"type": "object",
"properties": {
"recordingDownloadLink": {
"type": "string",
"description": "The download link for recording MP4/ARF file without HTML page rendering in browser or HTTP redirect. Expires 3 hours after the API request."
},
"audioDownloadLink": {
"type": "string",
"description": "The download link for recording audio file without HTML page rendering in browser or HTTP redirect. This attribute is not available if **Prevent Downloading** has been turned on for the recording being requested. Expires 3 hours after the API request."
},
"transcriptDownloadLink": {
"type": "string",
"description": "The download link for recording transcript file without HTML page rendering in browser or HTTP redirect. This attribute is not available if **Prevent Downloading** has been turned on for the recording being requested. Expires 3 hours after the API request."
},
"expiration": {
"type": "string",
"description": "The date and time when `recordingDownloadLink`, `audioDownloadLink`, and `transcriptDownloadLink` expire in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format."
}
},
"description": "The download links for MP4/ARF, audio, and transcript of the recording without HTML page rendering in browser or HTTP redirect. This attribute is not available if the user is not a [Compliance Officer](/docs/compliance#compliance) and **Prevent Downloading** has been turned on for the recording being requested. The Prevent Downloading option can be viewed and set on page when editing a recording. Note that there are various products in [Webex Suite](https://www.cisco.com/c/en/us/products/conferencing/product_comparison.html) such as \"Webex Meetings\", \"Webex Training\" and \"Webex Events\"."
},
"integrationTags": {
"type": "array",
"items": {
"type": "string"
},
"description": "External keys of the parent meeting created by an integration application. The key can be Zendesk ticket IDs, Jira IDs, Salesforce Opportunity IDs, etc. The integration application queries recordings by a key in its own domain."
},
"status": {
"type": "string",
"enum": [
"available",
"deleted",
"purged"
],
"description": " * `available` - Recording is available.\n * `deleted` - Recording has been moved to the recycle bin.\n * `purged` - Recording has been purged from the recycle bin. Please note that only a compliance officer can access recordings with a `purged` status.\n"
}
}
},
"DeleteRecordingObject": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"example": "audit",
"description": "Reason for deleting a recording. Only required when a Compliance Officer is operating on another user's recording."
},
"comment": {
"type": "string",
"example": "Maintain data privacy",
"description": "Compliance Officer's explanation for deleting a recording. The comment can be a maximum of 255 characters long."
}
}
},
"BulkSoftDeleteRecordingObject": {
"type": "object",
"required": [
"recordingIds"
],
"properties": {
"recordingIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Recording IDs for removing recordings into the recycle bin in batch. Please note that all the recording IDs should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified."
},
"siteUrl": {
"type": "string",
"example": "example.webex.com",
"description": "URL of the Webex site from which the API deletes recordings. If not specified, the API deletes recordings from the user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by the [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
}
}
},
"BulkRestoreRecordingObject": {
"type": "object",
"properties": {
"restoreAll": {
"type": "boolean",
"description": "If not specified or `false`, restores the recordings specified by `recordingIds`. If `true`, restores all recordings from the recycle bin."
},
"recordingIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Recording IDs for recovering recordings from the recycle bin in batch. Note that all the recording IDs should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified."
},
"siteUrl": {
"type": "string",
"example": "example.webex.com",
"description": "URL of the Webex site from which the API restores recordings. If not specified, the API restores recordings from a user's preferred site. All available Webex sites and preferred sites of a user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
}
}
},
"BulkPurgeRecordingObject": {
"type": "object",
"properties": {
"purgeAll": {
"type": "boolean",
"description": "If not specified or `false`, purges the recordings specified by `recordingIds`. If `true`, purges all recordings from the recycle bin."
},
"recordingIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Recording IDs for purging recordings from the recycle bin in batch. Note that all the recording IDs should belong to the site of `siteUrl` or the user's preferred site if `siteUrl` is not specified."
},
"siteUrl": {
"type": "string",
"example": "example.webex.com",
"description": "URL of the Webex site from which the API purges recordings. If not specified, the API purges recordings from user's preferred site. All available Webex sites and preferred sites of the user can be retrieved by [Get Site List](/docs/api/v1/meeting-preferences/get-site-list) API."
}
}
},
"ShareRecordingByIdObject": {
"type": "object",
"properties": {
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin-level scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host. The field is not editable and is only used to share or unshare a recording on behalf of the real meeting host."
},
"addEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Email addresses of users to share the recording with. The maximum size of the array is `100`."
},
"removeEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Email addresses of users to unshare the recording with. The maximum size of the array is `100`."
},
"sendEmail": {
"type": "boolean",
"description": "Whether to send email notifications to the users being shared. The default is `true`."
}
}
},
"ShareRecordingByLinkObject": {
"type": "object",
"properties": {
"hostEmail": {
"type": "string",
"example": "john.andersen@example.com",
"description": "Email address for the meeting host. This attribute should only be set if the user or application calling the API has the admin-level scopes. When used, the admin may specify the email of a user in a site they manage to be the meeting host. The field is not editable and is only used to share or unshare a recording link on behalf of the real meeting host."
},
"webShareLink": {
"type": "string",
"example": "https://example.webex.com/recordingservice/sites/example/recording/playback/1234567890abcdef1234567890abcdef",
"description": "The link for the recording to be shared or unshared."
},
"addEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Email addresses of users to share the recording link with. The maximum size of the array is `100`."
},
"removeEmails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Email addresses of users to unshare the recording link with. The maximum size of the array is `100`."
},
"sendEmail": {
"type": "boolean",
"description": "Whether to send email notifications to the users being shared. The default is `true`."
}
}
},
"Webhook": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1dFQkhPT0svOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"description": "A unique identifier for the webhook."
},
"name": {
"type": "string",
"example": "My Awesome Webhook",
"description": "A user-friendly name for the webhook."
},
"targetUrl": {
"type": "string",
"example": "https://example.com/mywebhook",
"description": "URL that receives POST requests for each event."
},
"resource": {
"type": "string",
"enum": [
"attachmentActions",
"dataSources",
"memberships",
"messages",
"rooms",
"meetings",
"recordings",
"convergedRecordings",
"meetingParticipants",
"meetingTranscripts",
"telephony_calls",
"telephony_conference",
"telephony_mwi",
"uc_counters",
"serviceApp",
"adminBatchJobs"
],
"description": "Resource type for the webhook. Creating a webhook requires 'read' scope on the resource the webhook is for.\n * `attachmentActions` - [Attachment Actions](/docs/api/v1/attachment-actions) resource.\n * `dataSources` - [data sources](/docs/api/v1/data-sources) resource.\n * `memberships` - [Memberships](/docs/api/v1/memberships) resource.\n * `messages` - [Messages](/docs/api/v1/messages) resource.\n * `rooms` - [Rooms](/docs/api/v1/rooms) resource.\n * `meetings` - [Meetings](/docs/api/v1/meetings) resource.\n * `recordings` - [Recordings](/docs/api/v1/recordings) resource.\n * `convergedRecordings` - [CallRecordings](/docs/api/v1/converged-recordings) resource.\n * `meetingParticipants` - [Meeting Participants](/docs/api/v1/meeting-participants) resource.\n * `meetingTranscripts` - [Meeting Transcripts](/docs/api/v1/meeting-transcripts) resource.\n * `telephony_calls` - [Webex Calling](/docs/webex-calling-overview) call resources.\n * `telephony_conference` - [Webex Calling](/docs/webex-calling-overview) conference controls resource.\n * `telephony_mwi` - [Webex Calling](/docs/webex-calling-overview) voicemail message waiting indicator resource.\n * `uc_counters` - Performance counter for a dedicated instance.\n * `serviceApp` - Service App authorization notification.\n * `adminBatchJobs` - Admin Batch Jobs notification.\n"
},
"event": {
"type": "string",
"enum": [
"created",
"updated",
"deleted",
"started",
"ended",
"joined",
"left",
"migrated",
"authorized",
"deauthorized",
"statusChanged"
],
"description": "Event type for the webhook.\n * `created` - An object was created.\n * `updated` - An object was updated.\n * `deleted` - An object was deleted.\n * `started` - A meeting was started.\n * `ended` - A meeting was ended.\n * `joined` - A participant joined.\n * `left` - A participant left.\n * `migrated` - A room was migrated to a different geography. The roomId has changed.\n * `authorized` - A Service App was authorized.\n * `deauthorized` - A Service App was deauthorized.\n * `statusChanged` - Status of admin batch job was changed.\n"
},
"filter": {
"type": "string",
"example": "roomId=Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
"description": "Filter that defines the webhook scope."
},
"secret": {
"type": "string",
"example": "86dacc007724d8ea666f88fc77d918dad9537a15",
"description": "Secret used to generate payload signature."
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
],
"description": "Status of the webhook. Use `active` to reactivate a disabled webhook.\n * `active` - Webhook is active.\n * `inactive` - Webhook is inactive.\n"
},
"created": {
"type": "string",
"example": "2015-10-18T14:26:16+00:00",
"description": "Date and time the webhook was created."
},
"ownedBy": {
"type": "string",
"example": "org",
"description": "Specify `org` when creating an org/admin level webhook. Supported for `meetings`, `recordings`, `convergedRecordings`, `meetingParticipants`, `meetingTranscripts`, `videoMeshAlerts`, `controlHubAlerts`, `rooms`, `messaging` and `adminBatchJobs` (for Compliance Officers and messages with file attachments only - see [inline file DLP](/docs/api/guides/webex-real-time-file-dlp-basics)) resources."
}
}
},
"WebhookCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Webhook"
}
}
}
},
"WorkspaceLocationsCreationRequest": {
"type": "object",
"required": [
"displayName",
"address",
"countryCode",
"latitude",
"longitude"
],
"properties": {
"displayName": {
"type": "string",
"example": "Cisco Barcelona",
"description": "A friendly name for the location."
},
"address": {
"type": "string",
"example": "Carrer de Pere IV, Barcelona, Spain",
"description": "The location address."
},
"countryCode": {
"type": "string",
"example": "ES",
"description": "The location country code (ISO 3166-1)."
},
"cityName": {
"type": "string",
"example": "Barcelona",
"description": "The location city name."
},
"latitude": {
"type": "number",
"example": 41.406615,
"description": "The location latitude."
},
"longitude": {
"type": "number",
"example": 2.200717,
"description": "The location longitude."
},
"notes": {
"type": "string",
"example": "A note about the location",
"description": "Notes associated with the location."
}
}
},
"WorkspaceLocationsUpdateRequest": {
"type": "object",
"required": [
"displayName",
"address",
"countryCode",
"latitude",
"longitude"
],
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"description": "Unique identifier for the location."
},
"displayName": {
"type": "string",
"example": "Cisco Barcelona",
"description": "A friendly name for the location."
},
"address": {
"type": "string",
"example": "Carrer de Pere IV, Barcelona, Spain",
"description": "The location address."
},
"countryCode": {
"type": "string",
"example": "ES",
"description": "The location country code (ISO 3166-1)."
},
"cityName": {
"type": "string",
"example": "Barcelona",
"description": "The location city name."
},
"latitude": {
"type": "number",
"example": 41.406615,
"description": "The location latitude."
},
"longitude": {
"type": "number",
"example": 2.200717,
"description": "The location longitude."
},
"notes": {
"type": "string",
"example": "A note about the location",
"description": "Notes associated with the location."
}
}
},
"WorkspaceLocationsCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Location"
},
"description": "An array of location objects."
}
}
},
"WorkspaceLocationFloorsCreationRequest": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"floorNumber": {
"type": "number",
"example": -1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "The basement",
"description": "The floor display name."
}
}
},
"WorkspaceLocationFloorsUpdateRequest": {
"type": "object",
"required": [
"floorNumber"
],
"properties": {
"floorNumber": {
"type": "number",
"example": 1,
"description": "The floor number."
},
"displayName": {
"type": "string",
"example": "My custom name",
"description": "The floor display name."
}
}
},
"WorkspaceLocationFloorsCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Floor"
},
"description": "An array of floor objects."
}
}
},
"WorkspaceMetricsResponse": {
"type": "object",
"required": [
"workspaceId",
"metricName"
],
"properties": {
"workspaceId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE"
},
"metricName": {
"type": "string",
"enum": [
"soundLevel",
"ambientNoise",
"temperature",
"humidity",
"tvoc",
"peopleCount"
]
},
"aggregation": {
"type": "string",
"enum": [
"none",
"hourly",
"daily"
]
},
"from": {
"type": "string",
"example": "2020-10-21T13:33:37.789Z"
},
"to": {
"type": "string",
"example": "2020-10-31T16:00:00.532Z"
},
"unit": {
"type": "string",
"enum": [
"celsius",
"fahrenheit"
],
"description": "Output data unit (only present if `metricName` is `temperature`)."
},
"sortBy": {
"type": "string",
"enum": [
"newestFirst",
"oldestFirst"
]
},
"items": {
"type": "array",
"items": {},
"description": "The structure of the elements will depend on whether or not aggregated data was requested"
}
}
},
"DurationMetric": {
"type": "object",
"properties": {
"start": {
"type": "string",
"example": "2021-10-21T12:00:00Z",
"description": "Timestamp indicating the start of the aggregation bucket (ISO 8601)."
},
"end": {
"type": "string",
"example": "2021-10-21T13:00:00Z",
"description": "Timestamp indicating the end of the aggregation bucket (ISO 8601)."
},
"duration": {
"type": "number",
"example": 13,
"description": "The time duration (in a given state) in the bucket."
}
}
},
"WorkspaceDurationMetricsResponse": {
"type": "object",
"required": [
"workspaceId"
],
"properties": {
"workspaceId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE"
},
"aggregation": {
"type": "string",
"enum": [
"hourly",
"daily"
]
},
"measurement": {
"type": "string",
"enum": [
"timeUsed",
"timeBooked"
]
},
"from": {
"type": "string",
"example": "2020-10-21T13:33:37.789Z"
},
"to": {
"type": "string",
"example": "2020-10-31T16:00:00.532Z"
},
"unit": {
"type": "string",
"example": "minutes",
"description": "The time unit."
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DurationMetric"
}
}
}
},
"WorkspaceIssue": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Issue id."
},
"createdAt": {
"type": "string",
"description": "Issue created timestamp."
},
"title": {
"type": "string",
"description": "Issue title."
},
"description": {
"type": "string",
"description": "Issue description."
},
"recommendedAction": {
"type": "string",
"description": "Recommended action to mitigate issue."
},
"level": {
"type": "object",
"properties": {
"Members": {
"type": "string",
"enum": [
"error",
"warning",
"info"
]
}
},
"description": "Issue level."
}
}
},
"Workspace": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
"description": "Unique identifier for the Workspace."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"description": "`OrgId` associated with the workspace."
},
"locationId": {
"type": "string",
"example": "Y2lzY29...",
"description": "Location associated with the workspace (ID to use for the [/locations API](/docs/api/v1/locations))."
},
"workspaceLocationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Legacy workspace location ID associated with the workspace. Prefer `locationId`."
},
"floorId": {
"type": "string",
"example": "Y2lzY29z...",
"description": "Floor associated with the workspace."
},
"displayName": {
"type": "string",
"example": "SFO-12 Capanina",
"description": "A friendly name for the workspace."
},
"capacity": {
"type": "number",
"example": 5,
"description": "How many people the workspace is suitable for."
},
"type": {
"type": "string",
"enum": [
"notSet",
"focus",
"huddle",
"meetingRoom",
"open",
"desk",
"other"
],
"description": "The workspace type.\n * `notSet` - No workspace type set.\n * `focus` - High concentration.\n * `huddle` - Brainstorm/collaboration.\n * `meetingRoom` - Dedicated meeting space.\n * `open` - Unstructured agile.\n * `desk` - Individual.\n * `other` - Unspecified.\n"
},
"sipAddress": {
"type": "string",
"example": "test_workspace_1@trialorg.room.ciscospark.com",
"description": "`SipUrl` to call all the devices associated with the workspace."
},
"created": {
"type": "string",
"example": "2016-04-21T17:00:00.000Z",
"description": "The date and time that the workspace was registered, in ISO8601 format."
},
"calling": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"freeCalling",
"hybridCalling",
"webexCalling",
"webexEdgeForDevices",
"thirdPartySipCalling",
"none"
],
"description": "Calling.\n * `freeCalling` - Free Calling.\n * `hybridCalling` - Hybrid Calling.\n * `webexCalling` - Webex Calling.\n * `webexEdgeForDevices` - Webex Edge For Devices.\n * `thirdPartySipCalling` - Third-party SIP URI.\n * `none` - No Calling.\n"
},
"hybridCalling": {
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"example": "workspace@example.com",
"description": "End user email address in Cisco Unified CM."
}
},
"description": "The `hybridCalling` object only applies when calling type is `hybridCalling`."
},
"webexCalling": {
"type": "object",
"properties": {
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29g4..."
},
"description": "The Webex Calling license associated with this workspace."
}
},
"description": "The `webexCalling` object only applies when calling type is `webexCalling`."
}
},
"description": "Calling type."
},
"calendar": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"none",
"google",
"microsoft"
],
"description": " * `none` - No calendar.\n * `google` - Google Calendar.\n * `microsoft` - Microsoft Exchange or Office 365.\n"
},
"emailAddress": {
"type": "string",
"example": "workspace@example.com",
"description": "Workspace email address. Will not be set when the calendar type is `none`."
}
},
"description": "Calendar type. Calendar of type `none` does not include an `emailAddress` field."
},
"notes": {
"type": "string",
"example": "this is a note",
"description": "Notes associated to the workspace."
},
"hotdeskingStatus": {
"type": "string",
"enum": [
"on",
"off"
],
"description": "Hot desking status of the workspace.\n * `on` - Workspace supports hotdesking.\n * `off` - Workspace does not support hotdesking.\n"
},
"supportedDevices": {
"type": "string",
"enum": [
"collaborationDevices",
"phones"
],
"description": "The supported devices for the workspace. Default is `collaborationDevices`.\n * `collaborationDevices` - Workspace supports collaboration devices.\n * `phones` - Workspace supports MPP phones.\n"
},
"deviceHostedMeetings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "`true` if enabled or `false` otherwise."
},
"siteUrl": {
"type": "string",
"example": "'example.webex.com'",
"description": "The Webex site for the device hosting meetings."
}
},
"description": "Device hosted meetings configuration."
},
"devicePlatform": {
"type": "string",
"enum": [
"cisco",
"microsoftTeamsRoom"
],
"description": "The device platform.\n * `cisco` - Cisco.\n * `microsoftTeamsRoom` - Microsoft Teams Room.\n"
},
"indoorNavigation": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL of a map locating the workspace."
}
},
"description": "Indoor navigation configuration."
},
"health": {
"type": "object",
"properties": {
"level": {
"type": "string",
"enum": [
"error",
"warning",
"info",
"ok"
],
"description": "Health level. The level is based on the list of issues associated with the workspace."
},
"issues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkspaceIssue"
},
"description": "A list of workspace issues."
}
},
"description": "The health of the workspace."
},
"devices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Device"
},
"description": "A list of devices associated with the workspace."
},
"capabilities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CapabilityMap"
},
"description": "The map of workspace capabilities."
},
"plannedMaintenance": {
"type": "object",
"description": "The planned maintenance for the workspace.",
"properties": {
"mode": {
"type": "string",
"enum": [
"off",
"on",
"upcoming"
],
"description": "The planned maintenance mode for the workspace"
},
"startTime": {
"type": "string",
"example": "2026-10-01T00:00:00.000Z",
"description": "The start of the planned maintenance period."
},
"endTime": {
"type": "string",
"example": "2026-10-02T00:00:00.000Z",
"description": "The end of the planned maintenance period."
}
}
}
},
"example": {
"id": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"locationId": "YL34GrT...",
"workspaceLocationId": "YL34GrT...",
"floorId": "Y2lzY29z...",
"displayName": "SFO-12 Capanina",
"capacity": 5,
"sipAddress": ""
}
},
"WorkspaceCreationRequest": {
"type": "object",
"required": [
"displayName"
],
"properties": {
"displayName": {
"type": "string",
"example": "SFO-12 Capanina",
"description": "A friendly name for the workspace."
},
"orgId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"description": "`OrgId` associated with the workspace. Only admin users of another organization (such as partners) may use this parameter."
},
"locationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Location associated with the workspace. Must be provided when the `floorId` is set."
},
"workspaceLocationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Legacy workspace location ID associated with the workspace. Prefer `locationId`."
},
"floorId": {
"type": "string",
"example": "Y2lzY29z...",
"description": "Floor associated with the workspace."
},
"capacity": {
"type": "number",
"example": 5,
"description": "How many people the workspace is suitable for. If set, must be 0 or higher."
},
"type": {
"type": "string",
"enum": [
"notSet",
"focus",
"huddle",
"meetingRoom",
"open",
"desk",
"other"
],
"description": "The type that best describes the workspace.\n * `notSet` - No workspace type set.\n * `focus` - High concentration.\n * `huddle` - Brainstorm/collaboration.\n * `meetingRoom` - Dedicated meeting space.\n * `open` - Unstructured agile.\n * `desk` - Individual.\n * `other` - Unspecified.\n"
},
"sipAddress": {
"type": "string",
"description": "The `sipAddress` field can only be provided when calling type is `thirdPartySipCalling`."
},
"calling": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"freeCalling",
"hybridCalling",
"webexCalling",
"webexEdgeForDevices",
"thirdPartySipCalling",
"none"
],
"description": "The calling type that is supported on the workspace.\n * `freeCalling` - Free Calling (Default).\n * `hybridCalling` - Hybrid Calling.\n * `webexCalling` - Webex Calling.\n * `webexEdgeForDevices` - Webex Edge For Devices.\n * `thirdPartySipCalling` - Third-party SIP URI.\n * `none` - No Calling.\n"
},
"webexCalling": {
"type": "object",
"properties": {
"phoneNumber": {
"type": "string",
"example": "+12145654032",
"description": "End user phone number."
},
"extension": {
"type": "string",
"example": "28278",
"description": "End user extension."
},
"locationId": {
"type": "string",
"example": "Y2lzY29g4...",
"description": "Calling location ID."
},
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29g4...1,Y2lzY29g4...2,Y2lzY29g4...n"
},
"description": "A list of Webex Calling License IDs. If multiple license IDs are provided, the oldest suitable one will be applied."
}
},
"description": "The `webexCalling` object only applies when calling type is `webexCalling`."
}
},
"description": "Calling."
},
"calendar": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "microsoft"
},
"emailAddress": {
"type": "string",
"example": "workspace@example.com",
"description": "Workspace email address. Will not be set when the calendar type is `none`."
},
"resourceGroupId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOk5vcndheS9SRVNPVVJDRV9HUk9VUC9jOGFiMDJhNC01NjI5LTRiNTctOGUyNy03ZDZkZjJlN2YzNzA=",
"description": "The `ResourceGroup` ID is associated with the workspace and is only applicable for on-premise MICROSOFT calendar."
}
},
"description": "Workspace calendar configuration requires a `type` (`microsoft`, `google`, or `none`), an `emailAddress`, and a `resourceGroupId`. The default is `none`."
},
"notes": {
"type": "string",
"example": "this is a note",
"description": "Notes associated to the workspace."
},
"hotdeskingStatus": {
"type": "string",
"enum": [
"on",
"off"
],
"description": "Hot desking status of the workspace.\n * `on` - Workspace supports hotdesking.\n * `off` - Workspace does not support hotdesking.\n"
},
"deviceHostedMeetings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Set to `true` to enable or `false` to disable."
},
"siteUrl": {
"type": "string",
"example": "'example.webex.com'",
"description": "The Webex site for device hosting meetings."
}
},
"description": "To enable device hosted meetings, set a Webex `siteUrl` and the `enabled` flag to `true`."
},
"supportedDevices": {
"type": "string",
"enum": [
"collaborationDevices",
"phones"
],
"description": "The supported devices for the workspace. Default is `collaborationDevices`.\n * `collaborationDevices` - Workspace supports collaboration devices.\n * `phones` - Workspace supports MPP phones.\n"
},
"indoorNavigation": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL of a map locating the workspace."
}
},
"description": "Indoor navigation configuration."
}
}
},
"WorkspaceUpdateRequest": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"example": "SFO-12 Capanina",
"description": "A friendly name for the workspace."
},
"locationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Location associated with the workspace. Must be provided when the `floorId` is set."
},
"workspaceLocationId": {
"type": "string",
"example": "YL34GrT...",
"description": "Legacy workspace location ID associated with the workspace. Prefer `locationId`."
},
"floorId": {
"type": "string",
"example": "Y2lzY29z...",
"description": "Floor associated with the workspace."
},
"capacity": {
"type": "number",
"example": 5,
"description": "How many people the workspace is suitable for. If set, must be 0 or higher."
},
"type": {
"type": "string",
"enum": [
"notSet",
"focus",
"huddle",
"meetingRoom",
"open",
"desk",
"other"
],
"description": "The type that best describes the workspace.\n * `notSet` - No workspace type set.\n * `focus` - High concentration.\n * `huddle` - Brainstorm/collaboration.\n * `meetingRoom` - Dedicated meeting space.\n * `open` - Unstructured agile.\n * `desk` - Individual.\n * `other` - Unspecified.\n"
},
"calendar": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "microsoft"
},
"emailAddress": {
"type": "string",
"example": "workspace@example.com",
"description": "Workspace email address. Will not be set when the calendar type is `none`."
},
"resourceGroupId": {
"type": "string",
"example": "Y2lzY29zcGFyazovL3VybjpURUFNOk5vcndheS9SRVNPVVJDRV9HUk9VUC9jOGFiMDJhNC01NjI5LTRiNTctOGUyNy03ZDZkZjJlN2YzNzA=",
"description": "The `ResourceGroup` ID is associated with the workspace and is only applicable for on-premise MICROSOFT calendar."
}
},
"description": "An empty or null `calendar` field will not cause any changes. Provide a `type` (`microsoft`, `google`, or `none`), an `emailAddress`, and a `resourceGroupId`. To remove a calendar, set the `type` to `none`; this does not require an `emailAddress` or `resourceGroupId`."
},
"sipAddress": {
"type": "string",
"description": "The `sipAddress` field can only be provided when calling type is `thirdPartySipCalling`."
},
"calling": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"freeCalling",
"hybridCalling",
"webexCalling",
"webexEdgeForDevices",
"thirdPartySipCalling",
"none"
],
"description": "The calling type that is supported on the workspace.\n * `freeCalling` - Free Calling (Default).\n * `hybridCalling` - Hybrid Calling.\n * `webexCalling` - Webex Calling.\n * `webexEdgeForDevices` - Webex Edge For Devices.\n * `thirdPartySipCalling` - Third-party SIP URI.\n * `none` - No Calling.\n"
},
"webexCalling": {
"type": "object",
"properties": {
"phoneNumber": {
"type": "string",
"example": "+12145654032",
"description": "End user phone number."
},
"extension": {
"type": "string",
"example": "28278",
"description": "End user extension."
},
"locationId": {
"type": "string",
"example": "Y2lzY29g4...",
"description": "Calling location ID."
},
"licenses": {
"type": "array",
"items": {
"type": "string",
"example": "Y2lzY29g4...1,Y2lzY29g4...2,Y2lzY29g4...n"
},
"description": "A list of Webex Calling license IDs. If multiple license IDs are provided, the oldest suitable one will be applied."
}
},
"description": "The `webexCalling` object only applies when calling type is `webexCalling`."
}
},
"description": "Calling types supported on update are `freeCalling`, `thirdPartySipCalling`, `webexCalling` and `none`."
},
"notes": {
"type": "string",
"example": "this is a note",
"description": "Notes associated to the workspace."
},
"hotdeskingStatus": {
"type": "string",
"enum": [
"on",
"off"
],
"description": "Hot desking status of the workspace.\n * `on` - Workspace supports hotdesking.\n * `off` - Workspace does not support hotdesking.\n"
},
"deviceHostedMeetings": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"example": true,
"description": "Set to `true` to enable or `false` to disable."
},
"siteUrl": {
"type": "string",
"example": "'example.webex.com'",
"description": "The Webex site for device hosting meetings."
}
},
"description": "To enable device hosted meetings, set a Webex `siteUrl` and the `enabled` flag to `true`."
},
"indoorNavigation": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL of a map locating the workspace. Passing `null` will remove the configuration."
}
},
"description": "Indoor navigation configuration."
}
}
},
"WorkspaceCollectionResponse": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Workspace"
},
"description": "An array of workspace objects."
}
},
"example": {
"items": []
}
},
"CapabilityResponse": {
"type": "object",
"example": {
"capabilities": {
"occupancyDetection": {
"supported": true,
"configured": true
},
"presenceDetection": {
"supported": true,
"configured": true
},
"ambientNoise": {
"supported": true,
"configured": true
},
"soundLevel": {
"supported": true,
"configured": true
},
"temperature": {
"supported": true,
"configured": true
},
"airQuality": {
"supported": true,
"configured": true
},
"relativeHumidity": {
"supported": true,
"configured": true
}
}
},
"properties": {
"capabilities": {
"$ref": "#/components/schemas/CapabilityMap"
}
}
},
"CapabilityMap": {
"type": "object",
"description": "The map of workspace capabilities.",
"example": {
"occupancyDetection": {
"supported": true,
"configured": true
},
"presenceDetection": {
"supported": true,
"configured": true
},
"ambientNoise": {
"supported": true,
"configured": true
},
"soundLevel": {
"supported": true,
"configured": true
},
"temperature": {
"supported": true,
"configured": true
},
"airQuality": {
"supported": true,
"configured": true
},
"relativeHumidity": {
"supported": true,
"configured": true
}
},
"properties": {
"occupancyDetection": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"presenceDetection": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"ambientNoise": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"soundLevel": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"temperature": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"airQuality": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
},
"relativeHumidity": {
"$ref": "#/components/schemas/SupportAndConfiguredInfo"
}
}
},
"SupportAndConfiguredInfo": {
"type": "object",
"properties": {
"supported": {
"type": "boolean",
"example": true,
"description": "Is the workspace capability supported or not."
},
"configured": {
"type": "boolean",
"example": true,
"description": "Is the workspace capability configured or not."
}
},
"description": "Support and configured information for a workspace capability.",
"example": {
"supported": true,
"configured": true
}
},
"SearchType": {
"type": "string",
"description": "The type of search to be performed.",
"enum": [
"ORGANIZATION",
"INTERACTION",
"AGENT"
]
},
"SummaryListRequest": {
"description": "List summaries based on the given search type.",
"oneOf": [
{
"$ref": "#/components/schemas/SummaryListByOrganizationRequest"
},
{
"$ref": "#/components/schemas/SummaryListByInteractionRequest"
},
{
"$ref": "#/components/schemas/SummaryListByAgentRequest"
}
]
},
"SummaryListByOrganizationRequest": {
"type": "object",
"required": [
"orgId",
"searchType"
],
"properties": {
"orgId": {
"type": "string",
"description": "The unique identifier of the organization to which the summarized interactions belong."
},
"searchType": {
"type": "string",
"enum": [
"ORGANIZATION"
],
"description": "The type of search to be performed."
}
}
},
"SummaryListByInteractionRequest": {
"type": "object",
"required": [
"orgId",
"interactionId",
"searchType"
],
"properties": {
"orgId": {
"type": "string",
"description": "The unique identifier of the organization to which the summarized interactions belong."
},
"interactionId": {
"type": "string",
"description": "The unique identifier of a specific interaction."
},
"searchType": {
"type": "string",
"enum": [
"INTERACTION"
],
"description": "The type of search to be performed."
}
}
},
"SummaryListByAgentRequest": {
"type": "object",
"required": [
"orgId",
"agentCiUserId",
"searchType"
],
"properties": {
"orgId": {
"type": "string",
"description": "The unique identifier of the organization to which the summarized interactions belong."
},
"agentCiUserId": {
"type": "string",
"description": "The CI (Common Identity) user ID of the agent associated with the summaries."
},
"searchType": {
"type": "string",
"enum": [
"AGENT"
],
"description": "The type of search to be performed."
}
}
},
"PostCallSummary": {
"type": "object",
"properties": {
"initialContactReason": {
"type": "string",
"description": "The primary issue or request the customer contacted you about at the start of the interaction."
},
"additionalContext": {
"type": "string",
"description": "Relevant background details shared during the conversation that help explain the situation."
},
"additionalContactReasons": {
"type": "string",
"description": "Any new or secondary issues raised after the initial reason for contact."
},
"keyActionsTaken": {
"type": "string",
"description": "The main steps the agent took to investigate, resolve, or address the customer's request."
},
"nextSteps": {
"type": "string",
"description": "Clear follow-up actions and expected outcomes agreed upon before ending the interaction."
},
"chosenWrapUpCode": {
"type": "string",
"description": "The wrap-up reason code that was ultimately selected by the agent at the end of the interaction."
},
"proposedWrapUpCodes": {
"type": "array",
"nullable": true,
"description": "A list of wrap-up reasons suggested by the AI based on the interaction content. Each object contains a name field. Can return null, 1, or 2 objects.",
"items": {
"$ref": "#/components/schemas/ProposedWrapUpCode"
}
}
}
},
"MidCallSummary": {
"type": "object",
"properties": {
"reasonForTransferOrConsult": {
"type": "string",
"description": "The specific reason the interaction is being transferred or consulted."
},
"additionalContext": {
"type": "string",
"description": "Important information already gathered that the next agent needs to continue smoothly."
},
"keyActionsTaken": {
"type": "string",
"description": "Steps completed so far in the interaction before the transfer or consult occurred."
}
}
},
"ProposedWrapUpCode": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the proposed wrap-up reason."
}
}
},
"SummaryListResponse": {
"type": "object",
"properties": {
"orgId": {
"type": "string",
"description": "The unique identifier of the organization to which the summarized interactions belong."
},
"agentCiUserId": {
"type": "string",
"description": "The CI (Common Identity) user ID of the agent associated with the summaries. Present when searchType is AGENT; otherwise null.",
"nullable": true
},
"interactionId": {
"type": "string",
"description": "The unique identifier of a specific interaction. Present when searchType is INTERACTION; otherwise null.",
"nullable": true
},
"queueId": {
"type": "string",
"description": "The queue ID (reserved for future use).",
"nullable": true
},
"searchType": {
"$ref": "#/components/schemas/SearchType"
},
"summaries": {
"type": "object",
"description": "Map of summaries keyed by feature type (POST_CALL, MID_CALL). Each feature maps summary identifiers to their summary fields.",
"properties": {
"POST_CALL": {
"type": "object",
"description": "Post-call summaries keyed by summary identifier.",
"additionalProperties": {
"$ref": "#/components/schemas/PostCallSummary"
}
},
"MID_CALL": {
"type": "object",
"description": "Mid-call summaries keyed by summary identifier.",
"additionalProperties": {
"$ref": "#/components/schemas/MidCallSummary"
}
}
}
}
},
"example": {
"interactionId": null,
"orgId": "acc80d18-b1fb-4261-b44e-a46435eea1da",
"searchType": "ORGANIZATION",
"agentCiUserId": null,
"summaries": {
"POST_CALL": {
"acc80d18-b1fb-4261-b44e-a46435eea1da:1bf3bd99-633b-401a-a3d4-61157a446809:c47d7c08-0776-4e38-a6bb-751d933a0c5d": {
"initialContactReason": "Broken tools appointment request",
"additionalContext": "Customer mentioned they had previously tried to fix the tools themselves but were unsuccessful.",
"additionalContactReasons": "Customer also asked about warranty coverage for the broken tools.",
"keyActionsTaken": "Scheduled an appointment with Doctor Petrophe for the caller",
"nextSteps": "Confirm appointment details via email and follow up on warranty inquiry.",
"chosenWrapUpCode": "Appointment Scheduled",
"proposedWrapUpCodes": [
{
"name": "Appointment Scheduled"
},
{
"name": "Service Request"
}
]
}
},
"MID_CALL": {
"acc80d18-b1fb-4261-b44e-a46435eea1da:9d2a7879-8957-4cd6-a39c-46d4f21eaea5:c47d7c08-0776-4e38-a6bb-751d933a0c5d": {
"reasonForTransferOrConsult": "The caller wants to purchase fifteen tickets for an upcoming match but the current agent needs to check with teammates for ticket availability, requiring a transfer to another agent who can assist with ticket sales.",
"additionalContext": "The match will take place next weekend at 6 PM, and the caller is part of a group looking to buy a large number of tickets.",
"keyActionsTaken": "Checked the match schedule\\nInquired about the number of tickets needed\\nInitiated a transfer to check ticket availability with teammates"
}
}
},
"queueId": null
}
},
"SubscriptionRequest": {
"required": [
"destinationUrl",
"eventTypes",
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 64,
"minLength": 4,
"type": "string",
"description": "Client-defined string naming the subscription.",
"example": "My Integration's Subscription"
},
"description": {
"maxLength": 1024,
"minLength": 0,
"type": "string",
"description": "Client-defined string describing the subscription.",
"example": "The subscription my integration uses to synchronize with WxCC"
},
"eventTypes": {
"maxItems": 32,
"minItems": 1,
"type": "array",
"description": "Types of events to which the subscription will listen.",
"example": [
"agent:login",
"agent:logout"
],
"items": {
"type": "string"
}
},
"destinationUrl": {
"pattern": "^(https?)://.*$",
"type": "string",
"description": "URL to which webhooks will be posted. Must be HTTPS on an IANA-listed top-level domain name (e.g. .com) with a path (at least /). No query parameters, userinfo, non-443 ports, or fragments allowed. We do not treat this field as sensitive data, so do not use secrets in this URL such as tokens or API keys.",
"format": "uri",
"example": "https://www.cisco.com/"
},
"secret": {
"maxLength": 256,
"minLength": 32,
"type": "string",
"description": "Secret string used to sign payloads sent to the destination URL.",
"example": "my-32-plus-character-long-secret"
},
"orgId": {
"type": "string",
"description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permission to interact with the organization.",
"format": "uuid",
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
}
}
},
"SubscriptionResponse": {
"required": [
"createdBy",
"createdTime",
"destinationUrl",
"eventTypes",
"id",
"lastUpdatedBy",
"lastUpdatedTime",
"name",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Subscription ID.",
"format": "uuid",
"example": "41e92806-331d-4802-bc12-674f92d4a6f7"
},
"name": {
"maxLength": 64,
"minLength": 4,
"type": "string",
"description": "Client-defined string naming the subscription.",
"example": "My Integration's Subscription"
},
"description": {
"maxLength": 1024,
"type": "string",
"description": "Client-defined string describing the subscription.",
"example": "The subscription my integration uses to synchronize with WxCC"
},
"eventTypes": {
"maxItems": 32,
"minItems": 1,
"type": "array",
"description": "Types of events to which the subscription will listen.",
"example": [
"agent:login",
"agent:logout"
],
"items": {
"type": "string"
}
},
"destinationUrl": {
"type": "string",
"description": "URL to which webhooks will be posted. Must be HTTPS on an IANA-listed top-level domain name (e.g. .com) with a path (at least /). No query parameters, userinfo, non-443 ports, or fragments allowed. We do not treat this field as sensitive data, so do not use secrets in this URL such as tokens or API keys.",
"format": "uri",
"example": "https://www.cisco.com/"
},
"createdTime": {
"type": "integer",
"description": "Time when subscription was created (epoch milliseconds).",
"format": "int64",
"example": 1591702170000
},
"createdBy": {
"type": "string",
"description": "Email address of the user who created the subscription.",
"format": "email",
"example": "example@example.com"
},
"status": {
"type": "string",
"description": "Status of the subscription. Can be \"active\" or \"inactive\". The system may change the status to \"inactive\" in error scenarios.",
"example": "active",
"enum": [
"active",
"inactive"
]
},
"lastUpdatedTime": {
"type": "integer",
"description": "Time when the subscription was last updated (epoch milliseconds).",
"format": "int64",
"example": 1591702170000
},
"lastUpdatedBy": {
"type": "string",
"description": "Email address of the user who updated the subscription most recently.",
"format": "email",
"example": "example@example.com"
}
}
},
"ActionRequest": {
"type": "object",
"properties": {
"interactionId": {
"type": "string",
"description": "A unique identifier for each interaction or contact within the contact center.",
"example": "fb53f6d1-5535-4ac8-b081-53834e17d6f5"
},
"agentId": {
"type": "string",
"description": "The identifier for the agent whose burnout index has been calculated.",
"example": "fb53f6d1-5535-4ac8-b081-53834e17d6f5"
},
"clientId": {
"type": "string",
"description": "The name of the client initiating the action related to the agent burnout index. The name is limited to a maximum of 20 characters.",
"example": "Acme"
},
"actionType": {
"type": "string",
"description": "Specifies the type of action initiated based on the agent burnout index",
"example": "Break Played, Supervisor Notified, etc."
},
"actionDateType": {
"type": "object",
"description": "The Epoch timestamp indicating the precise time at which the action was executed.",
"example": 1617536244000
}
}
},
"ActionResponse": {
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "The data object contains the details of the action taken.",
"properties": {
"id": {
"type": "string",
"description": "A unique identifier for the action taken.",
"example": "fb53f6d1-5535-4ac8-b081-53834e17d6f5"
},
"interactionId": {
"type": "string",
"description": "A unique identifier for each interaction or contact within the contact center.",
"example": "fb53f6d1-5535-4ac8-b081-53834e17d6f5"
},
"orgId": {
"type": "string",
"description": "The organization ID to which the agent belongs.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"agentId": {
"type": "string",
"description": "The identifier for the agent whose burnout index has been calculated.",
"example": "fb53f6d1-5535-4ac8-b081-53834e17d6f5"
},
"clientId": {
"type": "string",
"description": "The name of the client initiating the action related to the agent burnout index. The name is limited to a maximum of 20 characters.",
"example": "Acme"
},
"actionType": {
"type": "string",
"description": "Specifies the type of action initiated based on the agent burnout index",
"example": "Break Played, Supervisor Notified, etc."
},
"actionDateTime": {
"type": "integer",
"description": "The Epoch timestamp indicating the precise time at which the action was executed.",
"format": "int64",
"example": 1617536244000
},
"createdDateTime": {
"type": "integer",
"description": "The Epoch timestamp indicating the time when the action was created.",
"format": "int64",
"example": 1617536244000
}
}
},
"trackingId": {
"type": "string",
"description": "The unique tracking ID for this request.",
"example": "fb53f6d1-5535-4ac8-b081-53834e17d6f5"
}
}
},
"AgentBurnoutDTO": {
"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
},
"enabled": {
"type": "boolean",
"description": "Used to toggle the state of the agent burnout configuration from active to inactive and vice-versa. Mandatory for create/update operation.",
"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"
},
"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": [
"agentInclusionType",
"enabled"
]
},
"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"
}
}
},
"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."
}
}
},
"EntityInfo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id",
"example": "id."
},
"name": {
"type": "string",
"description": "name",
"example": "name."
},
"additionalAttributes": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "A map containing additional attributes of entity where both the key and value are Strings.",
"example": "{\"key1\":\"value1\",\"key2\":\"value2\"}"
},
"description": "A map containing additional attributes of entity where both the key and value are Strings.",
"example": {
"key1": "value1",
"key2": "value2"
}
},
"createdDate": {
"type": "string"
},
"lastModifiedDate": {
"type": "string"
},
"version": {
"type": "integer",
"format": "int32"
}
}
},
"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"
},
"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"
]
},
"BulkRequestDTOAutoCSATQuestionDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOAutoCSATQuestionDTO"
}
}
}
},
"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"
}
}
},
"BulkResponseDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkResponseItemDTO"
}
}
}
},
"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
}
},
"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
}
}
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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"
]
},
"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
}
}
},
"ResponseEnvelopeAutoCSATQuestionDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutoCSATQuestionDTO"
}
}
}
},
"AutoCSATDTO": {
"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
},
"enabled": {
"type": "boolean",
"description": "Used to toggle the state of the Auto CSAT resource configuration from active to inactive and vice-versa. Mandatory for create/update operation.",
"example": true
},
"agentInclusionType": {
"type": "string",
"description": "Provides information whether all or specific agents are selected for Auto CSAT.",
"enum": [
"ALL",
"SPECIFIC"
],
"example": "ALL"
},
"surveyDataSource": {
"type": "string",
"description": "Survey Data Source Type",
"enum": [
"EXPERIENCE_MANAGEMENT",
"GLOBAL_VARIABLE"
],
"example": "EXPERIENCE_MANAGEMENT"
},
"selectedGlobalVariableId": {
"type": "string",
"description": "Selected Global Variable ID",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"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": [
"agentInclusionType",
"enabled",
"selectedGlobalVariableId",
"surveyDataSource"
]
},
"ResponseEnvelopeAutoCSATDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutoCSATDTO"
}
}
}
},
"GeneratedSummariesDTO": {
"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
},
"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
},
"agentInclusionType": {
"type": "string",
"description": "Provides information whether all or specific agents are selected for generated summaries.",
"enum": [
"ALL",
"SPECIFIC"
],
"example": "ALL"
},
"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
}
}
},
"ResponseMetaEnvelopeGeneratedSummariesDTOMetaDataPagedInfo": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataPagedInfo",
"description": "Metadata about response."
},
"data": {
"type": "array",
"description": "List of items matching the entity type.",
"items": {
"$ref": "#/components/schemas/GeneratedSummariesDTO"
}
}
}
},
"MetaDataPagedInfo": {
"type": "object",
"description": "Pagination metadata for paged API responses",
"properties": {
"orgid": {
"type": "string",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
"page": {
"type": "integer",
"format": "int32",
"description": "Current page number.",
"example": 1
},
"pageSize": {
"type": "integer",
"format": "int32",
"description": "Page size for current data set.",
"example": 20
},
"totalPages": {
"type": "integer",
"format": "int32",
"description": "Number of pages.",
"example": 5
},
"totalRecords": {
"type": "integer",
"format": "int64",
"description": "Total number of items.",
"example": 100
},
"links": {
"type": "object",
"$ref": "#/components/schemas/PaginationLinks",
"additionalProperties": {
"type": "string",
"description": "Links additional property."
},
"description": "Pagination links for navigating between result pages."
}
}
},
"PaginationLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"description": "Link to the current page.",
"example": "/v1/callbacks/organization/${orgId}/scheduled-callback?page=1&pageSize=10"
},
"first": {
"type": "string",
"description": "Link to the first page.",
"example": "/v1/callbacks/organization/${orgId}/scheduled-callback?page=0&pageSize=10"
},
"last": {
"type": "string",
"description": "Link to the last page.",
"example": "/v1/callbacks/organization/${orgId}/scheduled-callback?page=4&pageSize=10"
},
"next": {
"type": "string",
"description": "Link to the next page.",
"example": "/v1/callbacks/organization/${orgId}/scheduled-callback?page=2&pageSize=10"
},
"prev": {
"type": "string",
"description": "Link to the previous page.",
"example": "/v1/callbacks/organization/${orgId}/scheduled-callback?page=0&pageSize=10"
}
},
"required": [
"self"
]
},
"BusinessHoursDTOList": {
"type": "object",
"description": "Business Hours schema.",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Enter a name for the agent profile.",
"example": "New Business Hour",
"maxLength": 80,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_-]+(\\s?[a-zA-Z0-9_-]+)*$"
},
"description": {
"type": "string",
"description": "(Optional) Enter a description of the profile.",
"example": "This business hour can be set for happy hours",
"maxLength": 255,
"minLength": 0
},
"timezone": {
"type": "string",
"description": "The time zone that you provision for your business hour.",
"example": "America/New_York",
"minLength": 1
},
"holidaysId": {
"type": "string",
"description": "Holidays Id."
},
"overridesId": {
"type": "string",
"description": "Overrides Id."
},
"workingHoursCount": {
"type": "integer",
"format": "int64",
"description": "Working Hours Count."
},
"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
}
}
},
"BusinessHoursDTO": {
"type": "object",
"description": "Business Hours schema.",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Enter a name for the agent profile.",
"example": "New Business Hour",
"maxLength": 80,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_-]+(\\s?[a-zA-Z0-9_-]+)*$"
},
"description": {
"type": "string",
"description": "(Optional) Enter a description of the profile.",
"example": "This business hour can be set for happy hours",
"maxLength": 255,
"minLength": 0
},
"timezone": {
"type": "string",
"description": "The time zone that you provision for your business hour.",
"example": "America/New_York",
"minLength": 1
},
"workingHours": {
"type": "array",
"description": "Working hours",
"example": [
{
"name": "Happy Hours",
"days": [
"MON",
"TUE",
"WED",
"THU",
"FRI"
],
"startTime": "17:00",
"endTime": "18:59"
},
{
"name": "Open Hours",
"days": [
"MON",
"TUE",
"WED",
"THU",
"FRI",
"SAT",
"SUN"
],
"startTime": "19:00",
"endTime": "23:59"
}
],
"items": {
"$ref": "#/components/schemas/WorkingHoursDTO",
"description": "Working Hour."
},
"minItems": 1,
"uniqueItems": true
},
"holidaysId": {
"type": "string",
"description": "Holidays Id."
},
"overridesId": {
"type": "string",
"description": "Overrides Id."
},
"workingHoursCount": {
"type": "integer",
"format": "int64",
"description": "Working Hours Count."
},
"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": [
"name",
"timezone",
"workingHours"
]
},
"WorkingHoursDTO": {
"type": "object",
"description": "Working hours",
"example": [
{
"name": "Happy Hours",
"days": [
"MON",
"TUE",
"WED",
"THU",
"FRI"
],
"startTime": "17:00",
"endTime": "18:59"
},
{
"name": "Open Hours",
"days": [
"MON",
"TUE",
"WED",
"THU",
"FRI",
"SAT",
"SUN"
],
"startTime": "19:00",
"endTime": "23:59"
}
],
"properties": {
"name": {
"type": "string",
"description": "Name.",
"maxLength": 80,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_-]+(\\s?[a-zA-Z0-9_-]+)*$"
},
"days": {
"type": "array",
"description": "List of Days.",
"items": {
"type": "string",
"description": "Day.",
"enum": [
"SUN",
"MON",
"TUE",
"WED",
"THU",
"FRI",
"SAT"
]
},
"minItems": 1
},
"startTime": {
"type": "string",
"description": "Start Time."
},
"endTime": {
"type": "string",
"description": "End Time."
}
},
"required": [
"days",
"name"
]
},
"BulkRequestDTOBusinessHoursDTO": {
"type": "object",
"description": "Bulk Request Business Hours schema.",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOBusinessHoursDTO",
"description": "Item."
}
}
}
},
"BulkRequestItemDTOBusinessHoursDTO": {
"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/BusinessHoursDTO",
"description": "Item."
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"EntityReferenceInfoDTO": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description about reference info.",
"example": "list of referenced entities"
},
"meta": {
"$ref": "#/components/schemas/MetaDataReferencesPagingInfo"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityInfo"
}
}
}
},
"MetaDataReferencesPagingInfo": {
"title": "MetaDataReferencesPagingInfo",
"type": "object",
"properties": {
"orgid": {
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
"type": "string",
"description": "Org ID",
"format": "uuid",
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
"page": {
"type": "integer",
"description": "Current page number",
"format": "int32",
"example": 1
},
"pageSize": {
"type": "integer",
"description": "Page size for current data set",
"format": "int32",
"example": 100
},
"totalPages": {
"type": "integer",
"description": "Number of pages",
"format": "int32",
"example": 1
},
"totalRecords": {
"type": "integer",
"description": "Total number of items",
"format": "int32",
"example": 1000
},
"links": {
"type": "object",
"description": "Map of pagination links with self, next, prev, last and first",
"example": {
"next": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=2&pageSize=10",
"last": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=3&pageSize=10",
"prev": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=0&pageSize=10",
"self": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=1&pageSize=10",
"first": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/cad-variable?page=0&pageSize=10"
}
},
"referencedEntities": {
"type": "array",
"description": "List of referenced entities",
"example": [
"agent-profile",
"entrypoint"
],
"items": {
"type": "string"
}
},
"currentEntity": {
"type": "string",
"description": "Name of current entity",
"example": "entity_name"
}
},
"description": "Metadata of response for references with paging information"
},
"ResponseEnvelopeBusinessHoursDTO": {
"type": "object",
"description": "Response Envelope Business Hours schema.",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"description": "Meta additional property."
},
"description": "Additional properties for Meta."
},
"data": {
"type": "array",
"description": "List of Data.",
"items": {
"$ref": "#/components/schemas/BusinessHoursDTO",
"description": "Data item."
}
}
}
},
"HolidayListDTOList": {
"type": "object",
"description": "Holiday List schema.",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Enter a name for the holiday list.",
"example": "Holiday List 2022",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9_-]+(\\s?[a-zA-Z0-9_-]+)*$"
},
"description": {
"type": "string",
"description": "(Optional) Enter a description of the holiday list.",
"example": "This is a holiday list for year 2022.",
"maxLength": 255,
"minLength": 0
},
"holidaysCount": {
"type": "integer",
"format": "int64",
"description": "Holidays Count."
},
"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
}
}
},
"HolidayListDTO": {
"type": "object",
"description": "Holiday List schema.",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Enter a name for the holiday list.",
"example": "Holiday List 2022",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9_-]+(\\s?[a-zA-Z0-9_-]+)*$"
},
"description": {
"type": "string",
"description": "(Optional) Enter a description of the holiday list.",
"example": "This is a holiday list for year 2022.",
"maxLength": 255,
"minLength": 0
},
"holidays": {
"type": "array",
"description": "Holiday list.",
"example": {
"name": "My Holiday List",
"description": "My Holiday List Desc",
"holidays": [
{
"name": "Holi",
"startDate": "2022-04-16",
"endDate": "2022-04-16",
"frequency": "Yearly",
"recurrence": {
"interval": 1,
"specificDayOfMonth": 16,
"specificMonth": "APR",
"endDate": "2030-12-24"
}
},
{
"name": "Good Friday",
"startDate": "2022-05-24",
"endDate": "2022-05-24",
"frequency": "Yearly",
"recurrence": {
"interval": 1,
"specificDayOfMonth": 24,
"specificMonth": "MAY",
"endDate": "2030-12-24"
}
}
],
"id": "93912f11-6017-404b-bf14-5331890b1797",
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"createdTime": 1628231177000,
"lastUpdatedTime": 1628231177000
},
"items": {
"$ref": "#/components/schemas/HolidaysDTO",
"description": "Holiday."
},
"minItems": 1
},
"holidaysCount": {
"type": "integer",
"format": "int64",
"description": "Holidays Count."
},
"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": [
"holidays",
"name"
]
},
"HolidaysDTO": {
"type": "object",
"description": "Holiday list.",
"example": {
"name": "My Holiday List",
"description": "My Holiday List Desc",
"holidays": [
{
"name": "Holi",
"startDate": "2022-04-16",
"endDate": "2022-04-16",
"frequency": "Yearly",
"recurrence": {
"interval": 1,
"specificDayOfMonth": 16,
"specificMonth": "APR",
"endDate": "2030-12-24"
}
},
{
"name": "Good Friday",
"startDate": "2022-05-24",
"endDate": "2022-05-24",
"frequency": "Yearly",
"recurrence": {
"interval": 1,
"specificDayOfMonth": 24,
"specificMonth": "MAY",
"endDate": "2030-12-24"
}
}
],
"id": "93912f11-6017-404b-bf14-5331890b1797",
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"createdTime": 1628231177000,
"lastUpdatedTime": 1628231177000
},
"properties": {
"name": {
"type": "string",
"description": "Name.",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9_-]+(\\s?[a-zA-Z0-9_-]+)*$"
},
"startDate": {
"type": "string",
"description": "Start Date."
},
"endDate": {
"type": "string",
"description": "End Date."
},
"startTime": {
"type": "string",
"description": "Start Time."
},
"endTime": {
"type": "string",
"description": "End Time."
},
"frequency": {
"type": "string",
"description": "Frequency.",
"enum": [
"DontRepeat",
"Daily",
"Weekly",
"Monthly",
"Yearly"
]
},
"recurrence": {
"$ref": "#/components/schemas/RecurrenceDTO",
"description": "Recurrence."
},
"overlapsWith": {
"type": "array",
"description": "(Optional) Used to list the overlapping holidays.",
"example": "holidays",
"items": {
"type": "string",
"description": "(Optional) Used to list the overlapping holidays.",
"example": "\"holidays\": [\n{\n\"name\": \"Hol1\",\n\"startDate\": \"2025-09-06\",\n\"endDate\": \"2025-09-06\"\n},\n{\n\"name\": \"Hol2\",\n\"startDate\": \"2025-09-05\",\n\"endDate\": \"2025-09-05\",\n\"overlapsWith\":[\"Hol3\"]\n},\n{\n\"name\": \"Hol3\",\n\"startDate\": \"2025-09-05\",\n\"endDate\": \"2025-09-05\",\n\"overlapsWith\":[\"Hol2\"]\n}"
}
}
},
"required": [
"name"
]
},
"RecurrenceDTO": {
"type": "object",
"properties": {
"interval": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"occurrenceInTheMonth": {
"type": "string",
"enum": [
"FIRST",
"SECOND",
"THIRD",
"FOURTH",
"LAST"
]
},
"daysOfWeek": {
"type": "array",
"items": {
"type": "string",
"enum": [
"SUN",
"MON",
"TUE",
"WED",
"THU",
"FRI",
"SAT"
]
},
"maxItems": 7,
"minItems": 0
},
"specificDayOfMonth": {
"type": "integer",
"format": "int32",
"maximum": 31,
"minimum": 1
},
"specificMonth": {
"type": "string",
"enum": [
"JAN",
"FEB",
"MAR",
"APR",
"MAY",
"JUN",
"JUL",
"AUG",
"SEP",
"OCT",
"NOV",
"DEC"
]
},
"endDate": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$"
}
},
"required": [
"interval"
]
},
"BulkRequestDTOHolidayListDTO": {
"type": "object",
"description": "Bulk Request Holiday List schema.",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOHolidayListDTO",
"description": "Item."
}
}
}
},
"BulkRequestItemDTOHolidayListDTO": {
"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/HolidayListDTO",
"description": "Item."
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"ResponseEnvelopeHolidayListDTO": {
"type": "object",
"description": "Response Envelope Holiday List schema.",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"description": "Meta additional property."
},
"description": "Additional properties for Meta."
},
"data": {
"type": "array",
"description": "List of Data.",
"items": {
"$ref": "#/components/schemas/HolidayListDTO",
"description": "Data item."
}
}
}
},
"OverridesDTOList": {
"type": "object",
"description": "Summary details of an overrides resource.",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Enter a name for the agent profile.",
"example": "My Overrides",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9_-]+(\\s?[a-zA-Z0-9_-]+)*$"
},
"description": {
"type": "string",
"description": "(Optional) Enter a description of the profile.",
"example": "My Overrides Desc",
"maxLength": 255,
"minLength": 0
},
"timezone": {
"type": "string",
"description": "The time zone that you provision for your overrides.",
"example": "America/New_York",
"minLength": 1
},
"latestOverride": {
"$ref": "#/components/schemas/OverrideDTO"
},
"overridesCount": {
"type": "integer",
"format": "int64",
"description": "Number of overrides configured for this resource."
},
"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
}
}
},
"OverrideDTO": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9_-]+(\\s?[a-zA-Z0-9_-]+)*$"
},
"startDateTime": {
"type": "string"
},
"endDateTime": {
"type": "string"
},
"workingHours": {
"type": "boolean"
},
"frequency": {
"type": "string",
"enum": [
"DontRepeat",
"Daily",
"Weekly",
"Monthly",
"Yearly"
]
},
"recurrence": {
"$ref": "#/components/schemas/RecurrenceDTO"
}
},
"required": [
"name",
"workingHours"
]
},
"OverridesDTO": {
"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": "Enter a name for the agent profile.",
"example": "My Overrides",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9_-]+(\\s?[a-zA-Z0-9_-]+)*$"
},
"description": {
"type": "string",
"description": "(Optional) Enter a description of the profile.",
"example": "My Overrides Desc",
"maxLength": 255,
"minLength": 0
},
"timezone": {
"type": "string",
"description": "The time zone that you provision for your overrides.",
"example": "America/New_York",
"minLength": 1
},
"overrides": {
"type": "array",
"description": "Work hours to be overridden",
"example": {
"name": "My Overrides",
"description": "My Overrides Desc",
"timezone": "America/New_York",
"overrides": [
{
"name": "Day for me",
"startDateTime": "2022-05-26T00:00",
"endDateTime": "2022-05-26T23:59",
"workingHours": true
},
{
"name": "Fire Drill",
"startDateTime": "2022-05-26T14:30",
"endDateTime": "2022-05-26T16:30",
"workingHours": false
}
],
"id": "93912f11-6017-404b-bf14-5331890b1797",
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"createdTime": 1628231177000,
"lastUpdatedTime": 1628231177000
},
"items": {
"$ref": "#/components/schemas/OverrideDTO"
},
"minItems": 1
},
"latestOverride": {
"$ref": "#/components/schemas/OverrideDTO"
},
"overridesCount": {
"type": "integer",
"format": "int64"
},
"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": [
"name",
"overrides",
"timezone"
]
},
"BulkRequestDTOOverridesDTO": {
"type": "object",
"description": "Bulk request payload containing overrides items.",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOOverridesDTO"
}
}
}
},
"BulkRequestItemDTOOverridesDTO": {
"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/OverridesDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"ResponseEnvelopeOverridesDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OverridesDTO"
}
}
}
},
"AddressBookWithEntriesDTO": {
"required": [
"name",
"parentType"
],
"type": "object",
"properties": {
"organizationId": {
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
"type": "string",
"description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
"format": "uuid",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"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",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"format": "int32",
"example": 1
},
"name": {
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9._\\-\\s]*$",
"type": "string",
"description": "A name for the address book.",
"example": "HNI-Customers"
},
"description": {
"maxLength": 255,
"minLength": 0,
"pattern": "^[a-zA-Z0-9._\\-\\s]*$",
"type": "string",
"description": "A short description indicating the context of the address book.",
"example": "Phone number of all HNI customers"
},
"parentType": {
"type": "string",
"description": "A parent type which indicates whether the address book is accessible for all sites or a specific site.\n Once created, parentType cannot be modified.",
"example": "ORGANIZATION",
"enum": [
"ORGANIZATION",
"SITE"
]
},
"siteId": {
"type": "string",
"description": "The specific site id where the address book is accessible.",
"example": "c7b3665d-b386-4267-8397-1331f2a26018"
},
"addressBookEntries": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressBookEntryDTO"
}
},
"createdTime": {
"type": "integer",
"description": "Creation time(in epoch millis) of this resource.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
},
"lastUpdatedTime": {
"type": "integer",
"description": "Time(in epoch millis) when this resource was last updated.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
}
}
},
"AddressBookEntryDTO": {
"required": [
"name",
"number"
],
"type": "object",
"properties": {
"organizationId": {
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
"type": "string",
"description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
"format": "uuid",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"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",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"format": "int32",
"example": 1
},
"name": {
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9._\\-\\s]*$",
"type": "string",
"description": "A name for the address book entry.",
"example": "James Bond"
},
"number": {
"pattern": "^[0-9()+-]+$",
"type": "string",
"description": "The phone number for the entry.",
"example": "+14033212"
},
"createdTime": {
"type": "integer",
"description": "Creation time(in epoch millis) of this resource.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
},
"lastUpdatedTime": {
"type": "integer",
"description": "Time(in epoch millis) when this resource was last updated.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
}
}
},
"BulkExportDTOAddressBookBulkExportDTO": {
"type": "object",
"properties": {
"totalResources": {
"type": "integer",
"description": "Total number of items",
"format": "int32",
"example": 100
},
"pageNumber": {
"type": "integer",
"description": "Current page number",
"format": "int32",
"example": 0
},
"pageSize": {
"type": "integer",
"description": "Page size for current data set",
"format": "int32",
"example": 50
},
"rel": {
"type": "string",
"description": "Indicates whether more pages exist. When 'next' there are more pages available, otherwise 'last'.",
"example": "last"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressBookBulkExportDTO"
}
}
}
},
"AddressBookBulkExportDTO": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id for the address book in the bulk export request.",
"example": "HNI-Customers"
},
"name": {
"type": "string",
"description": "A name for the address book in the bulk export request.",
"example": "HNI-Customers"
},
"description": {
"type": "string",
"description": "A short description indicating the context of the address book.",
"example": "Phone number of all HNI customers"
},
"parentSite": {
"type": "string",
"description": "The specific site id where the address book is accessible.",
"example": "c7b3665d-b386-4267-8397-1331f2a26018"
},
"entryDetails": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressBookEntryDetailsDTO"
}
}
}
},
"AddressBookEntryDetailsDTO": {
"required": [
"entryName",
"phoneNumber"
],
"type": "object",
"properties": {
"entryName": {
"type": "string",
"description": "A name for the address book entry.",
"example": "James Bond"
},
"phoneNumber": {
"type": "string",
"description": "The phone number for the entry.",
"example": "+14033212"
}
}
},
"BulkRequestDTOAddressBookEntryDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOAddressBookEntryDTO"
}
}
}
},
"BulkRequestItemDTOAddressBookEntryDTO": {
"type": "object",
"properties": {
"itemIdentifier": {
"type": "integer",
"description": "Unique item identifier for a bulk operation.",
"format": "int32",
"example": 10
},
"item": {
"$ref": "#/components/schemas/AddressBookEntryDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values can be SAVE and DELETE.",
"example": "SAVE"
}
}
},
"ResponseEnvelopeAddressBookWithEntriesDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressBookWithEntriesDTO"
}
}
}
},
"ResponseEnvelopeAddressBookDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressBookDTO"
}
}
}
},
"AddressBookDTO": {
"required": [
"name",
"parentType"
],
"type": "object",
"properties": {
"organizationId": {
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
"type": "string",
"description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
"format": "uuid",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"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",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"format": "int32",
"example": 1
},
"name": {
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9._\\-\\s]*$",
"type": "string",
"description": "A name for the address book.",
"example": "HNI-Customers"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A short description indicating the context of the address book.",
"example": "Phone number of all HNI customers"
},
"parentType": {
"type": "string",
"description": "A parent type which indicates whether the address book is accessible for all sites or a specific site.\n Once created, parentType cannot be modified.",
"example": "ORGANIZATION",
"enum": [
"ORGANIZATION",
"SITE"
]
},
"siteId": {
"type": "string",
"description": "The specific site id where the address book is accessible.",
"example": "c7b3665d-b386-4267-8397-1331f2a26018"
},
"createdTime": {
"type": "integer",
"description": "Creation time(in epoch millis) of this resource.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
},
"lastUpdatedTime": {
"type": "integer",
"description": "Time(in epoch millis) when this resource was last updated.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
}
}
},
"AgentPersonalGreetingDTO_AgentPersonalGreetingsWithAttributeTag": {
"type": "object",
"description": "Agent Personal Greeting Agent Personal Greetings With Attribute Tag schema.",
"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",
"description": "Audio File."
},
"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": [
"agentId",
"contentType",
"name"
]
},
"FieldRequestBody": {
"type": "object",
"description": "Request payload identifying the entity references that should be removed from contact service queues. The `references` map contains key/value pairs where the key is the referenced entity type (for example, `team`, `site`, `agent`, `skillProfile`) and the value is the unique identifier of that entity. All matching references will be detached from any contact service queue in the target organization.",
"example": {
"references": {
"team": "76cf35bc-12df-49ef-88e1-c86226d8a645",
"skillProfile": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
}
},
"properties": {
"references": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "References additional property."
},
"description": "Map of entity type to entity identifier whose references must be removed from contact service queues. The key is the referenced entity type (e.g. `team`, `site`, `agent`, `skillProfile`) and the value is its UUID.",
"example": {
"team": "76cf35bc-12df-49ef-88e1-c86226d8a645"
}
}
}
},
"Response": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"details": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"links": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Link"
}
}
}
},
"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"
}
}
},
"AgentPersonalGreetingPatchDTO_AgentPersonalGreetingsWithAttributeTag": {
"type": "object",
"description": "Agent Personal Greeting Patch Agent Personal Greetings With Attribute Tag schema.",
"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"
}
}
},
"AgentPersonalGreetingDTO_AgentPersonalGreetingsWithGreetingPurpose": {
"type": "object",
"description": "Agent Personal Greeting Agent Personal Greetings With Greeting Purpose schema.",
"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",
"description": "Audio File."
},
"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": [
"agentId",
"contentType",
"name"
]
},
"AgentPersonalGreetingPatchDTO_AgentPersonalGreetingsWithGreetingPurpose": {
"type": "object",
"description": "Agent Personal Greeting Patch Agent Personal Greetings With Greeting Purpose schema.",
"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"
}
}
},
"AudioFileInfoDTO": {
"required": [
"contentType",
"name"
],
"type": "object",
"properties": {
"organizationId": {
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
"type": "string",
"description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
"format": "uuid",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"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",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"format": "int32",
"example": 1
},
"name": {
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9._\\-\\s]*$",
"type": "string",
"description": "A name for the Agent's personal greeting file. It should have valid extension i.e. .wav ",
"example": "WelcomeMessage.wav"
},
"contentType": {
"type": "string",
"description": "Indicates Content-Type of the Audio file. It can take one of these values: AUDIO_WAV, AUDIO_X_WAV",
"example": "AUDIO_WAV",
"enum": [
"AUDIO_WAV",
"TEXT_HTML",
"TEXT_PHP",
"AUDIO_X_WAV",
"APPLICATION_OCTET_STREAM"
]
},
"blobId": {
"type": "string",
"description": "Identifier for the audio file.",
"example": "audio-file_a7c700d5-2fac-4a6c-9a16-eb2f2b42d7a8"
},
"url": {
"type": "string",
"description": "Audio file download url.",
"format": "url",
"example": "https://cjp-ccone-devus1-ivr-media.s3.amazonaws.com/bde75a64-f4d5-4ffc-a239-feb607c17ef8/"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A short description of the dial plan.",
"example": "Required for transferring calls to Queues"
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"audioFile": {
"type": "string",
"format": "binary"
},
"createdTime": {
"type": "integer",
"description": "Creation time(in epoch millis) of this resource.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
},
"lastUpdatedTime": {
"type": "integer",
"description": "Time(in epoch millis) when this resource was last updated.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
}
}
},
"AudioFileInfoPatchDTO": {
"type": "object",
"properties": {
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A short description of the dial plan.",
"example": "Required for transferring calls to Queues"
}
}
},
"ResponseEnvelopeAudioFileInfoDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AudioFileInfoDTO"
}
}
}
},
"AuxiliaryCodeDTO": {
"required": [
"active",
"defaultCode",
"name",
"workTypeCode",
"workTypeId"
],
"type": "object",
"properties": {
"organizationId": {
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
"type": "string",
"description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
"format": "uuid",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"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",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"format": "int32",
"example": 1
},
"name": {
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9._)\\/(\\-\\s]*$",
"type": "string",
"description": "A name for the code.",
"example": "Sales-Query"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A short description indicating the context of the code.",
"example": "Wrap-up code to for sales query"
},
"defaultCode": {
"type": "boolean",
"description": "Indicates whether this is the default code(true) or not(false).\n\nIf this is the first idle or wrap-up code for your organization,it must be the default. It can be made non-default later once more codes are created.\n\n",
"example": true
},
"active": {
"type": "boolean",
"description": "Indicates whether the code is active(when true) or not active(when false). \n\nIt is required only during a create or an update operation.",
"example": true
},
"isSystemCode": {
"type": "boolean",
"description": "Indicates whether this is the system default code(true) or not(false). \n\n",
"example": true
},
"workTypeId": {
"type": "string",
"description": "Indicates the work type id associated with this code.",
"example": "19edbcf9-2dea-438b-bdae-446139a5d1fd"
},
"workTypeCode": {
"type": "string",
"description": "Indicates the work type associated with this code.",
"example": "WRAP_UP_CODE",
"enum": [
"IDLE_CODE",
"WRAP_UP_CODE"
]
},
"burnoutInclusion": {
"type": "string",
"description": "Indicates the idle code Inclusion status for agent burnout calculation. Default value is 'INCLUDED' for idle codes and 'NOT_APPLICABLE' for wrap up codes.",
"example": "INCLUDED",
"enum": [
"NOT_APPLICABLE",
"EXCLUDED",
"INCLUDED"
]
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"createdTime": {
"type": "integer",
"description": "Creation time(in epoch millis) of this resource.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
},
"lastUpdatedTime": {
"type": "integer",
"description": "Time(in epoch millis) when this resource was last updated.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
}
}
},
"BulkRequestDTOAuxiliaryCodeDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOAuxiliaryCodeDTO"
}
}
}
},
"BulkRequestItemDTOAuxiliaryCodeDTO": {
"type": "object",
"properties": {
"itemIdentifier": {
"type": "integer",
"description": "Unique item identifier for a bulk operation.",
"format": "int32",
"example": 10
},
"item": {
"$ref": "#/components/schemas/AuxiliaryCodeDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values can be SAVE and DELETE.",
"example": "SAVE"
}
}
},
"BulkExportDTOAuxCodeBulkExportDTO": {
"type": "object",
"properties": {
"totalResources": {
"type": "integer",
"description": "Total number of items",
"format": "int32",
"example": 100
},
"pageNumber": {
"type": "integer",
"description": "Current page number",
"format": "int32",
"example": 0
},
"pageSize": {
"type": "integer",
"description": "Page size for current data set",
"format": "int32",
"example": 50
},
"rel": {
"type": "string",
"description": "Indicates whether more pages exist. When 'next' there are more pages available, otherwise 'last'.",
"example": "last"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuxCodeBulkExportDTO"
}
}
}
},
"AuxCodeBulkExportDTO": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "A name for the code.",
"example": "Sales-Query"
},
"description": {
"type": "string",
"description": "A short description indicating the context of the code.",
"example": "Wrap-up code to for sales query"
},
"defaultCode": {
"type": "string",
"description": "Indicates the default work code for your organization.",
"example": "00734874-4732-43bb-bfff-d1e75d309eb1"
},
"workTypeName": {
"type": "string",
"description": "Indicates the work type associated with this code.",
"example": "WRAP_UP_CODE"
}
}
},
"ContactNumberDTO": {
"required": [
"number"
],
"type": "object",
"properties": {
"organizationId": {
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
"type": "string",
"description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
"format": "uuid",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"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",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"format": "int32",
"example": 1
},
"number": {
"pattern": "^[0-9]*$",
"type": "string",
"description": "The customized ani number.",
"example": "14033212"
},
"createdTime": {
"type": "integer",
"description": "Creation time(in epoch millis) of this resource.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
},
"lastUpdatedTime": {
"type": "integer",
"description": "Time(in epoch millis) when this resource was last updated.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
}
}
},
"BulkRequestDTOContactNumberDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOContactNumberDTO"
}
}
}
},
"BulkRequestItemDTOContactNumberDTO": {
"type": "object",
"properties": {
"itemIdentifier": {
"type": "integer",
"description": "Unique item identifier for a bulk operation.",
"format": "int32",
"example": 10
},
"item": {
"$ref": "#/components/schemas/ContactNumberDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values can be SAVE and DELETE.",
"example": "SAVE"
}
}
},
"BulkExportDTOContactNumberBulkExportDTO": {
"type": "object",
"properties": {
"totalResources": {
"type": "integer",
"description": "Total number of items",
"format": "int32",
"example": 100
},
"pageNumber": {
"type": "integer",
"description": "Current page number",
"format": "int32",
"example": 0
},
"pageSize": {
"type": "integer",
"description": "Page size for current data set",
"format": "int32",
"example": 50
},
"rel": {
"type": "string",
"description": "Indicates whether more pages exist. When 'next' there are more pages available, otherwise 'last'.",
"example": "last"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactNumberBulkExportDTO"
}
}
}
},
"ContactNumberBulkExportDTO": {
"type": "object",
"properties": {
"number": {
"type": "string"
}
}
},
"ResponseEnvelopeContactNumberDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactNumberDTO"
}
}
}
},
"ContactServiceQueueDTOList": {
"type": "object",
"description": "Contact Service Queue schema.",
"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": "Name of the Contact Service Queue",
"example": "Queue-1"
},
"description": {
"type": "string",
"description": "(Optional) A short description of the queue.",
"example": "Queue created by system"
},
"queueType": {
"type": "string",
"description": "This can be the following\n\nINBOUND\n\nOUTBOUND",
"enum": [
"INBOUND",
"OUTBOUND"
],
"example": "INBOUND"
},
"checkAgentAvailability": {
"type": "boolean",
"description": "This setting specifies whether the system can exclude teams with no logged in agents for the relevant routing strategies. It does not support Social Channel Type.",
"example": true
},
"channelType": {
"type": "string",
"description": "Setting to indicate the channel type. Use uppercase. Supported channel types are: \n\n TELEPHONY, EMAIL, SOCIAL_CHANNEL, and CHAT. \n\nFor TELEPHONY channelType, the following fields are mandatory - recordingPermitted, ivrRequeueUrl, recordingAllCallsPermitted, monitoringPermitted, parkingPermitted, pauseRecordingPermitted, controlFlowScriptUrl, defaultMusicInQueueMediaFileId.",
"enum": [
"TELEPHONY",
"EMAIL",
"FAX",
"CHAT",
"VIDEO",
"OTHERS",
"SOCIAL_CHANNEL",
"WORK_ITEM",
"CUSTOM_MESSAGING"
],
"example": "TELEPHONY"
},
"socialChannelType": {
"type": "string",
"description": "This can be the following\n\nMESSAGEBIRD\n\nMESSENGER",
"enum": [
"MESSAGEBIRD",
"MESSENGER",
"WHATSAPP",
"APPLE_BUSINESS_CHAT",
"GOOGLE_BUSINESS_MESSAGES"
],
"example": "MESSENGER"
},
"serviceLevelThreshold": {
"type": "integer",
"format": "int32",
"description": "The time in seconds that a customer request can be in a queue before the system flags it as outside the service level. It does not support Social Channel Type.",
"example": 0
},
"maxActiveContacts": {
"type": "integer",
"format": "int32",
"description": "The maximum number of simultaneous contacts allowed for this queue. It does not support Social Channel Type.",
"example": 5
},
"maxTimeInQueue": {
"type": "integer",
"format": "int32",
"description": "The time in seconds after which the system distributes the queued customer request to the overflow number that you provision for this queue. ",
"example": 2
},
"defaultMusicInQueueMediaFileId": {
"type": "string",
"description": "Identifies the default audio file which will be played for calls when they arrive or are waiting in queue. \nThis setting is available only for the Telephony channel type.",
"example": "defaultmusic_on_hold.wav"
},
"timezone": {
"type": "string",
"description": "(Optional) Any routing strategy for this queue uses the time zone that you select here.",
"example": "America/New_York"
},
"active": {
"type": "boolean",
"description": "Specify whether the queue is active or not active",
"example": true
},
"outdialCampaignEnabled": {
"type": "boolean",
"description": "Should be specified only for outdial queues; if enabled, then Call Distribution and Queue Routing Type can be specified.",
"example": true
},
"monitoringPermitted": {
"type": "boolean",
"description": "Indicates whether or not monitoring is permitted. \nThis setting is available only for the Telephony channel type.",
"example": true
},
"parkingPermitted": {
"type": "boolean",
"description": "Indicates whether or not parking is permitted. \nThis setting is available only for the Telephony channel type.",
"example": true
},
"recordingPermitted": {
"type": "boolean",
"description": "Indicates whether or not recording is permitted. \nThis setting is available only for the Telephony channel type.",
"example": true
},
"recordingAllCallsPermitted": {
"type": "boolean",
"description": "Indicates whether or not recording all calls is permitted. \nThis setting is available only for the Telephony channel type.",
"example": true
},
"pauseRecordingPermitted": {
"type": "boolean",
"description": "Indicates whether or not pausing the recording is permitted. \nThis setting is available only for the Telephony channel type.",
"example": true
},
"recordingPauseDuration": {
"type": "integer",
"format": "int32",
"description": "The duration in seconds of pause in recording. \nThis setting is available only for the Telephony channel type.",
"example": 2
},
"controlFlowScriptUrl": {
"type": "string",
"description": "The URL for the queue or the default control script of the queue. If you do not use the routing strategy module to configure the control script, the system automatically populates the URL.\nThis setting is available only for the Telephony channel type.",
"example": "https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield"
},
"ivrRequeueUrl": {
"type": "string",
"description": "This setting is available only for the Telephony channel type.",
"example": "https://www.youtube.com"
},
"overflowNumber": {
"type": "string",
"description": "The destination phone number to which the system distributes the customer calls when they exceed the Maximum Time in Queue that you have set in the routing strategy.\nThis setting is applicable only for the Telephony channel type and it is optional.",
"example": "1245677"
},
"vendorId": {
"type": "string",
"description": "The unique alphanumeric string that maps this queue to the vendor.\nThis setting is available only for the Telephony channel type and it is optional.",
"example": "AB123CSDR"
},
"routingType": {
"type": "string",
"description": "This can be one of the following\n\nLONGEST_AVAILABLE_AGENT\n\nSKILLS_BASED(skillBasedRoutingType is mandatory to define)",
"enum": [
"LONGEST_AVAILABLE_AGENT",
"SKILLS_BASED",
"CIRCULAR",
"LINEAR"
],
"example": "SKILLS_BASED"
},
"skillBasedRoutingType": {
"type": "string",
"description": "This can be the following\n\nLONGEST_AVAILABLE_AGENT\n\nBEST_AVAILABLE_AGENT",
"enum": [
"LONGEST_AVAILABLE_AGENT",
"BEST_AVAILABLE_AGENT"
],
"example": "BEST_AVAILABLE_AGENT"
},
"queueRoutingType": {
"type": "string",
"description": "This can be the following\n\nTEAM_BASED\n\nQUEUE_BASED",
"enum": [
"TEAM_BASED",
"SKILL_BASED",
"AGENT_BASED"
],
"example": "TEAM_BASED"
},
"xspVersion": {
"type": "string",
"description": "(Optional) Used to subscribe for recording events.",
"example": "xsp-24.0",
"maxLength": 80,
"minLength": 0
},
"subscriptionId": {
"type": "string",
"description": "(Optional) Used to subscribe for recording events.",
"example": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"maxLength": 80,
"minLength": 0
},
"assistantSkill": {
"$ref": "#/components/schemas/AssistantSkillMappingDTO",
"description": "Assistant Skill."
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"manuallyAssignable": {
"type": "boolean",
"description": "If `true`, the queue can be manually assigned.",
"example": false
},
"agentsLastUpdatedByUserName": {
"type": "string",
"description": "The name of the user who last modified the agents list."
},
"agentsLastUpdatedByUserEmailPrefix": {
"type": "string",
"description": "The email of the user who last modified the agents list."
},
"agentsLastUpdatedTime": {
"type": "integer",
"format": "int64",
"description": "The date when the agents list was last modified (epoch timestamp in milliseconds).",
"example": 1742553000000
},
"queueLevelSummariesInclusion": {
"type": "string",
"description": "Queue level summaries inclusion type. Used only when Queue inclusion for summaries is set to 'Specific Queues' at the org level AI Assistant->Summaries configuration.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.This is applicable/available only when AI Assistant add-on offer/license is added to the organization. If the value is missing in response, the consumer should assume a value as EXCLUDED.",
"example": "INCLUDED"
},
"queueLevelSentimentAnalysisInclusion": {
"type": "string",
"description": "Queue level sentiment analysis inclusion type. Used only when Queue inclusion for sentiment analysis is set to 'Specific Queues' at the org level AI Assistant->Quality Management configuration.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.This is applicable/available when either AI Assistant/AI Quality Management add-on offer/license is added to the organization. If the value is missing in response, the consumer should assume a value as EXCLUDED.",
"example": "INCLUDED"
},
"queueLevelPredictedWaitTimeInclusion": {
"type": "string",
"description": "Queue level predicted wait time inclusion type. Used only when Queue inclusion for predicted wait time is set to 'Specific Queues' at the org level AI Assistant->Predicted Wait Time configuration.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained. If the value is missing in response, the consumer should assume a value as EXCLUDED.",
"example": "INCLUDED"
},
"queueLevelAutoCsatInclusion": {
"type": "string",
"description": "Queue level auto CSAT inclusion type. Used only when Queue inclusion for auto CSAT is set to 'Specific Queues' at the org level AI Assistant->Auto CSAT configuration.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.This is applicable/available when either AI Assistant/AI Quality Management add-on offer/license is added to the organization. If the value is missing in response, the consumer should assume a value as EXCLUDED.",
"example": "INCLUDED"
},
"queueLevelRealTimeTranscriptionsInclusion": {
"type": "string",
"description": "Queue level real time transcriptions inclusion type. Used only when Queue inclusion for real time transcriptions is set to 'Specific Queues' at the org level AI Assistant->Real Time Transcriptions configuration.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.This is applicable/available when either AI Assistant/AI Quality Management add-on offer/license is added to the organization. If the value is missing in response, the consumer should assume a value as EXCLUDED.",
"example": "INCLUDED"
},
"personalizedAIRouting": {
"$ref": "#/components/schemas/QueuePersonalizedAIRoutingDTO",
"description": "Personalized AI Routing configuration for this queue. Controls AI-based intelligent routing to optimize agent selection based on ML predictions. When enabled, contacts are routed to agents predicted to have the best outcome based on configured KPIs. Requires 'personalized-ai-routing' permission and feature flag enablement. See QueuePersonalizedAIRoutingDTO for state transition requirements."
},
"pauseAndResume": {
"$ref": "#/components/schemas/QueuePauseAndResumeDTO",
"description": "Pause and resume configuration for EMAIL and SOCIAL channels only"
},
"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
}
}
},
"AssistantSkillMappingDTO": {
"type": "object",
"description": "Assistant skill related properties associated with the queue. This is applicable/available only when AI Assistant add-on offer/license is added to the organization.",
"properties": {
"assistantSkillId": {
"type": "string",
"description": "Id of an Assistant Skill mapped to the Contact Service Queue. If the value is missing in response, the consumer should assume a value as null.",
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
"assistantSkillUpdatedTime": {
"type": "integer",
"format": "int64",
"description": "Time(in epoch milliseconds) when assistant skill mapping was last updated. If the value is missing in response, the consumer should assume a value as null.",
"example": 1617536244000,
"readOnly": true
}
}
},
"QueuePersonalizedAIRoutingDTO": {
"type": "object",
"description": "Queue-level Personalized AI Routing configuration. Enables intelligent agent routing based on AI/ML predictions.",
"properties": {
"aiRoutingMode": {
"type": "string",
"default": "NONE",
"description": "AI Routing mode. Valid transitions: NONE \u2192 EVALUATION; EVALUATION \u2192 ACTIVE or NONE; ACTIVE \u2192 NONE. NONE: AI routing disabled (default). EVALUATION: Shadow mode - AI predictions are generated but not used for routing (for testing/validation). ACTIVE: AI routing enabled - contacts are routed based on AI predictions.",
"enum": [
"NONE",
"EVALUATION",
"ACTIVE"
],
"example": "EVALUATION"
},
"aiRoutingKPIId": {
"type": "string",
"description": "AI Routing KPI ID - the performance metric used by AI to optimize routing decisions. This should reference a valid KPI configured in the AI routing system. Required when aiRoutingMode is EVALUATION or ACTIVE.",
"example": "63beec53-8a61-489f-afc6-bb03c8c73834"
},
"evaluationModeStartTime": {
"type": "integer",
"format": "int64",
"description": "Timestamp (epoch milliseconds) when EVALUATION mode was activated. Automatically set by the system when transitioning from NONE to EVALUATION. Used to track evaluation duration and readiness for ACTIVE mode transition.",
"example": 1730269619000,
"readOnly": true
}
}
},
"QueuePauseAndResumeDTO": {
"type": "object",
"description": "Pause and resume configuration for EMAIL and SOCIAL channels only",
"properties": {
"enabled": {
"type": "boolean",
"description": "Indicates whether pause and resume is enabled for this queue",
"example": true
},
"pauseTimeout": {
"$ref": "#/components/schemas/PauseTimeoutDTO",
"description": "Pause timeout configuration. Required when enabled is true."
}
}
},
"PauseTimeoutDTO": {
"type": "object",
"description": "Pause timeout configuration. Required when enabled is true.",
"properties": {
"days": {
"type": "integer",
"format": "int32",
"description": "Number of days for pause timeout. Channel-specific maximum is enforced at the service layer based on configured limits.",
"example": 14,
"minimum": 0
},
"hours": {
"type": "integer",
"format": "int32",
"description": "Number of hours for pause timeout (0-23)",
"example": 12,
"maximum": 23,
"minimum": 0
},
"minutes": {
"type": "integer",
"format": "int32",
"description": "Number of minutes for pause timeout (0-59)",
"example": 45,
"maximum": 59,
"minimum": 0
}
}
},
"BulkRequestDTOContactServiceQueueDTO": {
"type": "object",
"description": "Bulk Request Contact Service Queue schema.",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOContactServiceQueueDTO",
"description": "Item."
}
}
}
},
"BulkRequestItemDTOContactServiceQueueDTO": {
"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/ContactServiceQueueDTO",
"description": "Item."
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"ContactServiceQueueDTO": {
"type": "object",
"description": "Contact Service Queue schema.",
"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": "Name of the Contact Service Queue",
"example": "Queue-1"
},
"description": {
"type": "string",
"description": "(Optional) A short description of the queue.",
"example": "Queue created by system"
},
"queueType": {
"type": "string",
"description": "This can be the following\n\nINBOUND\n\nOUTBOUND",
"enum": [
"INBOUND",
"OUTBOUND"
],
"example": "INBOUND"
},
"checkAgentAvailability": {
"type": "boolean",
"description": "This setting specifies whether the system can exclude teams with no logged in agents for the relevant routing strategies. It does not support Social Channel Type.",
"example": true
},
"channelType": {
"type": "string",
"description": "Setting to indicate the channel type. Use uppercase. Supported channel types are: \n\n TELEPHONY, EMAIL, SOCIAL_CHANNEL, and CHAT. \n\nFor TELEPHONY channelType, the following fields are mandatory - recordingPermitted, ivrRequeueUrl, recordingAllCallsPermitted, monitoringPermitted, parkingPermitted, pauseRecordingPermitted, controlFlowScriptUrl, defaultMusicInQueueMediaFileId.",
"enum": [
"TELEPHONY",
"EMAIL",
"FAX",
"CHAT",
"VIDEO",
"OTHERS",
"SOCIAL_CHANNEL",
"WORK_ITEM",
"CUSTOM_MESSAGING"
],
"example": "TELEPHONY"
},
"socialChannelType": {
"type": "string",
"description": "This can be the following\n\nMESSAGEBIRD\n\nMESSENGER",
"enum": [
"MESSAGEBIRD",
"MESSENGER",
"WHATSAPP",
"APPLE_BUSINESS_CHAT",
"GOOGLE_BUSINESS_MESSAGES"
],
"example": "MESSENGER"
},
"serviceLevelThreshold": {
"type": "integer",
"format": "int32",
"description": "The time in seconds that a customer request can be in a queue before the system flags it as outside the service level. It does not support Social Channel Type.",
"example": 0
},
"maxActiveContacts": {
"type": "integer",
"format": "int32",
"description": "The maximum number of simultaneous contacts allowed for this queue. It does not support Social Channel Type.",
"example": 5
},
"maxTimeInQueue": {
"type": "integer",
"format": "int32",
"description": "The time in seconds after which the system distributes the queued customer request to the overflow number that you provision for this queue. ",
"example": 2
},
"defaultMusicInQueueMediaFileId": {
"type": "string",
"description": "Identifies the default audio file which will be played for calls when they arrive or are waiting in queue. \nThis setting is available only for the Telephony channel type.",
"example": "defaultmusic_on_hold.wav"
},
"timezone": {
"type": "string",
"description": "(Optional) Any routing strategy for this queue uses the time zone that you select here.",
"example": "America/New_York"
},
"active": {
"type": "boolean",
"description": "Specify whether the queue is active or not active",
"example": true
},
"outdialCampaignEnabled": {
"type": "boolean",
"description": "Should be specified only for outdial queues; if enabled, then Call Distribution and Queue Routing Type can be specified.",
"example": true
},
"monitoringPermitted": {
"type": "boolean",
"description": "Indicates whether or not monitoring is permitted. \nThis setting is available only for the Telephony channel type.",
"example": true
},
"parkingPermitted": {
"type": "boolean",
"description": "Indicates whether or not parking is permitted. \nThis setting is available only for the Telephony channel type.",
"example": true
},
"recordingPermitted": {
"type": "boolean",
"description": "Indicates whether or not recording is permitted. \nThis setting is available only for the Telephony channel type.",
"example": true
},
"recordingAllCallsPermitted": {
"type": "boolean",
"description": "Indicates whether or not recording all calls is permitted. \nThis setting is available only for the Telephony channel type.",
"example": true
},
"pauseRecordingPermitted": {
"type": "boolean",
"description": "Indicates whether or not pausing the recording is permitted. \nThis setting is available only for the Telephony channel type.",
"example": true
},
"recordingPauseDuration": {
"type": "integer",
"format": "int32",
"description": "The duration in seconds of pause in recording. \nThis setting is available only for the Telephony channel type.",
"example": 2
},
"controlFlowScriptUrl": {
"type": "string",
"description": "The URL for the queue or the default control script of the queue. If you do not use the routing strategy module to configure the control script, the system automatically populates the URL.\nThis setting is available only for the Telephony channel type.",
"example": "https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield"
},
"ivrRequeueUrl": {
"type": "string",
"description": "This setting is available only for the Telephony channel type.",
"example": "https://www.youtube.com"
},
"overflowNumber": {
"type": "string",
"description": "The destination phone number to which the system distributes the customer calls when they exceed the Maximum Time in Queue that you have set in the routing strategy.\nThis setting is applicable only for the Telephony channel type and it is optional.",
"example": 1245677
},
"vendorId": {
"type": "string",
"description": "The unique alphanumeric string that maps this queue to the vendor.\nThis setting is available only for the Telephony channel type and it is optional.",
"example": "AB123CSDR"
},
"routingType": {
"type": "string",
"description": "This can be one of the following\n\nLONGEST_AVAILABLE_AGENT\n\nSKILLS_BASED(skillBasedRoutingType is mandatory to define)",
"enum": [
"LONGEST_AVAILABLE_AGENT",
"SKILLS_BASED",
"CIRCULAR",
"LINEAR"
],
"example": "SKILLS_BASED"
},
"skillBasedRoutingType": {
"type": "string",
"description": "This can be the following\n\nLONGEST_AVAILABLE_AGENT\n\nBEST_AVAILABLE_AGENT",
"enum": [
"LONGEST_AVAILABLE_AGENT",
"BEST_AVAILABLE_AGENT"
],
"example": "BEST_AVAILABLE_AGENT"
},
"queueRoutingType": {
"type": "string",
"description": "This can be the following\n\nTEAM_BASED\n\nQUEUE_BASED",
"enum": [
"TEAM_BASED",
"SKILL_BASED",
"AGENT_BASED"
],
"example": "TEAM_BASED"
},
"queueSkillRequirements": {
"type": "array",
"description": "List of Queue Skill Requirements.",
"items": {
"$ref": "#/components/schemas/QueueSkillRequirementDTO",
"description": "Queue Skill Requirement."
},
"uniqueItems": true
},
"agents": {
"type": "array",
"description": "The list of agents for AgentBased queue",
"example": [
{
"id": "16c93b13-f1e9-4a4f-bc47-957b9075a56f",
"ciUserId": "660e0a5a-8230-47d7-ae98-047fb180e1ff"
}
],
"items": {
"$ref": "#/components/schemas/QueueAgentsDTO",
"description": "Agent."
}
},
"callDistributionGroups": {
"type": "array",
"description": "List of Call Distribution Groups.",
"items": {
"$ref": "#/components/schemas/CallDistributionGroupDTO",
"description": "Call Distribution Group."
},
"uniqueItems": true
},
"xspVersion": {
"type": "string",
"description": "(Optional) Used to subscribe for recording events.",
"example": "xsp-24.0",
"maxLength": 80,
"minLength": 0
},
"subscriptionId": {
"type": "string",
"description": "(Optional) Used to subscribe for recording events.",
"example": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"maxLength": 80,
"minLength": 0
},
"assistantSkill": {
"$ref": "#/components/schemas/AssistantSkillMappingDTO",
"description": "Assistant Skill."
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"manuallyAssignable": {
"type": "boolean",
"description": "If `true`, the queue can be manually assigned.",
"example": false
},
"agentsLastUpdatedByUserName": {
"type": "string",
"description": "The name of the user who last modified the agents list."
},
"agentsLastUpdatedByUserEmailPrefix": {
"type": "string",
"description": "The email of the user who last modified the agents list."
},
"agentsLastUpdatedTime": {
"type": "integer",
"format": "int64",
"description": "The date when the agents list was last modified (epoch timestamp in milliseconds).",
"example": 1742553000000
},
"queueLevelSummariesInclusion": {
"type": "string",
"description": "Queue level summaries inclusion type. Used only when Queue inclusion for summaries is set to 'Specific Queues' at the org level AI Assistant->Summaries configuration.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.This is applicable/available only when AI Assistant add-on offer/license is added to the organization. If the value is missing in response, the consumer should assume a value as EXCLUDED.",
"example": "INCLUDED"
},
"queueLevelSentimentAnalysisInclusion": {
"type": "string",
"description": "Queue level sentiment analysis inclusion type. Used only when Queue inclusion for sentiment analysis is set to 'Specific Queues' at the org level AI Assistant->Quality Management configuration.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.This is applicable/available when either AI Assistant/AI Quality Management add-on offer/license is added to the organization. If the value is missing in response, the consumer should assume a value as EXCLUDED.",
"example": "INCLUDED"
},
"queueLevelPredictedWaitTimeInclusion": {
"type": "string",
"description": "Queue level predicted wait time inclusion type. Used only when Queue inclusion for predicted wait time is set to 'Specific Queues' at the org level AI Assistant->Predicted Wait Time configuration.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained. If the value is missing in response, the consumer should assume a value as EXCLUDED.",
"example": "INCLUDED"
},
"queueLevelAutoCsatInclusion": {
"type": "string",
"description": "Queue level auto CSAT inclusion type. Used only when Queue inclusion for auto CSAT is set to 'Specific Queues' at the org level AI Assistant->Auto CSAT configuration.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.This is applicable/available when either AI Assistant/AI Quality Management add-on offer/license is added to the organization. If the value is missing in response, the consumer should assume a value as EXCLUDED.",
"example": "INCLUDED"
},
"queueLevelRealTimeTranscriptionsInclusion": {
"type": "string",
"description": "Queue level real time transcriptions inclusion type. Used only when Queue inclusion for real time transcriptions is set to 'Specific Queues' at the org level AI Assistant->Real Time Transcriptions configuration.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.This is applicable/available when either AI Assistant/AI Quality Management add-on offer/license is added to the organization. If the value is missing in response, the consumer should assume a value as EXCLUDED.",
"example": "INCLUDED"
},
"personalizedAIRouting": {
"$ref": "#/components/schemas/QueuePersonalizedAIRoutingDTO",
"description": "Personalized AI Routing configuration for this queue. Controls AI-based intelligent routing to optimize agent selection based on ML predictions. When enabled, contacts are routed to agents predicted to have the best outcome based on configured KPIs. Requires 'personalized-ai-routing' permission and feature flag enablement. See QueuePersonalizedAIRoutingDTO for state transition requirements."
},
"pauseAndResume": {
"$ref": "#/components/schemas/QueuePauseAndResumeDTO",
"description": "Pause and resume configuration for EMAIL and SOCIAL channels only"
},
"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": [
"active",
"callDistributionGroups",
"channelType",
"checkAgentAvailability",
"maxActiveContacts",
"maxTimeInQueue",
"name",
"queueRoutingType",
"queueType",
"routingType",
"serviceLevelThreshold"
]
},
"QueueSkillRequirementDTO": {
"type": "object",
"description": "Skill requirement for the queue",
"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
},
"skillId": {
"type": "string",
"description": "Skill ID reference",
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"minLength": 1
},
"skillName": {
"type": "string",
"description": "Indicates the name of the skill. Once created, name cannot be modified.",
"example": "German Speaking"
},
"skillType": {
"type": "string",
"description": "This can be of the following types\n\nPROFICIENCY: id = 0\n\nBOOLEAN: id = 1\n\nTEXT: id = 2\n\nENUM: id = 3\n\nOnce created, skillType cannot be modified.\n",
"example": "BOOLEAN"
},
"condition": {
"type": "string",
"description": "Indicates a value that represents a skill the agent has.",
"example": "IS_NOT"
},
"skillValue": {
"type": "string",
"description": "A short textual description that represents a skill the agent has.",
"example": "Credit card SME",
"minLength": 1
},
"weight": {
"type": "integer",
"format": "int32",
"description": "Weight for proficiency skill requirement",
"example": 100,
"maximum": 1000
},
"dynamicSkill": {
"type": "boolean",
"description": "Indicates whether the skill is a dynamic skill or not. Default value is false.",
"example": false
},
"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": [
"condition",
"skillId",
"skillValue"
]
},
"QueueAgentsDTO": {
"type": "object",
"description": "Queue Agents schema.",
"properties": {
"id": {
"type": "string",
"description": "Id of an agent in WxCC",
"example": "b0503c7f-d13c-4d74-9eb5-64f3c818b8c7"
},
"ciUserId": {
"type": "string",
"description": "Id of an agent in Common Identity",
"example": "c71876ae-ddfa-4049-9a1b-298535152578"
}
},
"required": [
"id"
]
},
"CallDistributionGroupDTO": {
"type": "object",
"description": "Call Distribution Group schema.",
"properties": {
"agentGroups": {
"type": "array",
"description": "List of Agent Groups.",
"items": {
"$ref": "#/components/schemas/AgentGroupDTO",
"description": "Agent Group."
},
"uniqueItems": true
},
"order": {
"type": "integer",
"format": "int32",
"description": "The order of this call distribution group.",
"example": 1
},
"duration": {
"type": "integer",
"format": "int32",
"default": 0,
"description": "(Optional)The duration in seconds after which a contact in queue will be distributed to this group.",
"example": 2
}
}
},
"AgentGroupDTO": {
"type": "object",
"description": "Agent Group schema.",
"properties": {
"teamId": {
"type": "string",
"description": "ID of a team",
"example": "93912f11-6017-404b-bf14-5331890b1797"
}
}
},
"ResponseEnvelopeSkillBasedCSQDTO": {
"type": "object",
"description": "Response Envelope Skill Based CSQ schema.",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"description": "Meta additional property."
},
"description": "Additional properties for Meta."
},
"data": {
"type": "array",
"description": "List of Data.",
"items": {
"$ref": "#/components/schemas/SkillBasedCSQDTO",
"description": "Data item."
}
}
}
},
"SkillBasedCSQDTO": {
"type": "object",
"description": "Contact service queue projection enriched with skill-based routing metadata. Returned by the skill-profile lookup endpoints (`/contact-service-queue/by-skill-profile-id/{id}` and `/contact-service-queue/internal/by-skill-profile-id/{id}`). Extends MappedCSQDTO with the score and match flags computed while evaluating the queue's skill requirements against the caller's skill profile and dynamic skills.",
"example": {
"id": "26e2df70-0f77-41b8-8e8f-1d76e92c9638",
"name": "SupportQueue",
"channelType": "TELEPHONY",
"skillScore": 85,
"qsrType": "PROFICIENCY",
"dynamicSkillScore": 70,
"skillProfileSkillsMatch": true,
"dynamicSkillsMatch": true
},
"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",
"format": "uuid",
"description": "Unique identifier of the contact service queue.",
"example": "26e2df70-0f77-41b8-8e8f-1d76e92c9638"
},
"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
},
"channelType": {
"type": "string",
"description": "Channel type of the contact service queue (for example, `TELEPHONY`, `CHAT`, `EMAIL`, `SOCIAL`).",
"example": "TELEPHONY"
},
"name": {
"type": "string",
"description": "Display name of the contact service queue.",
"example": "SupportQueue"
},
"skillScore": {
"type": "integer",
"format": "int32",
"description": "Aggregated score (0-100) of how well the queue's static skill requirements match the caller's skill profile. Higher is a better match.",
"example": 85
},
"qsrType": {
"type": "string",
"description": "Type of queue skill requirement evaluated. Typical values: `PROFICIENCY`, `TEXT`, `BOOLEAN`, `ENUM`.",
"example": "PROFICIENCY"
},
"dynamicSkillScore": {
"type": "integer",
"format": "int32",
"description": "Aggregated score (0-100) of how well the queue's dynamic skill requirements match the caller's supplied dynamic skill values.",
"example": 70
},
"skillProfileSkillsMatch": {
"type": "boolean",
"description": "`true` if every static skill requirement defined on the queue is satisfied by the caller's skill profile.",
"example": true
},
"dynamicSkillsMatch": {
"type": "boolean",
"description": "`true` if every dynamic skill requirement defined on the queue is satisfied by the caller's dynamic skill values.",
"example": true
},
"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
}
}
},
"SkillBasedQueueRequestDTO": {
"type": "object",
"description": "Request payload used to look up skill-based contact service queues. Supply skillProfileId together with either a userId (to scope by a specific agent) or a list of dynamicSkills (to scope by dynamic skill values). For endpoints that filter by userId, omit dynamicSkills; for endpoints that filter by dynamic skills, omit userId.",
"example": {
"skillProfileId": "af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"userId": "660e0a5a-8230-47d7-ae98-047fb180e1ff",
"dynamicSkills": [
{
"skillId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"proficiencyValue": 7
}
]
},
"properties": {
"skillProfileId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the skill profile to look up queues for.",
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
"dynamicSkills": {
"type": "array",
"description": "Dynamic skill values used to further narrow down the matching skill-based queues. Used by the dynamic-skills lookup endpoint.",
"items": {
"$ref": "#/components/schemas/DynamicSkillDTO",
"description": "Dynamic Skill."
}
},
"userId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the user (agent) whose skill-based queues should be retrieved. Used by the user-and-skill-profile lookup endpoint.",
"example": "660e0a5a-8230-47d7-ae98-047fb180e1ff"
}
}
},
"DynamicSkillDTO": {
"type": "object",
"description": "Data transfer object representing a dynamic skill assignment with its value",
"properties": {
"skillId": {
"type": "string",
"description": "The unique identifier of the dynamic skill",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"textValue": {
"type": "string",
"description": "Text value for text-type dynamic skills",
"example": "Sample text skill value"
},
"booleanValue": {
"type": "boolean",
"description": "Boolean value for boolean-type dynamic skills",
"example": true
},
"proficiencyValue": {
"type": "integer",
"format": "int32",
"description": "Proficiency value for proficiency-type dynamic skills (range: 0-10)",
"example": 7
},
"enumSkillValues": {
"type": "array",
"description": "Set of enumerated skill values for enum-type dynamic skills",
"example": [
"SKILL_VALUE_1",
"SKILL_VALUE_2"
],
"items": {
"type": "string",
"description": "Enum Skill Value."
},
"uniqueItems": true
}
}
},
"ResponseEnvelopeMappedCSQDTO": {
"type": "object",
"description": "Response Envelope Mapped CSQ schema.",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"description": "Meta additional property."
},
"description": "Additional properties for Meta."
},
"data": {
"type": "array",
"description": "List of Data.",
"items": {
"$ref": "#/components/schemas/MappedCSQDTO",
"description": "Data item."
}
}
}
},
"MappedCSQDTO": {
"type": "object",
"description": "Lightweight contact service queue projection returned by queue-mapping lookup endpoints (by team ID, by CI user ID, by skill profile ID, by manually assignable queues). Contains only the minimum fields required to identify a queue and its channel type.",
"example": {
"id": "26e2df70-0f77-41b8-8e8f-1d76e92c9638",
"name": "SupportQueue",
"channelType": "TELEPHONY"
},
"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",
"format": "uuid",
"description": "Unique identifier of the contact service queue.",
"example": "26e2df70-0f77-41b8-8e8f-1d76e92c9638"
},
"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
},
"channelType": {
"type": "string",
"description": "Channel type of the contact service queue (for example, `TELEPHONY`, `CHAT`, `EMAIL`, `SOCIAL`).",
"example": "TELEPHONY"
},
"name": {
"type": "string",
"description": "Display name of the contact service queue.",
"example": "SupportQueue"
},
"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
}
}
},
"ManuallyAssignableQueuesRequest": {
"type": "object",
"description": "Request payload used to fetch contact service queues that are eligible for manual contact assignment for the specified agent and team.",
"example": {
"agentId": "660e0a5a-8230-47d7-ae98-047fb180e1ff",
"teamId": "76cf35bc-12df-49ef-88e1-c86226d8a645"
},
"properties": {
"agentId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the agent (CI user ID) for whom manually assignable queues should be retrieved.",
"example": "660e0a5a-8230-47d7-ae98-047fb180e1ff"
},
"teamId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the team that the agent belongs to. Used to scope the queues that the agent can be manually assigned contacts from.",
"example": "76cf35bc-12df-49ef-88e1-c86226d8a645"
}
}
},
"MetaDataPagedCSQ": {
"type": "object",
"description": "Meta Data Paged CSQ schema.",
"properties": {
"orgid": {
"type": "string",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
"page": {
"type": "integer",
"format": "int32",
"description": "Current page number.",
"example": 1
},
"pageSize": {
"type": "integer",
"format": "int32",
"description": "Page size for current data set.",
"example": 20
},
"totalPages": {
"type": "integer",
"format": "int32",
"description": "Number of pages.",
"example": 5
},
"totalRecords": {
"type": "integer",
"format": "int64",
"description": "Total number of items.",
"example": 100
},
"links": {
"type": "object",
"$ref": "#/components/schemas/PaginationLinks",
"additionalProperties": {
"type": "string",
"description": "Links additional property."
},
"description": "Pagination links for navigating between result pages."
},
"actualSummariesInclusionCount": {
"type": "integer",
"format": "int64",
"description": "Indicates the actual number of queues included for AI assistant-generated summaries in a given organization, including queues that are access-restricted for the user requesting the data.",
"example": 100
}
}
},
"ResponseEnvelopeRoutingBasedQueueDTO": {
"type": "object",
"description": "Response Envelope Routing Based Queue schema.",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"description": "Meta additional property."
},
"description": "Additional properties for Meta."
},
"data": {
"type": "array",
"description": "List of Data.",
"items": {
"$ref": "#/components/schemas/RoutingBasedQueueDTO",
"description": "Data item."
}
}
}
},
"RoutingBasedQueueDTO": {
"type": "object",
"description": "Lightweight representation of a contact service queue that an agent (user) is associated with through a particular routing pattern. Returned by the team-based, agent-based and skill-based by-user-id lookups; the `routingPattern` field indicates how the agent reaches this queue (for example, TEAM_BASED, AGENT_BASED, or SKILLS_BASED).",
"example": {
"id": "26e2df70-0f77-41b8-8e8f-1d76e92c9638",
"name": "SupportQueue",
"routingPattern": "TEAM_BASED"
},
"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",
"format": "uuid",
"description": "Unique identifier of the contact service queue.",
"example": "26e2df70-0f77-41b8-8e8f-1d76e92c9638"
},
"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": "Display name of the contact service queue.",
"example": "SupportQueue"
},
"routingPattern": {
"type": "string",
"description": "Routing pattern through which the agent is associated with this queue. Typical values: `TEAM_BASED`, `AGENT_BASED`, `SKILLS_BASED`.",
"example": "TEAM_BASED"
},
"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
}
}
},
"CSQGroupedAssistantSkillRequestDTO": {
"type": "object",
"description": "Request payload for fetching queue mapping summary grouped by Assistant Skill",
"properties": {
"assistantSkillIds": {
"type": "array",
"description": "List of AssistantSkill ids to fetch. If property is unspecified or set to null, then all assistantSkillIds mapped will be returned.",
"example": [
"f53c8b54-46ca-43f6-ba05-08426a46e23d",
"a53c8b54-46ca-43f6-ba05-08426a46e23f"
],
"items": {
"type": "string",
"description": "Assistant Skill Id."
},
"uniqueItems": true
}
}
},
"ResponseEnvelopeCSQGroupedAssistantSkillResponseDTO": {
"type": "object",
"description": "Response Envelope CSQGrouped Assistant Skill Response schema.",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"description": "Meta additional property."
},
"description": "Additional properties for Meta."
},
"data": {
"type": "array",
"description": "List of Data.",
"items": {
"$ref": "#/components/schemas/CSQGroupedAssistantSkillResponseDTO",
"description": "Data item."
}
}
}
},
"CSQGroupedAssistantSkillResponseDTO": {
"type": "object",
"description": "Queue mapping summary per Assistant Skill",
"properties": {
"assistantSkillId": {
"type": "string",
"description": "ID of Assistant Skill in AI Studio",
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
"associatedQueueCount": {
"type": "integer",
"format": "int64",
"description": "Number of queues mapped to this Assistant Skill ID"
},
"lastAssistantSkillUpdatedTime": {
"type": "integer",
"format": "int64",
"description": "Last updated time Assistant Skill mapping i.e. timestamp corresponding to most recently added queue mapping"
}
}
},
"ReassignAgentsRequestDTO": {
"type": "object",
"description": "Reassign Agents Request schema.",
"properties": {
"add": {
"type": "array",
"description": "List of Add.",
"items": {
"type": "string",
"description": "Add item."
},
"uniqueItems": true
},
"remove": {
"type": "array",
"description": "List of Remove.",
"items": {
"type": "string",
"description": "Remove item."
},
"uniqueItems": true
}
}
},
"ResponseMetaEnvelopeContactServiceQueueDTOMetaDataPagedInfo": {
"type": "object",
"description": "Response Meta Envelope Contact Service Queue Meta Data Paged Info schema.",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaDataPagedInfo",
"description": "Metadata about response."
},
"data": {
"type": "array",
"description": "List of items matching the entity type.",
"items": {
"$ref": "#/components/schemas/ContactServiceQueueDTO",
"description": "Data item."
}
}
}
},
"DesktopLayoutDTO": {
"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 Desktop Layout.",
"example": "New Desktop Layout",
"maxLength": 255,
"minLength": 0
},
"description": {
"type": "string",
"description": "A short description indicating the context of the Desktop Layout.",
"example": "This is the global layout",
"maxLength": 255,
"minLength": 0
},
"editedBy": {
"type": "string",
"description": "Indicates who modified the Desktop Layout.",
"example": "System",
"maxLength": 255,
"minLength": 0
},
"jsonFileName": {
"type": "string",
"description": "Enter the name of the file.",
"example": "Desktop Layout.json",
"maxLength": 255,
"minLength": 0
},
"jsonFileContent": {
"type": "string",
"description": "Enter the Desktop Layout json.",
"example": {
"version": "0.0.6",
"appTitle": "Contact Center Desktop",
"logo": "",
"dragDropEnabled": false,
"notificationTimer": 8,
"maximumNotificationCount": 3,
"browserNotificationTimer": 8,
"wxmConfigured": false,
"area": {
"headless": {
"id": "dw-headless",
"widgets": {
"comp1": {
"comp": "div"
}
},
"layout": {
"areas": [
[
"comp1"
]
],
"size": {
"cols": [
1
],
"rows": [
1
]
}
}
}
}
},
"minLength": 1
},
"global": {
"type": "boolean",
"description": "Indicates if the Desktop Layout is a global layout or a custom layout.",
"example": true
},
"status": {
"type": "boolean",
"description": "Indicates if the Desktop Layout is in active state or inactive.",
"example": true
},
"defaultJsonModified": {
"type": "boolean",
"description": "Indicates if the default Desktop Layout is modified.",
"example": true
},
"validated": {
"type": "boolean",
"description": "Indicates if the Desktop Layout is validated.",
"example": false
},
"validatedTime": {
"type": "integer",
"format": "int64",
"description": "Validated time(in epoch milliseconds) of this resource.",
"example": 1617536244000
},
"defaultJsonModifiedTime": {
"type": "integer",
"format": "int64",
"description": "Default Json Modified time(in epoch milliseconds) of this resource.",
"example": 1617536244000
},
"modifiedTime": {
"type": "integer",
"format": "int64",
"description": "Modified time(in epoch milliseconds) of this resource.",
"example": 1617536244000
},
"teamIds": {
"type": "array",
"description": "Specify the teams id to assign to this Desktop Layout.",
"example": [
"f53c8b54-46ca-43f6-ba05-08426a46e23d",
"a53c8b54-46ca-43f6-ba05-08426a46e23f"
],
"items": {
"type": "string",
"description": "Specify the teams id to assign to this Desktop Layout.",
"example": [
"f53c8b54-46ca-43f6-ba05-08426a46e23d",
"a53c8b54-46ca-43f6-ba05-08426a46e23f"
]
},
"uniqueItems": true
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"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": [
"defaultJsonModified",
"editedBy",
"global",
"jsonFileContent",
"jsonFileName",
"name",
"status",
"validated"
]
},
"BulkRequestDTODesktopLayoutDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTODesktopLayoutDTO"
}
}
}
},
"BulkRequestItemDTODesktopLayoutDTO": {
"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/DesktopLayoutDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"ResponseEnvelopeDesktopLayoutDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DesktopLayoutDTO"
}
}
}
},
"AgentProfileResponseDTOList": {
"type": "object",
"description": "Agent Profile Response schema.",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Enter a name for the agent profile.",
"example": "Agent-Profile(Auto WrapUp)",
"maxLength": 80,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\._\\s\\-\\(\\)]+$"
},
"description": {
"type": "string",
"description": "(Optional) Enter a description of the profile.",
"example": "This profile allows agent to auto wrap-up time and extend the wrap-up time.",
"maxLength": 255,
"minLength": 0
},
"parentType": {
"type": "string",
"description": "This can be the following\n\nORGANIZATION: The agent profile is available to all sites at your enterprise.\n\nSITE: The agent profile is available to a specific site.",
"enum": [
"ORGANIZATION",
"SITE"
],
"example": "SITE"
},
"siteId": {
"type": "string",
"description": "Identifier for a site which is a physical contact center location under the control of your enterprise. ",
"example": "8e6bb6da-2a78-4768-bef9-7e229f92af22"
},
"screenPopup": {
"type": "boolean",
"description": "Indicates whether to allow external pop-up screens(true) or not(false).",
"example": true
},
"lastAgentRouting": {
"type": "boolean",
"description": "This setting use only if your administrator enables the Last Agent Routing feature for your enterprise. Indicates whether to allow Last Agent Routing check box on the Agent Desktop during wrap-up(true) or not(false).",
"example": true
},
"scheduleAndManageCallBack": {
"type": "boolean",
"description": "Indicates whether to allow agents to schedule and manage callbacks(true) or not(false).",
"example": true
},
"autoWrapUp": {
"type": "boolean",
"description": "Indicates whether to allow auto wrap-up(true) or not(false).",
"example": true
},
"agentPersonalGreeting": {
"type": "boolean",
"description": "Indicates whether an agent can record a personal greeting(true) or not(false) from the agent desktop.",
"example": true
},
"autoAnswer": {
"type": "boolean",
"description": "Indicates whether incoming calls on the Agent Desktop need to be answered automatically(true) or not(false).",
"example": true
},
"autoWrapAfterSeconds": {
"type": "integer",
"format": "int32",
"description": "This setting allows auto wrap-up after seconds",
"example": 15
},
"agentAvailableAfterOutdial": {
"type": "boolean",
"description": "Enabled if you want the agent to go into the Available state after completing and wrapping up an outdial call. The agent can also manually select an Idle state from the STATUS NOW drop-down list before selecting a wrap-up code.\n",
"example": true
},
"allowAutoWrapUpExtension": {
"type": "boolean",
"description": "Indicates whether to allow auto wrap-up extension(true) or not(false).",
"example": true
},
"accessWrapUpCode": {
"type": "string",
"description": "Specify the wrap-up codes that the agents can select when they wrap up a contact.It can take one of these values:\n\nALL \u2014 To make all wrap-up codes available.\n\nSPECIFIC \u2014 To make specific codes available.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"wrapUpCodes": {
"type": "array",
"description": "Specify the wrap-up codes list that the agents can select when they wrap up a contact.",
"example": [
"WrapUp_Sale",
"WrapUp_Field"
],
"items": {
"type": "string",
"description": "Specify the wrap-up codes list that the agents can select when they wrap up a contact.",
"example": [
"WrapUp_Sale",
"WrapUp_Field"
]
},
"uniqueItems": true
},
"accessIdleCode": {
"type": "string",
"description": "Specify the Idle codes that the agents can select in Agent Desktop.It can take one of these values:\n\nALL \u2014 To make all idle codes available.\n\nSPECIFIC \u2014 To make specific codes available.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"idleCodes": {
"type": "array",
"description": "Specify the Idle codes list that the agents can select in Agent Desktop.",
"example": [
"aux_code_sale",
"aux_code2"
],
"items": {
"type": "string",
"description": "Specify the Idle codes list that the agents can select in Agent Desktop.",
"example": [
"aux_code_sale",
"aux_code2"
]
},
"uniqueItems": true
},
"accessQueue": {
"type": "string",
"description": "Specify the queues that the agents can select from the Queue drop-down list on the Agent Desktop.It can take one of these values:\n\nALL \u2014 To make all queues available.\n\nSPECIFIC \u2014 To make specific queues available\n\nNONE \u2014 If you do not want to make any queues available as transfer targets.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"accessEntryPoint": {
"type": "string",
"description": "Specify the entry points that the agents can select from the Entry Point drop-down list on the Agent Desktop.It can take one of these values:\n\nALL \u2014 To make all entry points available.\n\nSPECIFIC \u2014 To make specific entry points available\n\nNONE \u2014 If you do not want to make any entry points available as transfer targets.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"accessBuddyTeam": {
"type": "string",
"description": "Specify the teams that the agents can select from the Agent drop-down list on the Agent Desktop. It can take one of these values:\n\nALL \u2014 To make the agents on all teams available.\n\nSPECIFIC \u2014 To make agents on specific teams available, then select teams from the drop-down list\n\nNONE \u2014 If you do not want to make any teams available for consultation, conference, or call transfer.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"buddyTeams": {
"type": "array",
"description": "Specify the teams list that the agents can select from the Agent drop-down list on the Agent Desktop.",
"example": [
"5_Jan_Testing",
"7_Feb_Testing"
],
"items": {
"type": "string",
"description": "Specify the teams list that the agents can select from the Agent drop-down list on the Agent Desktop.",
"example": [
"5_Jan_Testing",
"7_Feb_Testing"
]
},
"uniqueItems": true
},
"consultToQueue": {
"type": "boolean",
"description": "Indicates whether you want the agent to be able to select a queue in the Queue drop-down list as a target for a consultation or not.",
"example": true
},
"outdialEnabled": {
"type": "boolean",
"description": "Indicates whether you want the agent to be able to make outdial calls(true) or not(false).",
"example": true
},
"outdialEntryPointId": {
"type": "string",
"description": "If you enabled Outdial, specify the entry point id that the agent can use to make outdial calls.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"outdialANIId": {
"type": "string",
"description": "This setting occurs only if you enabled Outdial. Specify the Outdial ANI id that the agent can use to make outdial calls.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"addressBookId": {
"type": "string",
"description": "Specify the address book id that includes the speed-dial numbers that the agent can select to make outdial and consult calls.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"dialPlanEnabled": {
"type": "boolean",
"description": "Indicates whether you want the agent to be able to make ad-hoc outdial calls(true) or not(false).",
"example": true
},
"dialPlans": {
"type": "array",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting appears only if Dial Plan is enabled. select the dial plans that determine the inputs that the system accepts in the Start a new call field. ",
"example": [
"US",
"Any Format"
],
"items": {
"type": "string",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting appears only if Dial Plan is enabled. select the dial plans that determine the inputs that the system accepts in the Start a new call field. ",
"example": [
"US",
"Any Format"
]
},
"uniqueItems": true
},
"timeoutDesktopInactivityCustomEnabled": {
"type": "boolean",
"description": "This setting enabled time out desktop inactivity feature.",
"example": true
},
"showUserDetailsMS": {
"type": "boolean",
"description": "Specify whether the show user details of microsoft account user enabled or not",
"example": true
},
"stateSynchronizationMS": {
"type": "boolean",
"description": "Specify whether the state synchronization of microsoft account user enabled or not",
"example": true
},
"showUserDetailsWebex": {
"type": "boolean",
"description": "Specify whether the show user details of webex account user enabled or not",
"example": true
},
"stateSynchronizationWebex": {
"type": "boolean",
"description": "Specify whether the state synchronization of webex account user enabled or not",
"example": true
},
"manageChannelAvailability": {
"type": "boolean",
"description": "Indicates whether the agent can manage channel availability(true) or not(false).",
"example": true
},
"timeoutDesktopInactivityMins": {
"type": "integer",
"format": "int32",
"description": "This setting occurs only if you enabled time out desktop inactivity feature. Specify time in minute(s).",
"example": 5,
"maximum": 10000,
"minimum": 3
},
"agentDNValidation": {
"type": "string",
"description": "Specifies the validation applied when an agent logs in with a DN. \n**Supported values going forward:** `ALL` (Unrestricted \u2014 agents may use any DN) and \n`PROVISIONED_VALUE` (login DN restricted to the value provisioned for the agent). \n**Note:** `SPECIFIC` (Validation Criteria) is no longer supported and must not be used \nfor new or updated profiles.\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"agentDNValidationCriteria": {
"type": "string",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting occurs only if you select Validation Criteria in the Validation For Agent DN.",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "SPECIFIC"
},
"agentDNValidationCriterions": {
"type": "array",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN.",
"example": [
"DN_5_Sept",
"DN_7_Jan"
],
"items": {
"type": "string",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN.",
"example": [
"DN_5_Sept",
"DN_7_Jan"
]
},
"uniqueItems": true
},
"loginVoiceOptions": {
"type": "array",
"description": "List of Login Voice Options.",
"items": {
"type": "string",
"description": "Login voice options.",
"enum": [
"AGENT_DN",
"EXTENSION",
"BROWSER"
],
"example": "AGENT_DN"
},
"uniqueItems": true
},
"active": {
"type": "boolean",
"description": "Specify whether the agent profile is active or not Active.",
"example": true
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"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
},
"autoAcceptDigitalInteractions": {
"type": "boolean",
"description": "Automatically accept digital interactions when agent becomes available",
"example": false
}
}
},
"AgentProfileDTO": {
"type": "object",
"description": "Agent Profile schema.",
"example": {
"name": "Agent-Profile(Auto WrapUp)",
"description": "This profile allows agent to auto wrap-up time and extend the wrap-up time.",
"parentType": "SITE",
"siteId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"screenPopup": true,
"lastAgentRouting": true,
"scheduleAndManageCallBack": true,
"autoWrapUp": true,
"agentPersonalGreeting": true,
"autoAnswer": true,
"autoWrapAfterSeconds": 15,
"agentAvailableAfterOutdial": true,
"allowAutoWrapUpExtension": true,
"accessWrapUpCode": "ALL",
"wrapUpCodes": [
"WrapUp_Sale",
"WrapUp_Field"
],
"accessIdleCode": "ALL",
"idleCodes": [
"aux_code_sale",
"aux_code2"
],
"accessQueue": "ALL",
"queues": [
"apim_queue_516789",
"apim_queue_6123456"
],
"accessEntryPoint": "ALL",
"entryPoints": [
"apim_entry_516789",
"apim_entry_6123456"
],
"accessBuddyTeam": "ALL",
"buddyTeams": [
"5_Jan_Testing",
"7_Feb_Testing"
],
"consultToQueue": true,
"outdialEnabled": true,
"outdialEntryPointId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"outdialANIId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"addressBookId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"dialPlanEnabled": true,
"dialPlans": [
"US",
"Any Format"
],
"timeoutDesktopInactivityCustomEnabled": true,
"showUserDetailsMS": true,
"stateSynchronizationMS": true,
"showUserDetailsWebex": true,
"stateSynchronizationWebex": true,
"manageChannelAvailability": true,
"timeoutDesktopInactivityMins": 5,
"agentDNValidation": "ALL",
"agentDNValidationCriteria": "ALL",
"agentDNValidationCriterions": [],
"loginVoiceOptions": [
"AGENT_DN"
],
"viewableStatistics": {
"agentStats": true,
"accessQueueStats": "SPECIFIC",
"contactServiceQueues": [
"apim_queue_516789",
"apim_queue_6123456"
],
"loggedInTeamStats": true,
"accessTeamStats": "SPECIFIC",
"teams": [
"apim_team_516789",
"apim_team_6123456"
]
},
"thresholdRules": [
"Threshold_monitor_agent",
"Threshold_call_data"
],
"active": true
},
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Enter a name for the agent profile.",
"example": "Agent-Profile(Auto WrapUp)",
"maxLength": 80,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\._\\s\\-\\(\\)]+$"
},
"description": {
"type": "string",
"description": "(Optional) Enter a description of the profile.",
"example": "This profile allows agent to auto wrap-up time and extend the wrap-up time.",
"maxLength": 255,
"minLength": 0
},
"parentType": {
"type": "string",
"description": "This can be the following\n\nORGANIZATION: The agent profile is available to all sites at your enterprise.\n\nSITE: The agent profile is available to a specific site.",
"enum": [
"ORGANIZATION",
"SITE"
],
"example": "SITE"
},
"siteId": {
"type": "string",
"description": "Identifier for a site which is a physical contact center location under the control of your enterprise. ",
"example": "8e6bb6da-2a78-4768-bef9-7e229f92af22"
},
"screenPopup": {
"type": "boolean",
"description": "Indicates whether to allow external pop-up screens(true) or not(false).",
"example": true
},
"lastAgentRouting": {
"type": "boolean",
"description": "This setting use only if your administrator enables the Last Agent Routing feature for your enterprise. Indicates whether to allow Last Agent Routing check box on the Agent Desktop during wrap-up(true) or not(false).",
"example": true
},
"scheduleAndManageCallBack": {
"type": "boolean",
"description": "Indicates whether to allow agents to schedule and manage callbacks(true) or not(false).",
"example": true
},
"autoWrapUp": {
"type": "boolean",
"description": "Indicates whether to allow auto wrap-up(true) or not(false).",
"example": true
},
"autoAnswer": {
"type": "boolean",
"description": "Indicates whether incoming calls on the Agent Desktop need to be answered automatically(true) or not(false).",
"example": true
},
"agentPersonalGreeting": {
"type": "boolean",
"description": "Indicates whether an agent can record a personal greeting(true) or not(false) from the agent desktop.",
"example": true
},
"autoWrapAfterSeconds": {
"type": "integer",
"format": "int32",
"description": "This setting allows auto wrap-up after seconds",
"example": 15
},
"agentAvailableAfterOutdial": {
"type": "boolean",
"description": "Enabled if you want the agent to go into the Available state after completing and wrapping up an outdial call. The agent can also manually select an Idle state from the STATUS NOW drop-down list before selecting a wrap-up code.\n",
"example": true
},
"allowAutoWrapUpExtension": {
"type": "boolean",
"description": "Indicates whether to allow auto wrap-up extension(true) or not(false).",
"example": true
},
"accessWrapUpCode": {
"type": "string",
"description": "Specify the wrap-up codes that the agents can select when they wrap up a contact.It can take one of these values:\n\nALL \u2014 To make all wrap-up codes available.\n\nSPECIFIC \u2014 To make specific codes available.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"wrapUpCodes": {
"type": "array",
"description": "Specify the wrap-up codes list that the agents can select when they wrap up a contact.",
"example": [
"WrapUp_Sale",
"WrapUp_Field"
],
"items": {
"type": "string",
"description": "Specify the wrap-up codes list that the agents can select when they wrap up a contact.",
"example": [
"WrapUp_Sale",
"WrapUp_Field"
]
},
"uniqueItems": true
},
"accessIdleCode": {
"type": "string",
"description": "Specify the Idle codes that the agents can select in Agent Desktop.It can take one of these values:\n\nALL \u2014 To make all idle codes available.\n\nSPECIFIC \u2014 To make specific codes available.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"idleCodes": {
"type": "array",
"description": "Specify the Idle codes list that the agents can select in Agent Desktop.",
"example": [
"aux_code_sale",
"aux_code2"
],
"items": {
"type": "string",
"description": "Specify the Idle codes list that the agents can select in Agent Desktop.",
"example": [
"aux_code_sale",
"aux_code2"
]
},
"uniqueItems": true
},
"accessQueue": {
"type": "string",
"description": "Specify the queues that the agents can select from the Queue drop-down list on the Agent Desktop.It can take one of these values:\n\nALL \u2014 To make all queues available.\n\nSPECIFIC \u2014 To make specific queues available\n\nNONE \u2014 If you do not want to make any queues available as transfer targets.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"queues": {
"type": "array",
"description": "Specify the queues list that the agents can select from the Queue drop-down list on the Agent Desktop.",
"example": [
"apim_queue_516789",
"apim_queue_6123456"
],
"items": {
"type": "string",
"description": "Specify the queues list that the agents can select from the Queue drop-down list on the Agent Desktop.",
"example": [
"apim_queue_516789",
"apim_queue_6123456"
]
},
"uniqueItems": true
},
"accessEntryPoint": {
"type": "string",
"description": "Specify the entry points that the agents can select from the Entry Point drop-down list on the Agent Desktop.It can take one of these values:\n\nALL \u2014 To make all entry points available.\n\nSPECIFIC \u2014 To make specific entry points available\n\nNONE \u2014 If you do not want to make any entry points available as transfer targets.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"entryPoints": {
"type": "array",
"description": "Specify the entry points list that the agents can select from the Entry Point drop-down list on the Agent Desktop.",
"example": [
"apim_entry_516789",
"apim_entry_6123456"
],
"items": {
"type": "string",
"description": "Specify the entry points list that the agents can select from the Entry Point drop-down list on the Agent Desktop.",
"example": [
"apim_entry_516789",
"apim_entry_6123456"
]
},
"uniqueItems": true
},
"accessBuddyTeam": {
"type": "string",
"description": "Specify the teams that the agents can select from the Agent drop-down list on the Agent Desktop. It can take one of these values:\n\nALL \u2014 To make the agents on all teams available.\n\nSPECIFIC \u2014 To make agents on specific teams available, then select teams from the drop-down list\n\nNONE \u2014 If you do not want to make any teams available for consultation, conference, or call transfer.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"buddyTeams": {
"type": "array",
"description": "Specify the teams list that the agents can select from the Agent drop-down list on the Agent Desktop.",
"example": [
"5_Jan_Testing",
"7_Feb_Testing"
],
"items": {
"type": "string",
"description": "Specify the teams list that the agents can select from the Agent drop-down list on the Agent Desktop.",
"example": [
"5_Jan_Testing",
"7_Feb_Testing"
]
},
"uniqueItems": true
},
"consultToQueue": {
"type": "boolean",
"description": "Indicates whether you want the agent to be able to select a queue in the Queue drop-down list as a target for a consultation or not.",
"example": true
},
"outdialEnabled": {
"type": "boolean",
"description": "Indicates whether you want the agent to be able to make outdial calls(true) or not(false).",
"example": true
},
"outdialEntryPointId": {
"type": "string",
"description": "If you enabled Outdial, specify the entry point id that the agent can use to make outdial calls.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"outdialANIId": {
"type": "string",
"description": "This setting occurs only if you enabled Outdial. Specify the Outdial ANI id that the agent can use to make outdial calls.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"addressBookId": {
"type": "string",
"description": "Specify the address book id that includes the speed-dial numbers that the agent can select to make outdial and consult calls.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"dialPlanEnabled": {
"type": "boolean",
"description": "Indicates whether you want the agent to be able to make ad-hoc outdial calls(true) or not(false).",
"example": true
},
"dialPlans": {
"type": "array",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting appears only if Dial Plan is enabled. select the dial plans that determine the inputs that the system accepts in the Start a new call field. ",
"example": [
"US",
"Any Format"
],
"items": {
"type": "string",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting appears only if Dial Plan is enabled. select the dial plans that determine the inputs that the system accepts in the Start a new call field. ",
"example": [
"US",
"Any Format"
]
},
"uniqueItems": true
},
"agentDNValidation": {
"type": "string",
"description": "Specifies the validation applied when an agent logs in with a DN. \n**Supported values going forward:** `ALL` (Unrestricted \u2014 agents may use any DN) and \n`PROVISIONED_VALUE` (login DN restricted to the value provisioned for the agent). \n**Note:** `SPECIFIC` (Validation Criteria) is no longer supported and must not be used \nfor new or updated profiles.\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"agentDNValidationCriteria": {
"type": "string",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting occurs only if you select Validation Criteria in the Validation For Agent DN.",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "SPECIFIC"
},
"agentDNValidationCriterions": {
"type": "array",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN.",
"example": [
"DN_5_Sept",
"DN_7_Jan"
],
"items": {
"type": "string",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN.",
"example": [
"DN_5_Sept",
"DN_7_Jan"
]
},
"uniqueItems": true
},
"loginVoiceOptions": {
"type": "array",
"description": "Login voice options.",
"example": [
"AGENT_DN",
"EXTENSION",
"BROWSER"
],
"items": {
"type": "string",
"description": "Login voice options.",
"enum": [
"AGENT_DN",
"EXTENSION",
"BROWSER"
],
"example": "AGENT_DN"
},
"uniqueItems": true
},
"viewableStatistics": {
"$ref": "#/components/schemas/ViewableStatisticsDTO",
"description": " Specifies the Statistics that agent of this profile can view.\n "
},
"thresholdRules": {
"type": "array",
"description": "The Agent Thresholds page appears only if your enterprise uses the Threshold Alerts feature.\nIf your enterprise uses the Agent Threshold Alerts feature, the page also provides settings to specify the thresholds associated with the agent.",
"example": [
"Threshold_monitor_agent",
"Threshold_call_data"
],
"items": {
"type": "string",
"description": "The Agent Thresholds page appears only if your enterprise uses the Threshold Alerts feature.\nIf your enterprise uses the Agent Threshold Alerts feature, the page also provides settings to specify the thresholds associated with the agent.",
"example": [
"Threshold_monitor_agent",
"Threshold_call_data"
]
},
"uniqueItems": true
},
"active": {
"type": "boolean",
"description": "Specify whether the agent profile is active or not Active.",
"example": true
},
"timeoutDesktopInactivityCustomEnabled": {
"type": "boolean",
"description": "This setting enabled time out desktop inactivity feature.",
"example": true
},
"showUserDetailsMS": {
"type": "boolean",
"description": "Specify whether the show user details of microsoft account user enabled or not",
"example": true
},
"stateSynchronizationMS": {
"type": "boolean",
"description": "Specify whether the state synchronization of microsoft account user enabled or not",
"example": true
},
"showUserDetailsWebex": {
"type": "boolean",
"description": "Specify whether the show user details of webex account user enabled or not",
"example": true
},
"stateSynchronizationWebex": {
"type": "boolean",
"description": "Specify whether the state synchronization of webex account user enabled or not",
"example": true
},
"manageChannelAvailability": {
"type": "boolean",
"description": "Indicates whether the agent can manage channel availability(true) or not(false).",
"example": true
},
"timeoutDesktopInactivityMins": {
"type": "integer",
"format": "int32",
"description": "This setting occurs only if you enabled time out desktop inactivity feature. Specify time in minute(s).",
"example": 5,
"maximum": 10000,
"minimum": 3
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"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
},
"autoAcceptDigitalInteractions": {
"type": "boolean",
"description": "Automatically accept digital interactions when agent becomes available",
"example": false
}
},
"required": [
"accessBuddyTeam",
"accessEntryPoint",
"accessIdleCode",
"accessQueue",
"accessWrapUpCode",
"active",
"agentDNValidation",
"name",
"parentType",
"viewableStatistics"
]
},
"ViewableStatisticsDTO": {
"type": "object",
"description": " Specifies the Statistics that agent of this profile can view.\n ",
"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
},
"agentStats": {
"type": "boolean",
"description": "Indicates whether you want the agents to view their personal statistics in Agent Desktop or not.",
"example": true
},
"accessQueueStats": {
"type": "string",
"description": "This setting controls whether the agent can view statistics for all or some queues in the Agent Personal Statistics tab.It can take one of these values:\n\nALL \u2014 To enable the agent to display statistics for all queues.\n\nSPECIFIC \u2014 Select Queues drop-down list to enable the agent to display statistics for specific queues.\n\nNONE \u2014 To prevent the agent from displaying queue statistics.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "SPECIFIC"
},
"contactServiceQueues": {
"type": "array",
"description": "This setting should be specified when Access Queue Statistics is SPECIFIC.",
"example": [
"apim_queue_516789",
"apim_queue_6123456"
],
"items": {
"type": "string",
"description": "This setting should be specified when Access Queue Statistics is SPECIFIC.",
"example": [
"apim_queue_516789",
"apim_queue_6123456"
]
},
"uniqueItems": true
},
"loggedInTeamStats": {
"type": "boolean",
"description": "Indicates whether the agent can view statistics for the team or not.",
"example": true
},
"accessTeamStats": {
"type": "string",
"description": "This setting controls whether the agent can view statistics for all or some teams in the Agent Personal Statistics tab.It can take one of these values:\n\nALL \u2014 To enable the agent to display statistics for all teams.\n\nSPECIFIC \u2014 Select Teams drop-down list to enable the agent to display statistics for specific teams.\n\nNONE \u2014 To prevent the agent from displaying teams statistics.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "SPECIFIC"
},
"teams": {
"type": "array",
"description": "This setting should be specified when Access Team Statistics is SPECIFIC. ",
"example": [
"apim_team_516789",
"apim_team_6123456"
],
"items": {
"type": "string",
"description": "This setting should be specified when Access Team Statistics is SPECIFIC. ",
"example": [
"apim_team_516789",
"apim_team_6123456"
]
},
"uniqueItems": true
},
"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": [
"accessQueueStats",
"accessTeamStats"
]
},
"AgentProfileResponseDTO": {
"type": "object",
"description": "Agent Profile Response schema.",
"example": {
"accessBuddyTeam": "ALL",
"accessEntryPoint": "ALL",
"accessIdleCode": "ALL",
"accessQueue": "ALL",
"accessWrapUpCode": "ALL",
"active": true,
"addressBookId": "3b20a52a-44c9-4c7f-9ccc-61379f1feb6a",
"agentAvailableAfterOutdial": false,
"agentDnCheck": true,
"agentDNValidation": "ALL",
"agentDNValidationCriteria": "ALL",
"agentDNValidationCriterions": [],
"agentPersonalGreeting": true,
"allowAutoWrapUpExtension": false,
"autoAnswer": false,
"autoWrapAfterSeconds": 0,
"autoWrapUp": false,
"browserCheck": true,
"buddyTeams": [],
"consultToQueue": false,
"createdTime": 1776695809000,
"description": "",
"dialPlanEnabled": false,
"dialPlans": [
"US",
"Any Format"
],
"entryPoints": [
"apim_entry_516789",
"apim_entry_6123456"
],
"extensionCheck": true,
"id": "a270c618-df2f-4ca5-a29b-2e8321f78f94",
"idleCodes": [
"aux_code_sale",
"aux_code2"
],
"lastAgentRouting": false,
"lastUpdatedTime": 1782305047122,
"loginVoiceOptions": [
"AGENT_DN",
"EXTENSION",
"BROWSER"
],
"name": "Test New DP",
"organizationId": "694f5d79-680a-4dd0-bc92-436908174db9",
"outdialANIId": "3ac3657b-cedd-424b-a584-2f9182b8fe47",
"outdialEnabled": true,
"outdialEntryPointId": "5ca51368-9ed8-4f01-bff2-33ffe56fbb08",
"parentType": "ORGANIZATION",
"queues": [
"apim_queue_516789",
"apim_queue_6123456"
],
"scheduleAndManageCallBack": true,
"screenPopup": false,
"showUserDetailsMS": false,
"showUserDetailsWebex": true,
"stateSynchronizationMS": false,
"stateSynchronizationWebex": false,
"thresholdRules": [],
"timeoutDesktopInactivityCustomEnabled": false,
"version": 21,
"viewableStatistics": {
"accessQueueStats": "NONE",
"accessTeamStats": "NONE",
"agentStats": false,
"contactServiceQueues": [],
"id": "c1d343b9-ca59-4134-b576-f306bf23b03d",
"loggedInTeamStats": false,
"organizationId": "694f5d79-680a-4dd0-bc92-436908174db9",
"teams": [],
"version": 10
},
"wrapUpCodes": [
"WrapUp_Sale",
"WrapUp_Field"
]
},
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Enter a name for the agent profile.",
"example": "Agent-Profile(Auto WrapUp)",
"maxLength": 80,
"minLength": 1,
"pattern": "^[a-zA-Z0-9\\._\\s\\-\\(\\)]+$"
},
"description": {
"type": "string",
"description": "(Optional) Enter a description of the profile.",
"example": "This profile allows agent to auto wrap-up time and extend the wrap-up time.",
"maxLength": 255,
"minLength": 0
},
"parentType": {
"type": "string",
"description": "This can be the following\n\nORGANIZATION: The agent profile is available to all sites at your enterprise.\n\nSITE: The agent profile is available to a specific site.",
"enum": [
"ORGANIZATION",
"SITE"
],
"example": "SITE"
},
"siteId": {
"type": "string",
"description": "Identifier for a site which is a physical contact center location under the control of your enterprise. ",
"example": "8e6bb6da-2a78-4768-bef9-7e229f92af22"
},
"screenPopup": {
"type": "boolean",
"description": "Indicates whether to allow external pop-up screens(true) or not(false).",
"example": true
},
"lastAgentRouting": {
"type": "boolean",
"description": "This setting use only if your administrator enables the Last Agent Routing feature for your enterprise. Indicates whether to allow Last Agent Routing check box on the Agent Desktop during wrap-up(true) or not(false).",
"example": true
},
"scheduleAndManageCallBack": {
"type": "boolean",
"description": "Indicates whether to allow agents to schedule and manage callbacks(true) or not(false).",
"example": true
},
"autoWrapUp": {
"type": "boolean",
"description": "Indicates whether to allow auto wrap-up(true) or not(false).",
"example": true
},
"agentPersonalGreeting": {
"type": "boolean",
"description": "Indicates whether an agent can record a personal greeting(true) or not(false) from the agent desktop.",
"example": true
},
"autoAnswer": {
"type": "boolean",
"description": "Indicates whether incoming calls on the Agent Desktop need to be answered automatically(true) or not(false).",
"example": true
},
"autoWrapAfterSeconds": {
"type": "integer",
"format": "int32",
"description": "This setting allows auto wrap-up after seconds",
"example": 15
},
"agentAvailableAfterOutdial": {
"type": "boolean",
"description": "Enabled if you want the agent to go into the Available state after completing and wrapping up an outdial call. The agent can also manually select an Idle state from the STATUS NOW drop-down list before selecting a wrap-up code.\n",
"example": true
},
"allowAutoWrapUpExtension": {
"type": "boolean",
"description": "Indicates whether to allow auto wrap-up extension(true) or not(false).",
"example": true
},
"accessWrapUpCode": {
"type": "string",
"description": "Specify the wrap-up codes that the agents can select when they wrap up a contact.It can take one of these values:\n\nALL \u2014 To make all wrap-up codes available.\n\nSPECIFIC \u2014 To make specific codes available.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"wrapUpCodes": {
"type": "array",
"description": "Specify the wrap-up codes list that the agents can select when they wrap up a contact.",
"example": [
"WrapUp_Sale",
"WrapUp_Field"
],
"items": {
"type": "string",
"description": "Specify the wrap-up codes list that the agents can select when they wrap up a contact.",
"example": [
"WrapUp_Sale",
"WrapUp_Field"
]
},
"uniqueItems": true
},
"accessIdleCode": {
"type": "string",
"description": "Specify the Idle codes that the agents can select in Agent Desktop.It can take one of these values:\n\nALL \u2014 To make all idle codes available.\n\nSPECIFIC \u2014 To make specific codes available.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"idleCodes": {
"type": "array",
"description": "Specify the Idle codes list that the agents can select in Agent Desktop.",
"example": [
"aux_code_sale",
"aux_code2"
],
"items": {
"type": "string",
"description": "Specify the Idle codes list that the agents can select in Agent Desktop.",
"example": [
"aux_code_sale",
"aux_code2"
]
},
"uniqueItems": true
},
"accessQueue": {
"type": "string",
"description": "Specify the queues that the agents can select from the Queue drop-down list on the Agent Desktop.It can take one of these values:\n\nALL \u2014 To make all queues available.\n\nSPECIFIC \u2014 To make specific queues available\n\nNONE \u2014 If you do not want to make any queues available as transfer targets.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"queues": {
"type": "array",
"description": "Specify the queues list that the agents can select from the Queue drop-down list on the Agent Desktop.",
"example": [
"apim_queue_516789",
"apim_queue_6123456"
],
"items": {
"type": "string",
"description": "Specify the queues list that the agents can select from the Queue drop-down list on the Agent Desktop.",
"example": [
"apim_queue_516789",
"apim_queue_6123456"
]
},
"uniqueItems": true
},
"accessEntryPoint": {
"type": "string",
"description": "Specify the entry points that the agents can select from the Entry Point drop-down list on the Agent Desktop.It can take one of these values:\n\nALL \u2014 To make all entry points available.\n\nSPECIFIC \u2014 To make specific entry points available\n\nNONE \u2014 If you do not want to make any entry points available as transfer targets.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"entryPoints": {
"type": "array",
"description": "Specify the entry points list that the agents can select from the Entry Point drop-down list on the Agent Desktop.",
"example": [
"apim_entry_516789",
"apim_entry_6123456"
],
"items": {
"type": "string",
"description": "Specify the entry points list that the agents can select from the Entry Point drop-down list on the Agent Desktop.",
"example": [
"apim_entry_516789",
"apim_entry_6123456"
]
},
"uniqueItems": true
},
"accessBuddyTeam": {
"type": "string",
"description": "Specify the teams that the agents can select from the Agent drop-down list on the Agent Desktop. It can take one of these values:\n\nALL \u2014 To make the agents on all teams available.\n\nSPECIFIC \u2014 To make agents on specific teams available, then select teams from the drop-down list\n\nNONE \u2014 If you do not want to make any teams available for consultation, conference, or call transfer.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"buddyTeams": {
"type": "array",
"description": "Specify the teams list that the agents can select from the Agent drop-down list on the Agent Desktop.",
"example": [
"5_Jan_Testing",
"7_Feb_Testing"
],
"items": {
"type": "string",
"description": "Specify the teams list that the agents can select from the Agent drop-down list on the Agent Desktop.",
"example": [
"5_Jan_Testing",
"7_Feb_Testing"
]
},
"uniqueItems": true
},
"consultToQueue": {
"type": "boolean",
"description": "Indicates whether you want the agent to be able to select a queue in the Queue drop-down list as a target for a consultation or not.",
"example": true
},
"outdialEnabled": {
"type": "boolean",
"description": "Indicates whether you want the agent to be able to make outdial calls(true) or not(false).",
"example": true
},
"outdialEntryPointId": {
"type": "string",
"description": "If you enabled Outdial, specify the entry point id that the agent can use to make outdial calls.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"outdialANIId": {
"type": "string",
"description": "This setting occurs only if you enabled Outdial. Specify the Outdial ANI id that the agent can use to make outdial calls.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"addressBookId": {
"type": "string",
"description": "Specify the address book id that includes the speed-dial numbers that the agent can select to make outdial and consult calls.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"dialPlanEnabled": {
"type": "boolean",
"description": "Indicates whether you want the agent to be able to make ad-hoc outdial calls(true) or not(false).",
"example": true
},
"dialPlans": {
"type": "array",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting appears only if Dial Plan is enabled. select the dial plans that determine the inputs that the system accepts in the Start a new call field. ",
"example": [
"US",
"Any Format"
],
"items": {
"type": "string",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting appears only if Dial Plan is enabled. select the dial plans that determine the inputs that the system accepts in the Start a new call field. ",
"example": [
"US",
"Any Format"
]
},
"uniqueItems": true
},
"timeoutDesktopInactivityCustomEnabled": {
"type": "boolean",
"description": "This setting enabled time out desktop inactivity feature.",
"example": true
},
"showUserDetailsMS": {
"type": "boolean",
"description": "Specify whether the show user details of microsoft account user enabled or not",
"example": true
},
"stateSynchronizationMS": {
"type": "boolean",
"description": "Specify whether the state synchronization of microsoft account user enabled or not",
"example": true
},
"showUserDetailsWebex": {
"type": "boolean",
"description": "Specify whether the show user details of webex account user enabled or not",
"example": true
},
"stateSynchronizationWebex": {
"type": "boolean",
"description": "Specify whether the state synchronization of webex account user enabled or not",
"example": true
},
"manageChannelAvailability": {
"type": "boolean",
"description": "Indicates whether the agent can manage channel availability(true) or not(false).",
"example": true
},
"timeoutDesktopInactivityMins": {
"type": "integer",
"format": "int32",
"description": "This setting occurs only if you enabled time out desktop inactivity feature. Specify time in minute(s).",
"example": 5,
"maximum": 10000,
"minimum": 3
},
"agentDNValidation": {
"type": "string",
"description": "Specifies the validation applied when an agent logs in with a DN. \n**Supported values going forward:** `ALL` (Unrestricted \u2014 agents may use any DN) and \n`PROVISIONED_VALUE` (login DN restricted to the value provisioned for the agent). \n**Note:** `SPECIFIC` (Validation Criteria) is no longer supported and must not be used \nfor new or updated profiles.\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"agentDNValidationCriteria": {
"type": "string",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting occurs only if you select Validation Criteria in the Validation For Agent DN.",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "SPECIFIC"
},
"agentDNValidationCriterions": {
"type": "array",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN.",
"example": [
"DN_5_Sept",
"DN_7_Jan"
],
"items": {
"type": "string",
"deprecated": true,
"description": "**Deprecated** as of 2026.06; will be removed after consumers migrate. This setting specify the list that occurs only if you select Validation Criteria in the Validation For Agent DN.",
"example": [
"DN_5_Sept",
"DN_7_Jan"
]
},
"uniqueItems": true
},
"loginVoiceOptions": {
"type": "array",
"description": "List of Login Voice Options.",
"items": {
"type": "string",
"description": "Login voice options.",
"enum": [
"AGENT_DN",
"EXTENSION",
"BROWSER"
],
"example": "AGENT_DN"
},
"uniqueItems": true
},
"viewableStatistics": {
"$ref": "#/components/schemas/viewableStatistics",
"description": "Viewable Statistics."
},
"thresholdRules": {
"type": "array",
"description": "The Agent Thresholds page appears only if your enterprise uses the Threshold Alerts feature.\nIf your enterprise uses the Agent Threshold Alerts feature, the page also provides settings to specify the thresholds associated with the agent.",
"example": [
"Threshold_monitor_agent",
"Threshold_call_data"
],
"items": {
"type": "string",
"description": "The Agent Thresholds page appears only if your enterprise uses the Threshold Alerts feature.\nIf your enterprise uses the Agent Threshold Alerts feature, the page also provides settings to specify the thresholds associated with the agent.",
"example": [
"Threshold_monitor_agent",
"Threshold_call_data"
]
},
"uniqueItems": true
},
"active": {
"type": "boolean",
"description": "Specify whether the agent profile is active or not Active.",
"example": true
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"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
},
"autoAcceptDigitalInteractions": {
"type": "boolean",
"description": "Automatically accept digital interactions when agent becomes available",
"example": false
}
},
"required": [
"accessBuddyTeam",
"accessEntryPoint",
"accessIdleCode",
"accessQueue",
"accessWrapUpCode",
"active",
"agentDNValidation",
"name",
"parentType"
]
},
"viewableStatistics": {
"type": "object",
"description": "Viewable Statistics schema.",
"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
},
"agentStats": {
"type": "boolean",
"description": "Indicates whether you want the agents to view their personal statistics in Agent Desktop or not.",
"example": true
},
"accessQueueStats": {
"type": "string",
"description": "This setting controls whether the agent can view statistics for all or some queues in the Agent Personal Statistics tab.It can take one of these values:\n\nALL \u2014 To enable the agent to display statistics for all queues.\n\nSPECIFIC \u2014 Select Queues drop-down list to enable the agent to display statistics for specific queues.\n\nNONE \u2014 To prevent the agent from displaying queue statistics.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "SPECIFIC"
},
"contactServiceQueues": {
"type": "array",
"description": "This setting should be specified when Access Queue Statistics is SPECIFIC.",
"example": [
"apim_queue_516789",
"apim_queue_6123456"
],
"items": {
"type": "string",
"description": "This setting should be specified when Access Queue Statistics is SPECIFIC.",
"example": [
"apim_queue_516789",
"apim_queue_6123456"
]
},
"uniqueItems": true
},
"loggedInTeamStats": {
"type": "boolean",
"description": "Indicates whether the agent can view statistics for the team or not.",
"example": true
},
"accessTeamStats": {
"type": "string",
"description": "This setting controls whether the agent can view statistics for all or some teams in the Agent Personal Statistics tab.It can take one of these values:\n\nALL \u2014 To enable the agent to display statistics for all teams.\n\nSPECIFIC \u2014 Select Teams drop-down list to enable the agent to display statistics for specific teams.\n\nNONE \u2014 To prevent the agent from displaying teams statistics.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "SPECIFIC"
},
"teams": {
"type": "array",
"description": "This setting should be specified when Access Team Statistics is SPECIFIC. ",
"example": [
"apim_team_516789",
"apim_team_6123456"
],
"items": {
"type": "string",
"description": "This setting should be specified when Access Team Statistics is SPECIFIC. ",
"example": [
"apim_team_516789",
"apim_team_6123456"
]
},
"uniqueItems": true
},
"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": [
"accessQueueStats",
"accessTeamStats"
]
},
"BulkRequestDTOAgentProfileDTO": {
"type": "object",
"description": "Bulk Request Agent Profile schema.",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOAgentProfileDTO",
"description": "Item."
}
}
}
},
"BulkRequestItemDTOAgentProfileDTO": {
"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/AgentProfileDTO",
"description": "Item."
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"DialledNumberEntryPointDTO": {
"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
},
"dialledNumber": {
"type": "string",
"description": "The dialed number(DN) used to map to entry points.",
"example": "+1-1234567890",
"maxLength": 20,
"minLength": 0,
"pattern": "^\\+{0,1}\\d+[\\d.\\-]*$"
},
"extension": {
"type": "string",
"description": "The extension used to map to entry points.",
"example": 1234,
"maxLength": 10,
"minLength": 0,
"pattern": "^\\d{2,10}$"
},
"routingPrefix": {
"type": "string",
"description": "The routing prefix is mapped to a location and can be prefixed with an extension",
"example": 91,
"maxLength": 7,
"minLength": 0,
"pattern": "^\\d{2,7}$"
},
"esn": {
"type": "string",
"description": "The esn is routing prefix with extension",
"example": 919876,
"maxLength": 17,
"minLength": 0,
"pattern": "^\\d{2,17}$"
},
"routePointId": {
"type": "string",
"description": "The identifier of a route point of WxC which is similar to entry point of WxCC",
"example": "7cbd4aad-0c3b-4de4-a15a-33cf05b9bf8j"
},
"entryPointId": {
"type": "string",
"description": "The identifier of an entry point to which you want to map the DN.",
"example": "7cbd4aad-0c3b-4de4-a15a-33cf05b9bf8j"
},
"entryPointName": {
"type": "string",
"description": "The entryPoint name of the entryPointId.",
"example": "Entry-Point"
},
"defaultAni": {
"type": "boolean",
"description": "The default dial number for the tenant to make outdial calls. The default dial number is displayed in the customer's caller ID, if an agent does not select a specific outdial ANI (Automatic Number Identification) for an outdial call.\n\nA default value is automatically set once and entry point mapping is created",
"example": true
},
"location": {
"type": "string",
"description": "The ID of the location as configured on Webex Calling(applicable only for Webex Calling).",
"example": "7cbd4aad-0c3b-4de4-a15a-33cf05b9bf8j"
},
"regionId": {
"type": "string",
"description": "Specify the telephony region id.\n\nYou can pass id for one of these regions:\n\nUS (USA), CA (Canada), MX (Mexico), AU (Australia), SG (Singapore), GB (United Kingdom), DE (Germany)\n\nYou can retrieve it by calling /api/global/telephony-region API.",
"example": "7cbd4aad-0c3b-4de4-a15a-33cf05b9bf8j"
},
"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."
},
"dialledNumberDigits": {
"type": "string"
}
},
"required": [
"entryPointId",
"entryPointName"
]
},
"BulkRequestDTODialledNumberEntryPointDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTODialledNumberEntryPointDTO"
}
}
}
},
"BulkRequestItemDTODialledNumberEntryPointDTO": {
"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/DialledNumberEntryPointDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"BulkExportDTODialledNumberEntryPointExportDTO": {
"type": "object",
"description": "Bulk export Dto",
"example": {
"totalResources": 100,
"pageNumber": 0,
"pageSize": 50,
"rel": "last",
"resources": []
},
"properties": {
"totalResources": {
"type": "integer",
"format": "int32",
"description": "Total number of items.",
"example": 100
},
"pageNumber": {
"type": "integer",
"format": "int32",
"description": "Current page number.",
"example": 0
},
"pageSize": {
"type": "integer",
"format": "int32",
"description": "Page size for current data set.",
"example": 50
},
"rel": {
"type": "string",
"description": "Indicates whether more pages exist. When 'next' there are more pages available, otherwise 'last'.",
"example": "last"
},
"resources": {
"type": "array",
"description": "Indicate the page resources",
"items": {
"$ref": "#/components/schemas/DialledNumberEntryPointExportDTO"
}
}
}
},
"DialledNumberEntryPointExportDTO": {
"type": "object",
"properties": {
"dialledNumber": {
"type": "string"
},
"extension": {
"type": "string"
},
"location": {
"type": "string"
},
"entryPointName": {
"type": "string"
},
"region": {
"type": "string"
}
}
},
"ResponseEnvelopeDialledNumberEntryPointDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DialledNumberEntryPointDTO"
}
}
}
},
"DialPlanDTO": {
"type": "object",
"description": "Dial Plan schema.",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Enter the name for the dial plan.",
"example": "Standard dial plan",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9,_\\-\\s]*$"
},
"description": {
"type": "string",
"description": "A short description of the dial plan.",
"example": "Required for transferring calls to Queues",
"maxLength": 255,
"minLength": 0
},
"regularExpression": {
"type": "string",
"description": "A regular expression specifies the format of the phone number and the characters that you can use while dialing a number.",
"example": "[0-9a-zA-Z]",
"maxLength": 255,
"minLength": 0
},
"prefix": {
"type": "string",
"description": "(Optional) Enter a prefix that the system automatically adds to the phone number that the agent enters. For example, digit 1 for long-distance calls within the United States.",
"example": "+1",
"maxLength": 50,
"minLength": 0
},
"strippedChars": {
"type": "string",
"description": "Enter the characters that system removes from the phone number that the agent dials.For example, left and right parentheses, space, and hyphen.",
"example": "()",
"maxLength": 128,
"minLength": 0
},
"active": {
"type": "boolean",
"description": "Specify whether the dial plan is active or not",
"example": true
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"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": [
"active",
"name",
"regularExpression"
]
},
"BulkRequestDTODialPlanDTO": {
"type": "object",
"description": "Bulk Request Dial Plan schema.",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTODialPlanDTO",
"description": "Item."
}
}
}
},
"BulkRequestItemDTODialPlanDTO": {
"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/DialPlanDTO",
"description": "Item."
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"ResponseEnvelopeDialPlanDTO": {
"type": "object",
"description": "Response Envelope Dial Plan schema.",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"description": "Meta additional property."
},
"description": "Additional properties for Meta."
},
"data": {
"type": "array",
"description": "List of Data.",
"items": {
"$ref": "#/components/schemas/DialPlanDTO",
"description": "Data item."
}
}
}
},
"EntryPointDTO": {
"required": [
"active",
"assetId",
"channelType",
"controlFlowScriptUrl",
"entryPointType",
"imiOrgType",
"maximumActiveContacts",
"name",
"overflowNumber",
"serviceLevelThreshold",
"socialChannelType"
],
"type": "object",
"properties": {
"organizationId": {
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
"type": "string",
"description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
"format": "uuid",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"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",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"format": "int32",
"example": 1
},
"name": {
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9&_\\-\\s]*$",
"type": "string",
"description": "A unique name for the entry point within the organization. It is required only during a create or an update operation.",
"example": "Telephony-Ep"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A short description of the entry point.",
"example": "Required for transferring out-dial calls to Queues"
},
"entryPointType": {
"type": "string",
"description": "Setting to indicate if this entry point is meant for incoming or outgoing contacts. Use uppercase. Can be set to either `INBOUND` or `OUTBOUND`. With Outbound Type, Only Telephony channel is supported. It is required only during a create or an update operation.",
"example": "INBOUND",
"enum": [
"INBOUND",
"OUTBOUND"
]
},
"channelType": {
"type": "string",
"description": "Setting to indicate the channel type. Use uppercase. Supported channel types are: \n\n TELEPHONY, EMAIL, VIDEO, SOCIAL_CHANNEL, FAX, CHAT and OTHERS. It is required only during a create or an update operation.",
"example": "TELEPHONY",
"enum": [
"TELEPHONY",
"EMAIL",
"FAX",
"CHAT",
"VIDEO",
"OTHERS",
"SOCIAL_CHANNEL"
]
},
"socialChannelType": {
"type": "string",
"description": "Setting to indicate the type of Social Channel.This setting is available only when channel type is SOCIAL_CHANNEL.Use uppercase. Can be set to either `MESSAGEBIRD` or `MESSENGER`.",
"example": "MESSENGER",
"enum": [
"MESSAGEBIRD",
"MESSENGER",
"WHATSAPP",
"APPLE_BUSINESS_CHAT",
"GOOGLE_BUSINESS_MESSAGES"
]
},
"active": {
"type": "boolean",
"description": "Used to toggle the state of the entrypoint from active to inactive and vice-versa. It is required only during a create or an update operation.",
"example": true
},
"serviceLevelThreshold": {
"type": "integer",
"description": "Allows to set the time that a customer request can be in a queue before the system flags it as outside the service level. \n\n If the agent completes a customer service request within this time interval, the system considers it within the service level. \nIt is required only for a create or an update operation.",
"format": "int32",
"example": 12
},
"maximumActiveContacts": {
"type": "integer",
"description": "Caps the maximum number of simultaneous calls for this entry point.\n\nThe system busies out any additional calls when the number of active calls exceeds this number.\n\nIt is required only for a create or an update operation.",
"format": "int32",
"example": 1
},
"controlFlowScriptUrl": {
"type": "string",
"description": "The system automatically populates this field with the URL for this entry point or the default control script of the queue.It happens when you don\u2019t configure the control script using the Webex Contact Center Routing Strategy module.This setting is available for the Telephony channel type.",
"example": "https://flow-control.produs1.ciscoccservice.com/31f1c57f-4fa1-417b-b5c5-6feb6abea062/royal-enfield"
},
"overflowNumber": {
"maxLength": 40,
"minLength": 0,
"pattern": "^[0-9]*$",
"type": "string",
"description": "Allows to set the destination phone number to which the system diverts the customer calls when they exceed the Maximum Time in Queue \n\nthat has been set in the routing strategy.\n\nThis setting is applicable only for the Telephony channel type.",
"example": "1231231231"
},
"timezone": {
"type": "string",
"description": "(Optional) Any routing strategy for this entry point uses the time zone that you select here.",
"example": "America/New_York"
},
"imiOrgType": {
"type": "string",
"description": "Refers to the type of digital channels used by the org. It takes two values: IMI (if all channels used are IMI) and MIXED_MODE (if both native and IMI channels are used).",
"example": "MIXED_MODE",
"enum": [
"MIXED_MODE",
"IMI"
]
},
"assetId": {
"type": "string",
"description": "ID of the asset in IMI that corresponds to this entrypoint.",
"example": "a_38412723414"
},
"xspVersion": {
"maxLength": 80,
"minLength": 0,
"type": "string",
"description": "(Optional) Used to subscribe for recording events.",
"example": "xsp-24.0"
},
"subscriptionId": {
"maxLength": 80,
"minLength": 0,
"type": "string",
"description": "(Optional) Used to subscribe for recording events.",
"example": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478"
},
"routePointId": {
"type": "string",
"description": "The identifier of a route point of WxC which is similar to entry point of WxCC",
"example": "7cbd4aad-0c3b-4de4-a15a-33cf05b9bf8j"
},
"flowId": {
"type": "string"
},
"flowTagId": {
"type": "string"
},
"musicOnHoldId": {
"type": "string"
},
"outdialQueueId": {
"type": "string"
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"callbackEnabled": {
"type": "boolean",
"description": "Indicates whether the created resource is call back enabled or not",
"example": false
},
"outdialTransferToQueueEnabled": {
"type": "boolean",
"description": "Indicates whether the resource is Default Outdial Transfer to Queue.",
"example": false
},
"dnEpMappingCount": {
"type": "integer",
"format": "int64"
},
"flowOverrideSettings": {
"uniqueItems": true,
"type": "array",
"description": "Add a Flow override settings to entry-point.\nThis feature enables non-flow developers and designers including Contact Center Supervisors and other Contact Center personnel to modify settings such as business hours and audio prompts within Control Hub using configurable parameters, bypassing the complexity of flow editing.\nNote that flow override settings are applicable only for telephony entry-point.",
"example": [
{
"name": "WelcomePromt",
"type": "String",
"entityType": "audio-file",
"value": "greetings.wav",
"id": "4f8d4487-a48e-48f5-be67-b4242345d0cf"
}
],
"items": {
"$ref": "#/components/schemas/FlowOverrideSettingDTO"
}
},
"createdTime": {
"type": "integer",
"description": "Creation time(in epoch millis) of this resource.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
},
"lastUpdatedTime": {
"type": "integer",
"description": "Time(in epoch millis) when this resource was last updated.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
}
}
},
"FlowOverrideSettingDTO": {
"required": [
"name",
"type"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"entityType": {
"type": "string"
},
"entityId": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"BulkRequestDTOEntryPointDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOEntryPointDTO"
}
}
}
},
"BulkRequestItemDTOEntryPointDTO": {
"type": "object",
"properties": {
"itemIdentifier": {
"type": "integer",
"description": "Unique item identifier for a bulk operation.",
"format": "int32",
"example": 10
},
"item": {
"$ref": "#/components/schemas/EntryPointDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values can be SAVE and DELETE.",
"example": "SAVE"
}
}
},
"BulkExportDTOEntryPointBulkExportDTO": {
"type": "object",
"properties": {
"totalResources": {
"type": "integer",
"description": "Total number of items",
"format": "int32",
"example": 100
},
"pageNumber": {
"type": "integer",
"description": "Current page number",
"format": "int32",
"example": 0
},
"pageSize": {
"type": "integer",
"description": "Page size for current data set",
"format": "int32",
"example": 50
},
"rel": {
"type": "string",
"description": "Indicates whether more pages exist. When 'next' there are more pages available, otherwise 'last'.",
"example": "last"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntryPointBulkExportDTO"
}
}
}
},
"EntryPointBulkExportDTO": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"serviceLevelThreshold": {
"type": "string"
},
"timezone": {
"type": "string"
},
"channelType": {
"type": "string"
},
"socialChannelType": {
"type": "string"
},
"entryPointType": {
"type": "string"
},
"assetId": {
"type": "string"
},
"flowId": {
"type": "string"
},
"flowTag": {
"type": "string"
},
"musicOnHoldId": {
"type": "string"
},
"outdialQueueId": {
"type": "string"
},
"callbackEnabled": {
"type": "boolean"
}
}
},
"ResponseEnvelopeEntryPointDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntryPointDTO"
}
}
}
},
"CadVariableDTO": {
"required": [
"active",
"agentEditable",
"agentViewable",
"defaultValue",
"name",
"reportable",
"variableType"
],
"type": "object",
"properties": {
"organizationId": {
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
"type": "string",
"description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
"format": "uuid",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"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",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"format": "int32",
"example": 1
},
"name": {
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z\\d_]+$",
"type": "string",
"description": "A name for the Global Variable.",
"example": "Global Variable"
},
"description": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"description": "A the description for the Global Variable created.",
"example": "Global Variable to describe meta-data."
},
"active": {
"type": "boolean",
"description": "Indicates whether the Global Variable is active or not.",
"example": true
},
"agentEditable": {
"type": "boolean",
"description": "Indicates whether the Global Variable is editable in the Agent Desktop by the agent or not.",
"example": true
},
"variableType": {
"type": "string",
"description": "A valid Global Variable Type. The valid types are: String, Integer, DateTime, Boolean, Decimal.",
"example": "INTEGER",
"enum": [
"STRING",
"INTEGER",
"DATE_TIME",
"BOOLEAN",
"DECIMAL",
"String",
"Integer",
"DateTime",
"Boolean",
"Decimal"
]
},
"defaultValue": {
"maxLength": 256,
"minLength": 0,
"type": "string",
"description": "A default value for the Global Variable.",
"example": "Default Value"
},
"reportable": {
"type": "boolean",
"description": "Indicates whether the Global Variable is reportable or not.",
"example": false
},
"agentViewable": {
"type": "boolean",
"description": "Indicates whether the agent can view the Global Variable in Agent Desktop or not.",
"example": true
},
"sensitive": {
"type": "boolean",
"description": "Indicates whether the Global Variable is sensitive or not.",
"example": true
},
"desktopLabel": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "A desktop label for the Global Variable created.",
"example": "Desktop Label"
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"createdTime": {
"type": "integer",
"description": "Creation time(in epoch millis) of this resource.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
},
"lastUpdatedTime": {
"type": "integer",
"description": "Time(in epoch millis) when this resource was last updated.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
}
}
},
"BulkRequestDTOCadVariableDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOCadVariableDTO"
}
}
}
},
"BulkRequestItemDTOCadVariableDTO": {
"type": "object",
"properties": {
"itemIdentifier": {
"type": "integer",
"description": "Unique item identifier for a bulk operation.",
"format": "int32",
"example": 10
},
"item": {
"$ref": "#/components/schemas/CadVariableDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values can be SAVE and DELETE.",
"example": "SAVE"
}
}
},
"BulkExportDTOCadVariableBulkExportDTO": {
"type": "object",
"properties": {
"totalResources": {
"type": "integer",
"description": "Total number of items",
"format": "int32",
"example": 100
},
"pageNumber": {
"type": "integer",
"description": "Current page number",
"format": "int32",
"example": 0
},
"pageSize": {
"type": "integer",
"description": "Page size for current data set",
"format": "int32",
"example": 50
},
"rel": {
"type": "string",
"description": "Indicates whether more pages exist. When 'next' there are more pages available, otherwise 'last'.",
"example": "last"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CadVariableBulkExportDTO"
}
}
}
},
"CadVariableBulkExportDTO": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "A name for the Global Variable.",
"example": "Global Variable"
},
"description": {
"type": "string",
"description": "A the description for the Global Variable created.",
"example": "Global Variable to describe meta-data."
},
"agentEditable": {
"type": "boolean",
"description": "Indicates whether the Global Variable is editable in the Agent Desktop by the agent or not.",
"example": true
},
"variableType": {
"type": "string",
"description": "A valid Global Variable Type. The valid types are: String, Integer, DateTime, Boolean, Decimal.",
"example": "INTEGER",
"enum": [
"STRING",
"INTEGER",
"DATE_TIME",
"BOOLEAN",
"DECIMAL",
"String",
"Integer",
"DateTime",
"Boolean",
"Decimal"
]
},
"defaultValue": {
"type": "string",
"description": "A default value for the Global Variable.",
"example": "Default Value"
},
"reportable": {
"type": "boolean",
"description": "Indicates whether the Global Variable is reportable or not.",
"example": false
},
"sensitive": {
"type": "boolean",
"description": "Indicates whether the Global Variable is sensitive or not.",
"example": false
},
"agentViewable": {
"type": "boolean",
"description": "Indicates whether the agent can view the Global Variable in Agent Desktop or not.",
"example": true
},
"desktopLabel": {
"type": "string",
"description": "A desktop label for the Global Variable created.",
"example": "Desktop Label"
}
}
},
"ResponseEnvelopeCadVariableDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CadVariableDTO"
}
}
}
},
"MultimediaProfileDTO": {
"required": [
"active",
"blendingMode",
"blendingModeEnabled",
"chat",
"email",
"name",
"social",
"telephony"
],
"type": "object",
"properties": {
"organizationId": {
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
"type": "string",
"description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
"format": "uuid",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"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",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"format": "int32",
"example": 1
},
"name": {
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9._\\-\\s]*$",
"type": "string",
"description": "Enter the name for the multimedia profile. Generally, use names that indicate the type of the profile, such as Default Telephony Profile.",
"example": "Default Telephony Profile"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Enter a description for the multimedia profile.",
"example": "This multimedia profile is for Default Telephony Profile"
},
"chat": {
"type": "integer",
"description": "Define the upper limits for this channel type. It should range from 0 or 1(depends on the 'BlendingMode') to 5.",
"format": "int32",
"example": 0
},
"email": {
"type": "integer",
"description": "Define the upper limits for this channel type. It should range from 0 to 5.",
"format": "int32",
"example": 5
},
"telephony": {
"type": "integer",
"description": "Define the upper limits for this channel type. It should be either 0 or 1(depends on the 'BlendingMode').",
"format": "int32",
"example": 0
},
"social": {
"type": "integer",
"description": "Define the upper limits for this channel type. It should range from 0 to 5.",
"format": "int32",
"example": 4
},
"active": {
"type": "boolean",
"description": "Specify whether the multimedia profile is active or not.",
"example": true
},
"blendingModeEnabled": {
"type": "boolean",
"description": "Specify whether the blending mode is enabled or not for a multimedia profile.",
"example": true
},
"blendingMode": {
"type": "string",
"description": "Blending mode can be one the following:\n\nBLENDED: This mode allows agents to handle multiple contacts of different channel types simultaneously. Number of contacts that you can set for Voice: 0\u00e2\u20ac\u201c1 and for Chat, Email, and Social Channel: 0\u00e2\u20ac\u201c5\n\nBLENDED_REALTIME: This allows agents to handle a contact of one real-time channel at a time - either voice or chat. Along with this they can handle non-realtime contacts which include email and social channels. Number of contacts that you can set for Voice: 1 (mandatory), Chat: 1\u00e2\u20ac\u201c5, Email and Social Channel: 0\u00e2\u20ac\u201c5\n\nEXCLUSIVE: This mode allows agents to focus on one customer contact at a time.",
"example": "BLENDED"
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"manuallyAssignable": {
"$ref": "#/components/schemas/MultimediaProfileChannelDTO"
},
"createdTime": {
"type": "integer",
"description": "Creation time(in epoch millis) of this resource.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
},
"lastUpdatedTime": {
"type": "integer",
"description": "Time(in epoch millis) when this resource was last updated.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
}
}
},
"MultimediaProfileChannelDTO": {
"required": [
"chat",
"email",
"social",
"telephony"
],
"type": "object",
"properties": {
"organizationId": {
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
"type": "string",
"description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
"format": "uuid",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"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",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"format": "int32",
"example": 1
},
"telephony": {
"type": "integer",
"description": "Define the upper limits for this channel type. It should be either 0 or 1.",
"format": "int32",
"example": 0
},
"chat": {
"type": "integer",
"description": "Define the upper limits for this channel type. It should range from 0 to 5.",
"format": "int32",
"example": 5
},
"email": {
"type": "integer",
"description": "Define the upper limits for this channel type. It should range from 0 to 10.",
"format": "int32",
"example": 5
},
"social": {
"type": "integer",
"description": "Define the upper limits for this channel type. It should range from 0 to 5.",
"format": "int32",
"example": 4
},
"createdTime": {
"type": "integer",
"description": "Creation time(in epoch millis) of this resource.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
},
"lastUpdatedTime": {
"type": "integer",
"description": "Time(in epoch millis) when this resource was last updated.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
}
}
},
"BulkRequestDTOMultimediaProfileDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOMultimediaProfileDTO"
}
}
}
},
"BulkRequestItemDTOMultimediaProfileDTO": {
"type": "object",
"properties": {
"itemIdentifier": {
"type": "integer",
"description": "Unique item identifier for a bulk operation.",
"format": "int32",
"example": 10
},
"item": {
"$ref": "#/components/schemas/MultimediaProfileDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values can be SAVE and DELETE.",
"example": "SAVE"
}
}
},
"BulkExportDTOMultimediaProfileExportDTO": {
"type": "object",
"properties": {
"totalResources": {
"type": "integer",
"description": "Total number of items",
"format": "int32",
"example": 100
},
"pageNumber": {
"type": "integer",
"description": "Current page number",
"format": "int32",
"example": 0
},
"pageSize": {
"type": "integer",
"description": "Page size for current data set",
"format": "int32",
"example": 50
},
"rel": {
"type": "string",
"description": "Indicates whether more pages exist. When 'next' there are more pages available, otherwise 'last'.",
"example": "last"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MultimediaProfileExportDTO"
}
}
}
},
"MultimediaProfileExportDTO": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"chat": {
"type": "integer",
"format": "int32"
},
"email": {
"type": "integer",
"format": "int32"
},
"fax": {
"type": "integer",
"format": "int32"
},
"telephony": {
"type": "integer",
"format": "int32"
},
"video": {
"type": "integer",
"format": "int32"
},
"social": {
"type": "integer",
"format": "int32"
},
"others": {
"type": "integer",
"format": "int32"
},
"active": {
"type": "boolean"
},
"blendingModeEnabled": {
"type": "boolean"
},
"blendingMode": {
"type": "string"
},
"manuallyAssignable": {
"$ref": "#/components/schemas/MultimediaProfileChannelDTO"
}
}
},
"ResponseEnvelopeMultimediaProfileDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MultimediaProfileDTO"
}
}
}
},
"OutdialANIDTOList": {
"type": "object",
"description": "Outdial ANI schema.",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Enter a name for the outdial ANI.",
"example": "outdial-ANI1",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9._\\-\\s]*$"
},
"description": {
"type": "string",
"description": "(Optional) Enter a description for the outdial ANI.",
"example": "This profile allows agent to select a phone number as the caller ID for an outdial call.",
"maxLength": 255,
"minLength": 0
},
"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
}
}
},
"OutdialANIDTO": {
"type": "object",
"description": "Outdial ANI schema.",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Enter a name for the outdial ANI.",
"example": "outdial-ANI1",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9._\\-\\s]*$"
},
"description": {
"type": "string",
"description": "(Optional) Enter a description for the outdial ANI.",
"example": "This profile allows agent to select a phone number as the caller ID for an outdial call.",
"maxLength": 255,
"minLength": 0
},
"outdialANIEntries": {
"type": "array",
"description": "List of Outdial ANIEntries.",
"items": {
"$ref": "#/components/schemas/OutdialANIEntryDTO",
"description": "Outdial ANIEntry."
},
"uniqueItems": true
},
"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": [
"name"
]
},
"OutdialANIEntryDTO": {
"type": "object",
"description": "Outdial ANIEntry schema.",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Enter a name for the outdial ANI entry.",
"example": "Test",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9._\\-\\s]*$"
},
"number": {
"type": "string",
"description": "Enter a valid phone number or valid SIP URI.",
"example": 98723487924
},
"defaultANIEntry": {
"type": "boolean",
"description": "Indicates whether this is the default Outdial ANI Entry(true) or not(false).",
"example": true
},
"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": [
"name",
"number"
]
},
"BulkRequestDTOOutdialANIDTO": {
"type": "object",
"description": "Bulk Request Outdial ANI schema.",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOOutdialANIDTO",
"description": "Item."
}
}
}
},
"BulkRequestItemDTOOutdialANIDTO": {
"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/OutdialANIDTO",
"description": "Item."
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"ResponseEnvelopeOutdialANIEntryDTO": {
"type": "object",
"description": "Response Envelope Outdial ANIEntry schema.",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"description": "Meta additional property."
},
"description": "Additional properties for Meta."
},
"data": {
"type": "array",
"description": "List of Data.",
"items": {
"$ref": "#/components/schemas/OutdialANIEntryDTO",
"description": "Data item."
}
}
}
},
"BulkRequestDTOOutdialANIEntryDTO": {
"type": "object",
"description": "Bulk Request Outdial ANIEntry schema.",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOOutdialANIEntryDTO",
"description": "Item."
}
}
}
},
"BulkRequestItemDTOOutdialANIEntryDTO": {
"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/OutdialANIEntryDTO",
"description": "Item."
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"ResponseEnvelopeOutdialANIDTO": {
"type": "object",
"description": "Response Envelope Outdial ANI schema.",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"description": "Meta additional property."
},
"description": "Additional properties for Meta."
},
"data": {
"type": "array",
"description": "List of Data.",
"items": {
"$ref": "#/components/schemas/OutdialANIDTO",
"description": "Data item."
}
}
}
},
"ResourceCollectionDTO": {
"type": "object",
"description": "A collection of resources with their types and access levels.",
"example": {
"id": "80f49a6e-11d7-4651-b730-99ed2f726f61",
"name": "Department1",
"description": "Department1 description.",
"resources": [
{
"name": "team",
"accessLevel": "SPECIFIC",
"ids": [
"00734874-4732-43bb-bfff-d1e75d309eb1",
"00734874-4732-43bb-bfff-d1e75d309eb2"
]
},
{
"name": "desktop-profile",
"accessLevel": "ALL"
},
{
"name": "desktop-layout",
"accessLevel": "NONE"
}
],
"resourceCount": 2
},
"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": "The name of the resource collection.",
"example": "Department1",
"maxLength": 80,
"minLength": 1,
"pattern": "^[a-zA-Z\\d-_\\s]+$"
},
"description": {
"type": "string",
"description": "An optional description of the resource collection.",
"example": "Department1 description.",
"maxLength": 255,
"minLength": 0
},
"resources": {
"type": "array",
"description": "The name of the resource and Type of resource list.",
"items": {
"$ref": "#/components/schemas/ResourceTypesDTO",
"description": "Resource."
},
"uniqueItems": true
},
"resourceCount": {
"type": "integer",
"format": "int64",
"description": "The total count of resources in this collection",
"example": 2
},
"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": [
"name"
]
},
"ResourceTypesDTO": {
"type": "object",
"description": "A resource type with its access level and associated IDs.",
"properties": {
"name": {
"type": "string",
"description": "The name of the resource.multimedia-profile - Has access to multimedia profile[multimedia-profile] resource name.\n\nqueue - Has access to queue[queue] resource name.\n\noverride - Has access to override[override] resource name.\n\nholiday-list - Has access to holiday list[holiday-list] resource name.\n\naudio-prompt - Has access to audio prompt[audio-prompt] resource name.\n\nflow - Has access to flow[flow] resource name.\n\nskill-profile - Has access to skill profile[skill-profile] resource name.\n\nteam - Has access to team[team] resource name.\n\nskill-definition - Has access to skill definition[skill-definition] resource name.\n\nsite - Has access to site[site] resource name.\n\noutdial-ani - Has access to outdial ani[outdial-ani] resource name.\n\nchannel - Has access to channel[channel] resource name.\n\nsub-flow - Has access to sub flow[sub-flow] resource name.\n\ndesktop-layout - Has access to desktop layout[desktop-layout] resource name.\n\nworking-hour - Has access to working hour[working-hour] resource name.\n\nfunction - Has access to function[function] resource name.\n\ndesktop-profile - Has access to desktop profile[desktop-profile] resource name.\n\nidle-wrapup-code - Has access to idle wrap-up code[idle-wrapup-code] resource name.\n\ncad-variable - Has access to cad variable[cad-variable] resource name.\n\naddress-book - Has access to address book[address-book] resource name.\n\n",
"example": "site",
"minLength": 1
},
"accessLevel": {
"type": "string",
"description": "This can be used to allow users to access specific, none or all resources.",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"ids": {
"type": "array",
"description": "The id of the resource can be used to allow users to access specific, of resources.",
"example": [
"00734874-4732-43bb-bfff-d1e75d309eb1",
"00734874-4732-43bb-bfff-d1e75d309eb2"
],
"items": {
"type": "string",
"description": "Id."
},
"uniqueItems": true
}
},
"required": [
"accessLevel",
"name"
]
},
"BulkRequestDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOBaseDTO"
}
}
}
},
"BulkRequestItemDTOBaseDTO": {
"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/BaseDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"BaseDTO": {
"type": "object",
"description": "This is the base schema for all DTOs.",
"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
},
"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."
}
}
},
"UpdateResourceRequestDTO": {
"type": "object",
"description": "Request DTO for updating a resource with its type and associated collections.",
"properties": {
"resourceType": {
"type": "string",
"description": "Resource type.",
"example": "team",
"minLength": 1
},
"resourceId": {
"type": "string",
"description": "Resource Id.",
"example": "80f49a6e-11d7-4651-b730-99ed2f726f61",
"minLength": 1
},
"resourceCollections": {
"type": "array",
"description": "List of resource collections associated with the resource.",
"items": {
"$ref": "#/components/schemas/ResourceCollectionDetails"
}
}
},
"required": [
"resourceId",
"resourceType"
]
},
"ResourceCollectionDetails": {
"type": "object",
"description": "Details of a resource collection, including its ID.",
"properties": {
"id": {
"type": "string",
"description": "ID of this contact center resource.",
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"minLength": 1
}
},
"required": [
"id"
]
},
"UpdateResourceResponseDTO": {
"type": "object",
"description": "Response DTO containing a list of updated resources.",
"example": {
"response": [
{
"id": "80f49a6e-11d7-4651-b730-99ed2f726f61",
"resourceType": "team",
"status": 200
},
{
"id": "90f49a6e-11d7-4651-b730-99ed2f726f62",
"resourceType": "desktop-profile",
"status": 400,
"apiError": {
"trackingId": "ccconfig_7113a3e7-bc11-43f2-9f2d-ded48e8685cd",
"error": {
"key": "400",
"reason": "400 BAD_REQUEST \"Entity not found or more than one entity found on the unique fields\"",
"message": [
{
"description": "400 BAD_REQUEST \"Entity not found or more than one entity found on the unique fields\""
}
]
}
}
}
]
},
"properties": {
"response": {
"type": "array",
"description": "List of updated resources.",
"items": {
"$ref": "#/components/schemas/UpdateResourceDTO"
}
}
}
},
"UpdateResourceDTO": {
"type": "object",
"description": "Data Transfer Object for updating a resource, including its ID, type, status, and any associated error information.",
"properties": {
"id": {
"type": "string",
"description": "ID of this contact center resource.",
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0",
"minLength": 1
},
"resourceType": {
"type": "string",
"description": "Name of the resource type.",
"example": "team",
"minLength": 1
},
"status": {
"type": "integer",
"format": "int32",
"description": "The HTTP status code.",
"example": 400
},
"apiError": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
},
"required": [
"id",
"resourceType"
]
},
"SiteDTO": {
"required": [
"active",
"multimediaProfileId",
"name"
],
"type": "object",
"properties": {
"organizationId": {
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
"type": "string",
"description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
"format": "uuid",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"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",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"format": "int32",
"example": 1
},
"name": {
"maxLength": 80,
"minLength": 1,
"pattern": "^[a-zA-Z\\d-_\\s]+$",
"type": "string",
"description": "Indicates the name of the site. Generally, it is the name of the geographical location. It is required only during a create or an update operation.",
"example": "California"
},
"active": {
"type": "boolean",
"description": "Indicates the status of the site whether it is active(when true) or not active(when false). It is required only during a create or an update operation.",
"example": true
},
"multimediaProfileId": {
"type": "string",
"description": "Indicates the multimedia profile for the site. It is required only during a create or an update operation.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"createdTime": {
"type": "integer",
"description": "Creation time(in epoch millis) of this resource.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
},
"lastUpdatedTime": {
"type": "integer",
"description": "Time(in epoch millis) when this resource was last updated.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
}
}
},
"BulkRequestDTOSiteDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOSiteDTO"
}
}
}
},
"BulkRequestItemDTOSiteDTO": {
"type": "object",
"properties": {
"itemIdentifier": {
"type": "integer",
"description": "Unique item identifier for a bulk operation.",
"format": "int32",
"example": 10
},
"item": {
"$ref": "#/components/schemas/SiteDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values can be SAVE and DELETE.",
"example": "SAVE"
}
}
},
"BulkExportDTOSiteBulkExportDTO": {
"type": "object",
"properties": {
"totalResources": {
"type": "integer",
"description": "Total number of items",
"format": "int32",
"example": 100
},
"pageNumber": {
"type": "integer",
"description": "Current page number",
"format": "int32",
"example": 0
},
"pageSize": {
"type": "integer",
"description": "Page size for current data set",
"format": "int32",
"example": 50
},
"rel": {
"type": "string",
"description": "Indicates whether more pages exist. When 'next' there are more pages available, otherwise 'last'.",
"example": "last"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteBulkExportDTO"
}
}
}
},
"SiteBulkExportDTO": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"multimediaProfileName": {
"type": "string"
}
}
},
"ResponseEnvelopeSiteDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SiteDTO"
}
}
}
},
"SkillDTO": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Indicates the name of the skill. Once created, name cannot be modified.",
"example": "German Speaking",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9,@_.\\-\\s]*$"
},
"description": {
"type": "string",
"description": "Indicates the description of the skill.",
"example": "Skill to speak fluent German.",
"maxLength": 255,
"minLength": 0
},
"serviceLevelThreshold": {
"type": "integer",
"format": "int32",
"description": "Allows to set the time that a customer request can be in a queue before the system flags it as outside the service level. \n\n If the agent completes a customer service request within this time interval, the system considers it within the service level. \nIt is required only for a create or an update operation.",
"example": 0
},
"enumSkillValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnumSkillValueDTO",
"description": "If skillType is enum, the skill can take different sub-values which are defined with this field. For instance, a skill named \"tech support\" may have enumSkillValues for \"windows\", \"macOS\" and \"linux\"."
},
"uniqueItems": true
},
"active": {
"type": "boolean",
"description": "Indicates the status of the skill whether it is active(when true) or not active(when false). It is required only during a create or an update operation.",
"example": true
},
"dynamicSkill": {
"type": "boolean",
"description": "Indicates whether the skill is a dynamic skill or not. Default value is false.",
"example": false
},
"skillType": {
"type": "string",
"description": "This can be of the following types\n\nPROFICIENCY: id = 0\n\nBOOLEAN: id = 1\n\nTEXT: id = 2\n\nENUM: id = 3\n\nOnce created, skillType cannot be modified.\n",
"enum": [
"Proficiency",
"Boolean",
"Text",
"enum"
],
"example": "BOOLEAN"
},
"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": [
"active",
"name",
"serviceLevelThreshold",
"skillType"
]
},
"EnumSkillValueDTO": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Indicates the name of the enumSkillValue.",
"example": "MacOS support",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9._\\-\\s]*$"
},
"description": {
"type": "string",
"description": "Indicates the description of the enumSkillValue.",
"example": "Ability to troubleshoot macOS issues.",
"maxLength": 255,
"minLength": 0
},
"skillId": {
"type": "string",
"description": "Represents the skillId of the enumSkillValue.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"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": [
"name"
]
},
"BulkRequestDTOSkillDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOSkillDTO"
}
}
}
},
"BulkRequestItemDTOSkillDTO": {
"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/SkillDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"ResponseEnvelopeSkillDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SkillDTO"
}
}
}
},
"SkillProfileDTOList": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Indicates the name of the skill Profile. It is required only during a create or an update operation.",
"example": "German Speaker",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9,@_.\\-\\s]*$"
},
"description": {
"type": "string",
"description": "A short description of the skill profile.",
"example": "Required for transferring out-dial calls to Queues",
"maxLength": 255,
"minLength": 0
},
"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
}
}
},
"SkillProfileDTO": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Indicates the name of the skill Profile. It is required only during a create or an update operation.",
"example": "German Speaker",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9,@_.\\-\\s]*$"
},
"description": {
"type": "string",
"description": "A short description of the skill profile.",
"example": "Required for transferring out-dial calls to Queues",
"maxLength": 255,
"minLength": 0
},
"activeSkills": {
"type": "array",
"description": "In activeSkills and activeEnumSkills at least one skill is mandatory.",
"items": {
"$ref": "#/components/schemas/ActiveSkillDTO"
},
"uniqueItems": true
},
"activeEnumSkills": {
"type": "array",
"description": "Indicates a value that represents a skill the agent has.",
"items": {
"$ref": "#/components/schemas/ActiveEnumSkillDTO"
},
"uniqueItems": true
},
"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": [
"activeSkills",
"name"
]
},
"ActiveSkillDTO": {
"type": "object",
"description": "In activeSkills and activeEnumSkills at least one skill is mandatory.",
"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
},
"textValue": {
"type": "string",
"description": "A short textual description that represents a skill the agent has.",
"example": "Credit card SME",
"maxLength": 100,
"minLength": 0
},
"booleanValue": {
"type": "boolean",
"description": "Indicates whether the agent has this skill (True) or does not have the skill (False).",
"example": true
},
"proficiencyValue": {
"type": "integer",
"format": "int32",
"description": "A number between 0 and 10 to indicate how proficient the agent is in this skill.",
"example": 1,
"maximum": 10,
"minimum": 0
},
"skillId": {
"type": "string",
"description": "Indicates a value that represents a skill the agent has.",
"example": "FRENCH",
"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
},
"skillName": {
"type": "string",
"description": "Name of the skill, included in the payload only when 'includeSkillDetails' is true.",
"example": "Customer Support"
}
},
"required": [
"booleanValue",
"skillId"
]
},
"ActiveEnumSkillDTO": {
"type": "object",
"description": "Indicates a value that represents a skill the agent has.",
"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
},
"enumSkillValueId": {
"type": "string",
"description": "ID of the enumSkillValue.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"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
},
"enumSkillName": {
"type": "string",
"description": "Enum skill name, included in the payload only if 'includeSkillDetails' is true.",
"example": "Language"
},
"enumSkillValue": {
"type": "string",
"description": "Enum skill value, included only if 'includeSkillDetails' is true.",
"example": "English"
},
"enumSkillId": {
"type": "string",
"description": "Enum skill ID, included only if 'includeSkillDetails' is true.",
"example": "56912f11-6017-404b-bf14-5331890b1456"
}
},
"required": [
"enumSkillValueId"
]
},
"BulkRequestDTOSkillProfileDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOSkillProfileDTO"
}
}
}
},
"BulkRequestItemDTOSkillProfileDTO": {
"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/SkillProfileDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"ResponseEnvelopeSkillProfileDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SkillProfileDTO"
}
}
}
},
"TeamResponseDTO": {
"type": "object",
"description": "Team Response schema.",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Indicates the name of the team such as Billing or Customer Support",
"example": "Customer Support"
},
"teamType": {
"type": "string",
"description": "Team type can be the following:\n\nAGENT: A specific number of agents are assigned to the team.\n\nCAPACITY: Specific number of agents not assigned to the team. Capacity-based teams for voice mailboxes or agent groups that are not managed by the Webex Contact Center system.",
"enum": [
"AGENT",
"CAPACITY"
],
"example": "AGENT"
},
"teamStatus": {
"type": "string",
"description": "Indicates whether the team is available to handle customer contacts.\nCan be one of: IN_SERVICE/NOT_AVAILABLE.\n",
"enum": [
"IN_SERVICE",
"NOT_AVAILABLE"
],
"example": "IN_SERVICE"
},
"dialedNumber": {
"type": "string",
"description": "The dial number where the system distributes the calls for this team. \nThis setting is applicable only for capacity-based teams.",
"example": "+14085550123"
},
"capacity": {
"type": "integer",
"format": "int32",
"description": "The maximum number of simultaneous contacts that this team can handle.\nThis setting is applicable only for capacity-based teams.",
"example": 1
},
"active": {
"type": "boolean",
"description": "Indicates whether the team is active(when true) or not active(when false).",
"example": true
},
"siteId": {
"type": "string",
"description": "Identifier for a site which is a physical contact center location under the control of your enterprise.",
"example": "8e6bb6da-2a78-4768-bef9-7e229f92af22"
},
"desktopLayoutId": {
"type": "string",
"description": "Identifier for an agent desktop layout which a Contact Center administrator has configured.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"siteName": {
"type": "string",
"description": "The name of the site this team belongs to.",
"example": "New_York"
},
"skillProfileId": {
"type": "string",
"description": "Id of the skill profile for this team if your enterprise uses the optional Skills-Based Routing feature.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"multiMediaProfileId": {
"type": "string",
"description": "Id of the multimedia profile for this team.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"userIds": {
"type": "array",
"description": "Indicates the agents id(s) who are part of this team.",
"example": [
"f53c8b54-46ca-43f6-ba05-08426a46e23d",
"a53c8b54-46ca-43f6-ba05-08426a46e23f"
],
"items": {
"type": "string",
"description": "Indicates the agents id(s) who are part of this team.",
"example": [
"f53c8b54-46ca-43f6-ba05-08426a46e23d",
"a53c8b54-46ca-43f6-ba05-08426a46e23f"
]
},
"uniqueItems": true
},
"description": {
"type": "string",
"description": "Indicates the team",
"example": "Capacity based team"
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"rankQueuesForTeam": {
"type": "boolean",
"description": "Rank Queues For Team."
},
"queueRankings": {
"type": "array",
"description": "List of Queue Rankings.",
"items": {
"$ref": "#/components/schemas/QueueRankingDTO",
"description": "Queue Ranking."
},
"uniqueItems": true
},
"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
}
}
},
"QueueRankingDTO": {
"type": "object",
"description": "Queue Ranking schema.",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"queueId": {
"type": "string",
"description": "Queue Id.",
"minLength": 1
},
"rank": {
"type": "integer",
"format": "int32",
"description": "Rank.",
"maximum": 50
},
"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": [
"queueId",
"rank"
]
},
"TeamDTO": {
"type": "object",
"description": "Team schema.",
"properties": {
"organizationId": {
"type": "string",
"format": "uuid",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$"
},
"id": {
"type": "string",
"description": "ID of this contact center resource. It should not be specified when creating a new resource. However, it is mandatory when updating a resource.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"version": {
"type": "integer",
"format": "int32",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"example": 1
},
"name": {
"type": "string",
"description": "Enter the name for the team. Generally, use names that indicate the function of the team, such as Billing or Customer Support. This field should be specified for create and update operation. Two teams in the same site in an organization cannot share the same name.",
"example": "inline-pcs-team"
},
"teamType": {
"type": "string",
"description": "Team type can be the following:\n\nAGENT: You assign a specific number of agents to the team.\n\nCAPACITY: You don\u2019t assign any specific number of agents to the team. You use capacity-based teams for voice mailboxes or agent groups that are not managed by the Webex Contact Center system.\n\nOnce created, teamType cannot be modified.",
"enum": [
"AGENT",
"CAPACITY"
],
"example": "AGENT"
},
"teamStatus": {
"type": "string",
"description": "Select the status of the team to indicate whether the team is available to handle customer contacts.\nCan be one of: IN_SERVICE/NOT_AVAILABLE.",
"enum": [
"IN_SERVICE",
"NOT_AVAILABLE"
],
"example": "IN_SERVICE"
},
"dialedNumber": {
"type": "string",
"description": "Enter the dial number where the system distributes the calls for this team. \nThis setting is applicable only for capacity-based teams.",
"example": "+14085550123"
},
"capacity": {
"type": "integer",
"format": "int32",
"description": "Enter the maximum number of simultaneous contacts that this team can handle.\nThis setting is applicable only for capacity-based teams.",
"example": 1
},
"active": {
"type": "boolean",
"description": "Specify whether the team is active or not Active.",
"example": true
},
"siteId": {
"type": "string",
"description": "Identifier for a site which is a physical contact center location under the control of your enterprise. Once specified, siteId should not be modified.",
"example": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"minLength": 1
},
"desktopLayoutId": {
"type": "string",
"description": "Identifier for an agent desktop layout which a Contact Center administrator has configured.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"skillProfileId": {
"type": "string",
"description": "(Optional) If your enterprise uses the optional Skills-Based Routing feature, you can select a skill profile for this team. \nNote: You can\u2019t assign this profile to a capacity-based team.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"multiMediaProfileId": {
"type": "string",
"description": "(Optional) If your organization administrator enables Multimedia for your enterprise, you can select a multimedia profile for this team. \nNote: You can\u2019t assign this profile to a capacity-based team.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"userIds": {
"type": "array",
"description": "Specify the agents id who will be part of this team. \nNote: You can\u2019t assign this profile to a capacity-based team.",
"example": [
"f53c8b54-46ca-43f6-ba05-08426a46e23d",
"a53c8b54-46ca-43f6-ba05-08426a46e23f"
],
"items": {
"type": "string",
"description": "Specify the agents id who will be part of this team. \nNote: You can\u2019t assign this profile to a capacity-based team.",
"example": [
"f53c8b54-46ca-43f6-ba05-08426a46e23d",
"a53c8b54-46ca-43f6-ba05-08426a46e23f"
]
},
"uniqueItems": true
},
"description": {
"type": "string",
"description": "Description.",
"maxLength": 255,
"minLength": 0
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"rankQueuesForTeam": {
"type": "boolean",
"description": "Indicates whether the queues should be ranked for the team.",
"example": true
},
"queueRankings": {
"type": "array",
"description": "List of Queue Rankings.",
"items": {
"$ref": "#/components/schemas/QueueRankingDTO",
"description": "Queue Ranking."
},
"uniqueItems": true
},
"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": [
"active",
"name",
"rankQueuesForTeam",
"siteId",
"teamStatus",
"teamType"
]
},
"BulkRequestDTOTeamDTO": {
"type": "object",
"description": "Bulk Request Team schema.",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOTeamDTO",
"description": "Item."
}
}
}
},
"BulkRequestItemDTOTeamDTO": {
"type": "object",
"description": "List of items in the bulk request.",
"properties": {
"itemIdentifier": {
"type": "integer",
"format": "int32",
"description": "Unique item identifier for a bulk operation.",
"example": 10
},
"item": {
"$ref": "#/components/schemas/TeamDTO",
"description": "Item."
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"ResponseEnvelopeTeamResponseDTO": {
"type": "object",
"description": "Response Envelope Team Response schema.",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"description": "Meta additional property."
},
"description": "Additional properties for Meta."
},
"data": {
"type": "array",
"description": "List of Data.",
"items": {
"$ref": "#/components/schemas/TeamResponseDTO",
"description": "Data item."
}
}
}
},
"UserProfileGranularAccessDTO": {
"type": "object",
"description": "Data Transfer Object for creating or updating a user profile with granular access controls.",
"example": {
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"name": "Contact Center Admin Profile",
"description": "This profile should be applied only to contact center admins.",
"profileType": "PREMIUM_AGENT",
"active": true,
"permissionAccessLevel": "ALL",
"resourceAccessLevel": "ALL",
"permissions": [
{
"id": "00734874-4732-43bb-bfff-d1e75d309eb1",
"name": "sites",
"access": "NONE"
}
],
"editableFolderIds": [
1,
2
],
"viewableFolderIds": [
1,
2
],
"nonViewableFolderIds": [
1,
2
],
"systemDefault": false,
"defaultResourceCollectionId": "80f49a6e-11d7-4651-b730-99ed2f726f61",
"resourceCollections": [
{
"id": "80f49a6e-11d7-4651-b730-99ed2f726f61",
"name": "Department1",
"description": "Department1 description.",
"resources": [
{
"name": "team",
"accessLevel": "SPECIFIC",
"ids": [
"00734874-4732-43bb-bfff-d1e75d309eb1",
"00734874-4732-43bb-bfff-d1e75d309eb2"
]
},
{
"name": "desktop-profile",
"accessLevel": "ALL"
},
{
"name": "desktop-layout",
"accessLevel": "NONE"
}
],
"resourceCount": 2
}
],
"createdTime": 0,
"lastUpdatedTime": 0
},
"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": "The name of the user profile.",
"example": "Contact Center Admin Profile",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9,_\\-\\s]*$"
},
"description": {
"type": "string",
"description": "An optional description of the profile.",
"example": "This profile should be applied only to contact center admins.",
"maxLength": 255,
"minLength": 0
},
"profileType": {
"type": "string",
"description": "The type determines the privileges applicable for a profile.\n\nIt can take one of these values:\n\nSTANDARD_AGENT \u2014 Has access to Agent Desktop[m_agent_desktop] module.\n\nPREMIUM_AGENT \u2014 Has access to Agent Desktop[m_agent_desktop] and Multimedia[m_multimedia] module.\n\nSUPERVISOR \u2014 Has access to all modules except to manage tenants in the Provisioning[m_provisioning] module.\n\nADMINISTRATOR \u2014 Has access to all modules.\n\nADMINISTRATOR_ONLY \u2014 Has access to Provisioning[m_provisioning], Real Time Reports[m_real_time_reports], Call Recording[m_call_recording], IMI Digital Channels[m_imi_digital_channels], and Routing Strategy[m_routing_strategy] modules.\n\nIt is required only during a create operation. \n\nThe profile type cannot be changed for an existing user profile.\n\n",
"enum": [
"ADMINISTRATOR",
"ADMINISTRATOR_ONLY",
"SUPERVISOR",
"PREMIUM_AGENT",
"STANDARD_AGENT",
"ANALYZER_ADMINISTRATOR",
"ANALYZER_SUPERVISOR",
"ANALYZER_USER"
],
"example": "PREMIUM_AGENT"
},
"active": {
"type": "boolean",
"description": "Specify whether the User profile is active or not.",
"example": true
},
"permissionAccessLevel": {
"type": "string",
"description": "This can be used to allow users of this profile access to specific or all the Webex Contact Center permissions.\n\nIt can take one of these values:\n\nALL \u2014 A contact center user with this profile can access all Contact Center permissions.\n\nSPECIFIC \u2014 A contact center user with this profile can access only specific permissions.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"resourceAccessLevel": {
"type": "string",
"description": "This can be used to allow users of this profile access to specific or all the Webex Contact Center resources.\n\nIt can take one of these values:\n\nALL \u2014 A contact center user with this profile can access all Contact Center resources.\n\nSPECIFIC \u2014 A contact center user with this profile can access only specific resources.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"permissions": {
"type": "array",
"description": "Specifies the permissions(s) a user of this profile has access to.\n\nIt should be chosen when permission access is SPECIFIC.\n\nPlease specify all the following permissions and their respective access type.\n\n",
"items": {
"$ref": "#/components/schemas/UserProfilePermissionsDTO",
"description": "Permission."
},
"uniqueItems": true
},
"editableFolderIds": {
"type": "array",
"description": "Indicates the id(s) of the reporting folders a user of this profile has read and write access to. \n",
"example": [
1,
2
],
"items": {
"type": "integer",
"format": "int32",
"description": "Editable Folder Id."
},
"uniqueItems": true
},
"viewableFolderIds": {
"type": "array",
"description": "Indicates the id(s) of the reporting folders a user of this profile has read access to. \n",
"example": [
1,
2
],
"items": {
"type": "integer",
"format": "int32",
"description": "Viewable Folder Id."
},
"uniqueItems": true
},
"nonViewableFolderIds": {
"type": "array",
"description": "Indicates the id(s) of the restricted reporting folders for a user of this profile. \n",
"example": [
1,
2
],
"items": {
"type": "integer",
"format": "int32",
"description": "Non Viewable Folder Id."
},
"uniqueItems": true
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"defaultResourceCollectionId": {
"type": "string",
"description": "Specifies the default resource collection for this profile",
"example": "80f49a6e-11d7-4651-b730-99ed2f726f61"
},
"resourceCollections": {
"type": "array",
"description": "Specifies the resource collection(s) a user of this profile has access to.\n\nresource collection(s) needs to be specified when resourceAccessLevel is SPECIFIC",
"items": {
"$ref": "#/components/schemas/ResourceCollectionDTO",
"description": "Resource Collection."
},
"uniqueItems": true
},
"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": [
"active",
"name",
"permissionAccessLevel",
"profileType",
"resourceAccessLevel"
]
},
"UserProfilePermissionsDTO": {
"type": "object",
"description": "User Profile Permissions DTO",
"properties": {
"id": {
"type": "string",
"description": "The id of the user profile permission.",
"example": "00734874-4732-43bb-bfff-d1e75d309eb1"
},
"name": {
"type": "string",
"description": "The name of the user profile permission.audio-prompt \u2014 Has access to Audio Prompt[audio_prompt] permission.\n\nagent-personalized-greeting \u2014 Has access to Agent Personalized Greeting[agent_personalized_greeting] permission.\n\nholiday-list \u2014 Has access to Holiday List[holiday_list] permission.\n\noverride \u2014 Has access to Override[override] permission.\n\nworking-hour \u2014 Has access to Working Hour[working_hour] permission.\n\ncall-recording-schedule \u2014 Has access to Call Recording Schedule[call_recording_schedule] permission.\n\nchannel \u2014 Has access to Channel[channel] permission.\n\nentry-point \u2014 Has access to Entry Point[entry_point] permission.\n\ncustom-channel \u2014 Has access to Custom Channel[custom_channel] permission.\n\nsupport-number \u2014 Has access to Support Number[support_number] permission.\n\nflow-settings-override \u2014 Has access to Flow Settings Override[flow_settings_override] permission.\n\nqueue \u2014 Has access to Queue[queue] permission.\n\nflow \u2014 Has access to Flow[flow] permission.\n\nfunction \u2014 Has access to Function[function] permission.\n\nglobal-variable \u2014 Has access to Global Variable[global_variable] permission.\n\nasset \u2014 Has access to Asset[asset] permission.\n\nweb-chat-asset \u2014 Has access to Web Chat Asset[web_chat_asset] permission.\n\nresource-collection \u2014 Has access to Resource Collection[resource_collection] permission.\n\nuser-profile \u2014 Has access to User Profile[user_profile] permission.\n\nuser \u2014 Has access to User[user] permission.\n\nsite \u2014 Has access to Site[site] permission.\n\nskill-profile \u2014 Has access to Skill Profile[skill_profile] permission.\n\nskill-definition \u2014 Has access to Skill Definition[skill_definition] permission.\n\nteam \u2014 Has access to Team[team] permission.\n\naddress-book \u2014 Has access to Address Book[address_book] permission.\n\nagent-wellbeing \u2014 Has access to Agent Wellbeing[agent_wellbeing] permission.This is applicable/available only when AI Assistant add-on offer/license is added to the organization.\n\nauto-csat \u2014 Has access to Auto CSAT[auto_csat] permission.This is applicable/available when either AI Assistant/AI Quality Management add-on offer/license is added to the organization.\n\ngenerated-summary \u2014 Has access to Generated Summary[generated_summary] permission.This is applicable/available only when AI Assistant add-on offer/license is added to the organization.\n\nreal-time-transcription \u2014 Has access to Real Time Transcription[real_time_transcription] permission.This is applicable/available when either AI Assistant/AI Quality Management add-on offer/license is added to the organization.\n\nsuggested-response \u2014 Has access to Suggested Response[suggested_response] permission.This is applicable/available only when AI Assistant add-on offer/license is added to the organization.\n\ndesktop-layout \u2014 Has access to Desktop Layout[desktop_layout] permission.\n\ndesktop-profile \u2014 Has access to Desktop Profile[desktop_profile] permission.\n\ndial-plan \u2014 Has access to Dial Plan[dial_plan] permission.\n\nmultimedia-profile \u2014 Has access to Multimedia Profile[multimedia_profile] permission.\n\nidle-wrapup-code \u2014 Has access to Idle Wrap-Up Code[idle_wrapup_code] permission.\n\noutdial-ani \u2014 Has access to Outdial ANI[outdial_ani] permission.\n\nquick-reply \u2014 Has access to Quick Reply[quick_reply] permission.\n\napi-key \u2014 Has access to API Key[api_key] permission.\n\naudit-trail \u2014 Has access to Audit Trail[audit_trail] permission.\n\nbusiness-rules-engine \u2014 Has access to Business Rules Engine[business_rules_engine] permission.\n\ncampaign-manager \u2014 Has access to Campaign Manager[campaign_manager] permission.\n\nrouting-strategy \u2014 Has access to Routing Strategy[routing_strategy] permission.\n\ntenant-setting \u2014 Has access to Tenant Setting[tenant_setting] permission.\n\naudio-recording-transcript \u2014 Has access to Audio Recording Transcript[audio_recording_transcript] permission.\n\ntag \u2014 Has access to Tag[tag] permission.\n\nadditional-supervisory \u2014 Has access to Additional Supervisory[additional_supervisory] permission.\n\nchange-agent-state \u2014 Has access to Change Agent State[change_agent_state] permission.\n\nmanage-agent-queues-assignment \u2014 Has access to Manage Agent Queues Assignment[manage_agent_queues_assignment] permission.\n\nreskill-agent \u2014 Has access to Reskill Agent[reskill_agent] permission.\n\nsend-message \u2014 Has access to Send Message[send_message] permission.\n\nsign-out-agent \u2014 Has access to Sign Out Agent[sign_out_agent] permission.\n\nanalyzer \u2014 Has access to Analyzer[analyzer] permission.\n\ncall-monitoring \u2014 Has access to Call Monitoring[call_monitoring] permission.\n\nbarge-in \u2014 Has access to Barge-In[barge_in] permission.\n\nwhisper-coach \u2014 Has access to Whisper Coach[whisper_coach] permission.\n\nrestricted-monitor-only \u2014 Has access to Restricted Monitor Only[restricted_monitor_only] permission.\n\nview-blind-monitor-request \u2014 Has access to View Blind Monitor Request[view_blind_monitor_request] permission.\n\nmid-call-monitor \u2014 Has access to Mid-Call Monitor[mid_call_monitor] permission.\n\nthreshold-rule \u2014 Has access to Threshold Rule[threshold_rule] permission.\n\nmultimedia \u2014 Has access to Multimedia[multimedia] permission.\n\nbasic-digital \u2014 Has access to Basic Digital[basic_digital] permission.\n\nsocial-channel \u2014 Has access to Social Channel[social_channel] permission.\n\ncoaching-insights \u2014 Has access to Coaching Insights[coaching-insights] permission.This is applicable/available only when AI Quality Management add-on offer/license is added to the organization.\n\nsentiment-analysis \u2014 Has access to Sentiment Analysis[sentiment-analysis] permission.This is applicable/available when either AI Assistant/AI Quality Management add-on offer/license is added to the organization.\n\nevaluations-analytics \u2014 Has access to Evaluations Analytics[evaluations-analytics] permission.This is applicable/available only when AI Quality Management add-on offer/license is added to the organization.\n\ncoaching-insights-assignment \u2014 Has access to Coaching Insights Assignment[coaching-insights-assignment] permission.This is applicable/available only when AI Quality Management add-on offer/license is added to the organization.\n\nevaluation-forms-assignment \u2014 Has access to Evaluation Forms Assignment[evaluation-forms-assignment] permission.This is applicable/available only when AI Quality Management add-on offer/license is added to the organization.\n\nevaluation-forms-manage \u2014 Has access to Evaluation Forms Manage[evaluation-forms-manage] permission.This is applicable/available only when AI Quality Management add-on offer/license is added to the organization.\n\nevaluation-forms-calibrate-questions \u2014 Has access to Evaluation Forms Calibrate Questions[evaluation-forms-calibrate-questions] permission.This is applicable/available only when AI Quality Management add-on offer/license is added to the organization.\n\npredicted-wait-time \u2014 Has access to Predicted Wait Time[predicted-wait-time] permission.\n\npersonalized-ai-routing \u2014 Has access to Personalized AI Routing[personalized-ai-routing] permission.\n\nplay \u2014 Has access to Play[play] permission.\n\ndownload \u2014 Has access to Download[download] permission.\n\ndelete-recording-transcript \u2014 Has access to Delete[delete-recording-transcript] permission.\n\nschedule-listening \u2014 Has access to Schedule Listening[schedule-listening] permission. This permission is available only for Supervisor profiles and controls access to manage Schedule Listening feature in ESD.\n\n",
"example": "site",
"minLength": 1
},
"access": {
"type": "string",
"description": "Indicates the access rights for a user of this profile for a Webex Contact Center module.\n\nIt can take be one of these values:\n\nVIEW \u2014 A contact center user with this profile has read only access to a Contact Center module.\n\nEDIT \u2014 A contact center user with this profile has read and write access to a Contact Center module.\n\nNONE \u2014 A contact center user with this profile cannot access the module.\n\n",
"enum": [
"EDIT",
"VIEW",
"NONE",
"ENABLED",
"DISABLED"
],
"example": "NONE"
}
},
"required": [
"name"
]
},
"BulkRequestDTOUserProfileGranularAccessDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOUserProfileGranularAccessDTO"
}
}
}
},
"BulkRequestItemDTOUserProfileGranularAccessDTO": {
"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/UserProfileGranularAccessDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"AccessControlListDTO": {
"type": "object",
"description": "Access Control List is higher order DTO of user profile and resource collection.",
"example": {
"organizationId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"id": "93912f11-6017-404b-bf14-5331890b1797",
"version": 1,
"name": "Administrator",
"profileType": "ADMINISTRATOR",
"description": "User Profile Description",
"active": true,
"permissionAccessLevel": "ALL",
"resourceAccessLevel": "ALL",
"editableFolderIds": [
1,
2,
3
],
"viewableFolderIds": [
4,
5,
6
],
"nonViewableFolderIds": [
7,
8,
9
],
"defaultResourceCollectionId": "123e4567-e89b-12d3-a456-426614174000",
"resourceCollections": [
{
"id": "80f49a6e-11d7-4651-b730-99ed2f726f61",
"name": "Department1",
"description": "Department1 description.",
"resources": [
{
"name": "team",
"accessLevel": "SPECIFIC",
"ids": [
"00734874-4732-43bb-bfff-d1e75d309eb1",
"00734874-4732-43bb-bfff-d1e75d309eb2"
]
},
{
"name": "desktop-profile",
"accessLevel": "ALL"
},
{
"name": "desktop-layout",
"accessLevel": "NONE"
}
],
"resourceCount": 2
}
],
"permissions": [
{
"id": "00734874-4732-43bb-bfff-d1e75d309eb1",
"name": "sites",
"access": "NONE"
}
],
"resources": [
{
"name": "site",
"accessLevel": "ALL",
"ids": [
"00734874-4732-43bb-bfff-d1e75d309eb1",
"00734874-4732-43bb-bfff-d1e75d309eb2"
]
}
],
"createdTime": 0,
"lastUpdatedTime": 0
},
"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": "name of the user profile as ACL.",
"example": "Administrator"
},
"profileType": {
"type": "string",
"description": "User Profile Type.",
"enum": [
"ADMINISTRATOR",
"ADMINISTRATOR_ONLY",
"SUPERVISOR",
"PREMIUM_AGENT",
"STANDARD_AGENT",
"ANALYZER_ADMINISTRATOR",
"ANALYZER_SUPERVISOR",
"ANALYZER_USER"
],
"example": "ADMINISTRATOR"
},
"description": {
"type": "string",
"description": "User Profile Description.",
"example": "User Profile Description"
},
"active": {
"type": "boolean",
"description": "Indicates whether the user profile is active.",
"example": true
},
"permissionAccessLevel": {
"type": "string",
"description": "Permissions Access Level for user profile level.",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"resourceAccessLevel": {
"type": "string",
"description": "Resource Access Level for resource collection level.",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"editableFolderIds": {
"type": "array",
"description": "Set of editable folder IDs that are part of user profile.",
"example": [
1,
2,
3
],
"items": {
"type": "integer",
"format": "int32"
},
"uniqueItems": true
},
"viewableFolderIds": {
"type": "array",
"description": "Set of viewable folder IDs that the part of user profile.",
"example": [
4,
5,
6
],
"items": {
"type": "integer",
"format": "int32"
},
"uniqueItems": true
},
"nonViewableFolderIds": {
"type": "array",
"description": "Set of non-viewable folder IDs that are part of user profile.",
"example": [
7,
8,
9
],
"items": {
"type": "integer",
"format": "int32"
},
"uniqueItems": true
},
"defaultResourceCollectionId": {
"type": "string",
"description": "Default Resource Collection ID.",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"resourceCollections": {
"type": "array",
"description": "Set of resource collections associated with the User Profile.",
"items": {
"$ref": "#/components/schemas/ResourceCollectionDTO"
},
"uniqueItems": true
},
"permissions": {
"type": "array",
"description": "Set of permissions associated with the User Profile.",
"items": {
"$ref": "#/components/schemas/UserProfilePermissionsDTO"
},
"uniqueItems": true
},
"resources": {
"type": "array",
"description": "Set of resources associated with the Resource Collection.",
"items": {
"$ref": "#/components/schemas/ResourceTypesDTO"
},
"uniqueItems": true
},
"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
}
}
},
"UserResponseDTO": {
"type": "object",
"description": "User response data transfer object containing user profile and configuration details",
"example": {
"id": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"firstName": "John",
"lastName": "Wick",
"email": "johnwick@company.com",
"workPhone": "1234567890",
"mobile": "1234567890",
"ciUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"broadCloudUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"timezone": "America/New_York",
"userProfileId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"userProfileType": "PREMIUM_AGENT",
"contactCenterEnabled": true,
"siteId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"siteName": "bengaluru",
"teamIds": [
"f53c8b54-46ca-43f6-ba05-08426a46e23d"
],
"skillProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"agentProfileId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"multimediaProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"deafultDialledNumber": "1234567890",
"externalIdentifier": "121212",
"active": true,
"imiUserCreated": true,
"systemDefault": false,
"userLevelBurnoutInclusion": "INCLUDED",
"userLevelAutoCSATInclusion": "INCLUDED",
"userLevelWellnessBreakReminders": "DISABLED",
"userLevelSummariesInclusion": "INCLUDED",
"createdTime": 1679392200000,
"lastModifiedTime": 1679392200000
},
"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
},
"firstName": {
"type": "string",
"description": "The first name of the user.",
"example": "John"
},
"lastName": {
"type": "string",
"description": "The last name of the user.",
"example": "Wick"
},
"email": {
"type": "string",
"description": "The email address of the user.",
"example": "johnwick@company.com"
},
"workPhone": {
"type": "string",
"description": "The work phone number of the user.",
"example": "1234567890"
},
"mobile": {
"type": "string",
"description": "The mobile phone number of the user.",
"example": "1234567890"
},
"ciUserId": {
"type": "string",
"description": "Cisco Common Identity user Id",
"example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1"
},
"broadCloudUserId": {
"type": "string",
"description": "Broadcloud user Id",
"example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1"
},
"timezone": {
"type": "string",
"description": "(Optional) The time zone that you provision for your enterprise.",
"example": "America/New_York"
},
"xspVersion": {
"type": "string",
"description": "(Optional) Used to subscribe for recording events.",
"example": "xsp-24.0"
},
"subscriptionId": {
"type": "string",
"description": "(Optional) Used to subscribe for recording events.",
"example": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478"
},
"userProfileId": {
"type": "string",
"description": "Identifier for an user profile which a Contact Center administrator has configured.",
"example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1"
},
"userProfileType": {
"type": "string",
"description": "Type of the user profile associated to this user. This is an optional response parameter based on the query parameter includeUserProfileType.",
"example": "PREMIUM_AGENT"
},
"contactCenterEnabled": {
"type": "boolean",
"description": "The setting is for accessing Desktop to handle customer requests.",
"example": true
},
"siteId": {
"type": "string",
"description": "Details of site which a Contact Center administrator has configured for the user.",
"example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1"
},
"siteName": {
"type": "string",
"description": "site name that user is associated with",
"example": "bengaluru"
},
"teamIds": {
"type": "array",
"description": "Specify the teams id which got assigned to this user. \nNote: You can\u2019t assign this profile to a capacity-based team.",
"examples": [
"f53c8b54-46ca-43f6-ba05-08426a46e23d",
"a53c8b54-46ca-43f6-ba05-08426a46e23f"
],
"items": {
"type": "string",
"description": "Specify the teams id which got assigned to this user. \nNote: You can\u2019t assign this profile to a capacity-based team.",
"examples": [
"f53c8b54-46ca-43f6-ba05-08426a46e23d",
"a53c8b54-46ca-43f6-ba05-08426a46e23f"
]
},
"uniqueItems": true
},
"skillProfileId": {
"type": "string",
"description": "(Optional) If your enterprise uses the optional Skills-Based Routing feature, This profile overrides any skill profile at the team level that is associated with the agent ",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"agentProfileId": {
"type": "string",
"description": "Identifier for a Desktop Profile which is a group of permissions and Agent Desktop behaviors that you assign to specific users.",
"example": "8e6bb6da-2a78-4768-bef9-7e229f92af22"
},
"multimediaProfileId": {
"type": "string",
"description": "(Optional) If your organization administrator enables Multimedia for your enterprise, you can select a multimedia profile for this team.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"deafultDialledNumber": {
"type": "string",
"description": "(Optional) The dial number of the agent.",
"example": "1234567890"
},
"externalIdentifier": {
"type": "string",
"description": "(Optional) Agent identification details, such as the employee number.",
"example": "121212"
},
"active": {
"type": "boolean",
"description": "Specify whether the user is active or not active.",
"example": true
},
"dbId": {
"type": "string",
"description": "Legacy identifier for migrated users.",
"example": "1dq45f23-1234-6r18-9a83-2atuiy0d4bh1"
},
"userProfileData": {
"$ref": "#/components/schemas/UserProfileDTO",
"description": "Details of UserProfile which a Contact Center administrator has configured for the user.This is an optional object, returned only when the endpoint 'Get User along with profile by ID' is invoked."
},
"userProfileGranularAccessData": {
"$ref": "#/components/schemas/UserProfileGranularAccessDTO",
"description": "Details of UserProfile which a Contact Center administrator has configured for the user.This is an optional object, returned only when the endpoint 'Get User along with profile by ID' is invoked."
},
"imiUserCreated": {
"type": "boolean",
"description": "Specify whether or not the corresponding user is created in IMI.",
"example": true
},
"preferredSupervisorTeamId": {
"type": "string",
"description": "The teamId to look for to load the desktop layout when a supervisor logs in to desktop.",
"example": "e27d2b54-46ca-43g6-ba65-08426e46e23d"
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"userLevelBurnoutInclusion": {
"type": "string",
"description": "User level burnout inclusion type. Used only when Agent inclusion is set to 'Specific Agents' at the org level Agent Wellbeing>Burnout config. If the value is missing in response, the consumer should assume a value as EXCLUDED.\nThis is applicable/available only when AI Assistant add-on offer/license is added to the organization.",
"enum": [
"INCLUDED",
"EXCLUDED"
],
"example": "INCLUDED"
},
"userLevelAutoCSATInclusion": {
"type": "string",
"deprecated": true,
"description": "User level AutoCSAT inclusion type. Used only when Agent inclusion is set to 'Specific Agents' at the org level Cisco AI Assistant>Auto CSAT config.\n",
"enum": [
"INCLUDED",
"EXCLUDED"
],
"example": "INCLUDED"
},
"userLevelWellnessBreakReminders": {
"type": "string",
"description": "User level Wellness break reminder type. If top level Agent burnout config has wellness break reminders enabled, this property determines if an Agent is enabled/disabled for receiving break reminders. If the value is missing in response, the consumer should assume a value as DISABLED.\nThis is applicable/available only when AI Assistant add-on offer/license is added to the organization.",
"enum": [
"DISABLED",
"ENABLED"
],
"example": "DISABLED"
},
"userLevelSummariesInclusion": {
"type": "string",
"deprecated": true,
"description": "User level Generated Summaries inclusion type. Used only when Generated Summaries is set to 'Specific Agents' at the org level Cisco AI Assistant>Generated Summaries.\n",
"enum": [
"INCLUDED",
"EXCLUDED"
],
"example": "INCLUDED"
},
"supervisorCapabilitiesEnabled": {
"type": "boolean",
"description": "Indicates whether supervisor capabilities are enabled for the user.",
"example": false
},
"agentCapabilitiesEnabled": {
"type": "boolean",
"description": "Indicates whether agent capabilities are enabled for the user.",
"example": false
},
"queuesCount": {
"$ref": "#/components/schemas/QueuesCountDTO",
"description": "Count of queues assigned to the user by queue type (team-based, skill-based, agent-based)"
},
"skillProfileUpdatedBy": {
"type": "string",
"description": "The ID of the user who last modified the skill profile",
"example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1"
},
"dynamicSkills": {
"type": "array",
"description": "The list of dynamic skills associated with the user",
"items": {
"$ref": "#/components/schemas/AssignedDynamicSkillsDTO",
"description": "Dynamic Skill."
}
},
"dynamicSkillsLimitReached": {
"type": "boolean",
"description": "Indicates if the user has reached the dynamic skills assignment limit. Present only if includeDynamicSkillsLimitReached=true is passed in the request.",
"example": true
},
"dynamicSkillsUpdatedBy": {
"type": "string",
"description": "The name of the user who last modified dynamic skills"
},
"dynamicSkillsUpdatedTime": {
"type": "integer",
"format": "int64",
"description": "The date when dynamic skills were last modified (epoch timestamp in milliseconds)",
"example": 1679392200000
},
"dynamicSkillAssigned": {
"type": "boolean",
"description": "Indicates if the user has the specified dynamic skill assigned. Present only if checkIfUserHasDynamicSkill=true and dynamicSkillId are provided in the request.",
"example": true
},
"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
},
"skillProfileUpdatedTime": {
"type": "integer",
"format": "int64",
"description": "The date when the skill profile was last modified (epoch timestamp in milliseconds)",
"example": 1679392200000
}
}
},
"UserProfileDTO": {
"type": "object",
"description": "User profile data transfer object that defines access permissions and resource scope for contact center users",
"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": "The name of the user profile.",
"example": "Contact Center Admin Profile",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9,_\\-\\s]*$"
},
"description": {
"type": "string",
"description": "An optional description of the profile.",
"example": "This profile should be applied only to contact center admins.",
"maxLength": 255,
"minLength": 0
},
"profileType": {
"type": "string",
"description": "The type determines the privileges applicable for a profile.\n\nIt can take one of these values:\n\nSTANDARD_AGENT \u2014 Has access to Agent Desktop[m_agent_desktop] module.\n\nPREMIUM_AGENT \u2014 Has access to Agent Desktop[m_agent_desktop] and Multimedia[m_multimedia] module.\n\nSUPERVISOR \u2014 Has access to all modules except to manage tenants in the Provisioning[m_provisioning] module.\n\nADMINISTRATOR \u2014 Has access to all modules.\n\nADMINISTRATOR_ONLY \u2014 Has access to Provisioning[m_provisioning], Real Time Reports[m_real_time_reports], Call Recording[m_call_recording], IMI Digital Channels[m_imi_digital_channels], and Routing Strategy[m_routing_strategy] modules.\n\nIt is required only during a create operation. \n\nThe profile type cannot be changed for an existing user profile.\n\n",
"enum": [
"ADMINISTRATOR",
"ADMINISTRATOR_ONLY",
"SUPERVISOR",
"PREMIUM_AGENT",
"STANDARD_AGENT",
"ANALYZER_ADMINISTRATOR",
"ANALYZER_SUPERVISOR",
"ANALYZER_USER"
],
"example": "PREMIUM_AGENT"
},
"accessAllModules": {
"type": "string",
"description": "This can be used to allow users of this profile access to specific or all the Webex Contact Center modules.\n\nIt can take one of these values:\n\nALL \u2014 A contact center user with this profile can access all Contact Center modules.\n\nSPECIFIC \u2014 A contact center user with this profile can access only specific modules.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"userProfileAppModules": {
"type": "array",
"description": "Specifies the module(s) a user of this profile has access to.\n\nIt should be chosen when module access is SPECIFIC.\n\nPlease specify all the following modules and their respective access type.\n\n",
"items": {
"$ref": "#/components/schemas/UserProfileAppModuleDTO",
"description": "User Profile App Module."
},
"uniqueItems": true
},
"accessAllEntryPoints": {
"type": "string",
"description": "Allow users of this profile access to specific or all the entry points for an organization.\n\nIt can take one of these values:\n\nALL \u2014 A contact center user with this profile can access all the entry points for an organization.\n\nSPECIFIC \u2014 A contact center user with this profile can access only specific entry points for an organization.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"accessAllSites": {
"type": "string",
"description": "Allow users of this profile access to specific or all the sites for an organization.\n\nIt can take one of these values:\n\nALL \u2014 A contact center user with this profile can access all the sites for an organization.\n\nSPECIFIC \u2014 A contact center user with this profile can access only specific sites for an organization.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"accessAllQueues": {
"type": "string",
"description": "Allow users of this profile access to specific or all the contact center queues for an organization.\n\nIt can take one of these values:\n\nALL \u2014 A contact center user with this profile can access all the contact center queues for an organization.\n\nSPECIFIC \u2014 A contact center user with this profile can access only specific contact center queues for an organization.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"accessAllTeams": {
"type": "string",
"description": "Allow users of this profile access to specific or all the contact center teams for an organization.\n\nIt can take one of these values:\n\nALL \u2014 A contact center user with this profile can access all the contact center teams for an organization.\n\nSPECIFIC \u2014 A contact center user with this profile can access only specific contact center teams for an organization.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"active": {
"type": "boolean",
"description": "Specify whether the User profile is active or not.",
"example": true
},
"editableFolderIds": {
"type": "array",
"description": "Indicates the id(s) of the reporting folders a user of this profile has read and write access to. \n",
"items": {
"description": "Identifier of a folder the user profile can edit",
"example": 1
},
"uniqueItems": true
},
"viewableFolderIds": {
"type": "array",
"description": "Indicates the id(s) of the reporting folders a user of this profile has read access to. \n",
"items": {
"description": "Identifier of a folder the user profile can view",
"example": 2
},
"uniqueItems": true
},
"nonViewableFolderIds": {
"type": "array",
"description": "Indicates the id(s) of the restricted reporting folders for a user of this profile. \n",
"items": {
"description": "Identifier of a folder hidden from the user profile",
"example": 3
},
"uniqueItems": true
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"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
},
"entryPoints": {
"type": "array",
"description": "Specify the id(s) of the entry point(s) a user of this profile will have access to. \n\nIt should be chosen when entry points access is SPECIFIC. Please see '''Entry Point documentation''', and use Get EntryPoints API to fetch the values of entry points.\n\n",
"items": {
"description": "Entry point identifier assigned to the user profile",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"uniqueItems": true
},
"sites": {
"type": "array",
"description": "Specify the id(s) of the site(s) a user of this profile will have access to. \nIt should be chosen when sites access is SPECIFIC. Please see Sites documentation, and use Get Site API to fetch the values of site IDs.\n\n",
"items": {
"description": "Site identifier assigned to the user profile",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"uniqueItems": true
},
"queues": {
"type": "array",
"description": "Specify the id(s) of the queue(s) a user of this profile will have access to. \nIt should be chosen when queues access is SPECIFIC. Please see Queues documentation, and use Get Queues API to fetch the values of queue IDs.\n\n",
"items": {
"description": "Queue identifier assigned to the user profile",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"uniqueItems": true
},
"teams": {
"type": "array",
"description": "Specify the id(s) of the team(s) a user of this profile will have access to.\nIt should be chosen when teams access is SPECIFIC. Please see Teams documentation, and use Get Teams API to fetch the values of team IDs.\n\n",
"items": {
"description": "Team identifier assigned to the user profile",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"uniqueItems": true
}
},
"required": [
"accessAllEntryPoints",
"accessAllModules",
"accessAllQueues",
"accessAllSites",
"accessAllTeams",
"active",
"name",
"profileType"
]
},
"UserProfileAppModuleDTO": {
"type": "object",
"description": "User Profile App Module DTO",
"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
},
"appModuleId": {
"type": "string",
"description": "The code of a Webex Contact Center module. \n\nPlease specify descriptions for each of these modules:\n\nm_provisioning - Refers to the provisioning module. Has access to Manage EntryPoints and Queues[f_manage_entrypt_queue], Revoke API Key[f_revoke_api_key], DN Mappings[f_dn_mappings], Manage User Profiles[f_manage_user_profiles], Manage Tenants[f_manage_tenants], Manage Users[f_manage_users], Portal Branding[f_portal_branding], Audit Trail[f_audit_trail], Manage Sites[f_manage_sites], Manage Teams[f_manage_teams], and Manage Dial Plans[f_manage_dial_plans] features.\n\nm_real_time_reports - Refers to the real time reporting module. Has access to Summary View[f_summary_view], Agent State Change[f_agent_state_change], Real Time Threshold Alerts[f_realtime_threshold_alerts], and Web CallBack Report[f_web_callback_report] features.\n\nm_historical_reports - Refers to the historical reporting module.\n\nm_routing_strategy - Refers to the routing strategy module. Has access to Manage Media Files[f_manage_media_files] and Manage Call Flow Scripts[f_manage_call_flow_scripts] features.\n\nm_call_recording - Refers to the call recording module.\n\nm_call_monitoring - Refers to the call monitoring module. Has access to Barge In[f_barge_in], View Blind Monitor Request[f_view_blind_monitor_requests], Whisper Coach[f_whisper_coach], Mid Call Monitor[f_mid_call_monitor], and Restricted Monitor[f_restricted_monitor_only] features.\n\nm_reporting_analytics - Refers to the reporting analytics module. Has access to Analyzer Data Exchange[f_analyzer_data_exchange] and Business Rules[f_business_rules] features. \n\nm_recording_management - Refers to the recording management module. Has access to Tags[f_tags], Security Keys[f_security_keys], Manage Recordings[f_manage_recordings], and Custom Attributes[f_custom_attributes] features.\n\nm_agent_desktop - Refers to the agent desktop module.\n\nm_logout_agents - Refers to the agent logout module.\n\nm_manage_agent_states - Refers to the agent state module. Has access to Sign Out Agent[f_sign_out_agent] and Change Agent State[f_change_agent_state] features.\n\nm_additional_supervisory_features - Refers to the additional supervisory features module. Has access to Sign Out Agents[f_sign_out_agents], Change Agent States[f_change_agent_states] and Send Messages[f_send_messages] features.\n\nm_multimedia - Refers to the multimedia module. Has access to Provisioning[f_mm_provisioning], Basic Digital[f_mm_basic_digital], Social Channel[f_mm_social_channel] and Agent Desktop[f_mm_agent_desktop] features.\n\nm_agent_wellbeing - Refers to the Agent Wellbeing module. Has access to Agent Wellbeing provisioning features.\n\nm_auto_csat - Refers to the Auto Csat module.\n\nm_generated_summaries - Refers to the Generated Summaries module.\n\nm_agent_personal_greetings - Refers to the Agent Personal Greetings module.\n\nm_functions - Refers to the Functions in flow module.\n\nm_realtime_transcripts - Refers to the Realtime Transcripts module.\n\nm_suggested_responses - Refers to the Suggested Responses module.\n",
"example": "m_provisioning",
"minLength": 1
},
"moduleAccessType": {
"type": "string",
"description": "Indicates the access rights for a user of this profile for a Webex Contact Center module.\n\nIt can take be one of these values:\n\nVIEW \u2014 A contact center user with this profile has read only access to a Contact Center module.\n\nEDIT \u2014 A contact center user with this profile has read and write access to a Contact Center module.\n\nNONE \u2014 A contact center user with this profile cannot access the module.\n\n",
"enum": [
"NONE",
"VIEW",
"EDIT"
],
"example": "EDIT"
},
"userProfileAppFeature": {
"type": "array",
"description": "Specifies the module features(s) a user of this profile has access to. \n",
"items": {
"$ref": "#/components/schemas/UserProfileAppFeatureDTO",
"description": "User Profile App Feature item."
},
"uniqueItems": true
},
"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": [
"appModuleId",
"moduleAccessType"
]
},
"UserProfileAppFeatureDTO": {
"type": "object",
"description": "Data transfer object representing application feature access settings for a user profile",
"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
},
"appFeatureId": {
"type": "string",
"description": "The feature code of a Webex Contact Center module. \n\nPlease add all the following features with their respective modules and set it's featureAccessType to 'ON' or 'OFF', to specify if it is in use. Here is the complete list of Feature names and Feature Ids:\n\n\nFor module 'm_additional_supervisory_features' we have the following features:\n\nChange Agent States : f_change_agent_states\n\nSign out Agents : f_sign_out_agents\n\nSend Messages : f_send_messages\n\nRe-skill Agents : f_reskill_agents\n\nManage agent based queues : f_manage_agent_queue_assignments\n\nFor module 'm_real_time_reports' we have the following features:\n\nReal Time Threshold Alerts : f_realtime_threshold_alerts\n\nAgent State Change : f_agent_state_change\n\nSummary View : f_summary_view\n\nWeb Callback Report : f_web_callback_report\n\n\nFor module 'm_multimedia' we have the following features:\n\nMM Agent Desktop : f_mm_agent_desktop\n\nBasic Digital : f_mm_basic_digital\n\nMM Provisioning : f_mm_provisioning\n\nSocial Channel : f_mm_social_channel\n\n\nFor module 'm_reporting_analytics' we have the following features:\n\nAnalyzer Data Exchange : f_analyzer_data_exchange\n\nBusiness Rules : f_business_rules\n\n\nFor module 'm_manage_agent_states' we have the following features:\n\nChange Agent State : f_change_agent_state\n\nSign Out Agent : f_sign_out_agent\n\n\nFor module 'm_recording_management' we have the following features:\n\nCustom Attributes : f_custom_attributes\n\nManage Recordings : f_manage_recordings\n\nTags : f_tags\n\nSecurity Keys : f_security_keys\n\n\nFor module 'm_routing_strategy' we have the following features:\n\nManage Call Flow Scripts : f_manage_call_flow_scripts\n\nManage Media Files : f_manage_media_files\n\n\nFor module 'm_provisioning' we have the following features:\n\nManage EntryPoints and Queues : f_manage_teams\n\nManage Users : f_manage_users\n\nDN Mappings : f_dn_mappings\n\nManage Sites : f_manage_sites\n\nManage Teams : f_manage_teams\n\nManage User Profiles : f_manage_user_profiles\n\nRevoke API Key : f_revoke_api_key\n\nManage Dial Plans : f_manage_dial_plans\n\nManage Tenants : f_manage_tenants\n\nManage Entry Points and Queues : f_manage_entrypt_queue\n\nPortal Branding : f_portal_branding\n\nAudit Trail : f_audit_trail\n\nManage Business Hours : f_manage_business_hours\n\n\nFor module 'm_call_monitoring' we have the following features:\n\nMid Call Monitoring : f_mid_call_monitor\n\nBarge In : f_barge_in\n\nRestricted Monitor : f_restricted_monitor_only\n\nWhisper Coach : f_whisper_coach\n\nView Blind Monitor Request : f_view_blind_monitor_requests\n\n",
"example": "f_manage_sites",
"minLength": 1
},
"appFeatureName": {
"type": "string",
"description": "The feature name of the Webex Contact Center module.",
"example": "Manage Sites"
},
"featureAccessType": {
"type": "string",
"description": "Indicates whether a user of this profile has access to a module feature.\n\nIt can be one of these values:\n\nOFF \u2014 A contact center user with this profile cannot access this module feature.\n\nON \u2014 A contact center user with this profile can access this module feature.\n\n",
"enum": [
"OFF",
"ON"
],
"example": "ON"
},
"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": [
"appFeatureId",
"featureAccessType"
]
},
"QueuesCountDTO": {
"type": "object",
"description": "The count of each type of Contact Service Queues that the user is assigned to.\n",
"example": {
"teamBased": 5,
"skillBased": 3,
"agentBased": 2
},
"properties": {
"teamBased": {
"type": "integer",
"format": "int32",
"description": "Number of team-based queues assigned to the user.",
"example": 5
},
"skillBased": {
"type": "integer",
"format": "int32",
"description": "Number of skill-based queues assigned to the user.",
"example": 3
},
"agentBased": {
"type": "integer",
"format": "int32",
"description": "Number of agent-based queues assigned to the user.",
"example": 2
}
}
},
"AssignedDynamicSkillsDTO": {
"type": "object",
"description": "Data transfer object representing dynamic skills assigned to a user",
"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
},
"skillId": {
"type": "string",
"description": "The ID of the skill.",
"example": "skill456"
},
"skillName": {
"type": "string",
"description": "The name of the skill. Used for bulk upload operations to resolve skill by name instead of ID.",
"example": "CustomerService"
},
"textValue": {
"type": "string",
"description": "A short textual description that represents a skill the agent has.",
"example": "Credit card SME",
"maxLength": 100,
"minLength": 0
},
"booleanValue": {
"type": "boolean",
"description": "Indicates whether the agent has this skill (True) or does not have the skill (False).",
"example": true
},
"proficiencyValue": {
"type": "integer",
"format": "int32",
"description": "A number between 0 and 10 to indicate how proficient the agent is in this skill.",
"example": 5,
"maximum": 10,
"minimum": 0
},
"enumValue": {
"type": "string",
"description": "The enum value for enum-type skills. Supports multiple values as pipe-delimited string (e.g., '30|20|10').",
"example": "french"
},
"enumSkillValues": {
"type": "string",
"description": "Indicates a value that represents a skill the agent has.",
"example": "FRENCH"
},
"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": [
"skillId"
]
},
"BulkRequestDTOUserDTO": {
"type": "object",
"description": "Bulk Request User schema.",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOUserDTO",
"description": "Item."
}
}
}
},
"BulkRequestItemDTOUserDTO": {
"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/UserDTO",
"description": "Item."
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"UserDTO": {
"type": "object",
"description": "User data transfer object for creating and updating user information in the contact center system",
"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
},
"firstName": {
"type": "string",
"description": "The first name of the user. Can be changed using Users Management in Cisco Webex Control Hub.",
"example": "John",
"minLength": 1
},
"lastName": {
"type": "string",
"description": "The last name of the user. Can be changed using Users Management in Cisco Webex Control Hub.",
"example": "Wick",
"minLength": 1
},
"email": {
"type": "string",
"description": "The email address of the user. Can be changed using Users Management in Cisco Webex Control Hub.",
"example": "johnwick@company.com",
"minLength": 1
},
"workPhone": {
"type": "string",
"description": "The work phone number of the user.",
"example": "1234567890",
"maxLength": 20,
"minLength": 0
},
"mobile": {
"type": "string",
"description": "The mobile phone number of the user.",
"example": "1234567890",
"maxLength": 20,
"minLength": 0
},
"ciUserId": {
"type": "string",
"description": "Cisco Common Identity user Id. Existence of a CI user is a prerequisite to create a new WxCC user. It cannot be modified.",
"example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"minLength": 1
},
"broadCloudUserId": {
"type": "string",
"description": "Broadcloud user Id. This field cannot be modified.",
"example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1"
},
"userProfileId": {
"type": "string",
"description": "Identifier for an user profile which a Contact Center administrator has configured. Changing the profile type requires a token with `FLS:Read_Scope` scope. As of today, changing the profile type for a user is supported only from Cisco Webex Control Hub.",
"example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"minLength": 1
},
"contactCenterEnabled": {
"type": "boolean",
"description": "The setting is for accessing the Agent Desktop to handle customer requests.",
"example": true
},
"timezone": {
"type": "string",
"description": "(Optional) The time zone that you provision for your enterprise.",
"example": "America/New_York"
},
"xspVersion": {
"type": "string",
"description": "(Optional) Used to subscribe for recording events. This field cannot be modified.",
"example": "xsp-24.0",
"maxLength": 80,
"minLength": 0
},
"subscriptionId": {
"type": "string",
"description": "(Optional) Used to subscribe for recording events. This field cannot be modified.",
"example": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478",
"maxLength": 80,
"minLength": 0
},
"siteId": {
"type": "string",
"description": "(Optional) Identifier for a site which is a physical contact center location under the control of your enterprise. This field is applicable only when contactCenterEnabled is true.",
"example": "8e6bb6da-2a78-4768-bef9-7e229f92af22"
},
"teamIds": {
"type": "array",
"description": "Specify the teams id which got assigned to this user. \nNote: You can't assign this profile to a capacity-based team. This field is applicable only when contactCenterEnabled is true.",
"items": {
"description": "Team identifier assigned to the user",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"uniqueItems": true
},
"skillProfileId": {
"type": "string",
"description": "(Optional) If your enterprise uses the optional Skills-Based Routing feature, This profile overrides any skill profile at the team level that is associated with the agent.This field is applicable only when contactCenterEnabled is true.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"agentProfileId": {
"type": "string",
"description": "Identifier for a Desktop Profile which is a group of permissions and Agent Desktop behaviors that you assign to specific users. This field is applicable only when contactCenterEnabled is true.",
"example": "8e6bb6da-2a78-4768-bef9-7e229f92af22"
},
"multimediaProfileId": {
"type": "string",
"description": "(Optional) If your organization administrator enables Multimedia for your enterprise, you can select a multimedia profile for this team. This field is applicable only when contactCenterEnabled is true.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"deafultDialledNumber": {
"type": "string",
"description": "(Optional) The dial number of the agent. This field is applicable only when contactCenterEnabled is true.",
"example": "1234567890"
},
"externalIdentifier": {
"type": "string",
"description": "(Optional) Agent identification details, such as the employee number.",
"example": "121212"
},
"active": {
"type": "boolean",
"description": "Indicates whether the user is active or not active. Can be changed using Users Management in Cisco Webex Control Hub.",
"example": true
},
"imiUserCreated": {
"type": "boolean",
"description": "(Optional) Indicates whether this user has a corresponding user created in IMI digital channel. This field cannot be modified.",
"example": false
},
"preferredSupervisorTeamId": {
"type": "string",
"description": "(Optional) Indicates the id of a preferred supervisor.",
"example": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1"
},
"userLevelBurnoutInclusion": {
"type": "string",
"description": "User level burnout inclusion type. Used only when Agent inclusion is set to 'Specific Agents' at the org level Agent Wellbeing>Burnout config. If the value is missing in response, the consumer should assume a value as EXCLUDED.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.This is applicable/available only when AI Assistant add-on offer/license is added to the organization.",
"enum": [
"INCLUDED",
"EXCLUDED"
],
"example": "INCLUDED"
},
"userLevelAutoCSATInclusion": {
"type": "string",
"deprecated": true,
"description": "User level AutoCSAT inclusion type. Used only when Agent inclusion is set to 'Specific Agents' at the org level Cisco AI Assistant>Auto CSAT config.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.",
"enum": [
"INCLUDED",
"EXCLUDED"
],
"example": "INCLUDED"
},
"userLevelWellnessBreakReminders": {
"type": "string",
"description": "User level Wellness break reminder type. If top level Agent burnout config has wellness break reminders enabled, this property determines if an Agent is enabled/disabled for receiving break reminders. If the value is missing in response, the consumer should assume a value as DISABLED.\nThis is applicable/available only when AI Assistant add-on offer/license is added to the organization.",
"enum": [
"DISABLED",
"ENABLED"
],
"example": "DISABLED"
},
"userLevelSummariesInclusion": {
"type": "string",
"deprecated": true,
"description": "User level Generated Summaries inclusion type. Used only when Generated Summaries is set to 'Specific Agents' at the org level Cisco AI Assistant>Generated Summaries.\nDuring entity creation(single or bulk), if this parameter is not provided or null, default will be set to 'EXCLUDED'\nDuring entity update(single or bulk), if this parameter is not provided or null, the previous value will be retained.",
"enum": [
"INCLUDED",
"EXCLUDED"
],
"example": "INCLUDED"
},
"supervisorCapabilitiesEnabled": {
"type": "boolean",
"description": "Indicates whether supervisor capabilities are enabled for the user.",
"example": false
},
"agentCapabilitiesEnabled": {
"type": "boolean",
"description": "Indicates whether agent capabilities are enabled for the user.",
"example": false
},
"dynamicSkills": {
"type": "array",
"description": "The list of dynamic skills assigned to the user",
"example": [
{
"organizationId": "21ec9a4a-2b8a-418c-afa5-4ff40e6a17f7",
"skillId": "2683334c-abec-4c0b-a6b1-211bd81d1b4b",
"textValue": "abc"
},
{
"organizationId": "21ec9a4a-2b8a-418c-afa5-4ff40e6a17f7",
"skillId": "2683334c-abec-4c0b-a6b1-211bd81d1b4b",
"proficiencyValue": 7
}
],
"items": {
"$ref": "#/components/schemas/AssignedDynamicSkillsDTO",
"description": "Dynamic Skill."
}
},
"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": [
"active",
"ciUserId",
"contactCenterEnabled",
"email",
"firstName",
"lastName",
"userProfileId"
]
},
"BulkRequestDTOUpdateDynamicSkillsDTO": {
"type": "object",
"description": "Bulk Request Update Dynamic Skills schema.",
"properties": {
"items": {
"type": "array",
"description": "List of items in the bulk request.",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOUpdateDynamicSkillsDTO",
"description": "Item."
}
}
}
},
"BulkRequestItemDTOUpdateDynamicSkillsDTO": {
"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/UpdateDynamicSkillsDTO",
"description": "Item."
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values are `SAVE` and `DELETE`.",
"example": "SAVE"
}
}
},
"UpdateDynamicSkillsDTO": {
"type": "object",
"description": "Data transfer object for updating dynamic skills assigned to a user",
"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
},
"userId": {
"type": "string",
"description": "The unique identifier of the user whose dynamic skills are being updated",
"example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1"
},
"enumSkillValues": {
"type": "array",
"description": "Set of enumerated skill values for enum-type dynamic skills",
"example": [
"SKILL_VALUE_1",
"SKILL_VALUE_2"
],
"items": {
"type": "string",
"description": "Enum Skill Value."
},
"uniqueItems": true
},
"textValue": {
"type": "string",
"description": "Text value for text-type dynamic skills (maximum 100 characters)",
"example": "Sample text skill value",
"maxLength": 100,
"minLength": 0
},
"booleanValue": {
"type": "boolean",
"description": "Boolean value for boolean-type dynamic skills",
"example": true
},
"proficiencyValue": {
"type": "integer",
"format": "int32",
"description": "Proficiency value for proficiency-type dynamic skills (range: 0-10)",
"example": 7,
"maximum": 10,
"minimum": 0
},
"skillId": {
"type": "string",
"description": "The unique identifier of the dynamic skill being updated",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"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
}
}
},
"MetaDataPagedUser": {
"type": "object",
"description": "Meta Data Paged User schema.",
"properties": {
"orgid": {
"type": "string",
"description": "ID of the contact center organization. This field is required for all bulk save operations.",
"example": "af9eecc5-0472-4549-9a83-2afdae0d4ba0"
},
"page": {
"type": "integer",
"format": "int32",
"description": "Current page number.",
"example": 1
},
"pageSize": {
"type": "integer",
"format": "int32",
"description": "Page size for current data set.",
"example": 20
},
"totalPages": {
"type": "integer",
"format": "int32",
"description": "Number of pages.",
"example": 5
},
"totalRecords": {
"type": "integer",
"format": "int64",
"description": "Total number of items.",
"example": 100
},
"links": {
"type": "object",
"$ref": "#/components/schemas/PaginationLinks",
"additionalProperties": {
"type": "string",
"description": "Links additional property."
},
"description": "Pagination links for navigating between result pages."
},
"actualBurnoutInclusionCount": {
"type": "integer",
"format": "int64",
"description": "Indicates the actual count of Agents selected for Agent burnout detection, including restricted agents that are not visible to requesting user.",
"example": 100
},
"actualAutoCSATCount": {
"type": "integer",
"format": "int64",
"description": "Indicates the actual count of Agents selected for Auto CSAT scores, including restricted agents that are not visible to requesting user.",
"example": 100
},
"actualSummariesCount": {
"type": "integer",
"format": "int64",
"description": "Indicates the actual count of Agents selected for Generated Summaries, including restricted agents that are not visible to requesting user.",
"example": 100
}
}
},
"UserDetailsResponseDTO": {
"type": "object",
"description": "Data transfer object containing detailed user information",
"properties": {
"id": {
"type": "string",
"description": "Unique ID of the user",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"firstName": {
"type": "string",
"description": "First name of the user",
"example": "John"
},
"lastName": {
"type": "string",
"description": "Last name of the user",
"example": "Doe"
},
"email": {
"type": "string",
"description": "Email address of the user",
"example": "john.doe@example.com"
}
}
},
"UserResponseDTO_UserResponseWithUserProfile": {
"type": "object",
"description": "User response data transfer object containing user profile and configuration details",
"example": {
"id": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"firstName": "John",
"lastName": "Wick",
"email": "johnwick@company.com",
"workPhone": "1234567890",
"mobile": "1234567890",
"ciUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"broadCloudUserId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"timezone": "America/New_York",
"userProfileId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"userProfileType": "PREMIUM_AGENT",
"contactCenterEnabled": true,
"siteId": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"siteName": "bengaluru",
"teamIds": [
"f53c8b54-46ca-43f6-ba05-08426a46e23d"
],
"skillProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"agentProfileId": "8e6bb6da-2a78-4768-bef9-7e229f92af22",
"multimediaProfileId": "f53c8b54-46ca-43f6-ba05-08426a46e23d",
"deafultDialledNumber": "1234567890",
"externalIdentifier": "121212",
"active": true,
"imiUserCreated": true,
"systemDefault": false,
"userLevelBurnoutInclusion": "INCLUDED",
"userLevelAutoCSATInclusion": "INCLUDED",
"userLevelWellnessBreakReminders": "DISABLED",
"userLevelSummariesInclusion": "INCLUDED",
"createdTime": 1679392200000,
"lastModifiedTime": 1679392200000
},
"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
},
"firstName": {
"type": "string",
"description": "The first name of the user.",
"example": "John"
},
"lastName": {
"type": "string",
"description": "The last name of the user.",
"example": "Wick"
},
"email": {
"type": "string",
"description": "The email address of the user.",
"example": "johnwick@company.com"
},
"workPhone": {
"type": "string",
"description": "The work phone number of the user.",
"example": "1234567890"
},
"mobile": {
"type": "string",
"description": "The mobile phone number of the user.",
"example": "1234567890"
},
"ciUserId": {
"type": "string",
"description": "Cisco Common Identity user Id",
"example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1"
},
"broadCloudUserId": {
"type": "string",
"description": "Broadcloud user Id",
"example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1"
},
"timezone": {
"type": "string",
"description": "(Optional) The time zone that you provision for your enterprise.",
"example": "America/New_York"
},
"xspVersion": {
"type": "string",
"description": "(Optional) Used to subscribe for recording events.",
"example": "xsp-24.0"
},
"subscriptionId": {
"type": "string",
"description": "(Optional) Used to subscribe for recording events.",
"example": "04d0bdf6-6d6a-4aae-8a8a-71c9152e6478"
},
"userProfileId": {
"type": "string",
"description": "Identifier for an user profile which a Contact Center administrator has configured.",
"example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1"
},
"userProfileType": {
"type": "string",
"description": "Type of the user profile associated to this user. This is an optional response parameter based on the query parameter includeUserProfileType.",
"example": "PREMIUM_AGENT"
},
"contactCenterEnabled": {
"type": "boolean",
"description": "The setting is for accessing Desktop to handle customer requests.",
"example": true
},
"siteId": {
"type": "string",
"description": "Details of site which a Contact Center administrator has configured for the user.",
"example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1"
},
"siteName": {
"type": "string",
"description": "site name that user is associated with",
"example": "bengaluru"
},
"teamIds": {
"type": "array",
"description": "Specify the teams id which got assigned to this user. \nNote: You can\u2019t assign this profile to a capacity-based team.",
"examples": [
"f53c8b54-46ca-43f6-ba05-08426a46e23d",
"a53c8b54-46ca-43f6-ba05-08426a46e23f"
],
"items": {
"type": "string",
"description": "Specify the teams id which got assigned to this user. \nNote: You can\u2019t assign this profile to a capacity-based team.",
"examples": [
"f53c8b54-46ca-43f6-ba05-08426a46e23d",
"a53c8b54-46ca-43f6-ba05-08426a46e23f"
]
},
"uniqueItems": true
},
"skillProfileId": {
"type": "string",
"description": "(Optional) If your enterprise uses the optional Skills-Based Routing feature, This profile overrides any skill profile at the team level that is associated with the agent ",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"agentProfileId": {
"type": "string",
"description": "Identifier for a Desktop Profile which is a group of permissions and Agent Desktop behaviors that you assign to specific users.",
"example": "8e6bb6da-2a78-4768-bef9-7e229f92af22"
},
"multimediaProfileId": {
"type": "string",
"description": "(Optional) If your organization administrator enables Multimedia for your enterprise, you can select a multimedia profile for this team.",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"deafultDialledNumber": {
"type": "string",
"description": "(Optional) The dial number of the agent.",
"example": "1234567890"
},
"externalIdentifier": {
"type": "string",
"description": "(Optional) Agent identification details, such as the employee number.",
"example": "121212"
},
"active": {
"type": "boolean",
"description": "Specify whether the user is active or not active.",
"example": true
},
"dbId": {
"type": "string",
"description": "Legacy identifier for migrated users.",
"example": "1dq45f23-1234-6r18-9a83-2atuiy0d4bh1"
},
"userProfileData": {
"$ref": "#/components/schemas/UserProfileDTO_UserResponseWithUserProfile",
"description": "Details of UserProfile which a Contact Center administrator has configured for the user.This is an optional object, returned only when the endpoint 'Get User along with profile by ID' is invoked."
},
"imiUserCreated": {
"type": "boolean",
"description": "Specify whether or not the corresponding user is created in IMI.",
"example": true
},
"preferredSupervisorTeamId": {
"type": "string",
"description": "The teamId to look for to load the desktop layout when a supervisor logs in to desktop.",
"example": "e27d2b54-46ca-43g6-ba65-08426e46e23d"
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"userLevelBurnoutInclusion": {
"type": "string",
"description": "User level burnout inclusion type. Used only when Agent inclusion is set to 'Specific Agents' at the org level Agent Wellbeing>Burnout config. If the value is missing in response, the consumer should assume a value as EXCLUDED.\nThis is applicable/available only when AI Assistant add-on offer/license is added to the organization.",
"enum": [
"INCLUDED",
"EXCLUDED"
],
"example": "INCLUDED"
},
"userLevelAutoCSATInclusion": {
"type": "string",
"deprecated": true,
"description": "User level AutoCSAT inclusion type. Used only when Agent inclusion is set to 'Specific Agents' at the org level Cisco AI Assistant>Auto CSAT config.\n",
"enum": [
"INCLUDED",
"EXCLUDED"
],
"example": "INCLUDED"
},
"userLevelWellnessBreakReminders": {
"type": "string",
"description": "User level Wellness break reminder type. If top level Agent burnout config has wellness break reminders enabled, this property determines if an Agent is enabled/disabled for receiving break reminders. If the value is missing in response, the consumer should assume a value as DISABLED.\nThis is applicable/available only when AI Assistant add-on offer/license is added to the organization.",
"enum": [
"DISABLED",
"ENABLED"
],
"example": "DISABLED"
},
"userLevelSummariesInclusion": {
"type": "string",
"deprecated": true,
"description": "User level Generated Summaries inclusion type. Used only when Generated Summaries is set to 'Specific Agents' at the org level Cisco AI Assistant>Generated Summaries.\n",
"enum": [
"INCLUDED",
"EXCLUDED"
],
"example": "INCLUDED"
},
"supervisorCapabilitiesEnabled": {
"type": "boolean",
"description": "Indicates whether supervisor capabilities are enabled for the user.",
"example": false
},
"agentCapabilitiesEnabled": {
"type": "boolean",
"description": "Indicates whether agent capabilities are enabled for the user.",
"example": false
},
"queuesCount": {
"$ref": "#/components/schemas/QueuesCountDTO_UserResponseWithUserProfile",
"description": "Count of queues assigned to the user by queue type (team-based, skill-based, agent-based)"
},
"skillProfileUpdatedBy": {
"type": "string",
"description": "The ID of the user who last modified the skill profile",
"example": "1dq21e23-1234-5578-9a83-2afdae0d4ba1"
},
"dynamicSkills": {
"type": "array",
"description": "The list of dynamic skills associated with the user",
"items": {
"$ref": "#/components/schemas/AssignedDynamicSkillsDTO_UserResponseWithUserProfile",
"description": "Dynamic Skill."
}
},
"dynamicSkillsLimitReached": {
"type": "boolean",
"description": "Indicates if the user has reached the dynamic skills assignment limit. Present only if includeDynamicSkillsLimitReached=true is passed in the request.",
"example": true
},
"dynamicSkillsUpdatedBy": {
"type": "string",
"description": "The name of the user who last modified dynamic skills"
},
"dynamicSkillsUpdatedTime": {
"type": "integer",
"format": "int64",
"description": "The date when dynamic skills were last modified (epoch timestamp in milliseconds)",
"example": 1679392200000
},
"dynamicSkillAssigned": {
"type": "boolean",
"description": "Indicates if the user has the specified dynamic skill assigned. Present only if checkIfUserHasDynamicSkill=true and dynamicSkillId are provided in the request.",
"example": true
},
"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
},
"skillProfileUpdatedTime": {
"type": "integer",
"format": "int64",
"description": "The date when the skill profile was last modified (epoch timestamp in milliseconds)",
"example": 1679392200000
}
}
},
"UserProfileDTO_UserResponseWithUserProfile": {
"type": "object",
"description": "User profile data transfer object that defines access permissions and resource scope for contact center users",
"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": "The name of the user profile.",
"example": "Contact Center Admin Profile",
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9,_\\-\\s]*$"
},
"description": {
"type": "string",
"description": "An optional description of the profile.",
"example": "This profile should be applied only to contact center admins.",
"maxLength": 255,
"minLength": 0
},
"profileType": {
"type": "string",
"description": "The type determines the privileges applicable for a profile.\n\nIt can take one of these values:\n\nSTANDARD_AGENT \u2014 Has access to Agent Desktop[m_agent_desktop] module.\n\nPREMIUM_AGENT \u2014 Has access to Agent Desktop[m_agent_desktop] and Multimedia[m_multimedia] module.\n\nSUPERVISOR \u2014 Has access to all modules except to manage tenants in the Provisioning[m_provisioning] module.\n\nADMINISTRATOR \u2014 Has access to all modules.\n\nADMINISTRATOR_ONLY \u2014 Has access to Provisioning[m_provisioning], Real Time Reports[m_real_time_reports], Call Recording[m_call_recording], IMI Digital Channels[m_imi_digital_channels], and Routing Strategy[m_routing_strategy] modules.\n\nIt is required only during a create operation. \n\nThe profile type cannot be changed for an existing user profile.\n\n",
"enum": [
"ADMINISTRATOR",
"ADMINISTRATOR_ONLY",
"SUPERVISOR",
"PREMIUM_AGENT",
"STANDARD_AGENT",
"ANALYZER_ADMINISTRATOR",
"ANALYZER_SUPERVISOR",
"ANALYZER_USER"
],
"example": "PREMIUM_AGENT"
},
"accessAllModules": {
"type": "string",
"description": "This can be used to allow users of this profile access to specific or all the Webex Contact Center modules.\n\nIt can take one of these values:\n\nALL \u2014 A contact center user with this profile can access all Contact Center modules.\n\nSPECIFIC \u2014 A contact center user with this profile can access only specific modules.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"userProfileAppModules": {
"type": "array",
"description": "Specifies the module(s) a user of this profile has access to.\n\nIt should be chosen when module access is SPECIFIC.\n\nPlease specify all the following modules and their respective access type.\n\n",
"items": {
"$ref": "#/components/schemas/UserProfileAppModuleDTO_UserResponseWithUserProfile",
"description": "User Profile App Module."
},
"uniqueItems": true
},
"accessAllEntryPoints": {
"type": "string",
"description": "Allow users of this profile access to specific or all the entry points for an organization.\n\nIt can take one of these values:\n\nALL \u2014 A contact center user with this profile can access all the entry points for an organization.\n\nSPECIFIC \u2014 A contact center user with this profile can access only specific entry points for an organization.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"accessAllSites": {
"type": "string",
"description": "Allow users of this profile access to specific or all the sites for an organization.\n\nIt can take one of these values:\n\nALL \u2014 A contact center user with this profile can access all the sites for an organization.\n\nSPECIFIC \u2014 A contact center user with this profile can access only specific sites for an organization.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"accessAllQueues": {
"type": "string",
"description": "Allow users of this profile access to specific or all the contact center queues for an organization.\n\nIt can take one of these values:\n\nALL \u2014 A contact center user with this profile can access all the contact center queues for an organization.\n\nSPECIFIC \u2014 A contact center user with this profile can access only specific contact center queues for an organization.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"accessAllTeams": {
"type": "string",
"description": "Allow users of this profile access to specific or all the contact center teams for an organization.\n\nIt can take one of these values:\n\nALL \u2014 A contact center user with this profile can access all the contact center teams for an organization.\n\nSPECIFIC \u2014 A contact center user with this profile can access only specific contact center teams for an organization.\n\n",
"enum": [
"SPECIFIC",
"ALL",
"PROVISIONED_VALUE",
"NONE"
],
"example": "ALL"
},
"active": {
"type": "boolean",
"description": "Specify whether the User profile is active or not.",
"example": true
},
"editableFolderIds": {
"type": "array",
"description": "Indicates the id(s) of the reporting folders a user of this profile has read and write access to. \n",
"items": {
"description": "Identifier of a folder the user profile can edit",
"example": 1
},
"uniqueItems": true
},
"viewableFolderIds": {
"type": "array",
"description": "Indicates the id(s) of the reporting folders a user of this profile has read access to. \n",
"items": {
"description": "Identifier of a folder the user profile can view",
"example": 2
},
"uniqueItems": true
},
"nonViewableFolderIds": {
"type": "array",
"description": "Indicates the id(s) of the restricted reporting folders for a user of this profile. \n",
"items": {
"description": "Identifier of a folder hidden from the user profile",
"example": 3
},
"uniqueItems": true
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"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
},
"entryPoints": {
"type": "array",
"description": "Specify the id(s) of the entry point(s) a user of this profile will have access to. \n\nIt should be chosen when entry points access is SPECIFIC. Please see '''Entry Point documentation''', and use Get EntryPoints API to fetch the values of entry points.\n\n",
"items": {
"description": "Entry point identifier assigned to the user profile",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"uniqueItems": true
},
"sites": {
"type": "array",
"description": "Specify the id(s) of the site(s) a user of this profile will have access to. \nIt should be chosen when sites access is SPECIFIC. Please see Sites documentation, and use Get Site API to fetch the values of site IDs.\n\n",
"items": {
"description": "Site identifier assigned to the user profile",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"uniqueItems": true
},
"queues": {
"type": "array",
"description": "Specify the id(s) of the queue(s) a user of this profile will have access to. \nIt should be chosen when queues access is SPECIFIC. Please see Queues documentation, and use Get Queues API to fetch the values of queue IDs.\n\n",
"items": {
"description": "Queue identifier assigned to the user profile",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"uniqueItems": true
},
"teams": {
"type": "array",
"description": "Specify the id(s) of the team(s) a user of this profile will have access to.\nIt should be chosen when teams access is SPECIFIC. Please see Teams documentation, and use Get Teams API to fetch the values of team IDs.\n\n",
"items": {
"description": "Team identifier assigned to the user profile",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"uniqueItems": true
}
},
"required": [
"accessAllEntryPoints",
"accessAllModules",
"accessAllQueues",
"accessAllSites",
"accessAllTeams",
"active",
"name",
"profileType"
]
},
"UserProfileAppModuleDTO_UserResponseWithUserProfile": {
"type": "object",
"description": "User Profile App Module DTO",
"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
},
"appModuleId": {
"type": "string",
"description": "The code of a Webex Contact Center module. \n\nPlease specify descriptions for each of these modules:\n\nm_provisioning - Refers to the provisioning module. Has access to Manage EntryPoints and Queues[f_manage_entrypt_queue], Revoke API Key[f_revoke_api_key], DN Mappings[f_dn_mappings], Manage User Profiles[f_manage_user_profiles], Manage Tenants[f_manage_tenants], Manage Users[f_manage_users], Portal Branding[f_portal_branding], Audit Trail[f_audit_trail], Manage Sites[f_manage_sites], Manage Teams[f_manage_teams], and Manage Dial Plans[f_manage_dial_plans] features.\n\nm_real_time_reports - Refers to the real time reporting module. Has access to Summary View[f_summary_view], Agent State Change[f_agent_state_change], Real Time Threshold Alerts[f_realtime_threshold_alerts], and Web CallBack Report[f_web_callback_report] features.\n\nm_historical_reports - Refers to the historical reporting module.\n\nm_routing_strategy - Refers to the routing strategy module. Has access to Manage Media Files[f_manage_media_files] and Manage Call Flow Scripts[f_manage_call_flow_scripts] features.\n\nm_call_recording - Refers to the call recording module.\n\nm_call_monitoring - Refers to the call monitoring module. Has access to Barge In[f_barge_in], View Blind Monitor Request[f_view_blind_monitor_requests], Whisper Coach[f_whisper_coach], Mid Call Monitor[f_mid_call_monitor], and Restricted Monitor[f_restricted_monitor_only] features.\n\nm_reporting_analytics - Refers to the reporting analytics module. Has access to Analyzer Data Exchange[f_analyzer_data_exchange] and Business Rules[f_business_rules] features. \n\nm_recording_management - Refers to the recording management module. Has access to Tags[f_tags], Security Keys[f_security_keys], Manage Recordings[f_manage_recordings], and Custom Attributes[f_custom_attributes] features.\n\nm_agent_desktop - Refers to the agent desktop module.\n\nm_logout_agents - Refers to the agent logout module.\n\nm_manage_agent_states - Refers to the agent state module. Has access to Sign Out Agent[f_sign_out_agent] and Change Agent State[f_change_agent_state] features.\n\nm_additional_supervisory_features - Refers to the additional supervisory features module. Has access to Sign Out Agents[f_sign_out_agents], Change Agent States[f_change_agent_states] and Send Messages[f_send_messages] features.\n\nm_multimedia - Refers to the multimedia module. Has access to Provisioning[f_mm_provisioning], Basic Digital[f_mm_basic_digital], Social Channel[f_mm_social_channel] and Agent Desktop[f_mm_agent_desktop] features.\n\nm_agent_wellbeing - Refers to the Agent Wellbeing module. Has access to Agent Wellbeing provisioning features.\n\nm_auto_csat - Refers to the Auto Csat module.\n\nm_generated_summaries - Refers to the Generated Summaries module.\n\nm_agent_personal_greetings - Refers to the Agent Personal Greetings module.\n\nm_functions - Refers to the Functions in flow module.\n\nm_realtime_transcripts - Refers to the Realtime Transcripts module.\n\nm_suggested_responses - Refers to the Suggested Responses module.\n",
"example": "m_provisioning",
"minLength": 1
},
"moduleAccessType": {
"type": "string",
"description": "Indicates the access rights for a user of this profile for a Webex Contact Center module.\n\nIt can take be one of these values:\n\nVIEW \u2014 A contact center user with this profile has read only access to a Contact Center module.\n\nEDIT \u2014 A contact center user with this profile has read and write access to a Contact Center module.\n\nNONE \u2014 A contact center user with this profile cannot access the module.\n\n",
"enum": [
"NONE",
"VIEW",
"EDIT"
],
"example": "EDIT"
},
"userProfileAppFeature": {
"type": "array",
"description": "Specifies the module features(s) a user of this profile has access to. \n",
"items": {
"$ref": "#/components/schemas/UserProfileAppFeatureDTO_UserResponseWithUserProfile",
"description": "User Profile App Feature item."
},
"uniqueItems": true
},
"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": [
"appModuleId",
"moduleAccessType"
]
},
"UserProfileAppFeatureDTO_UserResponseWithUserProfile": {
"type": "object",
"description": "Data transfer object representing application feature access settings for a user profile",
"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
},
"appFeatureId": {
"type": "string",
"description": "The feature code of a Webex Contact Center module. \n\nPlease add all the following features with their respective modules and set it's featureAccessType to 'ON' or 'OFF', to specify if it is in use. Here is the complete list of Feature names and Feature Ids:\n\n\nFor module 'm_additional_supervisory_features' we have the following features:\n\nChange Agent States : f_change_agent_states\n\nSign out Agents : f_sign_out_agents\n\nSend Messages : f_send_messages\n\nRe-skill Agents : f_reskill_agents\n\nManage agent based queues : f_manage_agent_queue_assignments\n\nFor module 'm_real_time_reports' we have the following features:\n\nReal Time Threshold Alerts : f_realtime_threshold_alerts\n\nAgent State Change : f_agent_state_change\n\nSummary View : f_summary_view\n\nWeb Callback Report : f_web_callback_report\n\n\nFor module 'm_multimedia' we have the following features:\n\nMM Agent Desktop : f_mm_agent_desktop\n\nBasic Digital : f_mm_basic_digital\n\nMM Provisioning : f_mm_provisioning\n\nSocial Channel : f_mm_social_channel\n\n\nFor module 'm_reporting_analytics' we have the following features:\n\nAnalyzer Data Exchange : f_analyzer_data_exchange\n\nBusiness Rules : f_business_rules\n\n\nFor module 'm_manage_agent_states' we have the following features:\n\nChange Agent State : f_change_agent_state\n\nSign Out Agent : f_sign_out_agent\n\n\nFor module 'm_recording_management' we have the following features:\n\nCustom Attributes : f_custom_attributes\n\nManage Recordings : f_manage_recordings\n\nTags : f_tags\n\nSecurity Keys : f_security_keys\n\n\nFor module 'm_routing_strategy' we have the following features:\n\nManage Call Flow Scripts : f_manage_call_flow_scripts\n\nManage Media Files : f_manage_media_files\n\n\nFor module 'm_provisioning' we have the following features:\n\nManage EntryPoints and Queues : f_manage_teams\n\nManage Users : f_manage_users\n\nDN Mappings : f_dn_mappings\n\nManage Sites : f_manage_sites\n\nManage Teams : f_manage_teams\n\nManage User Profiles : f_manage_user_profiles\n\nRevoke API Key : f_revoke_api_key\n\nManage Dial Plans : f_manage_dial_plans\n\nManage Tenants : f_manage_tenants\n\nManage Entry Points and Queues : f_manage_entrypt_queue\n\nPortal Branding : f_portal_branding\n\nAudit Trail : f_audit_trail\n\nManage Business Hours : f_manage_business_hours\n\n\nFor module 'm_call_monitoring' we have the following features:\n\nMid Call Monitoring : f_mid_call_monitor\n\nBarge In : f_barge_in\n\nRestricted Monitor : f_restricted_monitor_only\n\nWhisper Coach : f_whisper_coach\n\nView Blind Monitor Request : f_view_blind_monitor_requests\n\n",
"example": "f_manage_sites",
"minLength": 1
},
"appFeatureName": {
"type": "string",
"description": "The feature name of the Webex Contact Center module.",
"example": "Manage Sites"
},
"featureAccessType": {
"type": "string",
"description": "Indicates whether a user of this profile has access to a module feature.\n\nIt can be one of these values:\n\nOFF \u2014 A contact center user with this profile cannot access this module feature.\n\nON \u2014 A contact center user with this profile can access this module feature.\n\n",
"enum": [
"OFF",
"ON"
],
"example": "ON"
},
"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": [
"appFeatureId",
"featureAccessType"
]
},
"QueuesCountDTO_UserResponseWithUserProfile": {
"type": "object",
"description": "The count of each type of Contact Service Queues that the user is assigned to.\n",
"example": {
"teamBased": 5,
"skillBased": 3,
"agentBased": 2
},
"properties": {
"teamBased": {
"type": "integer",
"format": "int32",
"description": "Number of team-based queues assigned to the user.",
"example": 5
},
"skillBased": {
"type": "integer",
"format": "int32",
"description": "Number of skill-based queues assigned to the user.",
"example": 3
},
"agentBased": {
"type": "integer",
"format": "int32",
"description": "Number of agent-based queues assigned to the user.",
"example": 2
}
}
},
"AssignedDynamicSkillsDTO_UserResponseWithUserProfile": {
"type": "object",
"description": "Data transfer object representing dynamic skills assigned to a user",
"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
},
"skillId": {
"type": "string",
"description": "The ID of the skill.",
"example": "skill456"
},
"skillName": {
"type": "string",
"description": "The name of the skill. Used for bulk upload operations to resolve skill by name instead of ID.",
"example": "CustomerService"
},
"textValue": {
"type": "string",
"description": "A short textual description that represents a skill the agent has.",
"example": "Credit card SME",
"maxLength": 100,
"minLength": 0
},
"booleanValue": {
"type": "boolean",
"description": "Indicates whether the agent has this skill (True) or does not have the skill (False).",
"example": true
},
"proficiencyValue": {
"type": "integer",
"format": "int32",
"description": "A number between 0 and 10 to indicate how proficient the agent is in this skill.",
"example": 5,
"maximum": 10,
"minimum": 0
},
"enumValue": {
"type": "string",
"description": "The enum value for enum-type skills. Supports multiple values as pipe-delimited string (e.g., '30|20|10').",
"example": "french"
},
"enumSkillValues": {
"type": "string",
"description": "Indicates a value that represents a skill the agent has.",
"example": "FRENCH"
},
"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": [
"skillId"
]
},
"ResponseEnvelopeUserDynamicSkillResponseDTO": {
"type": "object",
"description": "Response Envelope User Dynamic Skill Response schema.",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"description": "Meta additional property."
},
"description": "Additional properties for Meta."
},
"data": {
"type": "array",
"description": "List of Data.",
"items": {
"$ref": "#/components/schemas/UserDynamicSkillResponseDTO",
"description": "Data item."
}
}
}
},
"UserDynamicSkillResponseDTO": {
"type": "object",
"description": "Response data transfer object containing user dynamic skill assignment information",
"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"
},
"firstName": {
"type": "string",
"description": "The first name of the user.",
"example": "John"
},
"lastName": {
"type": "string",
"description": "The last name of the user.",
"example": "Wick"
},
"email": {
"type": "string",
"description": "The email address of the user.",
"example": "johnwick@company.com"
},
"dynamicSkill": {
"$ref": "#/components/schemas/AssignedDynamicSkillsDTO",
"description": "The dynamic skill associated with the user"
}
}
},
"UserWithSkillDetailsDTO": {
"type": "object",
"description": "Data transfer object containing user information along with skill profile details",
"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
},
"firstName": {
"type": "string",
"description": "The first name of the user. Can be changed using Users Management in Cisco Webex Control Hub.",
"example": "John1"
},
"lastName": {
"type": "string",
"description": "The last name of the user. Can be changed using Users Management in Cisco Webex Control Hub.",
"example": "Wick1"
},
"email": {
"type": "string",
"description": "The email address of the user. Can be changed using Users Management in Cisco Webex Control Hub.",
"example": "johnwick1@company.com"
},
"skillProfileName": {
"type": "string",
"description": "The skillProfileName of the user.",
"example": "skillprofileName"
},
"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
}
}
},
"UserDetailsRequestDTO": {
"type": "object",
"description": "Get user details by a list of user IDs in the payload.",
"properties": {
"userIds": {
"type": "array",
"description": "List of valid user IDs.\nProvide this only when both `search` and `queueId` are not provided.\n",
"items": {
"description": "User identifier included in the request",
"example": "a1b2c3d4-e5f6-7g8h-9i10-j11k12l13m14"
}
},
"search": {
"type": "string",
"description": "Text used to search for users (e.g., by firstName, lastName or email of the user).\nIf provided, `queueId` is **required**.\nCannot be used in combination with `userIds`.\n",
"example": "john"
},
"queueId": {
"type": "string",
"description": "Agent Based Queue ID to filter users .\nRequired if `search` is provided.\nCannot be used with `userIds`.\n",
"example": "c0ffee12-3456-abcd-7890-deadbeef1234"
}
}
},
"UserDetailsResponseEnvelopeDTO": {
"type": "object",
"description": "Response envelope containing user details data with metadata and pagination information",
"example": {
"meta": {
"orgid": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"page": 1,
"pageSize": 100,
"totalPages": 3,
"totalRecords": 300
},
"data": [
{
"id": "1dq21e23-1234-5578-9a83-2afdae0d4ba1",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@company.com"
}
]
},
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"description": "Meta additional property."
},
"description": "Metadata of response with paging information. Includes orgId, page, pageSize, totalPages, totalRecords, and pagination links.",
"example": {
"orgid": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1",
"page": 1,
"pageSize": 100,
"totalPages": 3,
"totalRecords": 300,
"links": {
"next": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=2&pageSize=100",
"last": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=2&pageSize=100",
"prev": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=0&pageSize=100",
"self": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=1&pageSize=100",
"first": "/organization/bde75a64-f4d5-4ffc-a239-feb607c17ef8/user/fetch-user-details-by-ids?page=0&pageSize=100"
}
}
},
"data": {
"type": "array",
"description": "List of Data.",
"items": {
"$ref": "#/components/schemas/UserDetailsResponseDTO",
"description": "Data item."
}
}
}
},
"JsonValue": {
"type": "object",
"description": "Json Value schema.",
"properties": {
"valueType": {
"type": "string",
"description": "Value Type.",
"enum": [
"ARRAY",
"OBJECT",
"STRING",
"NUMBER",
"TRUE",
"FALSE",
"NULL"
]
}
}
},
"ReSkillAgentRequestDTO": {
"type": "object",
"description": "Request DTO for re-skilling an agent with a new skill profile and/or dynamic skills",
"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
},
"skillProfileId": {
"type": "string",
"description": "The unique identifier of the skill profile to assign to the agent",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"dynamicSkills": {
"$ref": "#/components/schemas/DynamicSkills",
"description": "Dynamic skills to add or remove from the agent"
},
"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
}
}
},
"DynamicSkills": {
"type": "object",
"description": "Container for dynamic skills operations (add/remove)",
"properties": {
"add": {
"type": "array",
"description": "List of dynamic skills to be added to the agent",
"items": {
"$ref": "#/components/schemas/UpdateDynamicSkillsDTO",
"description": "Add item."
}
},
"remove": {
"type": "array",
"description": "List of dynamic skill IDs to be removed from the agent",
"example": [
"skill-id-1",
"skill-id-2"
],
"items": {
"type": "string",
"description": "Remove item."
}
}
}
},
"WorkTypeDTO": {
"required": [
"active",
"name",
"workTypeCode"
],
"type": "object",
"properties": {
"organizationId": {
"maxLength": 36,
"minLength": 32,
"pattern": "^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{4}-?[0-9a-fA-F]{12}$",
"type": "string",
"description": "ID of the contact center organization. It is required to define for the following operations - All bulk save operations",
"format": "uuid",
"example": "f53c8b54-46ca-43f6-ba05-08426a46e23d"
},
"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",
"description": "The version of this resource. For a newly created resource, it will be 0 unless specified otherwise.",
"format": "int32",
"example": 1
},
"name": {
"maxLength": 80,
"minLength": 0,
"pattern": "^[a-zA-Z0-9._\\-\\s]*$",
"type": "string",
"description": "A name for the Work Type.",
"example": "Idle Code"
},
"description": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "A description for the Work type code created.",
"example": "This is an 'Idle' work type."
},
"workTypeCode": {
"type": "string",
"description": "Identifier for the Work Type being created. Can be 'WRAP_UP_CODE' or 'IDLE_CODE'. ",
"example": "IDLE_CODE"
},
"active": {
"type": "boolean",
"description": "Indicates whether the work type is active or not.",
"example": false
},
"systemDefault": {
"type": "boolean",
"description": "Indicates whether the created resource is system created or not",
"example": false
},
"createdTime": {
"type": "integer",
"description": "Creation time(in epoch millis) of this resource.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
},
"lastUpdatedTime": {
"type": "integer",
"description": "Time(in epoch millis) when this resource was last updated.",
"format": "int64",
"readOnly": true,
"example": 1617536244000
}
}
},
"BulkRequestDTOWorkTypeDTO": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BulkRequestItemDTOWorkTypeDTO"
}
}
}
},
"BulkRequestItemDTOWorkTypeDTO": {
"type": "object",
"properties": {
"itemIdentifier": {
"type": "integer",
"description": "Unique item identifier for a bulk operation.",
"format": "int32",
"example": 10
},
"item": {
"$ref": "#/components/schemas/WorkTypeDTO"
},
"requestAction": {
"type": "string",
"description": "Identifier for action type. Possible values can be SAVE and DELETE.",
"example": "SAVE"
}
}
},
"BulkExportDTOWorkTypeBulkExportDTO": {
"type": "object",
"properties": {
"totalResources": {
"type": "integer",
"description": "Total number of items",
"format": "int32",
"example": 100
},
"pageNumber": {
"type": "integer",
"description": "Current page number",
"format": "int32",
"example": 0
},
"pageSize": {
"type": "integer",
"description": "Page size for current data set",
"format": "int32",
"example": 50
},
"rel": {
"type": "string",
"description": "Indicates whether more pages exist. When 'next' there are more pages available, otherwise 'last'.",
"example": "last"
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkTypeBulkExportDTO"
}
}
}
},
"WorkTypeBulkExportDTO": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "A name for the Work Type.",
"example": "Idle Code"
},
"description": {
"type": "string",
"description": "A description for the Work type code created.",
"example": "This is an 'Idle' work type."
},
"workTypeCode": {
"type": "string",
"description": "Identifier for the Work Type being created. Can be 'WRAP_UP_CODE' or 'IDLE_CODE'. ",
"example": "IDLE_CODE"
}
}
},
"ResponseEnvelopeWorkTypeDTO": {
"type": "object",
"properties": {
"meta": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkTypeDTO"
}
}
}
},
"EWTApiResponse": {
"type": "object",
"properties": {
"estimatedWaitTime": {
"type": "number",
"description": "The estimated wait time in milli seconds.",
"format": "double",
"example": 20349.12
}
}
},
"NotificationRequest": {
"properties": {
"isKeepAliveEnabled": {
"description": "This represents that a json message {\\\"keepalive\\\":\\\"true\\\"} is expected over the websocket connection from Client. This should be sent periodically (usually 4s). If there are no keep-alive messages from the client for a period of 16 seconds, the server will drop the websocket.",
"example": true,
"default": false,
"type": "boolean"
},
"clientType": {
"description": "ClientType is used to identify a web application differently from other web applications. It is used to group connections together for a specific user coming from that specific web application, maximum length 20 characters.",
"example": "AgentDesktop",
"type": "string",
"default": "DefaultClient",
"maxLength": 20
},
"allowMultiLogin": {
"description": "This cannot be used without providing \\\"clientType\\\". When set to true, it informs the server to allow multiple logins for this user coming from the same clientType. Upto 10 multiple logins will be allowed.",
"example": false,
"default": false,
"type": "boolean"
},
"force": {
"description": "When true, will drop a random connection and then subscribes if connections for a user exceed maximum limit. When allowMultiLogin is false and a multi-login is attempted, if set to true will drop all connections for that user of that clientType & then subscribes.",
"example": false,
"default": false,
"type": "boolean"
}
},
"type": "object"
},
"NotificationResponse": {
"properties": {
"webSocketUrl": {
"description": "Url used by the client to setup websocket.",
"example": "wss://api.wxcc-us1.cisco.com/v1/notification/subscription/AgentDesktop-ffffffac0f-39fa-4122-80d8-f2c2266e6391",
"type": "string"
},
"subscriptionId": {
"description": "Id used by client to subscribe to interested events.",
"example": "AgentDesktop-ffffffac0f-39fa-4122-80d8-f2c2266e6391",
"format": "uuid"
}
},
"required": [
"webSocketUrl",
"subscriptionId"
],
"type": "object"
},
"QueueApiResponse": {
"required": [
"data",
"meta"
],
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"description": "List of Queue statistics records retrieved according to query parameters.",
"items": {
"$ref": "#/components/schemas/OutQueueStatistics"
}
}
}
},
"Meta": {
"type": "object",
"properties": {
"orgId": {
"type": "string",
"description": "Organization ID to which resources belong.",
"example": "3dae8fdd-06e2-411a-9035-51f3719f5b65"
}
},
"description": "Response metadata."
},
"OutQueueStatistics": {
"type": "object",
"properties": {
"intervalStartTime": {
"type": "integer",
"description": "Time in GMT (milliseconds)",
"format": "int64",
"example": 1591702200000
},
"queueId": {
"type": "string",
"description": "The ID of the Queue.",
"example": "06ce7234-dd3e-49e2-8763-d93766739d"
},
"queueName": {
"type": "string",
"description": "Name of the queue.",
"example": "main-queue"
},
"channelType": {
"type": "string",
"description": "The type of channel associated with this operation.",
"example": "telephony"
},
"totalOfferedTasks": {
"type": "integer",
"description": "Number of times tasks were offered to the agents in the queue during the interval. This count includes the ones that are accepted or rejected by the agent.",
"format": "int32",
"example": 7
},
"totalEnqueuedTasks": {
"type": "integer",
"description": "Number of times tasks were parked in the queue during the interval. Tasks are not parked in queue if they are offered to an agent immediately since one is available.",
"format": "int32",
"example": 7
},
"totalAssignedTasks": {
"type": "integer",
"description": "DEPRECATED FIELD, This field always returns 0",
"format": "int32",
"example": 1,
"deprecated": true
},
"totalAcceptedTasks": {
"type": "integer",
"description": "Number of assigned tasks that were accepted in the queue.",
"format": "int32",
"example": 7
},
"totalRejectedTasks": {
"type": "integer",
"description": "Number of times tasks were rejected by the agents when they were offered during the interval.",
"format": "int32",
"example": 2
},
"totalAbandonedTasks": {
"type": "integer",
"description": "Number of assigned tasks that were abandoned in the queue.",
"format": "int32",
"example": 1
},
"averageEnqueuedTime": {
"type": "number",
"description": "The Queue's average enqueue time in milli seconds.\ni.e total time in queue / number of calls that were queued",
"format": "double",
"example": 20349.12
},
"averageHandledTime": {
"type": "number",
"description": "The Queue's average handle time in milli seconds.\ni.e total time the call was connected / number of calls that were handled.\nNote :- This does not include wrap-up time",
"format": "double",
"example": 93729.01
},
"serviceLevelThresholdPercentage": {
"type": "number",
"description": "The Service Level threshold % is an aggregate percentage based on how many contacts out of\nthe total handled have met the service level value and gives an indication of the timely pick-up of contacts by agents.",
"format": "double",
"example": 25.34
}
},
"description": "List of Queue statistics records retrieved according to query parameters."
},
"RealtimeRequest": {
"properties": {
"isKeepAliveEnabled": {
"description": "This represents that a json message {\\\"keepalive\\\":\\\"true\\\"} is expected over the websocket connection from Client. This should be sent periodically (usually 4s). If there are no keep-alive messages from the client for a period of 15 seconds, the server will drop the websocket.",
"example": true,
"default": true,
"type": "boolean"
},
"clientType": {
"description": "ClientType is used to identify a web application differently from other web applications. It is used to group connections together for a specific user coming from that specific web application.",
"example": "ExtensiveSupervisoryDesktop",
"default": "DefaultClient",
"type": "string",
"maxLength": 64,
"minLength": 4
},
"allowMultiLogin": {
"description": "This cannot be used without providing \\\"clientType\\\". When set to true, it informs the server to allow multiple logins for this user coming from the same clientType. Upto 10 multiple logins will be allowed.",
"example": false,
"default": false,
"maxLength": 64,
"minLength": 4,
"type": "boolean"
},
"force": {
"description": "When true, will drop a random connection and then subscribes if connections for a user exceed maximum limit. When allowMultiLogin is false and a multi-login is attempted, if set to true will drop all connections for that user of that clientType & then subscribes.",
"example": false,
"default": false,
"maxLength": 64,
"minLength": 4,
"type": "boolean"
}
},
"type": "object"
},
"RealtimeResponse": {
"properties": {
"webSocketUrl": {
"description": "Url used by the client to setup websocket.",
"example": "wss://api.wxcc-us1.cisco.com/v1/realtime/subscription/ExtensiveSupervisoryDesktop-ffffffac0f-39fa-4122-80d8-f2c2266e6391",
"type": "string"
},
"subscriptionId": {
"description": "Id used by client to subscribe to interested events.",
"example": "ExtensiveSupervisoryDesktop-ffffffac0f-39fa-4122-80d8-f2c2266e6391",
"format": "uuid"
}
},
"required": [
"webSocketUrl",
"subscriptionId"
],
"type": "object"
},
"SearchRequest": {
"type": "object",
"properties": {
"variables": {
"type": "object",
"description": "The variables definition are the part that looks like task(from: $startTime, to: $endTime) in the query. \n It works just like the argument definitions for a function in a typed language. These variables are applicable only for persisted queries that has these variables. An example of persisted query with variables - {\n task (from: $startTime, to: $endTime, filter: {\n and : [\n {channelType : {equals: telephony}}\n ]\n } , pagination: {cursor:\"0\"}) {\n tasks {\n id\n channelType\n }\n }\n}",
"example": {
"startTime": 1629369769066,
"endTime": 1629458280000
}
},
"query": {
"type": "string",
"description": "A graphQL query specifying the task attributes needed in the response for the specified time window. from: Start time for the query (in epoch milliseconds) and it cannot be older than 36 months from the current time. to: End time for the query (in epoch milliseconds) and it cannot be greater than the current time. The duration between to and from must not be more than 365 days.\n",
"example": "query($startTime: Long!,$endTime: Long!) { task (from: $startTime, to: $endTime, filter: { and : [ {channelType : {equals: telephony}} {status: {equals: \"created\"}} {owner: {equals: {id: \"owner-id\"}}} {customer: {equals: {name: \"customer-name\"}}} ]} , pagination: {cursor:\"0\"}) { tasks { id channelType}}}"
}
},
"example": null
},
"SubscriptionApiListResponse": {
"required": [
"data",
"meta"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionResponse"
}
},
"meta": {
"$ref": "#/components/schemas/MetaSubInfo"
}
}
},
"MetaSubInfo": {
"properties": {
"orgId": {
"description": "Organization ID used for this operation.",
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101",
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"ErrorResult": {
"required": [
"trackingId"
],
"type": "object",
"properties": {
"error": {
"$ref": "#/components/schemas/Error"
},
"trackingId": {
"type": "string",
"description": "Unique ID by which a request can be debugged, provided in request header or autogenerated. Please provide if opening a support case.",
"example": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23"
}
}
},
"Error": {
"required": [
"key"
],
"type": "object",
"properties": {
"key": {
"type": "integer",
"description": "Status code of error.",
"format": "int32",
"example": 400
},
"message": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldValidationError"
}
}
}
},
"FieldValidationError": {
"required": [
"description"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Message detailing an error discovered during request processing.",
"example": "Body is invalid JSON."
}
}
},
"SubscriptionCreateApiResponse": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaSubInfo"
},
"data": {
"$ref": "#/components/schemas/SubscriptionResponse"
}
}
},
"SubscriptionApiResponse": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/SubscriptionResponse"
}
}
},
"SubscriptionRequestUpdate": {
"type": "object",
"properties": {
"description": {
"maxLength": 1024,
"minLength": 0,
"type": "string",
"description": "Client-defined string describing the subscription.",
"example": "The subscription my integration uses to synchronize with WxCC"
},
"eventTypes": {
"maxItems": 32,
"minItems": 1,
"type": "array",
"description": "Types of events to which the subscription will listen.",
"example": [
"agent:login",
"agent:logout"
],
"items": {
"type": "string"
}
},
"destinationUrl": {
"pattern": "^(https?)://.*$",
"type": "string",
"description": "URL to which webhooks will be posted. Must be HTTPS on an IANA-listed top-level domain name (e.g. .com) with a path (at least /). No query parameters, userinfo, non-443 ports, or fragments allowed. We do not treat this field as sensitive data, so do not use secrets in this URL such as tokens or API keys.",
"format": "uri",
"example": "https://www.cisco.com/"
},
"status": {
"pattern": "(active|inactive)",
"type": "string",
"description": "Status of the subscription. Can be \"active\" or \"inactive\". The system may change the status to \"inactive\" in error scenarios.",
"example": "inactive",
"enum": [
"active",
"inactive"
]
},
"secret": {
"maxLength": 256,
"minLength": 32,
"type": "string",
"description": "Secret string used to sign payloads sent to the destination URL.",
"example": "my-32-plus-character-long-secret"
},
"orgId": {
"type": "string",
"description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permission to interact with the organization.",
"format": "uuid",
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
}
}
},
"EventTypesApiListResponse": {
"required": [
"data",
"meta"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventTypesResponse"
}
},
"meta": {
"$ref": "#/components/schemas/Meta"
}
}
},
"EventTypesResponse": {
"required": [
"action",
"name",
"resource"
],
"type": "object",
"properties": {
"name": {
"maxLength": 64,
"minLength": 4,
"type": "string",
"description": "The name of the event type. Consists of the resource and the action which occurred on it, separated by a colon. Use when registering a subscription.",
"example": "agent:login"
},
"resource": {
"maxLength": 64,
"minLength": 4,
"type": "string",
"description": "The resource to which the event type belongs.",
"example": "agent"
},
"action": {
"maxLength": 64,
"minLength": 4,
"type": "string",
"description": "The action being taken on the resource in the event.",
"example": "login"
}
}
},
"SubscriptionApiListResponseEnhanced": {
"required": [
"data",
"meta"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionResponseEnhanced"
}
},
"meta": {
"$ref": "#/components/schemas/MetaSubInfo"
}
}
},
"SubscriptionResponseEnhanced": {
"required": [
"createdBy",
"createdTime",
"destinationUrl",
"eventTypes",
"id",
"lastUpdatedBy",
"lastUpdatedTime",
"name",
"resourceVersion",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Subscription ID.",
"format": "uuid",
"example": "41e92806-331d-4802-bc12-674f92d4a6f7"
},
"name": {
"maxLength": 64,
"minLength": 4,
"type": "string",
"description": "Client-defined string naming the subscription.",
"example": "My Integration's Subscription"
},
"description": {
"maxLength": 1024,
"type": "string",
"description": "Client-defined string describing the subscription.",
"example": "The subscription my integration uses to synchronize with WxCC"
},
"eventTypes": {
"maxItems": 32,
"minItems": 1,
"type": "array",
"description": "Types of events to which the subscription will listen.",
"example": [
"agent:login",
"agent:logout"
],
"items": {
"type": "string"
}
},
"destinationUrl": {
"type": "string",
"description": "URL to which webhooks will be posted. Must be HTTPS on an IANA-listed top-level domain name (e.g. .com) with a path (at least /). No query parameters, userinfo, non-443 ports, or fragments allowed. We do not treat this field as sensitive data, so do not use secrets in this URL such as tokens or API keys.",
"format": "uri",
"example": "https://www.cisco.com/"
},
"createdTime": {
"type": "integer",
"description": "Time when subscription was created (epoch milliseconds).",
"format": "int64",
"example": 1591702170000
},
"createdBy": {
"type": "string",
"description": "Email address of the user who created the subscription.",
"format": "email",
"example": "example@example.com"
},
"status": {
"type": "string",
"description": "Status of the subscription. Can be \"active\" or \"inactive\". The system may change the status to \"inactive\" in error scenarios.",
"example": "active",
"enum": [
"active",
"inactive"
]
},
"lastUpdatedTime": {
"type": "integer",
"description": "Time when the subscription was last updated (epoch milliseconds).",
"format": "int64",
"example": 1591702170000
},
"lastUpdatedBy": {
"type": "string",
"description": "Email address of the user who updated the subscription most recently.",
"format": "email",
"example": "example@example.com"
},
"resourceVersion": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Version of the resource.",
"example": "agent:1.0.0"
}
}
},
"SubscriptionRequestEnhanced": {
"required": [
"destinationUrl",
"eventTypes",
"name",
"resourceVersion"
],
"type": "object",
"properties": {
"name": {
"maxLength": 64,
"minLength": 4,
"type": "string",
"description": "Client-defined string naming the subscription.",
"example": "My Integration's Subscription"
},
"description": {
"maxLength": 1024,
"minLength": 0,
"type": "string",
"description": "Client-defined string describing the subscription.",
"example": "The subscription my integration uses to synchronize with WxCC"
},
"eventTypes": {
"maxItems": 32,
"minItems": 1,
"type": "array",
"description": "Types of events to which the subscription will listen.",
"example": [
"agent:login",
"agent:logout"
],
"items": {
"type": "string"
}
},
"destinationUrl": {
"pattern": "^(https?)://.*$",
"type": "string",
"description": "URL to which webhooks will be posted. Must be HTTPS on an IANA-listed top-level domain name (e.g. .com) with a path (at least /). No query parameters, userinfo, non-443 ports, or fragments allowed. We do not treat this field as sensitive data, so do not use secrets in this URL such as tokens or API keys.",
"format": "uri",
"example": "https://www.cisco.com/"
},
"secret": {
"maxLength": 256,
"minLength": 32,
"type": "string",
"description": "Secret string used to sign payloads sent to the destination URL.",
"example": "my-32-plus-character-long-secret"
},
"orgId": {
"type": "string",
"description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permission to interact with the organization.",
"format": "uuid",
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
"resourceVersion": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Represents version of the resource client is interested in. Should be of the format \u2018resource:version\u2019. Refer to the List Event Types V2 API for details on the latest available resources and versions.",
"example": "agent:1.0.0"
}
}
},
"SubscriptionCreateApiResponseEnhanced": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/MetaSubInfo"
},
"data": {
"$ref": "#/components/schemas/SubscriptionResponseEnhanced"
}
}
},
"SubscriptionApiResponseEnhanced": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/Meta"
},
"data": {
"$ref": "#/components/schemas/SubscriptionResponseEnhanced"
}
}
},
"SubscriptionRequestUpdateEnhanced": {
"required": [
"resourceVersion"
],
"type": "object",
"properties": {
"description": {
"maxLength": 1024,
"minLength": 0,
"type": "string",
"description": "Client-defined string describing the subscription.",
"example": "The subscription my integration uses to synchronize with WxCC"
},
"eventTypes": {
"maxItems": 32,
"minItems": 1,
"type": "array",
"description": "Types of events to which the subscription will listen.",
"example": [
"agent:login",
"agent:logout"
],
"items": {
"type": "string"
}
},
"destinationUrl": {
"pattern": "^(https?)://.*$",
"type": "string",
"description": "URL to which webhooks will be posted. Must be HTTPS on an IANA-listed top-level domain name (e.g. .com) with a path (at least /). No query parameters, userinfo, non-443 ports, or fragments allowed. We do not treat this field as sensitive data, so do not use secrets in this URL such as tokens or API keys.",
"format": "uri",
"example": "https://www.cisco.com/"
},
"status": {
"pattern": "(active|inactive)",
"type": "string",
"description": "Status of the subscription. Can be \"active\" or \"inactive\". The system may change the status to \"inactive\" in error scenarios.",
"example": "inactive",
"enum": [
"active",
"inactive"
]
},
"secret": {
"maxLength": 256,
"minLength": 32,
"type": "string",
"description": "Secret string used to sign payloads sent to the destination URL.",
"example": "my-32-plus-character-long-secret"
},
"orgId": {
"type": "string",
"description": "Organization ID to be used for this operation. If unspecified, the Organization ID is inferred from the token. The token must have permission to interact with the organization.",
"format": "uuid",
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
"resourceVersion": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "Represents version of the resource client is interested in. Should be of the format \u2018resource:version\u2019. Refer to the List Event Types V2 API for details on the latest available resources and versions.",
"example": "agent:1.0.0"
}
}
},
"EventTypesApiListResponseEnhanced": {
"required": [
"data",
"meta"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventTypesResponse"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResourceVersionInfo"
}
}
},
"MetaResourceVersionInfo": {
"required": [
"resourceVersionList"
],
"type": "object",
"properties": {
"orgId": {
"type": "string",
"description": "Organization ID used for this operation.",
"format": "uuid",
"example": "97cdbf45-ebe2-4687-8341-44d5c7abf101"
},
"resourceVersionList": {
"type": "array",
"description": "List of all resources, and it's supported versions available to subscribe.",
"items": {
"$ref": "#/components/schemas/ResourceVersion"
}
}
}
},
"ResourceVersion": {
"type": "object",
"properties": {
"resource": {
"type": "string",
"description": "Resource name.",
"example": "agent"
},
"version": {
"type": "string",
"description": "Version of the resource.",
"example": "1.0.0"
}
},
"description": "List of all resources, and it's supported versions available to subscribe."
},
"CCUsageReportRequest": {
"type": "object",
"description": "Request payload to create a usage report for a specific resource type and date range.",
"properties": {
"resourceType": {
"type": "string",
"description": "Type of resource this report contains.",
"example": "ContactSessionRecord"
},
"startDate": {
"type": "string",
"description": "Report start date (inclusive), in yyyy-MM-dd format.",
"example": "2025-01-01"
},
"endDate": {
"type": "string",
"description": "Report end date (exclusive), in yyyy-MM-dd format.",
"example": "2025-01-31"
}
},
"example": {
"resourceType": "ContactSessionRecord",
"startDate": "2025-01-01",
"endDate": "2025-01-31"
}
},
"CreateCCUsageReportResponse": {
"type": "object",
"description": "Response returned after successfully creating a usage report.",
"properties": {
"reportId": {
"type": "string",
"description": "Unique report ID (UUID without hyphens).",
"example": "550e8400e29b41d4a716446655440000"
},
"createdTime": {
"type": "string",
"description": "Report creation timestamp in ISO 8601 format.",
"example": "2026-02-01T09:31:04Z"
}
},
"example": {
"reportId": "550e8400e29b41d4a716446655440000",
"createdTime": "2026-02-01T09:31:04Z"
}
},
"CCUsageReport": {
"type": "object",
"properties": {
"reportId": {
"type": "string",
"description": "Unique report ID (UUID without hyphens). A single usage report may contain multiple report files.",
"example": "550e8400e29b41d4a716446655440000",
"pattern": "^[0-9a-f]{32}$"
},
"resourceType": {
"type": "string",
"description": "Type of resource this usage report contains.",
"example": "ContactSessionRecord"
},
"orgId": {
"type": "string",
"description": "Organization ID whose data is included in this report file.",
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
},
"status": {
"type": "string",
"description": "Overall status of the usage report.\n\nThis status represents the aggregated state of all report files\ngenerated under this report. A report may contain multiple files,\neach with its own individual status.\n\nTypical rules:\n- queued\uff1aAll report files are pending\n- in progress: At least one report file is still being processed\n- completed: All report files have completed successfully\n- failed: All report files failed\n",
"enum": [
"queued",
"in progress",
"completed",
"failed"
],
"example": "completed"
},
"createdTime": {
"type": "string",
"description": "Timestamp when the usage report was created, in ISO 8601 format.",
"example": "2026-02-01T09:31:04Z"
},
"completedTime": {
"type": "string",
"description": "Timestamp when the all usage report files were completed, in ISO 8601 format. ",
"example": "2026-02-01T10:15:30Z"
},
"expiryTime": {
"type": "string",
"description": "Expiration time of the usage report, in ISO 8601 format.\n\nAfter this timestamp, the entire usage report will be permanently deleted,\nincluding all associated report files. Once expired, the report and its\nfiles can no longer be queried or downloaded.\n\nThe report expiration time is typically 7 days after the report was completed.\n",
"example": "2026-02-08T10:15:30Z"
},
"reportFiles": {
"type": "array",
"description": "List of report files generated for this usage report.\n\nDepending on the requested date range, the report may contain one or more\nreport files.\n\nWhen the requested date range spans more than 30 days, the overall range\nis automatically split by natural calendar months. Each report file\nrepresents one such time slice within the original requested range.\n\nReport files are processed independently and may have different statuses.\nThe overall report status is derived from the statuses of these files.\n",
"example": [
{
"startDate": "2025-12-23",
"endDate": "2025-12-31",
"status": "completed",
"fileId": "0f49a30b66f9415382ce2251f2ee194d",
"fileName": "ContactSessionRecord_550e8400e29b41d4a716446655440000_1eb65fdf-9643-417f-9974-ad72cae0e10f_2025-12-23_2025-12-31.csv",
"fileSize": 102400,
"checksum": "a1b2c3d4e5f67890",
"downloadUrl": "https://api.intgus1.ciscoccservice.com/async-api/v1/reports/0f49a30b66f9415382ce2251f2ee194d/download"
}
],
"items": {
"$ref": "#/components/schemas/CCUsageReportFile"
}
}
}
},
"CCUsageReportFile": {
"type": "object",
"properties": {
"startDate": {
"type": "string",
"description": "Report file start date (inclusive), in yyyy-MM-dd format.",
"example": "2025-01-01"
},
"endDate": {
"type": "string",
"description": "Report file end date (exclusive), in yyyy-MM-dd format.",
"example": "2025-01-31"
},
"status": {
"type": "string",
"description": "Current status of this report file.\n\nEach report file represents a specific time range within the\noverall usage report. File statuses are independent from\neach other and may differ within the same report.\n\nPossible values:\n- queued: File generation is pending\n- in progress: File is currently being generated\n- completed: File has been generated successfully and is available for download\n- failed: File generation failed\n",
"enum": [
"queued",
"in progress",
"completed",
"failed"
],
"example": "completed"
},
"fileId": {
"type": "string",
"description": "Unique file ID (UUID without hyphens).",
"example": "0f49a30b66f9415382ce2251f2ee194d",
"pattern": "^[0-9a-f]{32}$"
},
"fileName": {
"type": "string",
"description": "Name of the generated CSV file. Format: resourceType_reportId_orgId_startDate_endDate.csv",
"example": "ContactSessionRecord_550e8400e29b41d4a716446655440000_1eb65fdf-9643-417f-9974-ad72cae0e10f_2025-01-01_2025-01-31.csv"
},
"fileSize": {
"type": "integer",
"format": "int64",
"description": "Size of the generated file in bytes. Available only when the file status is completed.",
"example": 102400
},
"checksum": {
"type": "string",
"description": "MD5 checksum of the generated file for integrity verification. Available only when the file status is completed.",
"example": "a1b2c3d4e5f67890"
},
"downloadUrl": {
"type": "string",
"description": "Secure download URL for the file. Available only when the file status is completed.",
"example": "https://api.intgus1.ciscoccservice.com/v1/usage-reports/0f49a30b66f9415382ce2251f2ee194d/download"
}
}
},
"CCUsageReportResourceType": {
"type": "object",
"description": "Describes a resource type that can be used to generate usage reports.",
"properties": {
"resourceType": {
"type": "string",
"description": "Technical identifier for the resource type.",
"example": "ContactSessionRecord"
},
"displayName": {
"type": "string",
"description": "Human-readable name of the resource type.",
"example": "Contact Session Record"
},
"description": {
"type": "string",
"description": "Description of the data contained in this resource type.",
"example": "Detailed records of all contact sessions including call details, queue times, and outcomes."
},
"dataStartDate": {
"type": "string",
"description": "Earliest date for which data is available.",
"example": "2023-01-01"
},
"dataEndDate": {
"type": "string",
"description": "Latest date for which data is available.",
"example": "2025-01-31"
}
},
"example": {
"resourceType": "ContactSessionRecord",
"displayName": "Contact Session Record",
"description": "Detailed records of all contact sessions including call details, queue times, and outcomes.",
"dataStartDate": "2023-01-01",
"dataEndDate": "2025-01-31"
}
},
"LogInResourceRequest": {
"properties": {
"dialNumber": {
"description": "A dialNumber field contains the number to dial such as a route point or extension, maximum length 43 characters.",
"type": "string",
"example": "5678956899"
},
"teamId": {
"description": "The unique ID representing a team of users. Leaving this field blank is valid for supervisor role but invalid for agent role, maximum length 36 characters.",
"type": "string",
"example": "5c8e24ff-a31a-422d-b7a7-b56c6739081d"
},
"isExtension": {
"description": "It indicates if the dialNumber field is full number or extension. It is set to false by default.",
"type": "boolean",
"example": "false"
},
"roles": {
"description": "It represents the current role of the user. The user can either be an ```agent``` or a ```supervisor```.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"agent",
"supervisor"
]
},
"deviceType": {
"description": "It represents the way to differentiate type of login request (```AGENT_DN```, ```EXTENSION```, ```BROWSER```). Leaving this field is valid for supervisor role but invalid for agent role.",
"type": "string",
"example": "AGENT_DN"
},
"deviceId": {
"description": "It is equal to dialNumber for AGENT_DN & EXTENSION deviceType and for BROWSER it is populated as webrtc-AgentUUID, maximum length 43 characters.",
"type": "string",
"example": "5678956899"
}
},
"required": [
"dialNumber",
"roles"
],
"type": "object"
},
"LogOutResourceRequest": {
"properties": {
"logoutReason": {
"description": "The reason for performing logout operation, maximum length 128 characters.",
"type": "string",
"example": "Logout initiated by user abcd@xyz.com"
},
"agentId": {
"description": "Unique ID of the user who is being logged out, maximum length 36 characters.",
"type": "string",
"example": "faedfcc8-035a-41e3-ad53-ee9fad4ca286"
}
},
"required": [
"logoutReason"
],
"type": "object"
},
"StateResourceRequest": {
"properties": {
"state": {
"description": "It represents the current state of the user. Can be set to ```Available``` or ```Idle```.",
"type": "string",
"example": "Available"
},
"auxCodeId": {
"description": "Auxiliary Codes are status codes which an agent can select in Webex Contact Center Agent Desktop. They are of two types: ```Idle``` and ```Wrap-Up``` codes, and every agent profile must have one of each for the agent to use. Idle codes are used to explain an agent's unavailability to take customer contacts, such as during a lunch break or a meeting. Wrap-up codes indicate the result of customer contacts, such as successful resolution or escalation of the contact. Creating and managing auxiliary codes requires an administrator role and the appropriate cjp:config_write or cjp:config_read scopes, maximum length 36 characters.",
"type": "string",
"example": "AXUH3oN12eV-WekpnDpl"
},
"lastStateChangeReason": {
"description": "It represents the reason of the last state change request, maximum length 128 characters.",
"type": "string",
"example": "Lunch"
},
"agentId": {
"description": "User for which state change is initiated, maximum length 36 characters.",
"type": "string",
"example": "1a80ba23-194b-49af-9b93-074b3ecc852a"
}
},
"required": [
"state",
"auxCodeId"
],
"type": "object",
"description": "Request payload to update an agent state."
},
"BuddyAgentRequest": {
"properties": {
"agentProfileId": {
"description": "The profile ID of a particular agent. Can be obtained from [Users API](/docs/users), maximum length 36 characters.",
"type": "string",
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
},
"mediaType": {
"description": "The media type for the request. The supported values are ```telephony```, ```chat```, ```social```, ```email```, ```workItem``` and ```customMessaging```.",
"type": "string",
"example": "telephony"
},
"state": {
"description": "It represents the current state of the returned agents which can be either ```Available``` or ```Idle```. If state is omitted from the payload, the API will return a list of both available and idle agents. This is useful for consult scenarios, since consulting an idle agent is also supported.",
"type": "string",
"example": "Available"
}
},
"required": [
"agentProfileId",
"mediaType"
],
"type": "object",
"description": "Request payload to retrieve buddy agents."
},
"AgentActivitiesApiResponse": {
"required": [
"data",
"meta"
],
"type": "object",
"properties": {
"meta": {
"description": "Response metadata.",
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"description": "List of agent activities retrieved according to query parameters.",
"items": {
"$ref": "#/components/schemas/AgentActivity"
}
}
},
"description": "Response wrapper for agent activities."
},
"AgentActivity": {
"required": [
"active",
"agentDn",
"agentId",
"agentLogin",
"agentName",
"agentSessionId",
"channelId",
"channelType",
"currentState",
"endTime",
"idleCode",
"idleCodeName",
"isLogin",
"mmProfileType",
"queueId",
"queueName",
"reason",
"siteId",
"siteName",
"startTime",
"subChannelType",
"taskId",
"teamId",
"teamName",
"wrapupCodeName"
],
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "Active indicates whether the activity is completed (false) or in progress (true).",
"example": true
},
"agentId": {
"type": "string",
"description": "Unique identifier of an agent.",
"example": "AWn8XmdC-MmYjwcdYK2i"
},
"agentDn": {
"type": "string",
"description": "Dialed number for the agent.",
"example": "5555555"
},
"agentLogin": {
"type": "string",
"description": "Login username of the agent.",
"example": "agent@mailinator.com"
},
"agentSessionId": {
"type": "string",
"description": "Agent Session Id",
"example": "72a79e8b-6d2e-4423-869a-01bfebc081e6"
},
"agentName": {
"type": "string",
"description": "The name of the agent.",
"example": "John Smith"
},
"currentState": {
"type": "string",
"description": "The activity state (e.g. idle, available, connected, etc.).",
"example": "idle"
},
"siteId": {
"type": "string",
"description": "Unique identifier for a site.",
"example": "AWn8XmdC-MmYjwcdYK2i"
},
"siteName": {
"type": "string",
"description": "The name of the site.",
"example": "Austin"
},
"teamId": {
"type": "string",
"description": "Unique identifier for a team.",
"example": "AWn8XmdC-MmYjwcdYK2i"
},
"teamName": {
"type": "string",
"description": "The name of the team.",
"example": "email"
},
"isLogin": {
"type": "integer",
"description": "Indicates whether the activity was the login event (1) or not (0).",
"format": "int32",
"example": 1
},
"taskId": {
"type": "string",
"description": "Unique identifier for a task.",
"example": "35d88b03-6c43-45e4-9fba-99b728ad4750"
},
"channelId": {
"type": "string",
"description": "Unique identifier for the channel.",
"example": "35d88b03-6c43-45e4-9fba-99b728ad4750"
},
"channelType": {
"type": "string",
"description": "Channel type for the activity (e.g. email, telephony, chat, etc.).",
"example": "email"
},
"subChannelType": {
"type": "string",
"description": "SubChannel type for the activity.",
"example": "email"
},
"idleCodeName": {
"type": "string",
"description": "In case of an idle activity, it will have an idle code attached with it (e.g. Break, Meeting, Lunch, etc.).",
"example": "Break"
},
"idleCode": {
"type": "string",
"description": "Unique identifier for the idle code.",
"example": "AWn8XmdC-MmYjwcdYK2i"
},
"queueId": {
"type": "string",
"description": "Unique identifier for the queue.",
"example": "AWn8XmdC-MmYjwcdYK2i"
},
"queueName": {
"type": "string",
"description": "The name of the Queue.",
"example": "Support Queue"
},
"wrapupCodeName": {
"type": "string",
"description": "Selected wrapup code upon finished task.",
"example": "Sale"
},
"reason": {
"type": "string",
"description": "Reason",
"example": "reason"
},
"startTime": {
"type": "integer",
"description": "Epoch timestamp in milliseconds of the start of the activity.",
"format": "int64",
"example": 1605169648658
},
"endTime": {
"type": "integer",
"description": "Epoch timestamp in milliseconds of the end of the activity. If active, it will be -1.",
"format": "int64",
"example": 1605169648658
},
"mmProfileType": {
"type": "string",
"description": "Multimedia profile type",
"example": "blended"
}
},
"description": "List of agent activities retrieved according to query parameters."
},
"AgentApiResponse": {
"required": [
"data",
"meta"
],
"type": "object",
"properties": {
"meta": {
"description": "Response metadata.",
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"description": "List of Agent Statistics records retrieved according to query parameters.",
"items": {
"$ref": "#/components/schemas/OutAgentStatistics"
}
}
},
"description": "Response wrapper for agent statistics."
},
"OutAgentStatistics": {
"required": [
"channels"
],
"type": "object",
"properties": {
"intervalStartTime": {
"type": "integer",
"description": "Time in GMT",
"format": "int64",
"example": 1591702200000
},
"agentId": {
"type": "string",
"description": "The ID of the agent.",
"example": "06ce7234-dd3e-49e2-8763-d93766739d"
},
"agentName": {
"type": "string",
"description": "The name of the agent",
"example": "Daniel Garrett"
},
"teamId": {
"type": "string",
"description": "The ID of the team.",
"example": "fbf80248-b328-4c37-9ea5-4c2ec8b4d52c"
},
"teamName": {
"type": "string",
"description": "Name of the team to which agent belongs.",
"example": "Collaboration"
},
"channels": {
"type": "array",
"description": "Channel-level statistics for the agent.",
"items": {
"$ref": "#/components/schemas/ChannelResponse"
}
}
},
"description": "List of Agent Statistics records retrieved according to query parameters."
},
"ChannelResponse": {
"type": "object",
"properties": {
"channelType": {
"type": "string",
"description": "Channel Type",
"example": "chat"
},
"totalAssignedTasks": {
"type": "integer",
"description": "Number of tasks assigned within the channel during the agent session.",
"format": "int32",
"example": 3
},
"totalOfferedTasks": {
"type": "integer",
"description": "Number of offered tasks within this channel during the agent's session.",
"format": "int32",
"example": 3
},
"totalAcceptedTasks": {
"type": "integer",
"description": "Number of assigned tasks that were accepted by the agent.",
"format": "int32",
"example": 3
},
"totalRejectedTasks": {
"type": "integer",
"description": "Number of assigned tasks that were rejected by the agent.",
"format": "int32",
"example": 3
},
"totalTransferredTasks": {
"type": "integer",
"description": "Number of tasks that the agent transferred to another agent.",
"format": "int32",
"example": 2
},
"totalEngagedDuration": {
"type": "integer",
"description": "The amount of time the agent was engaged with a customer (in milliseconds).\nNote :-\n- Does not include wrap-up time and consult duration\n- Includes conferencing duration since the customer is involved",
"format": "int32",
"example": 40302
},
"totalHoldDuration": {
"type": "integer",
"description": "The amount of time for which the customer(s) was put on hold (in milliseconds).",
"format": "int64",
"example": 10198
},
"totalWrapUpDuration": {
"type": "integer",
"description": "The amount of time spent by the agent wrapping up customer interactions (in milliseconds).\ni.e Sum of all wrap-up time metric for a given agent",
"format": "int64",
"example": 3552
},
"totalAvailableTime": {
"type": "integer",
"description": "Duration of time(in milliseconds) outside of the idle time when an agent was available and handling contacts after logging in.",
"format": "int64",
"example": 234947
},
"totalUnAvailableTime": {
"type": "integer",
"description": "Amount of time the agent was unavailable (in milliseconds).",
"format": "int64",
"example": 22300
},
"averageHandledTime": {
"type": "number",
"description": "This is the average of the total handle time by an agent (in milliseconds)\ni.e avg(engagedDuration(connected state) + hold-duration + wrap-up time)",
"format": "double",
"example": 22300
}
},
"description": "Statistics for a specific channel."
},
"AgentChannelStateChangeResourceRequest": {
"properties": {
"channelType": {
"type": "array",
"items": {
"type": "string"
},
"description": "It represents the channelType of the agent which can be set to ```telephony```,```chat```, ```social```, ```email```, ```workItem``` and ```customMessaging```. This would be sent for any channel types the agent wants to set the state on. In the event that the agent is setting more than one channel type states at once, it would send multiple state change requests .channelType is a list, and can include one or more channel types in the request. Note: `customMessaging` requires the `wxcc_digital_byoc` feature flag to be enabled for the organization.",
"example": "[telephony, chat]"
},
"state": {
"description": "It represents the current state of the user. Can be set to ```Available``` or ```Idle``` or ```LoggedOut``` or ```Reserved``` or ```Engaged``` or or ```EngagedOther``` .",
"type": "string",
"example": "Idle"
},
"auxCodeId": {
"description": "Auxiliary Codes are status codes which an agent can select in Webex Contact Center Agent Desktop. They are of two types: ```Idle``` and ```Wrap-Up``` codes, and every agent profile must have one of each for the agent to use. Idle codes are used to explain an agent's unavailability to take customer contacts, such as during a lunch break or a meeting. Wrap-up codes indicate the result of customer contacts, such as successful resolution or escalation of the contact. Creating and managing auxiliary codes requires an administrator role and the appropriate cjp:config_write or cjp:config_read scopes, maximum length 36 characters.",
"type": "string",
"example": "c08805ca-920a-4d7d-a9d8-cb3fe40a76c5"
},
"reason": {
"description": "It represents the reason of the last agent channel state change request, maximum length 128 characters.",
"type": "string",
"example": "Lunch"
},
"agentId": {
"description": "User for which agent channel state change is initiated, maximum length 36 characters.",
"type": "string",
"example": "1a80ba23-194b-49af-9b93-074b3ecc852a"
}
},
"required": [
"channelType",
"state"
],
"type": "object"
},
"CallMonitoringRequest": {
"required": [
"id",
"monitorType"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id represents the unique request id with which the Monitoring Request will be created, maximum length 36 characters.",
"example": "3b7e6ad3-e5fe-4dd1-89a1-d7d952e29990"
},
"monitorType": {
"type": "string",
"description": " It represents the type of the monitoring request. It can to be ```midcall```, ```adhoc``` and ```continuous```",
"example": "midcall"
},
"taskId": {
"type": "string",
"format": "UUID",
"description": "The unique ID representing the task that needs to be monitored. Mandatory for ```midcall``` type.",
"example": "9ce62805-3931-44d3-a839-3004025f7e30"
},
"queueIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "If the call is routed to an agent and the agent is assigned to a queue, the queueId can be entered here to initiate a successful call monitoring request for that particular queue, maximum length of each queue is 36 characters and maximum number of queueIds 250.",
"example": "[fbed39e1-4ed8-4179-828b-075e3788649c]"
},
"teams": {
"type": "array",
"items": {
"type": "string"
},
"description": "If the call is routed to an agent and the agent is assigned to a team, the teamId can be entered here to initiate a successful monitoring request for that particular team, maximum length of each team is 36 characters and maximum number of teams 100.",
"example": "[510d198d-7aa7-4b75-a5ff-e61759f4f313]"
},
"sites": {
"type": "array",
"items": {
"type": "string"
},
"description": "If the call is routed to an agent and the agent is assigned to a site, the siteId can be entered here to initiate a successful monitoring request for that particular site, maximum length of each site is 36 characters and the maximum number of sites 20.",
"example": "[67c5b4c8-9c78-4400-8148-8254dc550c49]"
},
"agents": {
"type": "array",
"items": {
"type": "string"
},
"description": "Enter the agentId to monitor a particular agent to whom the call is being assigned, maximum length of each agent is 36 characters and the maximum number of agents is 500.",
"example": "[fbed39e1-4ed8-4179-828b-075e3788649c]"
},
"trackingId": {
"type": "string",
"format": "UUID",
"description": "An unique id to keep a track of events occurring during the call",
"example": "8bd52805-3931-44d3-a839-3004025f7e30"
},
"invisibleMode": {
"type": "boolean",
"description": "This allows the supervisor to obfuscate their details from Team Performance Widget panel. Set ```true``` inorder to activate this mode",
"example": "false"
}
}
},
"ScheduleCallbackRequest": {
"required": [
"customerName",
"callbackNumber",
"timezone",
"scheduleDate",
"startTime",
"endTime",
"queueId"
],
"type": "object",
"properties": {
"customerName": {
"type": "string",
"description": "Name of the Customer for which callback has to be scheduled. Max customer name length should be 250 character",
"example": "John Doe"
},
"callbackNumber": {
"type": "string",
"description": "Customer's phone number for the callback. Allows an optional country code followed by digits (0-9) and the special characters: space, hyphen -, parentheses ( and ), and period ., ensuring the total length is between 7 and 15 characters.",
"example": "+12(345)67-890"
},
"timezone": {
"type": "string",
"description": "Valid IANA timezone name",
"example": "America/New_York"
},
"scheduleDate": {
"type": "string",
"format": "date",
"description": "Scheduled date in ISO-8601 (YYYY-MM-DD) format. This must be a valid date in local time zone and within 31 days from current date",
"example": "2025-03-28"
},
"startTime": {
"type": "string",
"format": "time",
"description": "Scheduled start time in ISO-8601 (HH:mm:ss) format. Start time must be at least 30 minutes in the future from current time.",
"example": "17:45:15"
},
"endTime": {
"type": "string",
"format": "time",
"description": "Scheduled end time in ISO-8601 (HH:mm:ss) format. End time must be at least 30 minutes after the startTime and must not exceed 8 hours after startTime.",
"example": "16:50:55"
},
"queueId": {
"type": "string",
"description": "Unique identifier for the queue to which the callback is associated.",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"callbackReason": {
"type": "string",
"description": "Reason for the callback request. This is optional and can be used to provide additional context.",
"example": "Credit Card Issue"
},
"sourceInteraction": {
"type": "string",
"format": "uuid",
"description": "Source interaction ID for the callback. This is optional and can be used to link the callback to a specific interaction. This should be a valid UUID.",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"assigneeAgent": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the specific agent (CI userId), who should be assigned to handle the callback. This field is optional and is primarily used for personal callbacks.",
"example": "123e4567-e89b-12d3-a456-426614174000"
}
}
},
"ScheduleCallbackResponse": {
"type": "object",
"$ref": "#/components/schemas/CallbackSchedule"
},
"CallbackSchedule": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the scheduled callback.",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"customerName": {
"type": "string",
"description": "Name of the customer requesting the callback.",
"example": "John Doe"
},
"callbackNumber": {
"type": "string",
"description": "Phone number provided for the callback.",
"example": "+1234567890"
},
"timezone": {
"type": "string",
"description": "Timezone in which the callback is scheduled.",
"example": "America/New_York"
},
"scheduleDate": {
"type": "string",
"format": "date",
"description": "Date for the callback in ISO format (YYYY-MM-DD).",
"example": "2025-04-08"
},
"startTime": {
"type": "string",
"format": "time",
"description": "Scheduled start time in ISO 8601 format (HH:mm:ss), local to the specified timezone.",
"example": "14:30:00"
},
"endTime": {
"type": "string",
"format": "time",
"description": "Scheduled end time in ISO 8601 format (HH:mm:ss), local to the specified timezone.",
"example": "15:30:00"
},
"queueId": {
"type": "string",
"description": "Identifier for the queue to route the callback request.",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"callbackReason": {
"type": "string",
"description": "Reason provided for the callback request.",
"example": "Customer requested a follow-up."
},
"sourceInteraction": {
"type": "string",
"format": "uuid",
"description": "UUID of the source interaction.",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"callbackOrigin": {
"type": "string",
"description": "Origin of the callback request, such as 'livecall' or 'api'.",
"example": "api"
},
"createdTimestamp": {
"type": "integer",
"format": "int64",
"description": "Unix timestamp in milliseconds when the callback was created.",
"example": 1672531199000
},
"lastUpdatedTimestamp": {
"type": "integer",
"format": "int64",
"description": "Unix timestamp in milliseconds when the callback was last updated.",
"example": 1672531199000
},
"assigneeAgent": {
"type": "string",
"format": "uuid",
"description": "The unique identifier of the agent assigned to handle the callback.",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"assignedTime": {
"type": "integer",
"format": "int64",
"description": "Unix timestamp in milliseconds when the assigneeAgent was last updated.",
"example": 1672531199000
},
"orgId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the organization.",
"example": "123e4567-e89b-12d3-a456-426614174000"
}
},
"required": [
"id",
"customerName",
"callbackNumber",
"timezone",
"scheduleDate",
"startTime",
"endTime",
"queueId",
"callbackOrigin",
"createdTimestamp",
"lastUpdatedTimestamp",
"orgId"
]
},
"CallbackScheduleMetadata": {
"type": "object",
"properties": {
"orgId": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the organization.",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"page": {
"type": "integer",
"description": "Current page number.",
"example": 1
},
"pageSize": {
"type": "integer",
"description": "Number of items per page.",
"example": 10
},
"totalPages": {
"type": "integer",
"description": "Total number of pages.",
"example": 5
},
"totalRecords": {
"type": "integer",
"description": "Total number of items.",
"example": 50
},
"links": {
"$ref": "#/components/schemas/PaginationLinks"
}
},
"required": [
"orgId",
"page",
"pageSize",
"totalPages",
"totalRecords",
"links"
]
},
"CallbackSchedulesResponse": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/CallbackScheduleMetadata"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CallbackSchedule"
}
}
}
},
"CallbackScheduleUpdateRequest": {
"allOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier for the scheduled callback.",
"example": "123e4567-e89b-12d3-a456-426614174000"
}
},
"required": [
"id"
]
},
{
"$ref": "#/components/schemas/ScheduleCallbackRequest"
}
]
},
"CreateTaskRequest": {
"description": "Request body for creating a task.",
"required": [
"destination",
"entryPointId",
"mediaType"
],
"type": "object",
"properties": {
"destination": {
"type": "string",
"description": "A valid customer DN, on which the response is expected, maximum length 36 characters.",
"example": "2147751365"
},
"entryPointId": {
"type": "string",
"description": "An entryPointId for respective task. For ```CALLBACK``` and ```OUTDIAL``` this should be an outboundEP. For ```EXECUTE_FLOW``` this should be an inboundEP which is mapped to a flow that will be triggered, maximum length 36 characters.",
"example": "510d198d-7aa7-4b75-a5ff-e61759f4f313"
},
"attributes": {
"type": "object",
"description": "This is a schema free data tuple to pass-on specific data, depending on the outboundType. Supports a maximum of 30 tuples. Each tuple can have a key up to 200 bytes (up to 200 UTF-8 characters) and a value up to 1024 bytes (up to 1024 UTF-8 characters).",
"example": {
"channel": "sales"
}
},
"outboundType": {
"type": "string",
"description": "The outbound type for the task. Supported values are ```CALLBACK```, ```OUTDIAL```, and ```EXECUTE_FLOW```. Use ```OUTDIAL``` when the user is logged into the Agent Desktop and needs to make an outbound call to the customer. Use ```CALLBACK``` when the user is not logged in and needs to schedule a callback to the customer. Use ```EXECUTE_FLOW``` when the task is linked to a predefined flow triggered through an Inbound Entrypoint.",
"example": "CALLBACK"
},
"mediaType": {
"type": "string",
"description": "The media type for the request. The ```telephony``` type is required for ```EXECUTE_FLOW``` and ```CALLBACK```. The supported value is ```telephony```.",
"example": "telephony"
},
"origin": {
"type": "string",
"description": "The contact center number, which is an ANI Outdial number, that will be used while making a call to the customer. This field is mandatory for ```EXECUTE_FLOW``` and ```OUTDIAL``` type while it is optional for ```CALLBACK```. If not provided for ```CALLBACK``` type, default out-dial ANI configuration will be used, maximum length 36 characters. The origin value must exactly match one of the configured Outdial ANIs in the agent profile.",
"example": "2147751364"
},
"callback": {
"type": "object",
"description": "Callback details. Required only when outboundType is set to ```CALLBACK```.",
"$ref": "#/components/schemas/CallbackDetails"
},
"customAttributes": {
"type": "object",
"description": "This is a schema-free data tuple to pass on specific SIP header data, Supports a maximum of 20 headers, selected alphabetically if more than 20 are present. Each header key is converted to lowercase, and hyphens are retained. The payload is restricted to 1100 bytes to comply with RFC3261 when using UDP. No header values are logged to ensure PII protection.Ex:The Caller ID Name is included as 'caller_id_name', derived from the appropriate SIP header",
"example": {
"x_custom_header": "val"
}
}
}
},
"CallbackDetails": {
"description": "Details for a callback task.",
"type": "object",
"required": [
"callbackOrigin",
"callbackType"
],
"properties": {
"callbackOrigin": {
"type": "string",
"description": "The source of callback request. The supported value is ```web```.",
"example": "web"
},
"callbackType": {
"type": "string",
"description": "The type of callback. The supported value is ```immediate```.",
"example": "immediate"
}
}
},
"CreateTaskResponse": {
"description": "Response body after successfully requesting a task creation.",
"type": "object",
"example": {
"meta": {
"orgId": "658d1102-8c11-4850-a809-d7a99cc1c22f"
},
"data": {
"id": "768d1102-8c11-4850-a809-d7a99cc1c22e"
}
},
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"type": "object",
"description": "Response metadata.",
"required": [
"orgId"
],
"properties": {
"orgId": {
"type": "string",
"format": "uuid",
"description": "UUID of the organization, inferred from the authorization token.",
"example": "658d1102-8c11-4850-a809-d7a99cc1c22f"
}
}
},
"data": {
"type": "object",
"description": "Response data.",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "UUID of the created task. Use this ID to monitor and manage the task lifecycle via subsequent API calls.",
"example": "768d1102-8c11-4850-a809-d7a99cc1c22e"
}
}
}
}
},
"PatchTaskRequest": {
"description": "Request body for patching a task.",
"required": [
"attributes"
],
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "This is a schema free data tuple to pass-on specific data, depending on the outboundType. Supports a maximum of 30 tuples. Each tuple can have a key up to 200 bytes (up to 200 UTF-8 characters) and a value up to 1024 bytes (up to 1024 UTF-8 characters).",
"example": {
"channel": "sales"
}
}
}
},
"WrapUpResourceRequest": {
"description": "Request body for wrapping up a task.",
"properties": {
"auxCodeId": {
"description": "Auxiliary codes are status codes which an agent can select in Webex Contact Center Agent Desktop. They are of two types: ```Idle``` and ```Wrap-Up``` codes, and every agent profile must have one of each for the agent to use. Idle codes are used to explain an agent's unavailability to take customer contacts, such as during a lunch break or a meeting. Wrap-up codes indicate the result of customer contacts, such as successful resolution or escalation of the contact. Creating and managing auxiliary codes requires an administrator role and the appropriate cjp:config_write or cjp:config_read scopes, maximum length 36 characters.",
"type": "string",
"example": "AXUH3oN12eV-WekpnDpl"
},
"wrapUpReason": {
"description": "Every wrap up reason will have an unique auxillary code. Use this field to specify the reason for wrapping up the call, maximum length 128 characters.",
"type": "string",
"example": "Sales"
}
},
"required": [
"wrapUpReason",
"auxCodeId"
],
"type": "object"
},
"MediaResourceRequest": {
"description": "Request body for media resource.",
"properties": {
"mediaResourceId": {
"description": "It is an identifier of a media resource, maximum length 36 characters",
"type": "string",
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
},
"required": [
"mediaResourceId"
],
"type": "object"
},
"ResumeRecordingResourceRequest": {
"description": "Request body for resuming a recording.",
"properties": {
"autoResumed": {
"description": "The setting to mention if the recording has to resume automatically.",
"type": "boolean",
"example": true
}
},
"required": [
"autoResumed"
],
"type": "object"
},
"TransferResourceRequest": {
"description": "Request body for transferring a task.",
"properties": {
"to": {
"description": "The user destination ID or the entry point ID to transfer, maximum length 43 characters.",
"type": "string",
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
},
"destinationType": {
"description": "The user can transfer to another user in the team(```agent```), queue(```queue```), dial number(```dialNumber```), entry point(```entrypointDialNumber```).",
"type": "string",
"example": "dialNumber"
}
},
"required": [
"to",
"destinationType"
],
"type": "object"
},
"ConsultResourceRequest": {
"description": "Request body for a consult.",
"properties": {
"to": {
"description": "The destination ID to consult, maximum length 36 characters.",
"type": "string",
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
},
"destinationType": {
"description": "The user can consult to another user in the team(```agent```), queue(```queue```), entry point(```entryPoint```) or dial number(```dialNumber```).\n When consulting an Entry Point (EP) that is associated with multiple Directory Numbers (DNs), the consult typically goes to one of the associated DNs.",
"type": "string",
"example": "dialNumber"
},
"holdParticipants": {
"description": "This allows the caller to specify their preference for whether the main call should be placed on hold or not during consult.",
"type": "boolean",
"example": true
}
},
"required": [
"to",
"destinationType"
],
"type": "object"
},
"ConferenceResourceRequest": {
"description": "Request body for a conference.",
"properties": {
"agentId": {
"description": "The unique Id of the user logged in as an agent.",
"type": "string",
"format": "UUID",
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
},
"to": {
"description": "The destination ID to consult, maximum length 36 characters.",
"type": "string",
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
},
"destinationType": {
"description": "The user can consult to another user in the team(```agent```), dial number(```dialNumber```), entry point(```entryPoint```).",
"type": "string",
"example": "agent"
}
},
"required": [
"to"
],
"type": "object"
},
"ConsultTransferResourceRequest": {
"description": "Request body for a consult transfer.",
"properties": {
"to": {
"description": "The consulted user destination ID to transfer, maximum length 36 characters.",
"type": "string",
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
},
"destinationType": {
"description": "The user can transfer to another consulted user in the team(```agent```), dial number(```dialNumber```), entry point(```entryPoint```)",
"type": "string",
"example": "dialNumber"
}
},
"required": [
"to",
"destinationType"
],
"type": "object"
},
"EndConsultRequest": {
"description": "Request body for ending a consult.",
"properties": {
"queueId": {
"description": "The unique ID of a particular queue, maximum length 36 characters.",
"type": "string",
"example": "315fbb91-2288-427c-9588-ec764cd46ea4"
}
},
"type": "object"
},
"TaskApiResponse": {
"description": "API response for a task.",
"required": [
"data",
"meta"
],
"type": "object",
"properties": {
"meta": {
"description": "Response metadata.",
"$ref": "#/components/schemas/Meta"
},
"data": {
"type": "array",
"description": "List of tasks retrieved according to query parameters.",
"items": {
"$ref": "#/components/schemas/Task"
}
}
}
},
"Task": {
"required": [
"attributes",
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the task.",
"example": "93912f11-6017-404b-bf14-5331890b1797"
},
"attributes": {
"$ref": "#/components/schemas/TaskAttributes"
}
},
"description": "List of tasks retrieved according to query parameters."
},
"TaskAttributes": {
"required": [
"channelType",
"createdTime",
"lastUpdatedTime",
"owner",
"queue",
"status"
],
"type": "object",
"properties": {
"owner": {
"$ref": "#/components/schemas/TaskOwner"
},
"queue": {
"$ref": "#/components/schemas/TaskQueue"
},
"channelType": {
"type": "string",
"description": "Task channel type(s) permitted in the response. Must be lowercase. By default, there is no channel type filtering.",
"example": "email"
},
"status": {
"type": "string",
"description": "Current status of the task.",
"example": "created",
"enum": [
"created",
"queued",
"offered",
"assigned",
"abandoned",
"completed"
]
},
"createdTime": {
"type": "integer",
"description": "Created time of the task (epoch milliseconds).",
"format": "int64",
"example": 1591702170000
},
"lastUpdatedTime": {
"type": "integer",
"description": "Last updated time of the task (epoch milliseconds). Updates whenever the underlying data is modified, even if the Task view of the data is the same. May also update after task \"closure\", so not suitable for finding a task's \"closed time\"",
"format": "int64",
"example": 1591712170099
},
"captureRequested": {
"type": "boolean",
"description": "Whether a capture has been requested for this Task. If this is true, a capture should eventually be available. False indicates no capture will be made available. If null, it is not yet known whether a capture has been requested.",
"example": false
},
"origin": {
"type": "string",
"description": "Customer's channel-specific identifier. For telephony, this is the phone number. For email and chat, this is the email address.",
"example": "chatuser@email.com"
},
"destination": {
"type": "string",
"description": "Destination the customer contacted. For telephony, this is the number the contact called. For chat, this is the URL of the page where the chat takes place. For email, it is the email address contacted.",
"example": "+18005555555"
},
"direction": {
"type": "string",
"description": "Indicates which party initiated the Task. If \"inbound\", call was initiated by customer. If \"outbound\", was initiated by system as part of campaign. If \"outdial\", was initiated by an agent.",
"example": "inbound"
},
"reasonCode": {
"type": "string",
"description": "Reason code specified by customer to indicate main aim of the task",
"example": "Credit"
}
},
"description": "Attributes of the task."
},
"TaskOwner": {
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the agent last assigned to this task.",
"example": "e0c7611b-8035-443a-b7a8-dca9f8b8289b"
},
"name": {
"type": "string",
"description": "Name of the agent last assigned to this task.",
"example": "Joseph Lambert"
}
},
"description": "The owner of the task."
},
"TaskQueue": {
"description": "The queue where the task belongs.",
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the last queue to which the task was assigned.",
"example": "89cf3b93-f020-42c6-84dc-87db6a92eae7"
},
"name": {
"type": "string",
"description": "Name of the last queue to which the task was assigned.",
"example": "Technical Support Queue"
}
}
},
"CreateTaskRequestV2": {
"description": "Request body for creating a task.",
"oneOf": [
{
"$ref": "#/components/schemas/WorkItem"
},
{
"$ref": "#/components/schemas/CustomMessaging"
},
{
"$ref": "#/components/schemas/Telephony"
}
],
"discriminator": {
"propertyName": "channelType"
}
},
"Origin": {
"type": "object",
"description": "Origin of the task. For inbound `workItem` and `customMessaging` tasks, this represents the customer. For outbound `telephony` tasks, this may be the agent's information or a configured outbound ANI in the organization. Outbound ANI is applicable to `telephony` only.",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Identifier of the task originator. For inbound `workItem` and `customMessaging` tasks, this is typically the customer's identifier (e.g., email address). For outbound `telephony` tasks, this may be the agent's identifier or a configured outbound ANI in the organization.",
"example": "customer@domain.com"
},
"name": {
"type": "string",
"nullable": true,
"description": "Optional human-readable display name for the originator.",
"example": "Customer Name"
}
}
},
"Destination": {
"type": "object",
"description": "Destination for the task. Use `businessAddress` type for `workItem` and `customMessaging` tasks and `dialNumber` type for `telephony` tasks.",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"description": "Destination identifier. For `workItem` and `customMessaging` tasks, this is the business address associated with the configured channel entry point. For `telephony` tasks, this is the dial number to call. **Migrating from v1:** Previously the top-level `destination` field (plain string) for telephony.",
"example": "customer-support@biz.com"
},
"type": {
"type": "string",
"description": "Destination type. Use `businessAddress` for `workItem` and `customMessaging` tasks and `dialNumber` for `telephony` tasks.",
"enum": [
"businessAddress",
"dialNumber"
],
"example": "businessAddress"
}
}
},
"FlowSettings": {
"type": "object",
"description": "Schema-free data map to pass specific data to the externalized flow settings. Supports a maximum of 15 tuples. Each tuple can have a key up to 200 bytes and a value up to 512 bytes.",
"additionalProperties": {
"type": "string"
},
"example": {
"flow1": "setting1"
}
},
"GlobalVariables": {
"type": "object",
"description": "Schema-free data map to pass specific data depending on the outbound type. Values are validated against the global variables configured in the organization. Supports a maximum of 30 tuples. Each tuple can have a key up to 200 bytes and a value up to 1024 bytes. **Migrating from v1:** Previously named `attributes`.",
"additionalProperties": {
"type": "string"
},
"example": {
"var1": "value1"
}
},
"WorkItem": {
"type": "object",
"description": "Request body to create an inbound `workItem` task via a configured workItem channel. The `channel` must reference an active configured workItem channel in the organization. `workItemData` within `channelParams` carries the structured form payload \u2014 up to 50 entries, with keys up to 100 UTF-8 bytes and values up to 1024 UTF-8 bytes.",
"required": [
"origin",
"destination",
"channelType",
"channel",
"channelParams"
],
"properties": {
"origin": {
"title": "Origin",
"type": "object",
"description": "Origin of the task. For inbound `workItem` tasks, this represents the customer.",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Customer's identifier, such as an email address.",
"example": "customer@domain.com"
},
"name": {
"type": "string",
"nullable": true,
"description": "Optional human-readable display name for the customer.",
"example": "Customer Name"
}
}
},
"destination": {
"title": "Destination",
"type": "object",
"description": "Destination for the workItem task. The `type` must be `businessAddress`.",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"description": "Business address associated with the configured workItem channel entry point.",
"example": "customer-support@biz.com"
},
"type": {
"type": "string",
"description": "Must be `businessAddress` for `workItem` tasks.",
"enum": [
"businessAddress",
"dialNumber"
],
"example": "businessAddress"
}
}
},
"channelType": {
"type": "string",
"enum": [
"workItem"
],
"description": "Discriminator field. Must be `workItem` for custom channel task creation.",
"example": "workItem"
},
"channel": {
"type": "string",
"description": "Identifier of the configured workItem channel in the organization. Required for `workItem` requests.",
"example": "support-form"
},
"flowSettings": {
"$ref": "#/components/schemas/FlowSettings"
},
"globalVariables": {
"$ref": "#/components/schemas/GlobalVariables"
},
"channelParams": {
"$ref": "#/components/schemas/WorkItemParams"
}
},
"example": {
"origin": {
"id": "customer@domain.com",
"name": "Customer Name"
},
"destination": {
"id": "customer-support@biz.com",
"type": "businessAddress"
},
"channelType": "workItem",
"channel": "support-form",
"channelParams": {
"type": "work-item-form",
"message": {
"aliasId": "msg-001",
"workItemData": {
"name": "customer name",
"email": "customer@domain.com"
},
"timestamp": 1732786800000
}
}
}
},
"WorkItemParams": {
"type": "object",
"description": "Work item channel parameters.",
"required": [
"type",
"message"
],
"properties": {
"type": {
"type": "string",
"enum": [
"work-item-form"
],
"description": "Must be `work-item-form` for work item channel parameters.",
"example": "work-item-form"
},
"message": {
"$ref": "#/components/schemas/WorkItemForm"
}
}
},
"WorkItemForm": {
"type": "object",
"description": "Work item message payload.",
"required": [
"aliasId",
"workItemData",
"timestamp"
],
"properties": {
"aliasId": {
"type": "string",
"description": "Identifier of the work item message.",
"example": "msg-001"
},
"workItemData": {
"type": "object",
"description": "Structured key-value payload for the work item form. Maximum 50 entries; keys up to 100 UTF-8 bytes, values up to 1024 UTF-8 bytes.",
"maxProperties": 50,
"additionalProperties": {
"type": "string"
},
"example": {
"name": "customer name",
"email": "customer@domain.com"
}
},
"timestamp": {
"type": "integer",
"format": "int64",
"description": "Unix epoch timestamp in milliseconds representing when the work item was originated.",
"example": 1732786800000
}
}
},
"CustomMessaging": {
"type": "object",
"description": "Request body to create an inbound `customMessaging` task via a configured custom messaging channel. The `channel` must reference an active configured custom messaging channel in the organization. Requires the `wxcc_digital_byoc` feature flag enabled for the organization \u2014 returns `403` if not enabled. Only one message (text or text with attachments) is allowed per task creation request.",
"required": [
"origin",
"destination",
"channelType",
"channel",
"channelParams"
],
"properties": {
"origin": {
"title": "Origin",
"type": "object",
"description": "Origin of the task. For inbound `customMessaging` tasks, this represents the customer.",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Customer's identifier, such as an email address or user ID.",
"example": "customer@example.com"
},
"name": {
"type": "string",
"nullable": true,
"description": "Optional human-readable display name for the customer.",
"example": "Customer Name"
}
},
"example": {
"id": "customer@example.com",
"name": "Customer Name"
}
},
"destination": {
"title": "Destination",
"type": "object",
"description": "Destination for the customMessaging task. The `type` must be `businessAddress`.",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"description": "Business address associated with the configured custom messaging channel entry point.",
"example": "support@channel.biz"
},
"type": {
"type": "string",
"description": "Must be `businessAddress` for `customMessaging` tasks.",
"enum": [
"businessAddress"
],
"example": "businessAddress"
}
},
"example": {
"id": "support@channel.biz",
"type": "businessAddress"
}
},
"channelType": {
"type": "string",
"enum": [
"customMessaging"
],
"description": "Channel type for this request.",
"example": "customMessaging"
},
"channel": {
"type": "string",
"description": "Identifier of the configured custom messaging channel in the organization. Required for `customMessaging` requests.",
"example": "my-custom-channel"
},
"flowSettings": {
"$ref": "#/components/schemas/FlowSettings"
},
"globalVariables": {
"$ref": "#/components/schemas/GlobalVariables"
},
"channelParams": {
"$ref": "#/components/schemas/CustomMessagingParams"
}
},
"example": {
"origin": {
"id": "customer@example.com",
"name": "Customer Name"
},
"destination": {
"id": "support@channel.biz",
"type": "businessAddress"
},
"channelType": "customMessaging",
"channel": "my-custom-channel",
"channelParams": {
"type": "text",
"message": {
"aliasId": "123e4567-e89b-12d3-a456-426614174000",
"text": "Hello, I need help with my order.",
"timestamp": 1732786800000
}
}
}
},
"CustomMessagingParams": {
"type": "object",
"description": "Custom messaging channel parameters. The `type` field is a discriminator that determines the shape of `message`. Use `text` for a plain text message, or `text-with-attachments` for a message with one or more file attachments.",
"required": [
"type",
"message"
],
"properties": {
"type": {
"type": "string",
"enum": [
"text",
"text-with-attachments"
],
"description": "Discriminator for the custom messaging type. Must be `text` when the message contains only text, or `text-with-attachments` when the message includes file attachments. The value must match the shape of the `message` field \u2014 sending `attachments` with `type: \"text\"` or omitting `attachments` with `type: \"text-with-attachments\"` returns a `400`.",
"example": "text-with-attachments"
},
"message": {
"description": "The message payload. Must match the shape indicated by `type`: a `TextMessage` when `type` is `text`, or a `TextWithAttachment` when `type` is `text-with-attachments`.",
"oneOf": [
{
"$ref": "#/components/schemas/TextMessage"
},
{
"$ref": "#/components/schemas/TextWithAttachment"
}
],
"example": {
"aliasId": "123e4567-e89b-12d3-a456-426614174000",
"text": "Hello, I need help with my order.",
"timestamp": 1732786800000
}
}
},
"example": {
"type": "text",
"message": {
"aliasId": "123e4567-e89b-12d3-a456-426614174000",
"text": "Hello, I need help with my order.",
"timestamp": 1732786800000
}
}
},
"TextMessage": {
"type": "object",
"additionalProperties": false,
"description": "Text-only message payload for `customMessaging` tasks. Used when `channelParams.type` is `text`. The `attachments` field is not supported for this type \u2014 sending `attachments` returns a `400`.",
"required": [
"aliasId",
"text",
"timestamp"
],
"properties": {
"aliasId": {
"type": "string",
"description": "Partner-assigned unique identifier for this message. A UUID is strongly recommended \u2014 a valid UUID `aliasId` is reused as the event ID, enabling idempotent retries.",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"text": {
"type": "string",
"description": "Message text content. Must be non-empty. Maximum 20,000 characters.",
"maxLength": 20000,
"example": "Hello, I need help with my order."
},
"timestamp": {
"type": "integer",
"format": "int64",
"description": "Unix epoch timestamp representing when the message was originated. Accepts milliseconds (preferred) or seconds \u2014 values below 10,000,000,000 are treated as seconds and auto-converted to milliseconds.",
"example": 1732786800000
}
}
},
"TextWithAttachment": {
"type": "object",
"description": "Message payload with optional text and one or more file attachments for `customMessaging` tasks. Used when `channelParams.type` is `text-with-attachments`. Either `text` must be non-empty or at least one item in `attachments` must be provided.",
"required": [
"aliasId",
"attachments",
"timestamp"
],
"properties": {
"aliasId": {
"type": "string",
"description": "Partner-assigned unique identifier for this message. A UUID is strongly recommended \u2014 a valid UUID `aliasId` is reused as the event ID, enabling idempotent retries.",
"example": "123e4567-e89b-12d3-a456-426614174001"
},
"text": {
"type": "string",
"description": "Optional message text content. Required when `attachments` is empty. Maximum 20,000 characters.",
"maxLength": 20000,
"example": "Please see the attached screenshot."
},
"attachments": {
"type": "array",
"description": "List of file attachments. Maximum 5 items. Must always be present; can be `[]` when `text` is non-empty, but must contain at least one item when `text` is empty.",
"maxItems": 5,
"items": {
"$ref": "#/components/schemas/Attachment"
},
"example": [
{
"fileName": "screenshot.png",
"mimeType": "image/png",
"fileUrl": "https://example.com/files/screenshot.png"
}
]
},
"timestamp": {
"type": "integer",
"format": "int64",
"description": "Unix epoch timestamp representing when the message was originated. Accepts milliseconds (preferred) or seconds \u2014 values below 10,000,000,000 are treated as seconds and auto-converted to milliseconds.",
"example": 1732786800000
}
}
},
"Attachment": {
"type": "object",
"description": "File attachment for a `customMessaging` message.",
"required": [
"fileName",
"mimeType",
"fileUrl"
],
"properties": {
"fileName": {
"type": "string",
"description": "Name of the file, including its extension.",
"example": "screenshot.png"
},
"mimeType": {
"type": "string",
"description": "MIME type of the file in `type/subtype` format (e.g. `image/png`, `application/pdf`).",
"example": "image/png"
},
"fileUrl": {
"type": "string",
"description": "HTTPS URL of the file, accessible to Webex Contact Center for retrieval. Must use HTTPS. Maximum 2,000 characters. Note: per-file size limits and allowed MIME types are configured per channel in Control Hub \u2014 violations are not returned as API errors but surface asynchronously as `task:failed` webhook events.",
"maxLength": 2000,
"example": "https://cdn.example.com/files/screenshot.png"
}
}
},
"Telephony": {
"type": "object",
"description": "Request body to create an outbound `telephony` task routed through a configured entry point. `entryPointId` is required. When `callback` is provided, its `type` must be `immediate` and `origin` must be `web`.\n\n**Migrating from v1:** The following fields have been renamed or restructured \u2014 `entryPointId` \u2192 `channelParams.entryPointId`; `destination` (string) \u2192 `destination.id`; `origin` (string) \u2192 `origin.id`; `attributes` \u2192 `globalVariables`; `customAttributes` (SIP headers) \u2192 `channelParams.sipHeaders`; `mediaType` \u2192 `channelType`; `callback.callbackOrigin` \u2192 `channelParams.callback.origin`; `callback.callbackType` \u2192 `channelParams.callback.type`.",
"required": [
"origin",
"destination",
"channelType",
"channelParams"
],
"properties": {
"origin": {
"title": "Origin",
"type": "object",
"description": "Origin of the outbound telephony task. May be the agent's information or a configured outbound ANI in the organization.",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "Outbound ANI or agent identifier used for the telephony call.",
"example": "+18000000000"
},
"name": {
"type": "string",
"nullable": true,
"description": "Optional display name. May be omitted or null for telephony tasks.",
"example": null
}
}
},
"destination": {
"title": "Destination",
"type": "object",
"description": "Destination for the telephony task. The `type` must be `dialNumber`.",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string",
"description": "The dial number to call. **Migrating from v1:** Previously the top-level `destination` field (plain string).",
"example": "+19780000000"
},
"type": {
"type": "string",
"description": "Must be `dialNumber` for `telephony` tasks.",
"enum": [
"businessAddress",
"dialNumber"
],
"example": "dialNumber"
}
}
},
"channelType": {
"type": "string",
"enum": [
"telephony"
],
"description": "Discriminator field. Must be `telephony` for voice task creation. **Migrating from v1:** Previously named `mediaType`.",
"example": "telephony"
},
"channel": {
"type": "string",
"nullable": true,
"description": "Not applicable for telephony tasks. May be omitted or set to `null`.",
"example": null
},
"flowSettings": {
"$ref": "#/components/schemas/FlowSettings"
},
"globalVariables": {
"$ref": "#/components/schemas/GlobalVariables"
},
"channelParams": {
"$ref": "#/components/schemas/TelephonyParams"
}
},
"example": {
"origin": {
"id": "+18000000000",
"name": null
},
"destination": {
"id": "+19780000000",
"type": "dialNumber"
},
"channelType": "telephony",
"channelParams": {
"type": "telephony",
"entryPointId": "aef6455f-ccd6-4261-bb00-e80f845c01b0",
"outboundType": "CALLBACK",
"callback": {
"type": "immediate",
"origin": "web",
"number": "+19780000000"
}
}
}
},
"TelephonyParams": {
"type": "object",
"description": "Telephony channel parameters.",
"required": [
"type",
"entryPointId",
"outboundType"
],
"properties": {
"type": {
"type": "string",
"enum": [
"telephony"
],
"description": "Must be `telephony` for telephony channel parameters.",
"example": "telephony"
},
"entryPointId": {
"type": "string",
"description": "UUID of the entry point for the task. For `CALLBACK` and `OUTDIAL`, this must be an outbound entry point. For `EXECUTE_FLOW`, this must be an inbound entry point mapped to the flow to be triggered. **Migrating from v1:** Previously a top-level field, now nested under `channelParams`.",
"example": "aef6455f-ccd6-4261-bb00-e80f845c01b0"
},
"outboundType": {
"type": "string",
"description": "The outbound type for the task. Use `OUTDIAL` when the agent needs to make an outbound call to the customer. Use `CALLBACK` when scheduling a callback \u2014 `callback` field is required. Use `EXECUTE_FLOW` to trigger a predefined flow through an inbound entry point. Use `RECORD_GREETING` to record a personalized agent greeting.",
"enum": [
"CALLBACK",
"OUTDIAL",
"EXECUTE_FLOW",
"RECORD_GREETING"
],
"example": "CALLBACK"
},
"callback": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/CallbackParams"
}
],
"nullable": true,
"description": "Required when `outboundType` is `CALLBACK`. Must be omitted or `null` for `OUTDIAL`, `EXECUTE_FLOW`, and `RECORD_GREETING`. When provided, `type` must be `immediate` and `origin` must be `web`. **Migrating from v1:** Previously a top-level `callback` object with fields `callbackType` and `callbackOrigin`; now nested under `channelParams`."
},
"sipHeaders": {
"type": "object",
"nullable": true,
"description": "Optional map of SIP headers forwarded to the telephony infrastructure for the call. Supports up to 20 headers (selected alphabetically if more than 20 are provided). Each key is converted to lowercase with hyphens retained. The payload is restricted to 1100 bytes to comply with RFC 3261 (UDP). Header values are not logged to ensure PII protection. **Migrating from v1:** Previously named `customAttributes`.",
"additionalProperties": {
"type": "string"
},
"example": {
"X-Correlation-Id": "12345"
}
}
}
},
"CallbackParams": {
"type": "object",
"description": "Callback parameters for telephony tasks.",
"required": [
"type",
"origin"
],
"properties": {
"type": {
"type": "string",
"description": "Callback execution mode. Currently only `immediate` is supported. **Migrating from v1:** Previously named `callbackType`.",
"enum": [
"immediate"
],
"example": "immediate"
},
"origin": {
"type": "string",
"description": "Channel that originated the callback request. The supported value is `web`. **Migrating from v1:** Previously named `callbackOrigin`.",
"enum": [
"web"
],
"example": "web"
},
"number": {
"type": "string",
"nullable": true,
"description": "Optional callback number. Provided when the callback flow supplies a specific number to dial back.",
"example": "+19780000000"
}
}
},
"TaskMessageRequest": {
"description": "Request body to append an inbound message to an existing `workItem` or `customMessaging` task.",
"oneOf": [
{
"$ref": "#/components/schemas/WorkItemAppendTaskRequest"
},
{
"$ref": "#/components/schemas/CustomMessageAppendTaskRequest"
}
],
"discriminator": {
"propertyName": "mediaType",
"mapping": {
"workItem": "#/components/schemas/WorkItemAppendTaskRequest",
"customMessaging": "#/components/schemas/CustomMessageAppendTaskRequest"
}
}
},
"TaskMessageResponse": {
"description": "Response body after successfully requesting a task message append.",
"type": "object",
"example": {
"meta": {
"orgId": "658d1102-8c11-4850-a809-d7a99cc1c22f"
},
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000"
}
},
"required": [
"meta",
"data"
],
"properties": {
"meta": {
"type": "object",
"description": "Response metadata.",
"required": [
"orgId"
],
"properties": {
"orgId": {
"type": "string",
"format": "uuid",
"description": "UUID of the organization, inferred from the authorization token.",
"example": "658d1102-8c11-4850-a809-d7a99cc1c22f"
}
}
},
"data": {
"type": "object",
"description": "Response data.",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Append event identifier for the message. If `aliasId` is a valid UUID, the platform reuses it as the event identifier; otherwise a UUID is generated. Use this ID to correlate downstream webhook delivery for the appended message.",
"example": "123e4567-e89b-12d3-a456-426614174000"
}
}
}
}
},
"WorkItemAppendTaskRequest": {
"title": "WorkItem",
"type": "object",
"description": "Request body to append an inbound `workItem` message to an existing task.",
"required": [
"mediaType",
"channelParams"
],
"properties": {
"mediaType": {
"type": "string",
"enum": [
"workItem"
],
"description": "Media type for this request. Must be `workItem`.",
"example": "workItem"
},
"channelParams": {
"$ref": "#/components/schemas/WorkItemParams"
}
}
},
"CustomMessageAppendTaskRequest": {
"title": "CustomMessaging",
"type": "object",
"description": "Request body to append an inbound `customMessaging` message to an existing task. Custom Messaging must be enabled for the organization. The API returns `403` if the capability is unavailable.",
"required": [
"mediaType",
"channelParams"
],
"properties": {
"mediaType": {
"type": "string",
"enum": [
"customMessaging"
],
"description": "Media type for this request. Must be `customMessaging`.",
"example": "customMessaging"
},
"channelParams": {
"$ref": "#/components/schemas/CustomMessagingParams"
}
}
},
"ActivityInputChoices": {
"title": "ActivityInputChoices",
"type": "object",
"description": "Resolved choices for an activity input, returned by the activity input choices endpoint, along with resolution metadata.",
"additionalProperties": true,
"example": {
"count": 2,
"source": "static",
"choices": [
{
"name": "Voice",
"value": "TELEPHONY"
},
{
"name": "Work item",
"value": "WORK_ITEM"
}
],
"parentInputName": "",
"parentValue": "",
"isSearchEnabled": false,
"resolvedInput": "channelType",
"activity": "queue-lookup",
"input": "channelType"
},
"properties": {
"count": {
"type": "integer",
"description": "Number of choices returned.",
"example": 2
},
"source": {
"type": "string",
"description": "How the choices were resolved.",
"enum": [
"list",
"search",
"validate",
"dynamic",
"static"
],
"example": "static"
},
"choices": {
"type": "array",
"description": "The resolved choices.",
"items": {
"$ref": "#/components/schemas/ActivityChoiceEntry"
}
},
"parentInputName": {
"type": "string",
"description": "Parent input name echoed back for cascading resolution (empty when not cascading).",
"example": ""
},
"parentValue": {
"type": "string",
"description": "Parent input value echoed back for cascading resolution (empty when not cascading).",
"example": ""
},
"isSearchEnabled": {
"type": "boolean",
"description": "True when the input supports server-side search/filtering.",
"example": false
},
"resolvedInput": {
"type": "string",
"description": "The input name the choices were resolved for.",
"example": "channelType"
},
"activity": {
"type": "string",
"description": "The activity name the input belongs to.",
"example": "queue-lookup"
},
"input": {
"type": "string",
"description": "The requested input name.",
"example": "channelType"
}
}
},
"ActivityChoiceEntry": {
"title": "ActivityChoiceEntry",
"type": "object",
"description": "A single resolved choice for an activity input.",
"additionalProperties": true,
"properties": {
"name": {
"type": "string",
"description": "Human-readable label shown in authoring UIs.",
"example": "Main Support Queue"
},
"value": {
"type": "string",
"description": "The choice value/ID, suitable for use as the activity input value.",
"example": "Main_Support_Queue"
}
}
},
"ActivityInput": {
"title": "ActivityInput",
"type": "object",
"description": "A single input field on an activity definition.",
"additionalProperties": true,
"properties": {
"name": {
"type": "string",
"description": "Input field name.",
"example": "channelType"
},
"type": {
"type": "string",
"description": "Input data type (for example, `string`, `boolean`, `int`, `object[]`).",
"example": "string"
},
"required": {
"type": "boolean",
"description": "True if the input must be supplied.",
"example": true
},
"defaultValue": {
"description": "Default value applied when the input is not supplied. May be null. Type matches `type`.",
"example": null
},
"showOnCondition": {
"type": "string",
"nullable": true,
"description": "Expression controlling when this input is shown in authoring UIs, evaluated against sibling input values. Null when the input is always shown.",
"example": "toggle == false"
},
"isSecure": {
"type": "boolean",
"description": "True if the input holds sensitive data that should be masked.",
"example": false
},
"allowedValues": {
"type": "array",
"nullable": true,
"description": "Enumerated allowed values for a static-choice input. Null when the input is unconstrained or resolves its choices dynamically via `choicesEndpoint`.",
"items": {
"type": "string"
},
"example": [
"TELEPHONY",
"WORK_ITEM"
]
},
"choicesEndpoint": {
"type": "string",
"nullable": true,
"description": "Relative endpoint used to resolve choices dynamically for this input. Null when the input has no dynamic choices.",
"example": "GET /v2/activities/play-message/inputs/audioFile/choices"
},
"children": {
"type": "array",
"description": "Nested inputs for composite/object inputs. Empty when the input has no children.",
"items": {
"$ref": "#/components/schemas/ActivityInput"
}
},
"description": {
"type": "string",
"description": "Human-readable description of the input.",
"example": "Channel type the contact arrived on."
}
}
},
"ActivityOutput": {
"title": "ActivityOutput",
"type": "object",
"description": "A single output field produced by an activity.",
"additionalProperties": true,
"properties": {
"name": {
"type": "string",
"description": "Output field name.",
"example": "callerEnteredDigits"
},
"type": {
"type": "string",
"description": "Output data type.",
"example": "STRING"
},
"description": {
"type": "string",
"description": "Human-readable description of the output.",
"example": "Digits the caller entered before timeout."
}
}
},
"ActivityOutputPort": {
"title": "ActivityOutputPort",
"type": "object",
"description": "An output port the activity may exit through. Edges reference a port via their `condition`.",
"additionalProperties": true,
"properties": {
"condition": {
"type": "string",
"description": "Port condition. An edge's `condition` must match one of these verbatim (for example, `default`, `error`).",
"example": "default"
},
"label": {
"type": "string",
"description": "Human-readable port label shown in authoring UIs. May be empty.",
"example": "default"
},
"isErrorPath": {
"type": "boolean",
"description": "True if this port is the activity's error path.",
"example": false
}
}
},
"ActivityV2": {
"title": "ActivityV2",
"type": "object",
"description": "Definition of an activity type, including its inputs, outputs, and named output ports.",
"additionalProperties": true,
"example": {
"activityName": "play-message",
"displayName": "Play Message",
"category": "core",
"group": "action",
"activityType": "action",
"inputs": [],
"outputs": [],
"outputPorts": [
{
"condition": "error",
"label": "",
"isErrorPath": true
},
{
"condition": "default",
"label": "default",
"isErrorPath": false
}
]
},
"properties": {
"activityName": {
"type": "string",
"description": "Stable activity type identifier referenced by a flow node's `properties.activityName`. Read the value verbatim from this endpoint; it is not always kebab-case (for example, `SetCallerID`, `Feedback-V2`, `queue-lookup`).",
"example": "play-message"
},
"displayName": {
"type": "string",
"description": "Human-readable name shown in authoring UIs.",
"example": "Play Message"
},
"category": {
"type": "string",
"description": "High-level grouping the activity belongs to (for example, `core`).",
"example": "core"
},
"group": {
"type": "string",
"description": "Group the activity belongs to. An open set; observed values include `action`, `enum-gateway`, `http-request`, `parse-activity`, `set-variable`, and `terminating-action`. Read the value verbatim rather than assuming a fixed set.",
"example": "action"
},
"activityType": {
"type": "string",
"description": "Underlying activity classification used by the runtime (for example, `action`, `start`).",
"example": "action"
},
"inputs": {
"type": "array",
"description": "Declared inputs for the activity.",
"items": {
"$ref": "#/components/schemas/ActivityInput"
}
},
"outputs": {
"type": "array",
"description": "Declared outputs for the activity.",
"items": {
"$ref": "#/components/schemas/ActivityOutput"
}
},
"outputPorts": {
"type": "array",
"description": "Output ports the activity may exit through. An edge's `condition` must match one of these ports' `condition` values.",
"items": {
"$ref": "#/components/schemas/ActivityOutputPort"
}
}
}
},
"FlowV2ErrorResponse": {
"title": "FlowV2ErrorResponse",
"type": "object",
"description": "Standard error envelope returned by flow endpoints. For 400 (bad request) and 422 (validation failure), `details[]` carries field-level error information.",
"additionalProperties": true,
"example": {
"code": "INVALID_FLOW",
"message": "Flow document failed validation.",
"details": [
{
"path": "/nodes/2/inputs/queue",
"code": "UNKNOWN_QUEUE",
"message": "Queue 'Main_Support_Quueue' was not found in the project."
}
]
},
"properties": {
"code": {
"type": "string",
"description": "Stable, machine-readable error code.",
"example": "INVALID_FLOW"
},
"message": {
"type": "string",
"description": "Human-readable error message.",
"example": "Flow document failed validation."
},
"details": {
"type": "array",
"description": "Per-issue error details. Populated for 400 and 422 responses.",
"items": {
"$ref": "#/components/schemas/FlowV2ValidationError"
}
}
}
},
"FlowV2ValidationError": {
"title": "FlowV2ValidationError",
"type": "object",
"description": "A single validation error against a flow document.",
"properties": {
"activityName": {
"type": "string",
"description": "Name of the activity the error relates to.",
"example": "play-message"
},
"condition": {
"type": "string",
"description": "Edge condition the error relates to, when applicable.",
"example": "onTimeout"
},
"from": {
"type": "string",
"description": "Source node label of the offending edge, when applicable.",
"example": "WelcomeMessage"
},
"edge": {
"type": "string",
"description": "Human-readable description of the offending edge, when applicable.",
"example": "WelcomeMessage->DisconnectContact(onTimeout)"
},
"suggestion": {
"type": "string",
"description": "Suggested fix.",
"example": "Use one of: default, error"
},
"message": {
"type": "string",
"description": "Human-readable explanation of the error.",
"example": "Condition 'onTimeout' is not valid for activity 'play-message'."
},
"severity": {
"type": "string",
"description": "Severity of the issue.",
"enum": [
"ERROR"
],
"example": "ERROR"
}
}
},
"EventSpecificationsResponse": {
"title": "EventSpecificationsResponse",
"type": "object",
"description": "The list of event specifications available for use in `eventFlows[]`, plus ready-to-paste quick-start snippets.",
"additionalProperties": true,
"example": {
"specifications": [
{
"eventSourceName": "WebexContactCenter",
"eventClassificationName": "VoiceInteractions",
"eventSpecificationName": "ContactStartWorkflow"
},
{
"eventSourceName": "WebexContactCenter",
"eventClassificationName": "VoiceInteractions",
"eventSpecificationName": "GlobalErrorHandling"
}
],
"quick_start": {
"description": "Copy snippets directly into flow; backend resolves IDs from names.",
"voice_flow_start_node": {
"eventSourceName": "WebexContactCenter",
"eventClassificationName": "VoiceInteractions",
"eventSpecificationName": "ContactStartWorkflow"
},
"global_error_eventflow": {
"eventSourceName": "WebexContactCenter",
"eventClassificationName": "VoiceInteractions",
"eventSpecificationName": "GlobalErrorHandling"
}
}
},
"properties": {
"specifications": {
"type": "array",
"description": "The available event specifications.",
"items": {
"$ref": "#/components/schemas/EventSpecification"
}
},
"quick_start": {
"type": "object",
"description": "Ready-to-paste start-node and global-error snippets. The backend resolves IDs from the supplied names.",
"additionalProperties": true
}
}
},
"EventSpecification": {
"title": "EventSpecification",
"type": "object",
"description": "An event type that can be referenced from `eventFlows[]` in a flow document.",
"additionalProperties": true,
"properties": {
"eventSpecificationName": {
"type": "string",
"description": "Event specification name. Must be used verbatim as `FlowV2EventFlow.event`.",
"example": "ContactStartWorkflow"
},
"eventSourceName": {
"type": "string",
"description": "Name of the event source the specification belongs to.",
"example": "WebexContactCenter"
},
"eventClassificationName": {
"type": "string",
"description": "Name of the event classification the specification belongs to.",
"example": "VoiceInteractions"
}
}
},
"ActivityRes": {
"title": "ActivityRes",
"type": "object",
"properties": {
"group": {
"type": "string",
"description": "Group of the activity. It is one of 'start', 'action', 'event', and 'end'.",
"example": "start"
},
"id": {
"type": "string",
"description": "Activity ID",
"example": "9813529a-b01a-4eee-a79c-5016f7b0c772"
},
"name": {
"type": "string",
"description": "Activity label",
"example": "NewPhoneContact"
},
"properties": {
"type": "object",
"properties": {},
"description": "Additional properties are stored here",
"example": {
"displayName": "NewPhoneContact"
}
}
}
},
"AssociatedChannelRes": {
"title": "AssociatedChannelRes",
"type": "object",
"description": "Represents a channel associated with a flow version.",
"properties": {
"channelType": {
"type": "string",
"description": "Channel type associated with the flow version.",
"example": "customMessaging"
},
"id": {
"type": "string",
"description": "Identifier of the associated channel.",
"example": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
},
"name": {
"type": "string",
"description": "Display name of the associated channel.",
"example": "Task Queue 1"
}
}
},
"DiagramRes": {
"title": "DiagramRes",
"type": "object",
"description": "Represents the visual graph metadata for a flow, including widgets and additional diagram properties.",
"example": {
"properties": {
"activityId": "http-request-v2"
},
"widgets": {
"493751c9-7b87-4e93-9999-084f89f9e17b": {
"id": "6a59e2f5-3d3d-475a-91f7-d24ac25a614b",
"type": "start",
"widgetType": "activity",
"label": "New Activity Widget in Diagram"
}
}
},
"properties": {
"properties": {
"type": "object",
"description": "Additional properties are listed here",
"properties": {},
"example": {
"activityId": "http-request-v2"
}
},
"widgets": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/Widget"
},
"description": "Holds the activities and links",
"example": {
"493751c9-7b87-4e93-9999-084f89f9e17b": {
"id": "6a59e2f5-3d3d-475a-91f7-d24ac25a614b",
"type": "start",
"widgetType": "activity",
"label": "New Activity Widget in Diagram"
}
}
}
}
},
"EventDiagramRes": {
"title": "EventDiagramRes",
"type": "object",
"description": "Represents event-specific flow diagrams and global event mappings for a flow version.",
"example": {
"eventsMap": {
"GLOBAL_EVENTS": {
"id": "GLOBAL_EVENTS",
"name": "name",
"description": "description"
}
},
"properties": {
"offsetX": "0"
}
},
"properties": {
"eventsMap": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/EventFlowRes"
},
"description": "Holds global events",
"example": {
"GLOBAL_EVENTS": {
"id": "GLOBAL_EVENTS",
"name": "name",
"description": "description",
"process": {
"activities": {
"13ae6d9e-e607-4e43-aab7-a1af579953a7": {
"id": "13ae6d9e-e607-4e43-aab7-a1af579953a7",
"name": "GlobalErrorHandling",
"group": "event",
"properties": {
"displayName": "OnGlobalError",
"name": "GlobalErrorHandling",
"event": "OnGlobalError"
}
}
},
"links": [
{
"id": "db8170a0-ab4f-4415-8a3b-4561807a5287",
"sourceActivityId": "493751c9-7b87-4e93-9999-084f89f9e17b",
"targetActivityId": "e1e7266d-699b-4420-8ba1-109d5d97f144",
"conditionExpr": "out",
"properties": {
"value": "out"
}
}
]
},
"onEvents": {
"GlobalErrorHandling": "13ae6d9e-e607-4e43-aab7-a1af579953a7"
},
"diagram": {
"widgets": {
"13ae6d9e-e607-4e43-aab7-a1af579953a7": {
"id": "14fd05ea-62f8-4003-8ad4-9599b8434dd7",
"type": "event",
"widgetType": "activity",
"label": "New Activity Widget in Diagram"
}
}
}
}
}
},
"properties": {
"type": "object",
"properties": {},
"description": "Holds information on additional properties",
"example": {
"offsetX": "0"
}
}
}
},
"EventFlowRes": {
"title": "EventFlowRes",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description of the event pane",
"example": "description"
},
"diagram": {
"$ref": "#/components/schemas/DiagramRes"
},
"id": {
"type": "string",
"description": "Identifier of the event pane",
"example": "GLOBAL_EVENTS"
},
"name": {
"type": "string",
"description": "Name of the event pane",
"example": "name"
},
"onEvents": {
"type": "object",
"additionalProperties": {
"type": "string",
"description": "Holds event IDs",
"example": "13ae6d9e-e607-4e43-aab7-a1af579953a7"
},
"description": "List of events to which the flow version subscribes",
"example": {
"GlobalErrorHandling": "13ae6d9e-e607-4e43-aab7-a1af579953a7"
}
},
"process": {
"$ref": "#/components/schemas/ProcRes"
}
}
},
"FlowPreferenceRes": {
"title": "FlowPreferenceRes",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The flow preference name.",
"example": "hideSecureCADWarning"
},
"type": {
"type": "string",
"description": "The preference type.",
"example": "Boolean"
},
"value": {
"type": "string",
"description": "The preference value.",
"example": "true"
}
}
},
"FlowProgressionRes": {
"title": "FlowProgressionRes",
"type": "object",
"properties": {
"forkFrom": {
"type": "string",
"description": "Previous Flow Version holding the tag",
"example": "65c28d9db2a2375974066579"
},
"fvId": {
"type": "string",
"description": "Flow Version object ID",
"example": "65c28d9db2a2375974066579"
},
"fvName": {
"type": "string",
"description": "Name of the Flow Version object",
"example": "TestFlow"
}
}
},
"FlowRes": {
"title": "FlowRes",
"type": "object",
"example": {
"id": "65c28d9db2a2375974066579",
"projectId": "5e5c9ad6d61f870d6d778c1b",
"orgId": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8",
"flowType": "FLOW",
"status": "Draft",
"version": 1
},
"properties": {
"associatedChannels": {
"type": "array",
"description": "Channels associated with the flow.",
"items": {
"$ref": "#/components/schemas/AssociatedChannelRes"
},
"example": [
{
"channelType": "customMessaging",
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"name": "Task Queue 1"
}
]
},
"assignedRS": {
"uniqueItems": true,
"type": "array",
"description": "Assigned Routing Strategy.",
"example": [
"RS1",
"RS2"
],
"items": {
"type": "string"
}
},
"createdBy": {
"type": "string",
"description": "Email of the account which created the flow.",
"example": "user@company.com"
},
"createdDate": {
"type": "string",
"description": "Date of creation of the flow.",
"format": "date-time",
"example": "2024-02-07T14:10:50.663Z"
},
"draftVersion": {
"$ref": "#/components/schemas/FlowVersionRes"
},
"flowType": {
"type": "string",
"description": "Either of 'FLOW' or 'SUBFLOW.",
"example": "FLOW"
},
"flowVersions": {
"type": "array",
"description": "Published FlowVersions for this flow.",
"example": [
"65c28d9db2a2375974066579",
"75974065c28d9db3665792a2"
],
"items": {
"type": "string",
"description": "Flow Version object ID to with which the tag is currently associated.",
"example": "65c28d9db2a2375974066579"
}
},
"id": {
"type": "string",
"description": "Flow ID",
"example": "65c28d9db2a2375974066579"
},
"lastModifiedBy": {
"type": "string",
"description": "Email of the account which modified the flow last.",
"example": "user@company.com"
},
"lastModifiedDate": {
"type": "string",
"description": "Date the flow object is last modified.",
"example": "2024-02-07T14:10:50.663Z",
"format": "date-time"
},
"latestVersion": {
"$ref": "#/components/schemas/FlowVersionRes"
},
"lockedAt": {
"type": "string",
"description": "Moment at which a user began editing the flow and locked the flow for everyone else.",
"format": "date-time",
"example": "2024-02-07T14:10:50.663Z"
},
"lockedBy": {
"type": "string",
"description": "Email of the account which is currently editing the flow.",
"example": "user@company.com"
},
"orgId": {
"type": "string",
"description": "Organization ID.",
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
"preferences": {
"type": "array",
"description": "Flow preferences",
"items": {
"$ref": "#/components/schemas/FlowPreferenceRes"
}
},
"projectId": {
"type": "string",
"description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b",
"example": "5e5c9ad6d61f870d6d778c1b"
},
"status": {
"type": "string",
"description": "Indicates if this flow has ever been published - is one of 'Draft' or 'Published'.",
"example": "Draft"
},
"tagHistories": {
"type": "object",
"description": "Histories of the tags. Tracks how the tags have been assigned to versions chronologically",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowProgressionRes"
}
},
"example": {
"Latest": [
{
"fvId": "63e3fcb0b57f601a2ad62db4",
"fvName": "HttpTraceTest",
"forkFrom": "63e3fcb0b57f601a2ad62db4"
}
]
}
},
"tags": {
"type": "array",
"description": "Flow tags",
"items": {
"$ref": "#/components/schemas/FlowTagRes"
}
},
"validating": {
"type": "boolean",
"description": "Determines whether the version object needs to be validated.",
"example": false
},
"version": {
"type": "integer",
"description": "Version Number.",
"format": "int32",
"example": 1
}
}
},
"FlowTagRes": {
"title": "FlowTagRes",
"type": "object",
"description": "Represents a tag",
"properties": {
"default": {
"type": "boolean",
"description": "Determines whether the tag is a default tag",
"example": false
},
"displayName": {
"type": "string",
"description": "Display name of the tag. It is one of 'Live', 'Test', 'Dev', 'Latest'",
"example": "Live"
},
"flowVersionId": {
"type": "string",
"description": "Flow Version object ID to with which the tag is currently associated.",
"example": "65c28d9db2a2375974066579"
},
"id": {
"type": "string",
"description": "Identifier of the tag. It is one of 'Live', 'Test', 'Dev', 'Latest",
"example": "Live"
},
"versionNumber": {
"type": "integer",
"description": "Associated Flow Version object's version number",
"format": "int32",
"example": 1
}
}
},
"FlowVariablesRes": {
"title": "FlowVariablesRes",
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description for the variable",
"example": "var1 is meant for loop counter"
},
"desktopLabel": {
"type": "string",
"description": "Variable name shown on Agent Desktop",
"example": "var1"
},
"id": {
"type": "string",
"description": "Identifier for the variable",
"example": "04b302a9-6d92-4365-8902-9b04bc3bf5f9"
},
"isAgentEditable": {
"type": "boolean",
"description": "Determines whether is eligible for desktop agent to edit",
"example": false
},
"isCAD": {
"type": "boolean",
"description": "Determines whether variable is agent viewable",
"example": false
},
"isReportable": {
"type": "boolean",
"description": "Determines whether a variable is reportable",
"example": false
},
"isSecure": {
"type": "boolean",
"description": "Determines whether a variable is marked sensitive",
"example": false
},
"name": {
"type": "string",
"description": "Name of the variable",
"example": "var1"
},
"overwrite": {
"type": "boolean",
"description": "Determines whether a global variable has been overwritten",
"example": false
},
"source": {
"type": "string",
"description": "Source of the variable (GLOBAL, SUBFLOW_INPUT, SUBFLOW_OUTPUT, an empty string ). It's left empty for subflow local or flow variables",
"example": "GLOBAL"
},
"type": {
"type": "string",
"description": "Data type of the variable (STRING, INTEGER, DATETIME, DECIMAL, JSON, BOOLEAN)",
"example": "STRING"
},
"value": {
"type": "string",
"description": "Value of the variable",
"example": "hello world!"
}
}
},
"FlowVersionRes": {
"title": "FlowVersionRes",
"type": "object",
"description": "Represents a specific version of a flow or subflow, including diagram, process, variables, and validation details.",
"example": {
"id": "65c28d9db2a2375974066579",
"flowId": "661c7bc712eaf357de7e4aeb",
"name": "TestFlow",
"flowType": "FLOW",
"orgId": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8",
"version": 1,
"validating": false
},
"properties": {
"associatedChannels": {
"type": "array",
"description": "Channels associated with the flow version. Export and import payloads preserve this metadata so channel-specific activities, such as custom messaging activities, can be validated and resolved correctly.",
"items": {
"$ref": "#/components/schemas/AssociatedChannelRes"
},
"example": [
{
"channelType": "customMessaging",
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"name": "Task Queue 1"
}
]
},
"comment": {
"type": "string",
"description": "Publish note",
"example": "This flow version has the Set-Variable activity"
},
"createdBy": {
"type": "string",
"description": "Email of the account which created the flow version",
"example": "user@company.com"
},
"createdDate": {
"type": "string",
"description": "Date of creation of the version object",
"example": "2024-02-07T14:10:50.663Z",
"format": "date-time"
},
"description": {
"type": "string",
"description": "Description of the Flow Version",
"example": "This flow version has the 'Live' tag"
},
"diagram": {
"$ref": "#/components/schemas/DiagramRes"
},
"eventFlows": {
"$ref": "#/components/schemas/EventDiagramRes"
},
"flowId": {
"type": "string",
"description": "Flow/Subflow ID to which the version belongs",
"example": "661c7bc712eaf357de7e4aeb"
},
"flowType": {
"type": "string",
"description": "Flow Type (FLOW/SUBFLOW). Default value is FLOW",
"example": "FLOW"
},
"id": {
"type": "string",
"description": "Version object ID",
"example": "65c28d9db2a2375974066579"
},
"lastModifiedBy": {
"type": "string",
"description": "Email of the account which modified the flow version last",
"example": "user@company.com"
},
"lastModifiedDate": {
"type": "string",
"description": "Date the version object is last modified",
"example": "2024-02-07T14:10:50.663Z",
"format": "date-time"
},
"name": {
"type": "string",
"description": "Name of the Flow Version",
"example": "TestFlow"
},
"orgId": {
"type": "string",
"description": "Organization ID",
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
"persist": {
"type": "boolean",
"description": "Determines whether the version object needs to be persisted in the DB",
"example": true
},
"process": {
"$ref": "#/components/schemas/ProcRes"
},
"runtimeVariables": {
"type": "array",
"description": "Output variables of the activities configured in the flow",
"example": [
{
"name": "NewPhoneContact.ANI",
"type": "string",
"path": "",
"source": "Event",
"activityName": "ANI",
"displayName": "",
"uiVisible": true,
"description": ""
}
],
"items": {
"$ref": "#/components/schemas/UiRuntimeVariableRes"
}
},
"settings": {
"type": "array",
"description": "Settings for the flow version",
"example": [
{
"name": "showActivityWait",
"value": "true"
},
{
"`type`": "BOOLEAN",
"group": "activityWait"
},
{
"name": "delayTime",
"value": "2000"
},
{
"`type`": "INTEGER",
"group": "activityWait"
}
],
"items": {
"$ref": "#/components/schemas/FlowVersionSettingRes"
}
},
"validating": {
"type": "boolean",
"description": "Determines whether the version object needs to be validated",
"example": false
},
"validationResults": {
"type": "array",
"description": "Validation errors are stored here",
"items": {
"$ref": "#/components/schemas/ValidationResultRes"
}
},
"variableOrders": {
"type": "object",
"description": "Determines the order in which variables appear in the Agent's desktop",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VariableOrderRes"
}
},
"example": {
"pop-over": [
{
"name": "ani",
"variableSeq": "0"
}
]
}
},
"variables": {
"type": "array",
"description": "Variables in the version object",
"items": {
"$ref": "#/components/schemas/FlowVariablesRes"
}
},
"version": {
"type": "integer",
"description": "Version Number",
"format": "int32",
"example": 1
}
}
},
"FlowVersionSettingRes": {
"title": "FlowVersionSettingRes",
"type": "object",
"properties": {
"group": {
"type": "string",
"description": "The group the setting belongs to.",
"example": "activityWait"
},
"name": {
"type": "string",
"description": "The name of the flow version setting",
"example": "delayTime"
},
"type": {
"type": "string",
"description": "The setting type.",
"example": "INTEGER"
},
"value": {
"type": "string",
"description": "The setting value.",
"example": "2000"
}
}
},
"LinkRes": {
"title": "LinkRes",
"type": "object",
"properties": {
"conditionExpr": {
"type": "string",
"description": "Condition expression. It is one of 'out', and 'default'",
"example": "out"
},
"id": {
"type": "string",
"description": "Link ID",
"example": "dea7d650-9734-4fa3-bfc9-2c669415c9e3"
},
"properties": {
"type": "object",
"properties": {},
"description": "Additional properties are stored here",
"example": {
"value": "out"
}
},
"sourceActivityId": {
"type": "string",
"description": "Activity from which the link originates",
"example": "1330315f-7012-479a-8126-c767258004e6"
},
"targetActivityId": {
"type": "string",
"description": "Activity to which the link connects",
"example": "22a8930c-0770-4ab9-8e29-3a5ff1000e81"
}
}
},
"ProcRes": {
"title": "ProcRes",
"type": "object",
"description": "Represents the executable process graph for a flow version, including activities and links.",
"example": {
"activities": {
"493751c9-7b87-4e93-9999-084f89f9e17b": {
"id": "493751c9-7b87-4e93-9999-084f89f9e17b",
"name": "NewPhoneContact",
"group": "start"
}
},
"links": [
{
"id": "dea7d650-9734-4fa3-bfc9-2c669415c9e3",
"sourceActivityId": "1330315f-7012-479a-8126-c767258004e6",
"targetActivityId": "22a8930c-0770-4ab9-8e29-3a5ff1000e81",
"conditionExpr": "out"
}
]
},
"properties": {
"activities": {
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/ActivityRes"
},
"description": "Stores list of activities/events",
"example": {
"493751c9-7b87-4e93-9999-084f89f9e17b": {
"id": "493751c9-7b87-4e93-9999-084f89f9e17b",
"name": "NewPhoneContact",
"group": "start",
"properties": {
"name": "NewPhoneContact",
"event": "NewPhoneContact",
"activityId": "start"
}
}
}
},
"links": {
"type": "array",
"description": "Stores list of links",
"items": {
"$ref": "#/components/schemas/LinkRes"
}
}
}
},
"PublishParameters": {
"title": "PublishParameters",
"type": "object",
"description": "Metadata for the published version.",
"properties": {
"comment": {
"type": "string",
"description": "A comment to provide context on publishing the flow.",
"example": "Publishing the latest version"
},
"tagIds": {
"type": "array",
"description": "Tag IDs appropriate to this version. It must be one of 'Live', 'Test', 'Dev', 'Latest.",
"example": [
"Live"
],
"items": {
"type": "string"
}
}
}
},
"UiRuntimeVariableRes": {
"title": "UiRuntimeVariableRes",
"type": "object",
"properties": {
"activityName": {
"type": "string",
"description": "Name of the activity",
"example": "http-request-v2"
},
"description": {
"type": "string",
"description": "Determines whether the variable needs to be visible on the UI",
"example": "HTTPRequest_7sz"
},
"displayName": {
"type": "string",
"description": "Display name of the activity",
"example": "HTTPRequest_7sz"
},
"isSecure": {
"type": "boolean",
"description": "Determines whether a variable is marked sensitive",
"example": false
},
"name": {
"type": "string",
"description": "Name of the runtime variable",
"example": "NewPhoneContact.ANI"
},
"path": {
"type": "string",
"description": "Path of the runtime variable",
"example": "HTTPRequest_7sz.httpResponseBody"
},
"source": {
"type": "string",
"description": "Source of the runtime variable. Either 'Event' or 'Activity'",
"example": "Activity"
},
"type": {
"type": "string",
"description": "Data type of the runtime variable",
"example": "string"
},
"uiVisible": {
"type": "boolean",
"description": "Determines whether the variable needs to be visible on the UI",
"example": false
}
}
},
"ValidationResultRes": {
"title": "ValidationResultRes",
"type": "object",
"properties": {
"activityId": {
"type": "string",
"description": "Activity identifier",
"example": "e0d7128e-0f80-46c8-9554-9a9ae4dd9e7b"
},
"activityLabel": {
"type": "string",
"description": "Activity label",
"example": "PlayMessage_ysg"
},
"code": {
"type": "string",
"description": "Error code",
"example": "FC1015"
},
"docLink": {
"type": "string",
"description": "Document link",
"example": "https://help.webex.com/en-us/article/n5595zd/Webex-Contact-Center-Setup-and-Administration-Guide"
},
"message": {
"type": "string",
"description": "Error message to be displayed on the UI",
"example": "Add descriptions for activities"
},
"severity": {
"type": "string",
"description": "Severity of the error. Either ERROR or RECOMMENDATION",
"example": "ERROR"
}
}
},
"VariableOrderRes": {
"title": "VariableOrderRes",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the variable in the flow version object",
"example": "var1"
},
"variableSeq": {
"type": "string",
"description": "Sequence number of the variable",
"example": "1"
}
}
},
"Widget": {
"title": "Widget",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Widget ID of the entity",
"example": "6a59e2f5-3d3d-475a-91f7-d24ac25a614b"
},
"type": {
"type": "string",
"description": "Type of the widget. One of 'start', 'action', and 'end'",
"example": "start"
},
"label": {
"type": "string",
"description": "Label of the widget",
"example": "New Activity Widget in Diagram"
},
"widgetType": {
"type": "string",
"description": "Either 'activity' or 'link'",
"example": "activity"
}
}
},
"FlowLockResponse": {
"title": "FlowLockResponse",
"type": "string",
"description": "Lock/unlock acknowledgement. Returns the literal JSON string \"OK\" on success. Locks auto-expire after 15 minutes of inactivity.",
"example": "OK"
},
"FlowSearchResponse": {
"title": "FlowSearchResponse",
"type": "object",
"description": "Paginated list of flows matching the search criteria.",
"example": {
"pageInfo": {
"currentPage": 0,
"totalRecords": 8,
"pageSize": 3,
"totalPages": 3
},
"data": [
{
"orgId": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8",
"id": "6501eae8d7974a1c1d4c25d3",
"name": "Test_Flow",
"flowType": "FLOW",
"lastModifiedDate": "2026-02-10T01:59:02.213Z"
}
]
},
"properties": {
"pageInfo": {
"$ref": "#/components/schemas/FlowSearchPageInfo"
},
"data": {
"type": "array",
"description": "Flows matching the search criteria for the current page.",
"items": {
"$ref": "#/components/schemas/FlowSearchResult"
}
}
}
},
"FlowSearchPageInfo": {
"title": "FlowSearchPageInfo",
"type": "object",
"description": "Pagination metadata for a flow search response.",
"properties": {
"currentPage": {
"type": "integer",
"description": "Zero-based index of the current page.",
"format": "int32",
"example": 0
},
"totalRecords": {
"type": "integer",
"description": "Total number of flows matching the search criteria across all pages.",
"format": "int32",
"example": 8
},
"pageSize": {
"type": "integer",
"description": "Number of items on the current page.",
"format": "int32",
"example": 3
},
"totalPages": {
"type": "integer",
"description": "Total number of pages available for the search criteria.",
"format": "int32",
"example": 3
}
}
},
"FlowSearchResult": {
"title": "FlowSearchResult",
"type": "object",
"description": "Summary information for a flow returned by the search API.",
"properties": {
"orgId": {
"type": "string",
"description": "Organization ID.",
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
"id": {
"type": "string",
"description": "Flow ID.",
"example": "6501eae8d7974a1c1d4c25d3"
},
"name": {
"type": "string",
"description": "Name of the flow.",
"example": "Test_Flow"
},
"flowType": {
"type": "string",
"description": "Either of 'FLOW' or 'SUBFLOW'.",
"example": "FLOW"
},
"lastModifiedDate": {
"type": "string",
"description": "Date the flow was last modified.",
"format": "date-time",
"example": "2026-02-10T01:59:02.213Z"
}
}
},
"BasicFlow": {
"title": "BasicFlow",
"type": "object",
"example": {
"id": "65c28d9db2a2375974066579",
"name": "TestFlow",
"flowType": "FLOW",
"status": "Draft",
"orgId": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8",
"version": 1
},
"properties": {
"associatedChannels": {
"type": "array",
"description": "Channels associated with the flow.",
"items": {
"$ref": "#/components/schemas/AssociatedChannelRes"
},
"example": [
{
"channelType": "customMessaging",
"id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"name": "Task Queue 1"
}
]
},
"assignedRS": {
"uniqueItems": true,
"type": "array",
"description": "Assigned Routing Strategy",
"example": [
"rs-id1"
],
"items": {
"type": "string"
}
},
"createdBy": {
"type": "string",
"description": "Email of the account which created the flow",
"example": "user@company.com"
},
"createdDate": {
"type": "string",
"description": "Date of creation of the flow",
"example": "2024-02-07T14:10:50.663Z",
"format": "date-time"
},
"description": {
"type": "string",
"description": "Description of the flow",
"example": "This flow is updated with the 'Live' tag"
},
"flowType": {
"type": "string",
"description": "Flow Type (FLOW/SUBFLOW). Default value is FLOW",
"example": "FLOW"
},
"id": {
"type": "string",
"description": "Flow/Subflow ID",
"example": "65c28d9db2a2375974066579"
},
"lastModifiedBy": {
"type": "string",
"description": "Email of the account which modified the flow last",
"example": "user@company.com"
},
"lastModifiedDate": {
"type": "string",
"description": "Date the flow object is last modified",
"example": "2024-02-07T14:10:50.663Z",
"format": "date-time"
},
"lockedAt": {
"type": "string",
"description": "Moment at which a user began editing the flow and locked the flow for everyone else",
"example": "2024-02-07T14:10:50.663Z",
"format": "date-time"
},
"lockedBy": {
"type": "string",
"description": "Email of the account which is currently editing the flow",
"example": "user@company.com"
},
"name": {
"type": "string",
"description": "Name of the Flow",
"example": "TestFlow"
},
"orgId": {
"type": "string",
"description": "Organization ID",
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
"status": {
"type": "string",
"description": "Indicates if this flow has ever been published - is one of 'Draft' or 'Published'",
"example": "Draft"
},
"tagHistories": {
"type": "object",
"description": "Histories of the tags. Tracks how the tags have been assigned to versions chronologically",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FlowProgressionRes"
}
},
"example": {
"Latest": [
{
"fvId": "63e3fcb0b57f601a2ad62db4",
"fvName": "HttpTraceTest",
"forkFrom": "63e3fcb0b57f601a2ad62db4"
}
]
}
},
"tags": {
"type": "array",
"description": "Tags used by the flow",
"items": {
"$ref": "#/components/schemas/FlowTagRes"
}
},
"version": {
"type": "integer",
"description": "Version Number",
"format": "int32",
"example": 1
}
}
},
"FlowV2": {
"title": "FlowV2",
"type": "object",
"description": "Flow JSON document (formerly Flow IR / FDL 2.0). Describes a flow as top-level metadata plus arrays of nodes, edges, variables, event flows, and preferences.",
"additionalProperties": true,
"properties": {
"flowName": {
"type": "string",
"description": "Name of the flow.",
"example": "Customer_Support_Main"
},
"flowType": {
"type": "string",
"description": "Flow type. One of `FLOW` or `SUBFLOW`.",
"enum": [
"FLOW",
"SUBFLOW"
],
"example": "FLOW"
},
"contactType": {
"type": "string",
"description": "Channel type the flow is intended for (for example, `telephony`, `customMessaging`, `workItem`, `genericAction`).",
"example": "telephony"
},
"description": {
"type": "string",
"description": "Human-readable description of the flow.",
"example": "Routes inbound support calls to the main support queue."
},
"version": {
"type": "integer",
"format": "int64",
"description": "Monotonically increasing version number of the document.",
"example": 3
},
"status": {
"type": "string",
"description": "Lifecycle state of the document. One of `Draft` or `Published`.",
"enum": [
"Draft",
"Published"
],
"example": "Draft"
},
"nodes": {
"type": "array",
"description": "Activity nodes in the main flow process.",
"items": {
"$ref": "#/components/schemas/FlowV2Node"
}
},
"edges": {
"type": "array",
"description": "Edges connecting nodes in the main flow process.",
"items": {
"$ref": "#/components/schemas/FlowV2Edge"
}
},
"variables": {
"type": "array",
"description": "Flow variables.",
"items": {
"$ref": "#/components/schemas/FlowV2Variable"
}
},
"eventFlows": {
"type": "array",
"description": "Event-handler subflows bound to specific events.",
"items": {
"$ref": "#/components/schemas/FlowV2EventFlow"
}
},
"preferences": {
"type": "array",
"description": "Flow-level preferences.",
"items": {
"$ref": "#/components/schemas/FlowV2Preference"
}
}
},
"example": {
"flowName": "Customer_Support_Main",
"flowType": "FLOW",
"contactType": "telephony",
"description": "Routes inbound support calls to the main support queue.",
"version": 3,
"status": "Draft",
"nodes": [
{
"name": "NewPhoneContact",
"activityName": "NewPhoneContact",
"inputs": {},
"outputs": {},
"position": {
"x": 100,
"y": 200
}
},
{
"name": "PlayMessage_1",
"activityName": "PlayMessage",
"inputs": {
"audioFile": "welcome.wav"
},
"outputs": {},
"position": {
"x": 300,
"y": 200
}
}
],
"edges": [
{
"key": "edge-1",
"from_node": "NewPhoneContact",
"from_port": "out",
"to_node": "PlayMessage_1",
"condition": "out"
}
],
"variables": [
{
"name": "FlowVar1",
"type": "STRING",
"value": "var1",
"description": "",
"isCAD": true,
"isAgentEditable": true,
"isReportable": false,
"isSecure": false
}
],
"eventFlows": [],
"preferences": [
{
"name": "hideSecureCADWarning",
"type": "Boolean",
"value": "true"
}
]
}
},
"FlowV2Edge": {
"title": "FlowV2Edge",
"type": "object",
"description": "An edge connecting two flow nodes. Edge `condition` aliases are normalized server-side: `done` is rewritten to `out`, `NewPhoneContact` is rewritten to `out`, and `defaultBranch` is rewritten to `default`.",
"additionalProperties": true,
"properties": {
"key": {
"type": "string",
"description": "Stable, unique edge key within the flow. Used as the patch-merge key for `upsert_edges` and `remove_edge_keys`.",
"example": "edge-1"
},
"from_node": {
"type": "string",
"description": "Name of the source node. Must reference a node in the same process.",
"example": "NewPhoneContact"
},
"from_port": {
"type": "string",
"description": "Output port name on the source node. Must match an `outputPorts[].name` exposed by the source activity definition.",
"example": "out"
},
"to_node": {
"type": "string",
"description": "Name of the target node. Must reference a node in the same process.",
"example": "PlayMessage_1"
},
"condition": {
"type": "string",
"description": "Branch condition this edge fires on. Aliases: `done` -> `out`, `NewPhoneContact` -> `out`, `defaultBranch` -> `default`.",
"example": "out"
}
}
},
"FlowV2EventFlow": {
"title": "FlowV2EventFlow",
"type": "object",
"description": "An event-handler subflow bound to a specific event. The subflow runs when its bound event fires.",
"additionalProperties": true,
"properties": {
"event": {
"type": "string",
"description": "Name of the event this subflow handles. Must reference an event from `listEventSpecifications`.",
"example": "AgentDisconnected"
},
"nodes": {
"type": "array",
"description": "Activity nodes in the event-handler process.",
"items": {
"$ref": "#/components/schemas/FlowV2Node"
}
},
"edges": {
"type": "array",
"description": "Edges in the event-handler process.",
"items": {
"$ref": "#/components/schemas/FlowV2Edge"
}
}
}
},
"FlowV2Metadata": {
"title": "FlowV2Metadata",
"type": "object",
"description": "Result envelope returned for a flow on import, save draft, and patch draft. The persisted flow document is returned under `flow` (the server-assigned flow ID is `flow.id`), alongside any preflight warnings raised during the operation.",
"additionalProperties": true,
"properties": {
"flow": {
"description": "The persisted flow document, including the server-assigned `id`.",
"allOf": [
{
"$ref": "#/components/schemas/FlowV2Summary"
}
]
},
"preflightWarnings": {
"type": "array",
"description": "Non-blocking warnings raised while persisting the flow (for example, references that resolve but are flagged for review). Empty when there are none.",
"items": {
"type": "object",
"additionalProperties": true
},
"example": []
},
"preflightWarningsCount": {
"type": "integer",
"format": "int32",
"description": "Number of entries in `preflightWarnings`.",
"example": 0
}
},
"example": {
"flow": {
"id": "661c7bc712eaf357de7e4aeb",
"orgId": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8",
"version": 0,
"flowType": "FLOW",
"name": "SamplePlayMessageFlow",
"description": "Minimal sample flow: greet the caller, then disconnect",
"status": "Draft",
"createdBy": "user@example.com",
"createdDate": "2026-01-15T09:12:00.000Z",
"lastModifiedBy": "user@example.com",
"lastModifiedDate": "2026-05-20T14:30:00.000Z"
},
"preflightWarnings": [],
"preflightWarningsCount": 0
}
},
"FlowV2Summary": {
"title": "FlowV2Summary",
"type": "object",
"description": "Server-side metadata for a persisted flow document.",
"additionalProperties": true,
"properties": {
"id": {
"type": "string",
"description": "Server-assigned flow ID.",
"example": "661c7bc712eaf357de7e4aeb"
},
"orgId": {
"type": "string",
"description": "Organization ID that owns the flow.",
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
"version": {
"type": "integer",
"format": "int64",
"description": "Current version number of the flow document.",
"example": 0
},
"flowType": {
"type": "string",
"description": "Flow type. One of `FLOW` or `SUBFLOW`.",
"enum": [
"FLOW",
"SUBFLOW"
],
"example": "FLOW"
},
"name": {
"type": "string",
"description": "Flow name.",
"example": "SamplePlayMessageFlow"
},
"description": {
"type": "string",
"description": "Human-readable description of the flow.",
"example": "Minimal sample flow: greet the caller, then disconnect"
},
"status": {
"type": "string",
"description": "Lifecycle state. One of `Draft` or `Published`.",
"enum": [
"Draft",
"Published"
],
"example": "Draft"
},
"createdBy": {
"type": "string",
"description": "User ID that created the flow.",
"example": "user@example.com"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "Timestamp the flow was first created.",
"example": "2026-01-15T09:12:00.000Z"
},
"lastModifiedBy": {
"type": "string",
"description": "User ID that last modified the flow.",
"example": "user@example.com"
},
"lastModifiedDate": {
"type": "string",
"format": "date-time",
"description": "Timestamp the flow was last modified.",
"example": "2026-05-20T14:30:00.000Z"
}
},
"example": {
"id": "661c7bc712eaf357de7e4aeb",
"orgId": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8",
"version": 0,
"flowType": "FLOW",
"name": "SamplePlayMessageFlow",
"description": "Minimal sample flow: greet the caller, then disconnect",
"status": "Draft",
"createdBy": "user@example.com",
"createdDate": "2026-01-15T09:12:00.000Z",
"lastModifiedBy": "user@example.com",
"lastModifiedDate": "2026-05-20T14:30:00.000Z"
}
},
"FlowV2Node": {
"title": "FlowV2Node",
"type": "object",
"description": "A node in a flow process graph. Each node represents one activity instance.",
"additionalProperties": true,
"properties": {
"name": {
"type": "string",
"description": "Stable, unique node name within the flow. Used as the patch-merge key for `upsert_nodes` and `remove_node_names`.",
"example": "PlayMessage_1"
},
"activityName": {
"type": "string",
"description": "Activity type this node instantiates. Must match an `activityName` returned by `listActivityDefinitions`.",
"example": "PlayMessage"
},
"inputs": {
"type": "object",
"description": "Input values for the activity, keyed by input name. Shape depends on the activity definition.",
"additionalProperties": true,
"example": {
"audioFile": "welcome.wav"
}
},
"outputs": {
"type": "object",
"description": "Declared output bindings for the activity, keyed by output name. Used to map activity outputs to flow variables.",
"additionalProperties": true,
"example": {}
},
"position": {
"type": "object",
"description": "Node position on the flow canvas.",
"properties": {
"x": {
"type": "number",
"description": "Horizontal coordinate in pixels.",
"example": 300
},
"y": {
"type": "number",
"description": "Vertical coordinate in pixels.",
"example": 200
}
}
}
}
},
"FlowV2Preference": {
"title": "FlowV2Preference",
"type": "object",
"description": "A flow-level preference.",
"additionalProperties": true,
"properties": {
"name": {
"type": "string",
"description": "Preference name.",
"example": "hideSecureCADWarning"
},
"type": {
"type": "string",
"description": "Preference value type.",
"example": "Boolean"
},
"value": {
"type": "string",
"description": "Preference value, encoded as a string.",
"example": "true"
}
}
},
"FlowV2ValidationWarning": {
"title": "FlowV2ValidationWarning",
"type": "object",
"description": "A single non-blocking validation warning or recommendation against a flow document.",
"properties": {
"severity": {
"type": "string",
"description": "Severity of the issue.",
"enum": [
"WARNING",
"RECOMMENDATION"
],
"example": "RECOMMENDATION"
},
"code": {
"type": "string",
"description": "Stable warning code.",
"example": "FC1007"
},
"message": {
"type": "string",
"description": "Human-readable explanation of the warning.",
"example": "Add descriptions for activities"
}
}
},
"FlowV2ValidationResult": {
"title": "FlowV2ValidationResult",
"type": "object",
"description": "Result of validating a flow document.",
"example": {
"valid": false,
"errors": [
{
"activityName": "start",
"condition": "onTimeoutBOGUS",
"from": "NewContact",
"suggestion": "Use one of: out",
"message": "Condition 'onTimeoutBOGUS' is not valid for activity 'start'.",
"severity": "ERROR",
"edge": "NewContact->WelcomeMessage(onTimeoutBOGUS)"
}
],
"warnings": [
{
"severity": "RECOMMENDATION",
"code": "FC1007",
"message": "Add descriptions for activities"
}
],
"summary": "1 error(s), 1 warning(s)."
},
"properties": {
"valid": {
"type": "boolean",
"description": "True if the document passed validation."
},
"errors": {
"type": "array",
"description": "Blocking errors. Empty when `valid` is true.",
"items": {
"$ref": "#/components/schemas/FlowV2ValidationError"
}
},
"warnings": {
"type": "array",
"description": "Non-blocking warnings and recommendations.",
"items": {
"$ref": "#/components/schemas/FlowV2ValidationWarning"
}
},
"summary": {
"type": "string",
"description": "Human-readable summary of the validation outcome.",
"example": "FlowV2 looks valid for import/save."
}
}
},
"FlowV2DraftValidationEntry": {
"title": "FlowV2DraftValidationEntry",
"type": "object",
"description": "A single result entry returned when validating a stored flow draft.",
"properties": {
"code": {
"type": "string",
"description": "Stable result code.",
"example": "FC1007"
},
"docLink": {
"type": "string",
"description": "Link to documentation about this result. May be empty.",
"example": ""
},
"hint": {
"type": "string",
"description": "Additional hint about the result, when available.",
"example": "Flow has isolated activities. Ensure all nodes are reachable from the start node."
},
"message": {
"type": "string",
"description": "Human-readable explanation of the result.",
"example": "Add descriptions for activities"
},
"severity": {
"type": "string",
"description": "Severity of the result.",
"enum": [
"ERROR",
"WARNING",
"RECOMMENDATION"
],
"example": "RECOMMENDATION"
},
"activityLabel": {
"type": "string",
"description": "Label of the activity the result relates to. May be empty.",
"example": ""
}
}
},
"FlowV2DraftValidationResult": {
"title": "FlowV2DraftValidationResult",
"type": "object",
"description": "Result of validating a stored flow draft. Issues are returned under `results`.",
"example": {
"valid": true,
"results": [
{
"code": "FC1007",
"docLink": "",
"message": "Add descriptions for activities",
"severity": "RECOMMENDATION",
"activityLabel": ""
}
]
},
"properties": {
"valid": {
"type": "boolean",
"description": "True if the draft passed validation."
},
"results": {
"type": "array",
"description": "Per-issue results.",
"items": {
"$ref": "#/components/schemas/FlowV2DraftValidationEntry"
}
}
}
},
"FlowV2Variable": {
"title": "FlowV2Variable",
"type": "object",
"description": "A flow variable.",
"additionalProperties": true,
"properties": {
"name": {
"type": "string",
"description": "Variable name.",
"example": "FlowVar1"
},
"type": {
"type": "string",
"description": "Variable data type (for example, `STRING`, `INTEGER`, `BOOLEAN`).",
"example": "STRING"
},
"value": {
"type": "string",
"description": "Default value as a string.",
"example": "var1"
},
"description": {
"type": "string",
"description": "Human-readable description of the variable.",
"example": ""
},
"isCAD": {
"type": "boolean",
"description": "True if this variable is exposed as Call-Associated Data.",
"example": true
},
"isAgentEditable": {
"type": "boolean",
"description": "True if agents can edit the variable value at runtime.",
"example": true
},
"isReportable": {
"type": "boolean",
"description": "True if the variable is included in reporting.",
"example": false
},
"isSecure": {
"type": "boolean",
"description": "True if the variable holds sensitive data and must be masked in logs and reports.",
"example": false
}
}
},
"PatchDraftContract": {
"title": "PatchDraftContract",
"type": "object",
"description": "Structured patch applied to a flow draft. Server-side merge, idempotent, and re-validated after the merge \u2014 the patch is rejected if the merged document fails validation.",
"properties": {
"upsert_nodes": {
"type": "array",
"description": "Nodes to insert or replace. Matched by `name`. If a node with the same name exists, it is fully replaced; otherwise a new node is created.",
"items": {
"type": "object",
"additionalProperties": true
}
},
"upsert_edges": {
"type": "array",
"description": "Edges to insert or replace, matched by `id`.",
"items": {
"type": "object",
"additionalProperties": true
}
},
"remove_node_names": {
"type": "array",
"description": "Names of nodes to remove. Edges referencing a removed node must also be removed in the same patch, or the merged document will fail validation.",
"items": {
"type": "string"
}
},
"remove_edge_keys": {
"type": "array",
"description": "Identifiers of edges to remove.",
"items": {
"type": "string"
}
}
},
"example": {
"upsert_nodes": [
{
"id": "node-welcome",
"name": "WelcomeMessage",
"activityType": "action",
"properties": {
"activityName": "play-message",
"prompt": {
"promptType": "text",
"text": "Thanks for calling. Please hold.",
"textType": "text"
}
}
}
],
"upsert_edges": [
{
"id": "edge-1",
"from": "NewContact",
"to": "WelcomeMessage",
"condition": "out",
"properties": {}
}
],
"remove_node_names": [],
"remove_edge_keys": []
}
},
"FnInputDef": {
"title": "FnInputDef",
"type": "object",
"description": "A declared input variable of a custom function.",
"additionalProperties": true,
"properties": {
"name": {
"type": "string",
"description": "Input variable name.",
"example": "zip"
},
"dataType": {
"type": "string",
"description": "Input data type.",
"enum": [
"boolean",
"datetime",
"decimal",
"integer",
"json",
"string"
],
"example": "string"
},
"value": {
"description": "Default or sample value for the input.",
"example": "94043"
}
}
},
"FnListResponse": {
"title": "FnListResponse",
"type": "object",
"description": "Paginated list of custom functions. Function metadata records are returned under `data`, with pagination details under `pageInfo`.",
"additionalProperties": true,
"properties": {
"data": {
"type": "array",
"description": "Page of custom function metadata records. Each entry carries metadata only; the source code is returned only when fetching a single function.",
"items": {
"$ref": "#/components/schemas/FnMetadata"
}
},
"pageInfo": {
"$ref": "#/components/schemas/PageInfo"
}
},
"example": {
"data": [
{
"id": "64f1b2c3d4e5f6a7b8c9d0e1",
"orgId": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8",
"name": "validateZipCode",
"description": "Returns true if the supplied US zip code is in a valid 5-digit format.",
"language": "js",
"selectedRuntime": "nodejs22.x",
"status": "Published",
"timeoutInSec": 3,
"tagVersionMap": {
"Dev": "1",
"Latest": "1"
},
"createdBy": "user@example.com",
"createdDate": "2026-05-28T14:23:01Z",
"lastModifiedBy": "user@example.com",
"lastModifiedDate": "2026-05-28T14:23:01Z"
}
],
"pageInfo": {
"currentPage": 0,
"pageSize": 100,
"totalPages": 1,
"totalRecords": 1
}
}
},
"PageInfo": {
"title": "PageInfo",
"type": "object",
"description": "Pagination details for a paged list response.",
"additionalProperties": true,
"properties": {
"currentPage": {
"type": "integer",
"format": "int32",
"description": "Zero-based index of the returned page.",
"example": 0
},
"pageSize": {
"type": "integer",
"format": "int32",
"description": "Page size used by the query.",
"example": 100
},
"totalPages": {
"type": "integer",
"format": "int32",
"description": "Total number of pages.",
"example": 1
},
"totalRecords": {
"type": "integer",
"format": "int64",
"description": "Total number of records matching the query, across all pages.",
"example": 42
}
},
"example": {
"currentPage": 0,
"pageSize": 100,
"totalPages": 1,
"totalRecords": 42
}
},
"FnStatusResponse": {
"title": "FnStatusResponse",
"type": "string",
"description": "Acknowledgement returned by lock/unlock operations. Returns the literal JSON string \"OK\" on success.",
"example": "OK"
},
"FnConflictResponse": {
"title": "FnConflictResponse",
"type": "object",
"description": "Conflict envelope returned when a function with the same name already exists in the org.",
"additionalProperties": true,
"properties": {
"status": {
"type": "integer",
"description": "HTTP status code.",
"example": 409
},
"errors": {
"type": "array",
"description": "The conflicts encountered.",
"items": {
"type": "object",
"additionalProperties": true,
"properties": {
"description": {
"type": "string",
"description": "Human-readable description of the conflict.",
"example": "409 CONFLICT \"Function with name: validateZipCode already exists in org: 8eb7da9a-c81c-4d13-b08b-38fdeb7330d8. Please choose a different name.\""
},
"type": {
"type": "string",
"description": "Error type.",
"example": "Conflict"
}
}
}
}
},
"example": {
"status": 409,
"errors": [
{
"description": "409 CONFLICT \"Function with name: validateZipCode already exists in org: 8eb7da9a-c81c-4d13-b08b-38fdeb7330d8. Please choose a different name.\"",
"type": "Conflict"
}
]
}
},
"ErrorResponse": {
"type": "object",
"description": "Error response",
"properties": {
"code": {
"type": "string",
"description": "Error code"
},
"message": {
"type": "string",
"description": "Error description"
}
},
"example": {
"code": "InvalidRequest",
"message": "The campaign ID is missing"
}
},
"FnCreateReq": {
"title": "FnCreateReq",
"type": "object",
"description": "Source code and metadata of a custom function. `language` defaults to `js`. `selectedRuntime` defaults to the highest supported runtime for the chosen language. The `outputs` field is a stringified (escaped) JSON of output variable names mapped to sample values.",
"additionalProperties": true,
"properties": {
"name": {
"type": "string",
"description": "Function name. Must be unique within the organization.",
"example": "validateZipCode"
},
"description": {
"type": "string",
"description": "Human-readable description of the function.",
"example": "Returns true if the supplied US zip code is in a valid 5-digit format."
},
"language": {
"type": "string",
"description": "Programming language. Defaults to `js`.",
"enum": [
"js",
"py"
],
"default": "js",
"example": "js"
},
"selectedRuntime": {
"type": "string",
"description": "Runtime identifier (case-sensitive). For example, `nodejs22.x` or `python3.13`. Defaults to the highest supported runtime for the chosen language.",
"example": "nodejs22.x"
},
"timeoutInSec": {
"type": "integer",
"format": "int32",
"description": "Maximum execution time for the function, in seconds.",
"example": 3
},
"sourceCode": {
"type": "string",
"description": "Function source code as an escaped string. The handler must be an exported async function `export const handle = async (request, response) => { ... }`. Read inputs from `request.inputs.*`, set the result via `response.data = { ... }`, and `return response`.",
"example": "export const handle = async (request, response) => {\n response.data = { areaCode: String(request.inputs.ani || '').slice(-10).slice(0, 3) };\n return response;\n}\n"
},
"inputs": {
"type": "array",
"description": "Declared inputs of the function.",
"items": {
"$ref": "#/components/schemas/FnInputDef"
}
},
"outputs": {
"type": "string",
"description": "Stringified JSON of output variable names mapped to sample values.",
"example": "{\"isValid\":true}"
}
},
"example": {
"name": "validateZipCode",
"description": "Returns true if the supplied US zip code is in a valid 5-digit format.",
"language": "js",
"selectedRuntime": "nodejs22.x",
"timeoutInSec": 3,
"sourceCode": "export const handle = async (request, response) => {\n response.data = { areaCode: String(request.inputs.ani || '').slice(-10).slice(0, 3) };\n return response;\n}\n",
"inputs": [
{
"name": "zip",
"dataType": "string",
"value": "94043"
}
],
"outputs": "{\"isValid\":true}"
}
},
"FnMetadata": {
"title": "FnMetadata",
"type": "object",
"description": "Metadata for a custom function (no source code). Returned in list responses and inside the `fnMetadata` envelope of a single-function response.",
"additionalProperties": true,
"properties": {
"id": {
"type": "string",
"description": "Function ID. Hexadecimal ObjectId.",
"example": "64f1b2c3d4e5f6a7b8c9d0e1"
},
"orgId": {
"type": "string",
"description": "Organization ID that owns the function.",
"example": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8"
},
"name": {
"type": "string",
"description": "Function name.",
"example": "validateZipCode"
},
"description": {
"type": "string",
"description": "Human-readable description of the function.",
"example": "Returns true if the supplied US zip code is in a valid 5-digit format."
},
"language": {
"type": "string",
"description": "Programming language.",
"enum": [
"js",
"py"
],
"example": "js"
},
"selectedRuntime": {
"type": "string",
"description": "Runtime identifier.",
"example": "nodejs22.x"
},
"status": {
"type": "string",
"description": "Lifecycle status.",
"enum": [
"Draft",
"Published"
],
"example": "Published"
},
"timeoutInSec": {
"type": "integer",
"format": "int32",
"description": "Maximum execution time for the function, in seconds.",
"example": 3
},
"tagVersionMap": {
"type": "object",
"description": "Map of publish tag to the function version it currently points to.",
"additionalProperties": true,
"example": {
"Dev": "1",
"Latest": "1"
}
},
"lockedBy": {
"type": "string",
"description": "User ID currently holding the edit lock, or empty if unlocked.",
"example": ""
},
"createdBy": {
"type": "string",
"description": "User ID that created the function.",
"example": "user@example.com"
},
"createdDate": {
"type": "string",
"format": "date-time",
"description": "Timestamp the function was created.",
"example": "2026-05-28T14:23:01Z"
},
"lastModifiedBy": {
"type": "string",
"description": "User ID that last modified the function.",
"example": "user@example.com"
},
"lastModifiedDate": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the most recent modification.",
"example": "2026-05-28T14:23:01Z"
}
},
"example": {
"id": "64f1b2c3d4e5f6a7b8c9d0e1",
"orgId": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8",
"name": "validateZipCode",
"description": "Returns true if the supplied US zip code is in a valid 5-digit format.",
"language": "js",
"selectedRuntime": "nodejs22.x",
"status": "Published",
"timeoutInSec": 3,
"tagVersionMap": {
"Dev": "1",
"Latest": "1"
},
"lockedBy": "",
"createdBy": "user@example.com",
"createdDate": "2026-05-28T14:23:01Z",
"lastModifiedBy": "user@example.com",
"lastModifiedDate": "2026-05-28T14:23:01Z"
}
},
"FnDataResp": {
"title": "FnDataResp",
"type": "object",
"description": "A single custom function. The source code is returned under `fnCode`, and all lifecycle metadata under `fnMetadata`.",
"additionalProperties": true,
"properties": {
"fnCode": {
"type": "string",
"description": "Function source code as an escaped string. The handler is an exported async function `export const handle = async (request, response) => { ... }`.",
"example": "export const handle = async (request, response) => {\n response.data = { areaCode: String(request.inputs.ani || '').slice(-10).slice(0, 3) };\n return response;\n}\n"
},
"fnMetadata": {
"$ref": "#/components/schemas/FnMetadata"
}
},
"example": {
"fnCode": "export const handle = async (request, response) => {\n response.data = { areaCode: String(request.inputs.ani || '').slice(-10).slice(0, 3) };\n return response;\n}\n",
"fnMetadata": {
"id": "64f1b2c3d4e5f6a7b8c9d0e1",
"orgId": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8",
"name": "validateZipCode",
"description": "Returns true if the supplied US zip code is in a valid 5-digit format.",
"language": "js",
"selectedRuntime": "nodejs22.x",
"status": "Published",
"timeoutInSec": 3,
"tagVersionMap": {
"Dev": "1",
"Latest": "1"
},
"lockedBy": "",
"createdBy": "user@example.com",
"createdDate": "2026-05-28T14:23:01Z",
"lastModifiedBy": "user@example.com",
"lastModifiedDate": "2026-05-28T14:23:01Z"
}
}
},
"FnPublishReq": {
"title": "FnPublishReq",
"type": "object",
"description": "Tags and comments for a publish operation. Tags are case-sensitive.",
"additionalProperties": true,
"properties": {
"tags": {
"type": "array",
"description": "Publish tags to apply to this version.",
"items": {
"type": "string",
"enum": [
"Dev",
"Test",
"Latest",
"Live"
]
},
"example": [
"Dev",
"Latest"
]
},
"comment": {
"type": "string",
"description": "Optional publish comment.",
"example": "Initial release."
}
}
},
"FnExport": {
"title": "FnExport",
"type": "object",
"description": "Exported function definition, suitable for re-importing via the import API as an uploaded JSON file.",
"additionalProperties": true,
"properties": {
"name": {
"type": "string",
"description": "Function name.",
"example": "validateZipCode"
},
"language": {
"type": "string",
"description": "Source language of the function (for example, `js`, `py`).",
"example": "js"
},
"runtime": {
"type": "string",
"description": "Runtime the function executes on.",
"example": "nodejs22.x"
},
"description": {
"type": "string",
"description": "Human-readable description of the function.",
"example": "Validates and normalizes a US ZIP code."
},
"sourceCode": {
"type": "string",
"description": "Full function source code.",
"example": "export const handle = (request, response) => { /* ... */ };"
},
"inputs": {
"type": "array",
"description": "Declared function inputs.",
"items": {
"type": "object",
"additionalProperties": true
}
},
"outputs": {
"type": "string",
"description": "Declared function outputs as a JSON-encoded string.",
"example": "{\"myOutputVar1\": 7, \"myOutputVar2\": \"String data\"}"
}
},
"example": {
"name": "validateZipCode",
"language": "js",
"runtime": "nodejs22.x",
"description": "Validates and normalizes a US ZIP code.",
"sourceCode": "export const handle = (request, response) => { /* ... */ };",
"inputs": [],
"outputs": "{\"myOutputVar1\": 7, \"myOutputVar2\": \"String data\"}"
}
},
"FlowTemplate": {
"title": "FlowTemplate",
"type": "object",
"description": "Flow template metadata and flow structure used to seed new flows.",
"additionalProperties": true,
"example": {
"id": "tmpl-customer-callback",
"name": "Customer Callback",
"description": "Offers a callback when estimated wait time exceeds a threshold.",
"type": "flow"
},
"properties": {
"id": {
"type": "string",
"description": "Template ID.",
"example": "tmpl-customer-callback"
},
"name": {
"type": "string",
"description": "Template name.",
"example": "Customer Callback"
},
"description": {
"type": "string",
"description": "Human-readable description of the template.",
"example": "Offers a callback when estimated wait time exceeds a threshold."
},
"type": {
"type": "string",
"description": "Template kind. One of `flow` or `subflow`.",
"enum": [
"flow",
"subflow"
],
"example": "flow"
},
"flow": {
"$ref": "#/components/schemas/FlowV2"
}
}
},
"PatchRequest": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PatchDocument"
}
},
"PatchDocument": {
"required": [
"op",
"path"
],
"type": "object",
"properties": {
"op": {
"type": "string",
"description": "The operation to be performed ",
"example": "update",
"enum": [
"add",
"update",
"remove"
]
},
"path": {
"type": "string",
"description": "A JSON-Pointer",
"example": "/name"
},
"value": {
"type": "string",
"description": "The value to be used within the operations.",
"example": "test"
}
},
"description": "A JSONPatch document as defined by RFC 6902"
},
"BaseMetaResponseEnvelope": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "Organization ID",
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
}
},
"description": "Meta information of the response",
"example": {
"organizationId": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
}
},
"NestedRuleDocument": {
"allOf": [
{
"$ref": "#/components/schemas/RulesDocument"
}
]
},
"RulesDocument": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "type",
"example": "nested"
},
"childrenRules": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "type",
"example": "nested"
}
},
"description": "childrenRules",
"discriminator": {
"propertyName": "type"
}
}
},
"description": "Configuration details of the Rules based on which the Action will be triggered",
"example": {
"logic": "OR",
"args": [
"item buy,price,integer,Sum GT 100",
"item buy,sku,integer,Count GT 5"
]
},
"discriminator": {
"propertyName": "type"
}
},
"SingleRuleDocument": {
"allOf": [
{
"$ref": "#/components/schemas/RulesDocument"
}
]
},
"CreateOrUpdatePersonRequestModel": {
"type": "object",
"properties": {
"firstName": {
"type": "string",
"description": "firstName",
"example": "John"
},
"lastName": {
"type": "string",
"description": "lastName",
"example": "Doe"
},
"phone": {
"type": "array",
"description": "Phone Number",
"example": [
"+12342342345"
],
"items": {
"type": "string"
}
},
"email": {
"type": "array",
"description": "Email",
"example": [
"johndoe@gmail.com"
],
"items": {
"type": "string"
}
},
"temporaryId": {
"type": "array",
"description": "Temporary Id",
"example": [
"2342s-sdsd-342345"
],
"items": {
"type": "string"
}
},
"customerId": {
"type": "array",
"description": "Customer Id",
"example": [
"234"
],
"items": {
"type": "string"
}
}
},
"description": "Create Or Update Person"
},
"PersonResponse": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/BaseMetaResponseEnvelope"
},
"data": {
"$ref": "#/components/schemas/PersonResponseModel"
}
}
},
"PersonResponseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Profile View Template Id",
"example": "638505f32332c8200dac025e"
},
"firstName": {
"type": "string",
"description": "firstName",
"example": "John"
},
"lastName": {
"type": "string",
"description": "lastName",
"example": "Doe"
},
"phone": {
"type": "array",
"description": "Phone Number",
"example": [
"+12342342345"
],
"items": {
"type": "string"
}
},
"email": {
"type": "array",
"description": "Email",
"example": [
"johndoe@gmail.com"
],
"items": {
"type": "string"
}
},
"temporaryId": {
"type": "array",
"description": "Temporary Id",
"example": [
"2342s-sdsd-342345"
],
"items": {
"type": "string"
}
},
"customerId": {
"type": "array",
"description": "Customer Id",
"example": [
"234"
],
"items": {
"type": "string"
}
},
"aliases": {
"type": "array",
"description": "Aliases",
"example": [
"234",
"johndoe@gmail.com",
"+12342342345"
],
"items": {
"type": "string"
}
}
},
"description": "Person Response Model"
},
"MergePersonsRequest": {
"required": [
"personIdsToMerge"
],
"type": "object",
"properties": {
"personIdsToMerge": {
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"description": "List of Person Ids to merge",
"example": [
"6435e80153802b2a273bae3a",
"6435e80153802b2a273bae3b",
"6435e80153802b2a273bae3c"
],
"items": {
"type": "string"
}
}
},
"description": "Merge two or more persons"
},
"MergePersonRequestModel": {
"type": "object",
"properties": {
"override": {
"type": "boolean",
"description": "Override flag which will override the existing person with the new data if set to true. Default is false.",
"example": false
},
"firstName": {
"type": "string",
"description": "firstName",
"example": "John"
},
"lastName": {
"type": "string",
"description": "lastName",
"example": "Doe"
},
"phone": {
"uniqueItems": true,
"type": "array",
"description": "Phone Number",
"example": [
"+12342342345"
],
"items": {
"type": "string"
}
},
"email": {
"uniqueItems": true,
"type": "array",
"description": "Email",
"example": [
"johndoe@gmail.com"
],
"items": {
"type": "string"
}
},
"temporaryId": {
"uniqueItems": true,
"type": "array",
"description": "Temporary Id",
"example": [
"2342s-sdsd-342345"
],
"items": {
"type": "string"
}
},
"customerId": {
"uniqueItems": true,
"type": "array",
"description": "Customer Id",
"example": [
"234"
],
"items": {
"type": "string"
}
},
"socialId": {
"uniqueItems": true,
"type": "array",
"description": "Social Id",
"example": [
"johndoe@gmail.com,+12342342345"
],
"items": {
"type": "string"
}
}
},
"description": "Merge Person"
},
"PersonGetResponse": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/BaseMetaResponseEnvelope"
},
"data": {
"type": "array",
"description": "Data part of the response",
"items": {
"$ref": "#/components/schemas/PersonResponseModel"
}
}
}
},
"ApiError400": {
"required": [
"trackingId"
],
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Http Status Description",
"example": "400 BAD_REQUEST",
"enum": [
"100 CONTINUE",
"101 SWITCHING_PROTOCOLS",
"102 PROCESSING",
"103 EARLY_HINTS",
"103 CHECKPOINT",
"200 OK",
"201 CREATED",
"202 ACCEPTED",
"203 NON_AUTHORITATIVE_INFORMATION",
"204 NO_CONTENT",
"205 RESET_CONTENT",
"206 PARTIAL_CONTENT",
"207 MULTI_STATUS",
"208 ALREADY_REPORTED",
"226 IM_USED",
"300 MULTIPLE_CHOICES",
"301 MOVED_PERMANENTLY",
"302 FOUND",
"302 MOVED_TEMPORARILY",
"303 SEE_OTHER",
"304 NOT_MODIFIED",
"305 USE_PROXY",
"307 TEMPORARY_REDIRECT",
"308 PERMANENT_REDIRECT",
"400 BAD_REQUEST",
"401 UNAUTHORIZED",
"402 PAYMENT_REQUIRED",
"403 FORBIDDEN",
"404 NOT_FOUND",
"405 METHOD_NOT_ALLOWED",
"406 NOT_ACCEPTABLE",
"407 PROXY_AUTHENTICATION_REQUIRED",
"408 REQUEST_TIMEOUT",
"409 CONFLICT",
"410 GONE",
"411 LENGTH_REQUIRED",
"412 PRECONDITION_FAILED",
"413 PAYLOAD_TOO_LARGE",
"413 REQUEST_ENTITY_TOO_LARGE",
"414 URI_TOO_LONG",
"414 REQUEST_URI_TOO_LONG",
"415 UNSUPPORTED_MEDIA_TYPE",
"416 REQUESTED_RANGE_NOT_SATISFIABLE",
"417 EXPECTATION_FAILED",
"418 I_AM_A_TEAPOT",
"419 INSUFFICIENT_SPACE_ON_RESOURCE",
"420 METHOD_FAILURE",
"421 DESTINATION_LOCKED",
"422 UNPROCESSABLE_ENTITY",
"423 LOCKED",
"424 FAILED_DEPENDENCY",
"425 TOO_EARLY",
"426 UPGRADE_REQUIRED",
"428 PRECONDITION_REQUIRED",
"429 TOO_MANY_REQUESTS",
"431 REQUEST_HEADER_FIELDS_TOO_LARGE",
"451 UNAVAILABLE_FOR_LEGAL_REASONS",
"500 INTERNAL_SERVER_ERROR",
"501 NOT_IMPLEMENTED",
"502 BAD_GATEWAY",
"503 SERVICE_UNAVAILABLE",
"504 GATEWAY_TIMEOUT",
"505 HTTP_VERSION_NOT_SUPPORTED",
"506 VARIANT_ALSO_NEGOTIATES",
"507 INSUFFICIENT_STORAGE",
"508 LOOP_DETECTED",
"509 BANDWIDTH_LIMIT_EXCEEDED",
"510 NOT_EXTENDED",
"511 NETWORK_AUTHENTICATION_REQUIRED"
]
},
"message": {
"type": "string",
"description": "Error Message",
"example": "Bad Request"
},
"errors": {
"type": "array",
"description": "Bad Request",
"example": [
"Id cannot be null"
],
"items": {
"type": "string"
}
},
"timestamp": {
"type": "string",
"description": "Occurred timestamp",
"format": "date-time",
"example": "2023-03-27T20:59:32.376Z"
},
"trackingId": {
"type": "string",
"description": "Unique ID by which a request can be debugged. Please provide if opening a support case.",
"example": "76cd71d0e678a8bb"
}
}
},
"ApiError401": {
"required": [
"trackingId"
],
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Http Status Description",
"example": "401 UNAUTHORIZED",
"enum": [
"100 CONTINUE",
"101 SWITCHING_PROTOCOLS",
"102 PROCESSING",
"103 EARLY_HINTS",
"103 CHECKPOINT",
"200 OK",
"201 CREATED",
"202 ACCEPTED",
"203 NON_AUTHORITATIVE_INFORMATION",
"204 NO_CONTENT",
"205 RESET_CONTENT",
"206 PARTIAL_CONTENT",
"207 MULTI_STATUS",
"208 ALREADY_REPORTED",
"226 IM_USED",
"300 MULTIPLE_CHOICES",
"301 MOVED_PERMANENTLY",
"302 FOUND",
"302 MOVED_TEMPORARILY",
"303 SEE_OTHER",
"304 NOT_MODIFIED",
"305 USE_PROXY",
"307 TEMPORARY_REDIRECT",
"308 PERMANENT_REDIRECT",
"400 BAD_REQUEST",
"401 UNAUTHORIZED",
"402 PAYMENT_REQUIRED",
"403 FORBIDDEN",
"404 NOT_FOUND",
"405 METHOD_NOT_ALLOWED",
"406 NOT_ACCEPTABLE",
"407 PROXY_AUTHENTICATION_REQUIRED",
"408 REQUEST_TIMEOUT",
"409 CONFLICT",
"410 GONE",
"411 LENGTH_REQUIRED",
"412 PRECONDITION_FAILED",
"413 PAYLOAD_TOO_LARGE",
"413 REQUEST_ENTITY_TOO_LARGE",
"414 URI_TOO_LONG",
"414 REQUEST_URI_TOO_LONG",
"415 UNSUPPORTED_MEDIA_TYPE",
"416 REQUESTED_RANGE_NOT_SATISFIABLE",
"417 EXPECTATION_FAILED",
"418 I_AM_A_TEAPOT",
"419 INSUFFICIENT_SPACE_ON_RESOURCE",
"420 METHOD_FAILURE",
"421 DESTINATION_LOCKED",
"422 UNPROCESSABLE_ENTITY",
"423 LOCKED",
"424 FAILED_DEPENDENCY",
"425 TOO_EARLY",
"426 UPGRADE_REQUIRED",
"428 PRECONDITION_REQUIRED",
"429 TOO_MANY_REQUESTS",
"431 REQUEST_HEADER_FIELDS_TOO_LARGE",
"451 UNAVAILABLE_FOR_LEGAL_REASONS",
"500 INTERNAL_SERVER_ERROR",
"501 NOT_IMPLEMENTED",
"502 BAD_GATEWAY",
"503 SERVICE_UNAVAILABLE",
"504 GATEWAY_TIMEOUT",
"505 HTTP_VERSION_NOT_SUPPORTED",
"506 VARIANT_ALSO_NEGOTIATES",
"507 INSUFFICIENT_STORAGE",
"508 LOOP_DETECTED",
"509 BANDWIDTH_LIMIT_EXCEEDED",
"510 NOT_EXTENDED",
"511 NETWORK_AUTHENTICATION_REQUIRED"
]
},
"message": {
"type": "string",
"description": "Error Message",
"example": "UnAuthorized"
},
"errors": {
"type": "array",
"description": "UnAuthorized",
"example": [
"UnAuthorized to create resource"
],
"items": {
"type": "string"
}
},
"timestamp": {
"type": "string",
"description": "Occurred timestamp",
"format": "date-time",
"example": "2023-03-27T20:59:32.376Z"
},
"trackingId": {
"type": "string",
"description": "Unique ID by which a request can be debugged. Please provide if opening a support case.",
"example": "76cd71d0e678a8bb"
}
}
},
"ApiError404": {
"required": [
"trackingId"
],
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Http Status Description",
"example": "404 NOT_FOUND",
"enum": [
"100 CONTINUE",
"101 SWITCHING_PROTOCOLS",
"102 PROCESSING",
"103 EARLY_HINTS",
"103 CHECKPOINT",
"200 OK",
"201 CREATED",
"202 ACCEPTED",
"203 NON_AUTHORITATIVE_INFORMATION",
"204 NO_CONTENT",
"205 RESET_CONTENT",
"206 PARTIAL_CONTENT",
"207 MULTI_STATUS",
"208 ALREADY_REPORTED",
"226 IM_USED",
"300 MULTIPLE_CHOICES",
"301 MOVED_PERMANENTLY",
"302 FOUND",
"302 MOVED_TEMPORARILY",
"303 SEE_OTHER",
"304 NOT_MODIFIED",
"305 USE_PROXY",
"307 TEMPORARY_REDIRECT",
"308 PERMANENT_REDIRECT",
"400 BAD_REQUEST",
"401 UNAUTHORIZED",
"402 PAYMENT_REQUIRED",
"403 FORBIDDEN",
"404 NOT_FOUND",
"405 METHOD_NOT_ALLOWED",
"406 NOT_ACCEPTABLE",
"407 PROXY_AUTHENTICATION_REQUIRED",
"408 REQUEST_TIMEOUT",
"409 CONFLICT",
"410 GONE",
"411 LENGTH_REQUIRED",
"412 PRECONDITION_FAILED",
"413 PAYLOAD_TOO_LARGE",
"413 REQUEST_ENTITY_TOO_LARGE",
"414 URI_TOO_LONG",
"414 REQUEST_URI_TOO_LONG",
"415 UNSUPPORTED_MEDIA_TYPE",
"416 REQUESTED_RANGE_NOT_SATISFIABLE",
"417 EXPECTATION_FAILED",
"418 I_AM_A_TEAPOT",
"419 INSUFFICIENT_SPACE_ON_RESOURCE",
"420 METHOD_FAILURE",
"421 DESTINATION_LOCKED",
"422 UNPROCESSABLE_ENTITY",
"423 LOCKED",
"424 FAILED_DEPENDENCY",
"425 TOO_EARLY",
"426 UPGRADE_REQUIRED",
"428 PRECONDITION_REQUIRED",
"429 TOO_MANY_REQUESTS",
"431 REQUEST_HEADER_FIELDS_TOO_LARGE",
"451 UNAVAILABLE_FOR_LEGAL_REASONS",
"500 INTERNAL_SERVER_ERROR",
"501 NOT_IMPLEMENTED",
"502 BAD_GATEWAY",
"503 SERVICE_UNAVAILABLE",
"504 GATEWAY_TIMEOUT",
"505 HTTP_VERSION_NOT_SUPPORTED",
"506 VARIANT_ALSO_NEGOTIATES",
"507 INSUFFICIENT_STORAGE",
"508 LOOP_DETECTED",
"509 BANDWIDTH_LIMIT_EXCEEDED",
"510 NOT_EXTENDED",
"511 NETWORK_AUTHENTICATION_REQUIRED"
]
},
"message": {
"type": "string",
"description": "Error Message",
"example": "Resource not found"
},
"errors": {
"type": "array",
"description": "Resource Already Found",
"example": [
"Id 3249892348-sdfjsdhf-345hdsf-345345 Not Found"
],
"items": {
"type": "string"
}
},
"timestamp": {
"type": "string",
"description": "Occurred timestamp",
"format": "date-time",
"example": "2023-03-27T20:59:32.376Z"
},
"trackingId": {
"type": "string",
"description": "Unique ID by which a request can be debugged. Please provide if opening a support case.",
"example": "76cd71d0e678a8bb"
}
}
},
"ApiError500": {
"required": [
"trackingId"
],
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Http Status Description",
"example": "500 INTERNAL_SERVER_ERROR",
"enum": [
"100 CONTINUE",
"101 SWITCHING_PROTOCOLS",
"102 PROCESSING",
"103 EARLY_HINTS",
"103 CHECKPOINT",
"200 OK",
"201 CREATED",
"202 ACCEPTED",
"203 NON_AUTHORITATIVE_INFORMATION",
"204 NO_CONTENT",
"205 RESET_CONTENT",
"206 PARTIAL_CONTENT",
"207 MULTI_STATUS",
"208 ALREADY_REPORTED",
"226 IM_USED",
"300 MULTIPLE_CHOICES",
"301 MOVED_PERMANENTLY",
"302 FOUND",
"302 MOVED_TEMPORARILY",
"303 SEE_OTHER",
"304 NOT_MODIFIED",
"305 USE_PROXY",
"307 TEMPORARY_REDIRECT",
"308 PERMANENT_REDIRECT",
"400 BAD_REQUEST",
"401 UNAUTHORIZED",
"402 PAYMENT_REQUIRED",
"403 FORBIDDEN",
"404 NOT_FOUND",
"405 METHOD_NOT_ALLOWED",
"406 NOT_ACCEPTABLE",
"407 PROXY_AUTHENTICATION_REQUIRED",
"408 REQUEST_TIMEOUT",
"409 CONFLICT",
"410 GONE",
"411 LENGTH_REQUIRED",
"412 PRECONDITION_FAILED",
"413 PAYLOAD_TOO_LARGE",
"413 REQUEST_ENTITY_TOO_LARGE",
"414 URI_TOO_LONG",
"414 REQUEST_URI_TOO_LONG",
"415 UNSUPPORTED_MEDIA_TYPE",
"416 REQUESTED_RANGE_NOT_SATISFIABLE",
"417 EXPECTATION_FAILED",
"418 I_AM_A_TEAPOT",
"419 INSUFFICIENT_SPACE_ON_RESOURCE",
"420 METHOD_FAILURE",
"421 DESTINATION_LOCKED",
"422 UNPROCESSABLE_ENTITY",
"423 LOCKED",
"424 FAILED_DEPENDENCY",
"425 TOO_EARLY",
"426 UPGRADE_REQUIRED",
"428 PRECONDITION_REQUIRED",
"429 TOO_MANY_REQUESTS",
"431 REQUEST_HEADER_FIELDS_TOO_LARGE",
"451 UNAVAILABLE_FOR_LEGAL_REASONS",
"500 INTERNAL_SERVER_ERROR",
"501 NOT_IMPLEMENTED",
"502 BAD_GATEWAY",
"503 SERVICE_UNAVAILABLE",
"504 GATEWAY_TIMEOUT",
"505 HTTP_VERSION_NOT_SUPPORTED",
"506 VARIANT_ALSO_NEGOTIATES",
"507 INSUFFICIENT_STORAGE",
"508 LOOP_DETECTED",
"509 BANDWIDTH_LIMIT_EXCEEDED",
"510 NOT_EXTENDED",
"511 NETWORK_AUTHENTICATION_REQUIRED"
]
},
"message": {
"type": "string",
"description": "Error Message",
"example": "Internal server error"
},
"errors": {
"type": "array",
"description": "Internal server error",
"example": [
"Internal server error "
],
"items": {
"type": "string"
}
},
"timestamp": {
"type": "string",
"description": "Occurred timestamp",
"format": "date-time",
"example": "2023-03-27T20:59:32.376Z"
},
"trackingId": {
"type": "string",
"description": "Unique ID by which a request can be debugged. Please provide if opening a support case.",
"example": "76cd71d0e678a8bb"
}
}
},
"AddIdentitiesToPersonRequestModel": {
"type": "object",
"properties": {
"phone": {
"type": "array",
"description": "Phone Number",
"example": [
"+12342342345"
],
"items": {
"type": "string"
}
},
"email": {
"type": "array",
"description": "Email",
"example": [
"johndoe@gmail.com"
],
"items": {
"type": "string"
}
},
"temporaryId": {
"type": "array",
"description": "Temporary Id",
"example": [
"2342s-sdsd-342345"
],
"items": {
"type": "string"
}
},
"customerId": {
"type": "array",
"description": "Customer Id",
"example": [
"234"
],
"items": {
"type": "string"
}
}
},
"description": "Add Identities to Person"
},
"eventData": {
"type": "object",
"properties": {
"agentId": {
"type": "string",
"description": "Agent Id",
"example": "109332be-7fc4-4d4d-9488-ebdb8e13b9bbe"
},
"destination": {
"type": "string",
"description": "destination",
"example": "+12147651210"
},
"profileType": {
"type": "string",
"description": "profileType",
"example": "BLENDED"
},
"currentState": {
"type": "string",
"description": "currentState",
"example": "idle"
},
"idleCodeId": {
"type": "string",
"description": "idleCodeId",
"example": "AXUr0jX9H5Tuplm_IxiC"
},
"createdTime": {
"type": "string",
"description": "createdTime",
"example": "1645819554383"
}
},
"description": "Event Data"
},
"JourneyCloudEventModel": {
"required": [
"data",
"datacontenttype",
"id",
"identity",
"identitytype",
"source",
"specversion",
"type"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Event ID",
"example": "9ab65fdf-9643-417f-9974-ad72cae0e10f"
},
"specversion": {
"type": "string",
"description": "Event Spec Version",
"example": "1.0"
},
"type": {
"type": "string",
"description": "Event Type",
"example": "com.cisco.wxcc.event.agent"
},
"source": {
"type": "string",
"description": "Event Source",
"example": "/com/cisco/wxcc/123"
},
"time": {
"type": "string",
"description": "Event Time",
"example": "2022-08-15T22:29:43.768Z"
},
"identity": {
"type": "string",
"description": "Identity",
"example": "sjohndeo@cisco.com"
},
"identitytype": {
"type": "string",
"description": "Identity Type",
"example": "email"
},
"previousidentity": {
"type": "string",
"description": "Previous Identity",
"example": "sdeo@cisco.com"
},
"datacontenttype": {
"type": "string",
"description": "Event Data Content Type",
"example": "application/json"
},
"data": {
"$ref": "#/components/schemas/eventData"
}
},
"description": "Journey Cloud Event Model"
},
"ApiError409": {
"required": [
"trackingId"
],
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Http Status Description",
"example": "409 CONFLICT",
"enum": [
"100 CONTINUE",
"101 SWITCHING_PROTOCOLS",
"102 PROCESSING",
"103 EARLY_HINTS",
"103 CHECKPOINT",
"200 OK",
"201 CREATED",
"202 ACCEPTED",
"203 NON_AUTHORITATIVE_INFORMATION",
"204 NO_CONTENT",
"205 RESET_CONTENT",
"206 PARTIAL_CONTENT",
"207 MULTI_STATUS",
"208 ALREADY_REPORTED",
"226 IM_USED",
"300 MULTIPLE_CHOICES",
"301 MOVED_PERMANENTLY",
"302 FOUND",
"302 MOVED_TEMPORARILY",
"303 SEE_OTHER",
"304 NOT_MODIFIED",
"305 USE_PROXY",
"307 TEMPORARY_REDIRECT",
"308 PERMANENT_REDIRECT",
"400 BAD_REQUEST",
"401 UNAUTHORIZED",
"402 PAYMENT_REQUIRED",
"403 FORBIDDEN",
"404 NOT_FOUND",
"405 METHOD_NOT_ALLOWED",
"406 NOT_ACCEPTABLE",
"407 PROXY_AUTHENTICATION_REQUIRED",
"408 REQUEST_TIMEOUT",
"409 CONFLICT",
"410 GONE",
"411 LENGTH_REQUIRED",
"412 PRECONDITION_FAILED",
"413 PAYLOAD_TOO_LARGE",
"413 REQUEST_ENTITY_TOO_LARGE",
"414 URI_TOO_LONG",
"414 REQUEST_URI_TOO_LONG",
"415 UNSUPPORTED_MEDIA_TYPE",
"416 REQUESTED_RANGE_NOT_SATISFIABLE",
"417 EXPECTATION_FAILED",
"418 I_AM_A_TEAPOT",
"419 INSUFFICIENT_SPACE_ON_RESOURCE",
"420 METHOD_FAILURE",
"421 DESTINATION_LOCKED",
"422 UNPROCESSABLE_ENTITY",
"423 LOCKED",
"424 FAILED_DEPENDENCY",
"425 TOO_EARLY",
"426 UPGRADE_REQUIRED",
"428 PRECONDITION_REQUIRED",
"429 TOO_MANY_REQUESTS",
"431 REQUEST_HEADER_FIELDS_TOO_LARGE",
"451 UNAVAILABLE_FOR_LEGAL_REASONS",
"500 INTERNAL_SERVER_ERROR",
"501 NOT_IMPLEMENTED",
"502 BAD_GATEWAY",
"503 SERVICE_UNAVAILABLE",
"504 GATEWAY_TIMEOUT",
"505 HTTP_VERSION_NOT_SUPPORTED",
"506 VARIANT_ALSO_NEGOTIATES",
"507 INSUFFICIENT_STORAGE",
"508 LOOP_DETECTED",
"509 BANDWIDTH_LIMIT_EXCEEDED",
"510 NOT_EXTENDED",
"511 NETWORK_AUTHENTICATION_REQUIRED"
]
},
"message": {
"type": "string",
"description": "Error Message",
"example": "Resource Already Exists"
},
"errors": {
"type": "array",
"description": "Resource Already Exists",
"example": [
"Id 3249892348-sdfjsdhf-345hdsf-345345 already exists"
],
"items": {
"type": "string"
}
},
"timestamp": {
"type": "string",
"description": "Occurred timestamp",
"format": "date-time",
"example": "2023-03-27T20:59:32.376Z"
},
"trackingId": {
"type": "string",
"description": "Unique ID by which a request can be debugged. Please provide if opening a support case.",
"example": "76cd71d0e678a8bb"
}
}
},
"ApiError429": {
"required": [
"trackingId"
],
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Http Status Description",
"example": "429 TOO_MANY_REQUESTS",
"enum": [
"100 CONTINUE",
"101 SWITCHING_PROTOCOLS",
"102 PROCESSING",
"103 EARLY_HINTS",
"103 CHECKPOINT",
"200 OK",
"201 CREATED",
"202 ACCEPTED",
"203 NON_AUTHORITATIVE_INFORMATION",
"204 NO_CONTENT",
"205 RESET_CONTENT",
"206 PARTIAL_CONTENT",
"207 MULTI_STATUS",
"208 ALREADY_REPORTED",
"226 IM_USED",
"300 MULTIPLE_CHOICES",
"301 MOVED_PERMANENTLY",
"302 FOUND",
"302 MOVED_TEMPORARILY",
"303 SEE_OTHER",
"304 NOT_MODIFIED",
"305 USE_PROXY",
"307 TEMPORARY_REDIRECT",
"308 PERMANENT_REDIRECT",
"400 BAD_REQUEST",
"401 UNAUTHORIZED",
"402 PAYMENT_REQUIRED",
"403 FORBIDDEN",
"404 NOT_FOUND",
"405 METHOD_NOT_ALLOWED",
"406 NOT_ACCEPTABLE",
"407 PROXY_AUTHENTICATION_REQUIRED",
"408 REQUEST_TIMEOUT",
"409 CONFLICT",
"410 GONE",
"411 LENGTH_REQUIRED",
"412 PRECONDITION_FAILED",
"413 PAYLOAD_TOO_LARGE",
"413 REQUEST_ENTITY_TOO_LARGE",
"414 URI_TOO_LONG",
"414 REQUEST_URI_TOO_LONG",
"415 UNSUPPORTED_MEDIA_TYPE",
"416 REQUESTED_RANGE_NOT_SATISFIABLE",
"417 EXPECTATION_FAILED",
"418 I_AM_A_TEAPOT",
"419 INSUFFICIENT_SPACE_ON_RESOURCE",
"420 METHOD_FAILURE",
"421 DESTINATION_LOCKED",
"422 UNPROCESSABLE_ENTITY",
"423 LOCKED",
"424 FAILED_DEPENDENCY",
"425 TOO_EARLY",
"426 UPGRADE_REQUIRED",
"428 PRECONDITION_REQUIRED",
"429 TOO_MANY_REQUESTS",
"431 REQUEST_HEADER_FIELDS_TOO_LARGE",
"451 UNAVAILABLE_FOR_LEGAL_REASONS",
"500 INTERNAL_SERVER_ERROR",
"501 NOT_IMPLEMENTED",
"502 BAD_GATEWAY",
"503 SERVICE_UNAVAILABLE",
"504 GATEWAY_TIMEOUT",
"505 HTTP_VERSION_NOT_SUPPORTED",
"506 VARIANT_ALSO_NEGOTIATES",
"507 INSUFFICIENT_STORAGE",
"508 LOOP_DETECTED",
"509 BANDWIDTH_LIMIT_EXCEEDED",
"510 NOT_EXTENDED",
"511 NETWORK_AUTHENTICATION_REQUIRED"
]
},
"message": {
"type": "string",
"description": "Error Message",
"example": "Too many requests"
},
"errors": {
"type": "array",
"description": "Too many requests",
"example": [
"Too many requests"
],
"items": {
"type": "string"
}
},
"timestamp": {
"type": "string",
"description": "Occurred timestamp",
"format": "date-time",
"example": "2023-03-27T20:59:32.376Z"
},
"trackingId": {
"type": "string",
"description": "Unique ID by which a request can be debugged. Please provide if opening a support case.",
"example": "76cd71d0e678a8bb"
}
}
},
"BaseDataMessageResponseEnvelope": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "message",
"example": "Accepted for processing"
}
},
"description": "Data part of the response"
},
"BaseMetaWithWorkspaceResponseEnvelope": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "Organization ID",
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
},
"workspaceId": {
"type": "string",
"description": "Workspace ID",
"example": "ad72cae0e10f-417f-9974-417f-ad72cae0e10f"
}
},
"description": "Meta information of the response",
"example": {
"organizationId": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
}
},
"JourneyEventPostingResponse": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/BaseMetaWithWorkspaceResponseEnvelope"
},
"data": {
"$ref": "#/components/schemas/BaseDataMessageResponseEnvelope"
}
}
},
"CreateOrUpdateTemplateModel": {
"required": [
"attributes",
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Template Name",
"example": "sample-template"
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileViewAttributeRequestModel"
}
}
},
"description": "Create Or Update Template"
},
"ProfileViewAttributeRequestModel": {
"required": [
"aggregationMode",
"displayName",
"event",
"limit",
"lookBackDurationType",
"lookBackPeriod",
"metaData",
"metaDataType",
"verbose",
"version"
],
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "displayName",
"example": "Name"
},
"version": {
"type": "string",
"description": "version",
"example": "1.1"
},
"event": {
"type": "string",
"description": "event",
"example": "task:new"
},
"metaDataType": {
"type": "string",
"description": "metaDataType",
"example": "string"
},
"metaData": {
"type": "string",
"description": "metaData",
"example": "origin"
},
"limit": {
"minimum": 0,
"type": "integer",
"description": "limit",
"format": "int32",
"example": 30
},
"lookBackDurationType": {
"type": "string",
"description": "lookBackDurationType",
"example": "days"
},
"lookBackPeriod": {
"minimum": 1,
"type": "integer",
"description": "lookBackPeriod",
"format": "int32",
"example": 10
},
"aggregationMode": {
"type": "string",
"description": "aggregationMode",
"example": "Count"
},
"verbose": {
"type": "boolean",
"description": "verbose",
"example": true
},
"widgetAttributes": {
"$ref": "#/components/schemas/WidgetAttributesRequestModel"
},
"rules": {
"$ref": "#/components/schemas/Rules"
}
},
"description": "Create or Update Attribute of a ProfileViewTemplate"
},
"Rules": {
"type": "object",
"description": "Configuration details of the Rules",
"properties": {
"logic": {
"type": "string",
"description": "logic",
"example": "OR"
},
"args": {
"type": "array",
"description": "Arguments",
"example": [
"item buy,price,integer,Sum GT 100",
"item buy,sku,integer,Count GT 5"
],
"items": {
"type": "string"
}
}
}
},
"WidgetAttributesRequestModel": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "type",
"example": "table"
}
},
"description": "Create or Update WidgetAttributes",
"example": {
"type": "table"
}
},
"ProfileResponse": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/BaseMetaResponseEnvelope"
},
"data": {
"$ref": "#/components/schemas/TemplateResponseModel"
}
}
},
"ProfileViewAttributeResponseModel": {
"type": "object",
"properties": {
"displayName": {
"type": "string",
"description": "displayName",
"example": "Name"
},
"version": {
"type": "string",
"description": "version",
"example": "1.1"
},
"event": {
"type": "string",
"description": "event",
"example": "task:new"
},
"metaDataType": {
"type": "string",
"description": "metaDataType",
"example": "string"
},
"metaData": {
"type": "string",
"description": "metaData",
"example": "origin"
},
"limit": {
"type": "integer",
"description": "limit",
"format": "int32",
"example": 30
},
"lookBackDurationType": {
"type": "string",
"description": "lookBackDurationType",
"example": "days"
},
"lookBackPeriod": {
"type": "integer",
"description": "lookBackPeriod",
"format": "int32",
"example": 10
},
"aggregationMode": {
"type": "string",
"description": "aggregationMode",
"example": "Count"
},
"verbose": {
"type": "boolean",
"description": "verbose",
"example": true
},
"widgetAttributes": {
"$ref": "#/components/schemas/WidgetAttributesResponseModel"
},
"rules": {
"$ref": "#/components/schemas/RulesDocument"
}
},
"description": "Attributes under an ProfileViewTemplate"
},
"TemplateResponseModel": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"description": "Created Timestamp",
"example": "2022-10-18T04:21:34.124Z"
},
"createdBy": {
"type": "string",
"description": "Created By",
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
},
"updatedAt": {
"type": "string",
"description": "Updated Timestamp",
"example": "2022-10-18T04:21:34.124Z"
},
"updatedBy": {
"type": "string",
"description": "Updated By",
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
},
"id": {
"type": "string",
"description": "Profile View Template Id",
"example": "638505f32332c8200dac025e"
},
"name": {
"type": "string",
"description": "Template Name",
"example": "sample-template"
},
"workspaceId": {
"type": "string",
"description": "Workspace Id",
"example": "Customer-Journey-Widget"
},
"organizationId": {
"type": "string",
"description": "Organization Id",
"example": "Demo Assure"
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProfileViewAttributeResponseModel"
}
}
},
"description": "Template Response Model"
},
"WidgetAttributesResponseModel": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "type",
"example": "table"
}
},
"description": " WidgetAttributes",
"example": {
"type": "table"
}
},
"ProfileGetResponse": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/BaseMetaResponseEnvelope"
},
"data": {
"type": "array",
"description": "Data part of the response",
"items": {
"$ref": "#/components/schemas/TemplateResponseModel"
}
}
}
},
"JourneyActionTriggerHistory": {
"required": [
"actionId",
"doNotDisturbPeriod",
"triggeredAt"
],
"type": "object",
"properties": {
"actionId": {
"type": "string",
"description": "Action Id",
"example": "3489032dsfhsdf34"
},
"triggeredAt": {
"type": "string",
"description": "Triggered Date",
"format": "date-time",
"example": "2022-10-18T04:21:34.124Z"
},
"doNotDisturbPeriod": {
"type": "string",
"description": "Do Not Disturb Period",
"example": "10"
}
}
},
"ProfileViewSystemMetadata": {
"type": "object",
"properties": {
"journeyActionTriggerHistories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JourneyActionTriggerHistory"
}
}
},
"description": "ProfileViewSystemMetdata"
},
"ProgressiveProfileViewAttributes": {
"type": "object",
"properties": {
"queryTemplate": {
"$ref": "#/components/schemas/ProfileViewAttributeResponseModel"
},
"result": {
"type": "string",
"description": "Result Object",
"example": "\"{\"success\"}\""
},
"error": {
"type": "string",
"description": "Error data",
"example": "failed"
},
"journeyEvents": {
"type": "array",
"description": "Journey Events",
"example": [
"testEvent"
],
"items": {
"type": "string"
}
}
}
},
"ProgressiveProfileViewMetaDataModel": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "Organization ID",
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
},
"workspaceId": {
"type": "string",
"description": "Workspace ID",
"example": "ad72cae0e10f-417f-9974-417f-ad72cae0e10f"
},
"personId": {
"type": "string",
"description": "personId",
"example": "642f1c56276e305287405167"
},
"templateId": {
"type": "string",
"description": "templateId",
"example": "922f1c56276e305287405162"
}
}
},
"ProgressiveProfileViewModel": {
"required": [
"organizationId",
"personId",
"templateId",
"workspaceId"
],
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"description": "Workspace ID",
"example": "9ab65fdf-9643-417f-9974-ad72cae0e10f"
},
"organizationId": {
"type": "string",
"description": "Organization ID",
"example": "9ab65fdf-9643-417f-9974-ad72cae0e10f"
},
"personId": {
"type": "string",
"description": "Person ID",
"example": "6ab65fdf12833j3iu"
},
"templateId": {
"type": "string",
"description": "Template ID",
"example": "9ab65fdfcae0e10f"
},
"searchFilter": {
"type": "string",
"description": "search Filter",
"example": "9ab65fdfcae0e10f"
},
"attributes": {
"type": "array",
"description": "Attributes",
"items": {
"$ref": "#/components/schemas/ProgressiveProfileViewAttributes"
}
},
"systemMetdata": {
"$ref": "#/components/schemas/ProfileViewSystemMetadata"
},
"timestamp": {
"type": "string",
"description": "TimeStamp",
"example": "9ab65fdfcae0e10f"
}
},
"description": "Create Or Update Progressive Profile View"
},
"ProgressiveProfileViewStreamModel": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/ProgressiveProfileViewMetaDataModel"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgressiveProfileViewModel"
}
}
}
},
"JourneyEventStreamMetaDataModel": {
"type": "object",
"properties": {
"organizationId": {
"type": "string",
"description": "Organization ID",
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
},
"workspaceId": {
"type": "string",
"description": "Workspace ID",
"example": "ad72cae0e10f-417f-9974-417f-ad72cae0e10f"
},
"resultCount": {
"type": "integer",
"description": "Result Count",
"format": "int32",
"example": 10
},
"identity": {
"type": "string",
"description": "identity",
"example": "ram@cisco.com"
}
}
},
"JourneyEventStreamModel": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/JourneyEventStreamMetaDataModel"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JourneyCloudEventModel"
}
}
}
},
"WXCCSubscriptionResponseList": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/BaseMetaResponseEnvelope"
},
"data": {
"type": "array",
"description": "Data part of the response",
"items": {
"$ref": "#/components/schemas/WXCCSubscriptionResponseModel"
}
}
}
},
"WXCCSubscriptionResponseModel": {
"required": [
"createdTime",
"description",
"destinationUrl",
"eventTypes",
"id",
"lastUpdatedTime",
"name",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Subscription ID",
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
},
"name": {
"type": "string",
"description": "Subscription Name",
"example": "CareHybrid WXCC Subscription"
},
"description": {
"type": "string",
"description": "Subscription Description",
"example": "This is for carehybrid subscription"
},
"eventTypes": {
"type": "array",
"description": "Event Types to be subscribed",
"example": [
"task:*",
"agent:*"
],
"items": {
"type": "string"
}
},
"destinationUrl": {
"type": "string",
"description": "Destination URL",
"example": "https://uswest-nonprod.cjaas.cisco.com/events/v1/journey/wxcc-callback"
},
"createdTime": {
"type": "integer",
"description": "Created Time",
"format": "int64",
"example": 1669165699
},
"status": {
"type": "string",
"description": "Status",
"example": "active"
},
"lastUpdatedTime": {
"type": "integer",
"description": "Last Updated Time",
"format": "int64",
"example": 1669165699
}
},
"description": "WXCC Subscription Response Model"
},
"JourneyActionConfigurationUpsertRequestModel": {
"required": [
"name",
"rules"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name",
"example": "sample-action"
},
"cooldownPeriodInMinutes": {
"type": "integer",
"description": "Cooldown Period In Minutes",
"format": "int32",
"example": 10
},
"rules": {
"$ref": "#/components/schemas/Rules"
},
"actionTriggers": {
"type": "array",
"example": [
{
"type": "Webhook",
"webhookURL": "https://hooks.us.webexconnect.io/events/6M347NJ6",
"attributes": {
"httpverb": "post",
"requestbody": "{\"SMS\":\"12263762551\",\"callID\":\"\",\"MessageToSend\":\"Hello there!\"}"
}
}
],
"items": {
"$ref": "#/components/schemas/JourneyActionTriggerConfig"
}
},
"isActive": {
"type": "boolean",
"description": "Is Journey Action Configuration Active",
"example": true
}
},
"description": "Create a new, or Update and existing Journey Action"
},
"JourneyActionTriggerConfig": {
"required": [
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type",
"example": "Webhook"
}
}
},
"JourneyActionConfigResponseModel": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"description": "Created Timestamp",
"example": "2022-10-18T04:21:34.124Z"
},
"createdBy": {
"type": "string",
"description": "Created By",
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
},
"updatedAt": {
"type": "string",
"description": "Updated Timestamp",
"example": "2022-10-18T04:21:34.124Z"
},
"updatedBy": {
"type": "string",
"description": "Updated By",
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
},
"id": {
"type": "string",
"description": "Journey Action Id",
"example": "638505f32332c8200dac025e"
},
"name": {
"type": "string",
"description": "Journey Action Name",
"example": "sample-action"
},
"organizationId": {
"type": "string",
"description": "Organization Id",
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
},
"workspaceId": {
"type": "string",
"description": "Workspace Id",
"example": "6384d9021f6a5331f6cc4cf9"
},
"isActive": {
"type": "boolean",
"description": "Is Journey Action Configuration Active",
"example": true
},
"templateId": {
"type": "string",
"description": "Profile View Template ID",
"example": "637e72bc474c2a5b5f0eeeer"
},
"cooldownPeriodInMinutes": {
"type": "integer",
"description": "Cooldown Period In Minutes",
"format": "int32",
"example": 10
},
"rules": {
"$ref": "#/components/schemas/RulesDocument"
},
"actionTriggers": {
"type": "array",
"example": [
{
"type": "Webhook",
"webhookURL": "https://hooks.us.webexconnect.io/events/6M347NJ6",
"attributes": {
"httpverb": "post",
"requestbody": "{\"SMS\":\"12263762551\",\"callID\":\"\",\"MessageToSend\":\"Hello there!\"}"
}
}
],
"items": {
"$ref": "#/components/schemas/JourneyActionTriggerConfig"
}
}
},
"description": "Journey Action Configuration Response Model"
},
"JourneyActionResponse": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/BaseMetaResponseEnvelope"
},
"data": {
"$ref": "#/components/schemas/JourneyActionConfigResponseModel"
}
}
},
"JourneyActionGetResponse": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/BaseMetaResponseEnvelope"
},
"data": {
"type": "array",
"description": "Data part of the response",
"items": {
"$ref": "#/components/schemas/JourneyActionConfigResponseModel"
}
}
}
},
"WorkspaceRequestModel": {
"required": [
"description",
"name"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Workspace Name",
"example": "Customer-Journey-Widget"
},
"description": {
"type": "string",
"description": "Workspace Description",
"example": "This is for sandbox environment"
}
},
"description": "Create or Update Workspace of an organization"
},
"WorkspaceResponse": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/BaseMetaResponseEnvelope"
},
"data": {
"$ref": "#/components/schemas/WorkspaceResponseModel"
}
}
},
"WorkspaceResponseModel": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Workspace ID",
"example": "99ab6909-f982-410d-9e2f-16971d18ae24"
},
"name": {
"type": "string",
"description": "Workspace Name",
"example": "Customer-Journey-Widget"
},
"description": {
"type": "string",
"description": "Workspace Description",
"example": "This is for sandbox1 environment"
},
"wxccSubscriptionIds": {
"type": "array",
"description": "List of Wxcc Subscription Ids",
"example": [
"task:new",
"agent:login"
],
"items": {
"type": "string"
}
}
},
"description": "Workspace under an organization"
},
"GeneralSettingsModel": {
"type": "object",
"properties": {
"dataRetentionDays": {
"type": "integer",
"description": "Data Retention Days",
"format": "int32",
"example": 365
}
},
"description": "Create Or Update Organization General Settings"
},
"OrganizationSettingsModel": {
"type": "object",
"properties": {
"general": {
"$ref": "#/components/schemas/GeneralSettingsModel"
},
"webex": {
"$ref": "#/components/schemas/WebexSettingsModel"
}
},
"description": "Create Or Update Organization Settings"
},
"WebexSettingsModel": {
"type": "object",
"properties": {
"env": {
"type": "string",
"description": "Webex Environment Name",
"example": "qaus1"
}
},
"description": "Create Or Update Organization Webex Settings"
},
"OrganizationResponseModel": {
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"description": "Created Timestamp",
"example": "2022-10-18T04:21:34.124Z"
},
"createdBy": {
"type": "string",
"description": "Created By",
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
},
"updatedAt": {
"type": "string",
"description": "Updated Timestamp",
"example": "2022-10-18T04:21:34.124Z"
},
"updatedBy": {
"type": "string",
"description": "Updated By",
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
},
"organizationId": {
"type": "string",
"description": "Organization ID",
"example": "1eb65fdf-9643-417f-9974-ad72cae0e10f"
},
"name": {
"type": "string",
"description": "Organization Name",
"example": "Demo Assure"
},
"isActive": {
"type": "boolean",
"description": "Is An Organization Active",
"example": true
},
"workspaces": {
"type": "array",
"description": "Workspaces",
"items": {
"$ref": "#/components/schemas/WorkspaceResponseModel"
}
},
"enabledFeatureIds": {
"type": "array",
"description": "Enabled Feature Ids",
"example": [
"63d2d13e9544747f22f391cf5"
],
"items": {
"type": "string"
}
},
"settings": {
"$ref": "#/components/schemas/OrganizationSettingsModel"
}
},
"description": "Organization Response Model"
},
"OrganizationResponse": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/BaseMetaResponseEnvelope"
},
"data": {
"$ref": "#/components/schemas/OrganizationResponseModel"
}
}
},
"WorkspaceResponseList": {
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/BaseMetaResponseEnvelope"
},
"data": {
"type": "array",
"description": "Data part of the response",
"items": {
"$ref": "#/components/schemas/WorkspaceResponseModel"
}
}
}
},
"StartCampaignRequest": {
"required": [
"id",
"vendorVersion",
"campaignType",
"dialingRate",
"entryPointId",
"dialingListFetchURL",
"outdialANI",
"recordCount"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id represents the unique id with which the Campaign Request will be started, maximum length 64 characters.",
"example": "SalesCampaign_Prog"
},
"vendorVersion": {
"type": "string",
"description": "Vendor specific information, maximum length 32 characters.",
"example": "myCampaignManager"
},
"campaignType": {
"type": "string",
"description": "Type of campaign and campaignType should be one of \"progressive\", \"campaign\", \"predictive\", \"progressive_ivr\", \"predictive_ivr\" , \"preview_standard\", \"preview_direct\" ",
"example": "Progressive"
},
"campaignName": {
"type": "string",
"description": "(Optional) Used if different than id, maximum length 64 characters.",
"example": "campaign1"
},
"authToken": {
"type": "string",
"description": "(Not in use) The token needed by the dialer for querying records.",
"example": "Bearer "
},
"dialingRate": {
"type": "number",
"format": "float",
"description": "Number of contacts to be dialed out per available Agent. For Progressive 1:1 Dialer, it will support for only 1 contact and for Progressive 1:N Dialer it can support upto 10 contacts to be dialed out per available Agent",
"example": 1
},
"entryPointId": {
"type": "string",
"description": "Webex Contact Center outdial entry point, maximum length 36 characters.",
"example": "510d198d-7aa7-4b75-a5ff-e61759f4f313"
},
"dialingListFetchURL": {
"type": "string",
"description": "URL the dialer will use to fetch the list of contacts to dial for the campaign from campaign manager, maximum length 1024 characters.",
"example": "campaignMgr/v1//dialinglist/"
},
"outdialANI": {
"type": "string",
"description": "The ANI (E164) that will be presented to the customer. These must be restricted to the configured outdial Eps in Webex Contact Center, maximum length 50 characters.",
"example": "9784330011"
},
"recordCount": {
"type": "integer",
"description": "Value to indicate the recordCount the Campaign Manager expects the dialer to be able to request, the maximum is 400. If the value is greater than 400 it will be set to the maximum when the request is processed.",
"example": 50
},
"noAnswerRingLimit": {
"type": "integer",
"description": "(Optional) Number of seconds before a dialed call from the dialer is considered not answered, The range is from 16 to 80, default is 32. This field is not applicable for Direct preview campaigns.",
"example": 32
},
"maxDialingRate": {
"type": "number",
"format": "float",
"description": "Caps the maximum dialing rate per agent at this value. The range is from 1.0 to 10.0 , default is 1.0.",
"example": 10
},
"abandonRatePercentage": {
"type": "number",
"format": "float",
"description": "The percentage of calls that are allowed to be abandoned. The range is from 1.0 to 100.0 with a granularity of 0.1. The Default is 3.0",
"example": 3
},
"predictiveCorrectionPace": {
"type": "integer",
"description": "A count of the number of live voice connections that must occur before the dialer adjusts. Increasing this number results in less frequent adjustments based on a larger sample size. The range is from 10 to 5000 , default is 70.",
"example": 70
},
"predictiveGain": {
"type": "number",
"format": "float",
"description": "The size of the adjustment to lines per agent each time an adjustment is made. Increasing this number results in larger per-agent adjustments. The range is 0.1 to 3.0 , default is 1.0.",
"example": 2
},
"reservationPercentage": {
"type": "integer",
"description": "(Not in use) The percentage of agents to reserve within the queue associated with the campaign. The range is from 0 to 100 , default is 100",
"example": 50
},
"callProgressAnalysisParams": {
"$ref": "#/components/schemas/CallProgressAnalysisParamsRequest"
},
"ivrPorts": {
"type": "integer",
"description": "The number of IVR ports to use for this campaign. IVR ports are in use when calling a customer until the call is either ended or transferred to an agent. One IVR port can be considered equivalent to an agent in an agent based campaign.The range is from 1 to 1000.",
"example": 10
},
"previewOfferTimeout": {
"type": "integer",
"description": "(Required if previewOfferTimeoutAutoAction is provided, optional otherwise) The number of seconds dialer waits for an agent to act on a preview campaign record, before performing the provided previewOfferTimeoutAutoAction. The range is from 0 to 7200(2 hours) for ACCEPT auto-action and 10 to 7200(2 hours) for other auto-actions. The default is 600(10 minutes).",
"example": 300
},
"previewOfferTimeoutAutoAction": {
"type": "string",
"description": "(Required if previewOfferTimeout is provided, optional otherwise) The automatic action to be performed after the previewOfferTimeout duration has elapsed, if agent takes no action on the preview campaign record offered. Should be one of \"ACCEPT\", \"SKIP\", \"REMOVE\". The default is \"SKIP\".",
"example": "ACCEPT"
},
"previewActionsDisabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "(Optional) The list of preview actions to be disabled for the agent when a preview campaign record is offered. Can be empty if no action should be disabled, otherwise should be one of \"SKIP\", \"REMOVE\" or both. The default is an empty list",
"example": "[\"SKIP\", \"REMOVE\"]"
},
"validCampaignTimes": {
"$ref": "#/components/schemas/ValidCampaignTimes"
}
}
},
"CallProgressAnalysisParamsRequest": {
"type": "object",
"description": "(Optional) Call Progressive Params details. This is used for Progressive 1:N Dialer.",
"properties": {
"cpaEnabled": {
"type": "boolean",
"description": "(Optional) Determines if CPA should execute the campaign, default is false.",
"example": true
},
"amdEnabled": {
"type": "boolean",
"description": "(Optional) Determines if CPA should enable answering machine detection algorithm. cpaEnabled must be true when amdEnabled is set to true, default is false.",
"example": true
},
"minSilencePeriod": {
"type": "integer",
"description": "(Optional) The minimum silence period (in ms) is required to classify a call as voice detected. The range is from 100 to 1000, default is 608.",
"example": 608
},
"analysisPeriod": {
"type": "integer",
"description": "(Optional) The number of ms spent analyzing the call. The range is 1000 to 10000, default is 1000.",
"example": 1000
},
"minimumValidSpeech": {
"type": "integer",
"description": "(Optional) The minimum number of ms of voice required to classify a call as voice detected. The range is from 50 to 500, default is 112.",
"example": 112
},
"maxTimeAnalysis": {
"type": "integer",
"description": "(Optional) The maximum number of ms allowed for analysis before identifying a problem as dead air. The range is from 1000 to 10000, default is 3000.",
"example": 3000
},
"maxTermToneAnalysis": {
"type": "integer",
"description": "(Optional) The maximum number of ms the dialer analyzes an answering machine voice message looking for a termination tone. The range is 1000 to 60000, default is 30000.",
"example": 30000
},
"terminatingToneDetect": {
"type": "boolean",
"description": "(Optional) Determines if CPA should wait for the terminating tone of a voicemail before concluding. amdEnabled must be true when terminatingToneDetect is set to true, default is false.",
"example": true
}
}
},
"CampaignListResponse": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CampaignURLResponse"
},
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/MetaSubInfo"
}
},
"required": [
"data",
"meta"
],
"type": "object"
},
"CampaignURLResponse": {
"properties": {
"location": {
"description": "Returns the url for performing subsequent campaign updates or campaign stop",
"example": "https://api.wxcc-.cisco.com/v1/dialer/campaign/",
"format": "url",
"type": "string"
}
},
"required": [
"location"
],
"type": "object"
},
"UpdateCampaignRequest": {
"required": [
"dialingRate",
"dialingListFetchURL",
"outdialANI"
],
"type": "object",
"properties": {
"dialingRate": {
"type": "number",
"format": "float",
"description": "Number of contacts to be dialed out per available Agent. For Progressive 1:1 Dialer, it will support for only 1 contact and for Progressive 1:N Dialer it can support upto 10 contacts to be dialed out per available Agent",
"example": 1
},
"campaignName": {
"type": "string",
"description": "(Optional) Used if different than id, maximum length 64 characters.",
"example": "campaign1"
},
"authToken": {
"type": "string",
"description": "(Not in use) The token needed by the dialer for querying records.",
"example": "Bearer "
},
"dialingListFetchURL": {
"type": "string",
"description": "URL the dialer will use to fetch the list of contacts to dial for the campaign from campaign manager, maximum length 1024 characters.",
"example": "campaignMgr/v1//dialinglist/"
},
"outdialANI": {
"type": "string",
"description": "The ANI (E164) that will be presented to the customer. These must be restricted to the configured outdial Eps in Webex Contact Center, maximum length 50 characters.",
"example": "9784330011"
},
"noAnswerRingLimit": {
"type": "integer",
"description": "(Optional) Number of seconds before a dialed call from the dialer is considered not answered. The range is from 16 to 80, default is 32. This field is not applicable for Direct preview campaigns.",
"example": 32
},
"maxDialingRate": {
"type": "number",
"format": "float",
"description": "Caps the maximum dialing rate per agent at this value. The range is from 1.0 to 10.0, default is 1.0.",
"example": 10
},
"reservationPercentage": {
"type": "integer",
"description": "(Not in use) The percentage of agents to reserve within the queue associated with the campaign. The range is from 0 to 100 , default is 100.",
"example": 50
},
"previewOfferTimeout": {
"type": "integer",
"description": "(Required only if previewOfferTimeoutAutoAction is provided) The number of seconds dialer waits for an agent to act on a preview campaign record, before performing the provided previewOfferTimeoutAutoAction. The range is from 0 to 7200 seconds(2 hours) for ACCEPT auto-action, and from 10 to 7200 seconds(2 hours) for other auto-actions. The default value is 600 seconds(10 minutes).",
"example": 300
},
"previewOfferTimeoutAutoAction": {
"type": "string",
"description": "(Required only if previewOfferTimeout is provided) The automatic action to be performed after the previewOfferTimeout duration has elapsed, if agent takes no action on the preview campaign record offered. The action can be \"ACCEPT\", \"SKIP\" or \"REMOVE\". The default action is \"SKIP\".",
"example": "ACCEPT"
},
"previewActionsDisabled": {
"type": "array",
"items": {
"type": "string"
},
"description": "(Optional) The list of preview actions to be disabled for the agent when a preview campaign record is offered. The list can be empty if no action should be disabled, otherwise it can be either \"SKIP\" or \"REMOVE\" or both. The default is an empty list",
"example": "[\"SKIP\", \"REMOVE\"]"
},
"validCampaignTimes": {
"$ref": "#/components/schemas/ValidCampaignTimes"
}
}
},
"ShiftTime": {
"type": "object",
"required": [
"start",
"end"
],
"properties": {
"start": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$",
"description": "The start time of the shift in 24-hour format (HH:MM). Must be earlier than the end time.",
"example": "09:00"
},
"end": {
"type": "string",
"pattern": "^([0-1][0-9]|2[0-3]):[0-5][0-9]$",
"description": "The end time of the shift in 24-hour format (HH:MM). Must be later than the start time.",
"example": "17:00"
}
}
},
"DateOverride": {
"type": "object",
"required": [
"date",
"shiftTimes"
],
"properties": {
"date": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"description": "The specific date for which the shift schedule should be overridden, in YYYY-MM-DD format.",
"example": "2025-08-15"
},
"shiftTimes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShiftTime"
},
"minItems": 0,
"description": "The list of shift times that apply on this specific date, overriding the weekly schedule. An empty array indicates no shifts are scheduled for this date (e.g., holidays, company closures)."
}
}
},
"WeeklyShiftSchedule": {
"type": "object",
"required": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday",
"saturday",
"sunday"
],
"properties": {
"monday": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShiftTime"
},
"description": "List of shift times for Monday. Can be empty if no shifts are scheduled."
},
"tuesday": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShiftTime"
},
"description": "List of shift times for Tuesday. Can be empty if no shifts are scheduled."
},
"wednesday": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShiftTime"
},
"description": "List of shift times for Wednesday. Can be empty if no shifts are scheduled."
},
"thursday": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShiftTime"
},
"description": "List of shift times for Thursday. Can be empty if no shifts are scheduled."
},
"friday": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShiftTime"
},
"description": "List of shift times for Friday. Can be empty if no shifts are scheduled."
},
"saturday": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShiftTime"
},
"description": "List of shift times for Saturday. Can be empty if no shifts are scheduled."
},
"sunday": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShiftTime"
},
"description": "List of shift times for Sunday. Can be empty if no shifts are scheduled."
}
}
},
"ValidCampaignTimes": {
"type": "object",
"description": "(Optional) Defines the valid operating hours for the campaign based on a weekly schedule and optional date-specific overrides. The campaign will only be active during the specified time windows.",
"required": [
"timeZone",
"weeklySchedule"
],
"properties": {
"timeZone": {
"type": "string",
"description": "The IANA timezone name (e.g., 'America/New_York') that defines the timezone for all shift times in the schedule. This timezone is used to interpret the start and end times in the weekly schedule and date overrides.",
"example": "America/New_York"
},
"weeklySchedule": {
"$ref": "#/components/schemas/WeeklyShiftSchedule",
"description": "The recurring weekly schedule that defines when the campaign should be active. Each day of the week can have multiple shift time ranges."
},
"dateOverrides": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DateOverride"
},
"description": "Optional list of date-specific schedule overrides that take precedence over the weekly schedule for particular dates (e.g., holidays, special events)."
}
},
"example": {
"timeZone": "America/New_York",
"weeklySchedule": {
"monday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"tuesday": [
{
"start": "09:00",
"end": "17:00"
}
],
"wednesday": [
{
"start": "10:00",
"end": "14:00"
}
],
"thursday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"friday": [
{
"start": "09:00",
"end": "12:00"
}
],
"saturday": [
{
"start": "10:00",
"end": "15:00"
}
],
"sunday": []
},
"dateOverrides": [
{
"date": "2025-08-15",
"shiftTimes": [
{
"start": "11:00",
"end": "16:00"
}
]
}
]
}
},
"RecordingBodyParams": {
"required": [
"query"
],
"type": "object",
"properties": {
"query": {
"$ref": "#/components/schemas/RecordingQuery"
}
}
},
"RecordingQuery": {
"required": [
"taskIds"
],
"type": "object",
"properties": {
"orgId": {
"type": "string",
"description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization.",
"example": "8e18afdf-db79-449b-b4f5-ee4f14d9f45e"
},
"urlExpiration": {
"maximum": 60,
"type": "integer",
"description": "Expiration time of returned s3 url (in minutes).",
"format": "int32",
"example": 30
},
"taskIds": {
"maxItems": 10,
"uniqueItems": true,
"type": "array",
"description": "Comma separated list of taskIds to gather captures for. Maximum number of taskIds allowed are 10",
"example": [
"8e18afdf-db79-449b-b4f5-ee4f14d9f45e"
],
"items": {
"type": "string",
"format": "uuid"
}
},
"includeSegments": {
"type": "boolean",
"description": "Flag; (true) for individual capture segments of main recording, (false) for a stitched capture.",
"example": true
},
"includeVARecordings": {
"type": "boolean",
"description": "Flag; (true) for including virtual agent (VA) recordings, (false) for excluding virtual agent recordings. The default value is false.",
"example": false
},
"includeScreenRecordings": {
"type": "boolean",
"description": "Flag; (true) will return screen recording if available else will return empty array, (false) will exclude screen recordings. The default value is false.",
"example": false
},
"includeAllDigitalVersions": {
"type": "boolean",
"description": "Flag; (true) returns all available digital transcript artifacts for each requested task, including both legacy and schema-versioned digital transcript artifacts when both exist. (false) or omitted returns the default Captures behavior. This field applies only to digital transcript artifacts and does not change recording or voice transcript retrieval.",
"example": true
}
}
},
"DownloadMultipleInteractionsResponse": {
"required": [
"data",
"meta"
],
"type": "object",
"properties": {
"meta": {
"$ref": "#/components/schemas/RecordingMetaData"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MultipleInteractionsRecording"
}
}
}
},
"RecordingMetaData": {
"type": "object",
"properties": {
"orgId": {
"type": "string",
"description": "Organization ID used for this operation.",
"format": "uuid",
"example": "f1b130da-0cad-4d8b-91dd-7a3085440e89"
},
"urlExpiration": {
"type": "integer",
"description": "Number of minutes (from now) when the signed url expires.",
"format": "int32",
"example": 30
}
}
},
"MultipleInteractionsRecording": {
"required": [
"recording",
"transcription"
],
"type": "object",
"properties": {
"taskId": {
"type": "string",
"description": "The ID of the task.",
"format": "uuid",
"example": "e890a591-63f0-4984-a8f2-00e631368fb4"
},
"recording": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RecordingMulti"
}
},
"transcription": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TranscriptMulti"
}
},
"screenRecordings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ScreenRecordingMulti"
}
}
}
},
"RecordingMulti": {
"required": [
"attributes"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the recording.",
"example": "f1b130da-0cad-4d8b-91dd-7a3085440e89"
},
"segment": {
"type": "boolean",
"description": "Flag; Indicates if this is the entire recording or only a segment of main recording. This flag will be always false for consult callType.",
"example": true
},
"attributes": {
"$ref": "#/components/schemas/RecordingAttributes"
}
}
},
"RecordingAttributes": {
"type": "object",
"properties": {
"fileName": {
"type": "string",
"description": "The file name of the recording.",
"example": "recording-1.wav"
},
"filePath": {
"type": "string",
"description": "Capture download url.",
"example": "https://cjp-ccone-devus1-media-storage-recording.s3.amazonaws.com/9e4895c9-787b-4615-b15f-f1b3b12c3091/"
},
"startTime": {
"type": "integer",
"description": "Begin time of capture(epoch timestamp)",
"format": "int64",
"example": 1617373126000
},
"stopTime": {
"type": "integer",
"description": "End time of capture(epoch timestamp).",
"format": "int64",
"example": 1627373126000
},
"participants": {
"type": "array",
"description": "Comma separated list of CI user Id (UUID) of agents, masked customer contact email/phone details and virtual agent id if any involved in the recording.",
"example": [
"e890a591-63f0-4984-a8f2-00e631368fb4",
"+121****1219"
],
"items": {
"type": "string"
}
},
"channel1": {
"type": "string",
"description": "Caller - channel contains caller audio only, Agent - channel contains agent audio only for main call and its segments, VA - channel contains virtual agent audio only.",
"example": "Caller|Agent|VA"
},
"channel2": {
"type": "string",
"description": "Agent if callType is consult. For main callType, Agent/Caller/VA/Others based on number of participants.",
"example": "Caller|Agent|VA|Others"
},
"callType": {
"type": "string",
"description": "main if recording belongs to main call; consult if recording belongs to consult call; va-main if recording belongs to virtual agent in main call; va-consult if recording belongs to virtual agent in consult call.",
"example": "main|consult|va-main|va-consult"
},
"sensitive": {
"type": "boolean",
"description": "Applicable only to virtual agent recordings. Flag; (true) indicates the virtual agent recording may contain sensitive information, (false) otherwise.",
"example": true
}
}
},
"TranscriptMulti": {
"type": "object",
"properties": {
"Source": {
"type": "string",
"description": "Source of the transcription",
"example": "recording|realtime-voice|chat|sms|{{ channel name }}|{{ channel name }} etc."
},
"Provider": {
"type": "string",
"description": "Provider of the generated transcription",
"example": "CISCO"
},
"id": {
"type": "string",
"description": "Voice Channel Transcript: Ccai ConfigId, Digital Channel Transcript: Conversation Id",
"example": "cfg-id-101|CSRKT4K37D9OM2567"
},
"fileName": {
"type": "string",
"description": "The file name of the transcript.",
"example": "voiceTranscript.json|emailTranscript.json|facebookTranscript.json etc."
},
"filePath": {
"type": "string",
"description": "Capture download url. Please refer [Transcript Details Guide](/docs/digital-transcript-json-details) for more details.",
"example": "https://cjp-ccone-devus1-media-storage-recording.s3.amazonaws.com/9e4895c9-787b-4615-b15f-f1b3b12c3091/"
},
"startTime": {
"type": "string",
"description": "Begin time of capture(epoch timestamp)",
"example": "1617373126000"
},
"languageCode": {
"type": "string",
"description": "Language of the transcript",
"example": "en-US"
},
"createTime": {
"type": "string",
"description": "Create time of capture(epoch timestamp)",
"example": "1617373126000"
}
}
},
"ScreenRecordingMulti": {
"required": [
"id",
"attributes"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The ID of the screen recording.",
"example": "f13b9c64-0d72-4e8a-b5f1-9a6d3c2e7b15"
},
"attributes": {
"$ref": "#/components/schemas/ScreenRecordingAttributes"
}
}
},
"ScreenRecordingAttributes": {
"required": [
"fileName",
"filePath",
"startTime",
"stopTime",
"agentId",
"screenId"
],
"type": "object",
"properties": {
"fileName": {
"type": "string",
"description": "The file name of the screen recording.",
"example": "3305322a-630c-4791-a068-4a751529c4d7-segment.wav"
},
"filePath": {
"type": "string",
"description": "Screen recording download URL.",
"example": "https://cjp-ccone-intgus1-media-storage-recording.s3.amazonaws.com/470c589d-ce3f-4afe-adec-575c73c0e472"
},
"startTime": {
"type": "integer",
"description": "Begin time of screen recording (epoch timestamp)",
"format": "int64",
"example": 1617373126000
},
"stopTime": {
"type": "integer",
"description": "End time of screen recording (epoch timestamp).",
"format": "int64",
"example": 1627373126000
},
"agentId": {
"type": "string",
"description": "The ID of the agent whose screen was recorded.",
"example": "e890a591-63f0-4984-a8f2-00e631368fb4"
},
"screenId": {
"type": "string",
"description": "The ID of the screen being recorded.",
"example": "2e8f4a19-7b35-4c6d-93a1-d5f0b7c2e855"
}
}
},
"DncEntryRequest": {
"type": "object",
"required": [
"phoneNumber",
"source"
],
"properties": {
"phoneNumber": {
"type": "string",
"pattern": "^\\+[1-9]\\d{1,14}$",
"description": "The phone number to add to the DNC list. Must be in E.164 format (e.g., +1234567890).",
"example": "+1234567890"
},
"source": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The source or origin of the DNC entry. This helps track where the request originated from.",
"example": "customer-request"
},
"reason": {
"type": "string",
"maxLength": 500,
"description": "Optional reason for adding the phone number to the DNC list. This can help with compliance documentation.",
"example": "Customer requested to be removed from all marketing calls"
}
},
"example": {
"phoneNumber": "+1234567890",
"source": "customer-request",
"reason": "Customer opted out via email"
}
},
"DncEntryResponse": {
"type": "object",
"properties": {
"phoneNumber": {
"type": "string",
"pattern": "^\\+[1-9]\\d{1,14}$",
"description": "The phone number in the DNC list, in E.164 format.",
"example": "+1234567890"
},
"source": {
"type": "string",
"description": "The source or origin of the DNC entry.",
"example": "customer-request"
},
"addedDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the phone number was added to the DNC list.",
"example": "2024-01-15T10:30:00Z"
},
"addedBy": {
"type": "string",
"description": "The user or system that added the phone number to the DNC list.",
"example": "admin@example.com"
},
"reason": {
"type": "string",
"description": "The reason for adding the phone number to the DNC list, if provided.",
"example": "Customer opted out via phone"
},
"lastModified": {
"type": "string",
"format": "date-time",
"description": "The date and time when the DNC entry was last modified.",
"example": "2024-01-15T10:30:00Z"
}
},
"example": {
"phoneNumber": "+1234567890",
"source": "customer-request",
"addedDate": "2024-01-15T10:30:00Z",
"addedBy": "admin@example.com",
"reason": "Customer opted out via phone",
"lastModified": "2024-01-15T10:30:00Z"
}
},
"BadRequestError": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "integer",
"description": "Application error code for the bad request.",
"example": 1001
},
"message": {
"type": "string",
"description": "A detailed error message explaining what went wrong with the request.",
"example": "Invalid pageSize. Allowed range is 1 to 100."
},
"trackingId": {
"type": "string",
"description": "A unique identifier for this error that can be used for debugging purposes.",
"example": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f594b"
}
},
"example": {
"code": 1001,
"message": "Invalid pageSize. Allowed range is 1 to 100.",
"trackingId": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f594b"
}
},
"UnauthorizedError": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "integer",
"enum": [
401
],
"description": "HTTP status code for Unauthorized.",
"example": 401
},
"message": {
"type": "string",
"description": "A detailed error message explaining the authentication failure.",
"example": "Invalid or expired access token."
},
"trackingId": {
"type": "string",
"description": "A unique identifier for this error that can be used for debugging purposes.",
"example": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f591"
}
},
"example": {
"code": 401,
"message": "Invalid or expired access token.",
"trackingId": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f591"
}
},
"ForbiddenError": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "integer",
"enum": [
403
],
"description": "HTTP status code for Forbidden.",
"example": 403
},
"message": {
"type": "string",
"description": "A detailed error message explaining the authorization failure.",
"example": "Feature is not enabled for this organization."
},
"trackingId": {
"type": "string",
"description": "A unique identifier for this error that can be used for debugging purposes.",
"example": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f592"
}
},
"example": {
"code": 403,
"message": "Feature is not enabled for this organization.",
"trackingId": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f592"
}
},
"NotFoundError": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "integer",
"description": "Application error code indicating resource not found.",
"example": 1004
},
"message": {
"type": "string",
"description": "A detailed error message explaining what resource was not found.",
"example": "Campaign group 'Carshield_25May2026' not found."
},
"trackingId": {
"type": "string",
"description": "A unique identifier for this error that can be used for debugging purposes.",
"example": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f593"
}
},
"example": {
"code": 1004,
"message": "Campaign group 'Carshield_25May2026' not found.",
"trackingId": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f593"
}
},
"ConflictError": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "integer",
"enum": [
409
],
"description": "HTTP status code for Conflict.",
"example": 409
},
"message": {
"type": "string",
"description": "A detailed error message explaining the conflict.",
"example": "Phone number +1234567890 already exists in DNC list 'corporate-dnc-list'"
},
"trackingId": {
"type": "string",
"description": "A unique identifier for this error that can be used for debugging purposes.",
"example": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f594"
}
},
"example": {
"code": 409,
"message": "Phone number +1234567890 already exists in DNC list 'corporate-dnc-list'",
"trackingId": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f594"
}
},
"TooManyRequestsError": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "integer",
"enum": [
429
],
"description": "HTTP status code for Too Many Requests.",
"example": 429
},
"message": {
"type": "string",
"description": "A detailed error message explaining the rate limit.",
"example": "Too many requests. Rate limit exceeded."
},
"trackingId": {
"type": "string",
"description": "A unique identifier for this error that can be used for debugging purposes.",
"example": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f595"
}
},
"example": {
"code": 429,
"message": "Too many requests. Rate limit exceeded.",
"trackingId": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f595"
}
},
"InternalServerError": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "integer",
"description": "Application error code for the internal server error.",
"example": 1006
},
"message": {
"type": "string",
"description": "A detailed error message explaining the server error.",
"example": "An unexpected error occurred while processing your request."
},
"trackingId": {
"type": "string",
"description": "A unique identifier for this error that can be used for debugging purposes. Include this when contacting support.",
"example": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f596"
}
},
"example": {
"code": 1006,
"message": "An unexpected error occurred while processing your request.",
"trackingId": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f596"
}
},
"BadGatewayError": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "integer",
"enum": [
502
],
"description": "HTTP status code for Bad Gateway.",
"example": 502
},
"message": {
"type": "string",
"description": "A detailed error message explaining the gateway error.",
"example": "The server received an invalid response from an upstream server."
},
"trackingId": {
"type": "string",
"description": "A unique identifier for this error that can be used for debugging purposes.",
"example": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f597"
}
},
"example": {
"code": 502,
"message": "The server received an invalid response from an upstream server.",
"trackingId": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f597"
}
},
"ServiceUnavailableError": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "integer",
"enum": [
503
],
"description": "HTTP status code for Service Unavailable.",
"example": 503
},
"message": {
"type": "string",
"description": "A detailed error message explaining the service unavailability.",
"example": "Service is temporarily unavailable. Please try again later."
},
"trackingId": {
"type": "string",
"description": "A unique identifier for this error that can be used for debugging purposes.",
"example": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f598"
}
},
"example": {
"code": 503,
"message": "Service is temporarily unavailable. Please try again later.",
"trackingId": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f598"
}
},
"GatewayTimeoutError": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "integer",
"enum": [
504
],
"description": "HTTP status code for Gateway Timeout.",
"example": 504
},
"message": {
"type": "string",
"description": "A detailed error message explaining the timeout.",
"example": "The server did not receive a timely response from an upstream server."
},
"trackingId": {
"type": "string",
"description": "A unique identifier for this error that can be used for debugging purposes.",
"example": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f599"
}
},
"example": {
"code": 504,
"message": "The server did not receive a timely response from an upstream server.",
"trackingId": "GTWY_e6763c9a-71b2-4515-ad5b-89260f7f599"
}
},
"GetCampaignListResponse": {
"type": "object",
"description": "Response payload for retrieving campaigns within a campaign group, including pagination metadata.",
"required": [
"outcome",
"statusCode",
"campaigns",
"pagination"
],
"example": {
"outcome": "Success",
"statusCode": 0,
"campaigns": [
{
"campaignId": "CCV_1780403367475",
"campaignName": "Auto_Loan_Collection Campaigns",
"campaignGroupName": "Debt_Collection Campaigns",
"channel": "Voice",
"campaignType": "Basic",
"campaignDialingMode": "StandardPreview",
"status": "Running",
"createdTime": "2026-06-02T07:59:27Z",
"lastUpdatedTime": "2026-06-02T07:57:58Z",
"startDate": "2026-06-01",
"endDate": "2026-12-31",
"campaignCreatedBy": "John Smith",
"controlHubChannelEntryPointID": "a62231af-866b-404c-bc74-b8db98b76e6c",
"outdialANI": "+1512345678",
"cpaEnabled": "Yes",
"numberOfSFTPContactLists": 0,
"numberOfAPIContactLists": 10,
"numberOfManualFileContactLists": 2
}
],
"pagination": {
"page": 1,
"pageSize": 10,
"totalCount": 50,
"totalPages": 5
}
},
"properties": {
"outcome": {
"type": "string",
"description": "High-level outcome of the request.",
"example": "Success"
},
"statusCode": {
"type": "integer",
"description": "Application-level status code. `0` indicates success.",
"example": 0
},
"campaigns": {
"type": "array",
"description": "List of campaigns belonging to the campaign group for the requested page.",
"items": {
"$ref": "#/components/schemas/CampaignBasicInfo"
}
},
"pagination": {
"$ref": "#/components/schemas/PaginationInfo"
}
}
},
"CampaignBasicInfo": {
"type": "object",
"description": "Basic information for a campaign within a campaign group.",
"properties": {
"campaignId": {
"type": "string",
"description": "Unique identifier of the campaign.",
"example": "CCV_1779692613096"
},
"campaignName": {
"type": "string",
"description": "Display name of the campaign.",
"example": "Auto_Loan_Collection Campaigns"
},
"campaignGroupName": {
"type": "string",
"description": "Name of the campaign group to which the campaign belongs.",
"example": "Debt_Collection Campaigns"
},
"channel": {
"type": "string",
"description": "Channel through which the campaign is executed.",
"example": "CCVOICE"
},
"campaignType": {
"type": "string",
"description": "Type of campaign configuration.",
"enum": [
"Basic",
"Advanced"
],
"example": "Basic"
},
"campaignDialingMode": {
"type": "string",
"description": "Dialing mode of the campaign.",
"enum": [
"Progressive",
"Predictive",
"ProgressiveIvr",
"PredictiveIvr",
"StandardPreview",
"DirectPreview"
],
"example": "StandardPreview"
},
"status": {
"type": "string",
"description": "Current status of the campaign.",
"enum": [
"Draft",
"Running",
"Pending",
"Paused",
"Completed",
"Ended"
],
"example": "Running"
},
"createdTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the campaign was created (ISO 8601, UTC).",
"example": "2026-05-25T02:33:33Z"
},
"lastUpdatedTime": {
"type": "string",
"description": "Timestamp when the campaign was last updated (ISO 8601, UTC).",
"example": "2026-05-25T02:35:30Z"
},
"startDate": {
"type": "string",
"description": "Campaign schedule start date in `yyyy-MM-dd` format.",
"example": "2026-06-01"
},
"endDate": {
"type": "string",
"description": "Campaign schedule end date in `yyyy-MM-dd` format. Returns `N/A` when the campaign has no configured end date.",
"example": "2026-12-31"
},
"sourceCampaigns": {
"type": "array",
"description": "List of source campaigns in chaining from where the contacts are derived. Omitted from the response when empty.",
"items": {
"type": "string"
}
},
"fieldMapping": {
"type": "string",
"description": "Name of the field mapping associated with the campaign.",
"example": "Auto_Loans_Field_Mapping"
},
"timezone": {
"type": "string",
"description": "Timezone configured for the campaign schedule.",
"example": "UTC - 06:00 / USA / Central Time / Chicago, Dallas, Memphis, Nashville"
},
"scheduleType": {
"type": "string",
"description": "Type of schedule configured for the campaign. `Basic` uses a single daily start/end window; `Advanced` provides per-day windows with named day-of-week entries.",
"enum": [
"Basic",
"Advanced"
],
"example": "Advanced"
},
"scheduleInfo": {
"type": "array",
"nullable": true,
"description": "Schedule windows for the campaign. The shape of each entry depends on `scheduleType`: for `Basic`, entries are simple `startTime`/`endTime` windows; for `Advanced`, entries describe a specific day-of-week with one or more time slots.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ScheduleSlot"
},
{
"$ref": "#/components/schemas/AdvancedScheduleDay"
}
]
}
},
"safeCallingWindow": {
"type": "array",
"description": "Safe-calling windows for the campaign.",
"items": {
"$ref": "#/components/schemas/SafeCallingWindow"
}
},
"contactAttemptsStrategy": {
"description": "Strategy that governs how many times and in what order contacts are attempted. May be null if not configured.",
"allOf": [
{
"$ref": "#/components/schemas/ContactAttemptsStrategy"
}
]
},
"contactFlowPriority": {
"description": "Contact flow priority applied during dialing. Either a `Contact Attribute` priority or a `FreshVsRetry` priority.",
"allOf": [
{
"$ref": "#/components/schemas/ContactFlowPriority"
}
],
"example": {
"priorityBasedOn": "Contact Attribute",
"attributes": [
"Outstanding_Balance"
],
"orderBy": "Descending"
}
},
"campaignCreatedBy": {
"type": "string",
"description": "User or system that created the campaign.",
"example": "John Smith"
},
"controlHubChannelEntryPointID": {
"type": "string",
"format": "uuid",
"description": "Control Hub Channel (a.k.a. Entry Point) associated with the campaign.",
"example": "a62231af-866b-404c-bc74-b8db98b76e6c"
},
"outdialANI": {
"type": "string",
"description": "ANI used for outdial in E.164 format.",
"example": "+1512345678"
},
"dncLists": {
"type": "array",
"description": "DNC lists applied to the campaign.",
"items": {
"type": "string"
},
"example": [
"Auto_Loans_DNC",
"Debt_Collections_DNC"
]
},
"purposeTags": {
"type": "array",
"description": "Purpose tags applied to the campaign.",
"items": {
"type": "string"
},
"example": [
"Debt_Collection",
"AutoLoanCollection"
]
},
"pAndLTag": {
"type": "string",
"description": "P&L tag associated with the campaign.",
"example": "Auto_Loans"
},
"cpaEnabled": {
"type": "string",
"description": "Whether Call Progress Analysis (CPA) is enabled for the campaign.",
"enum": [
"Yes",
"No"
],
"example": "Yes"
},
"numberOfSFTPContactLists": {
"type": "integer",
"description": "Number of SFTP-sourced contact lists associated with the campaign.",
"example": 0
},
"numberOfAPIContactLists": {
"type": "integer",
"description": "Number of API-sourced contact lists associated with the campaign.",
"example": 10
},
"numberOfManualFileContactLists": {
"type": "integer",
"description": "Number of manually uploaded file contact lists associated with the campaign.",
"example": 2
}
}
},
"ContactFlowPriority": {
"type": "object",
"description": "Defines how contacts are prioritized within the dialing flow. The shape of the object varies based on `priorityBasedOn`: `Contact Attribute` uses the `attributes` field; `FreshVsRetry` uses fresh/retry split fields.",
"oneOf": [
{
"$ref": "#/components/schemas/ContactAttributePriority"
},
{
"$ref": "#/components/schemas/FreshVsRetryPriority"
}
]
},
"ContactAttributePriority": {
"type": "object",
"description": "Contact-attribute-based priority. Contacts are ordered by the values of the named attributes.",
"properties": {
"priorityBasedOn": {
"type": "string",
"description": "Discriminator value indicating attribute-based priority.",
"enum": [
"Contact Attribute"
],
"example": "Contact Attribute"
},
"attributes": {
"type": "array",
"description": "Names of the contact attributes used for ordering.",
"items": {
"type": "string"
},
"example": [
"Outstanding_Balance"
]
},
"orderBy": {
"type": "string",
"description": "Sort order applied to the attribute values.",
"enum": [
"Ascending",
"Descending"
],
"example": "Descending"
}
}
},
"FreshVsRetryPriority": {
"type": "object",
"description": "Fresh-versus-retry priority. Splits dialing capacity between brand-new contacts and retry attempts using the configured percentages and ordering.",
"properties": {
"priorityBasedOn": {
"type": "string",
"description": "Discriminator value indicating fresh-versus-retry priority.",
"enum": [
"FreshVsRetry"
],
"example": "FreshVsRetry"
},
"retryPercentage": {
"type": "string",
"description": "Percentage of dialing capacity allocated to retry attempts. Combined with `freshPercentage` should equal 100.",
"example": "45"
},
"retryPriority": {
"type": "string",
"description": "Order in which retry contacts are picked.",
"enum": [
"FIFO",
"LIFO"
],
"example": "LIFO"
},
"freshPercentage": {
"type": "string",
"description": "Percentage of dialing capacity allocated to fresh contacts. Combined with `retryPercentage` should equal 100.",
"example": "55"
},
"freshPriority": {
"type": "string",
"description": "Order in which fresh contacts are picked.",
"enum": [
"FIFO",
"LIFO"
],
"example": "FIFO"
}
}
},
"ScheduleSlot": {
"type": "object",
"description": "Basic schedule slot with a single start and end time, applied to every day the campaign runs.",
"required": [
"startTime",
"endTime"
],
"properties": {
"startTime": {
"type": "string",
"description": "Start time of the schedule slot in HH:mm (24-hour) format.",
"example": "02:00"
},
"endTime": {
"type": "string",
"description": "End time of the schedule slot in HH:mm (24-hour) format.",
"example": "06:00"
}
}
},
"AdvancedScheduleDay": {
"type": "object",
"description": "Advanced schedule entry describing one day of the week and its calling time slots.",
"required": [
"name",
"day",
"slots"
],
"properties": {
"name": {
"type": "string",
"description": "Day-of-week name.",
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"example": "Monday"
},
"day": {
"type": "string",
"description": "Day-of-week index as a string. `1` = Sunday through `7` = Saturday.",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7"
],
"example": "2"
},
"slots": {
"type": "array",
"description": "One or more start/end time slots active on this day.",
"items": {
"$ref": "#/components/schemas/ScheduleSlot"
},
"example": [
{
"startTime": "08:00",
"endTime": "20:00"
}
]
}
}
},
"SafeCallingWindow": {
"type": "object",
"properties": {
"scwStartTime": {
"type": "string",
"description": "Start time of the safe-calling window in HH:mm (24-hour) format.",
"example": "08:00"
},
"scwEndTime": {
"type": "string",
"description": "End time of the safe-calling window in HH:mm (24-hour) format.",
"example": "20:00"
}
}
},
"ContactAttemptsStrategy": {
"type": "object",
"description": "Strategy that governs how many times and in what order contacts are attempted.",
"properties": {
"maxAttempts": {
"type": "array",
"description": "Maximum attempts for the interval.",
"items": {
"$ref": "#/components/schemas/MaxAttemptRule"
}
},
"contactModesPriority": {
"type": "array",
"description": "Ordered priority of contact modes.",
"items": {
"$ref": "#/components/schemas/ContactModePriority"
}
},
"sequentialDialing": {
"$ref": "#/components/schemas/SequentialDialing"
},
"wrapUpCodesSet": {
"type": "string",
"description": "Name of the wrap-up codes set applied to the campaign.",
"example": "Auto_Loans_WrapUpCodes_Set"
},
"telephonyOutcomeSet": {
"type": "string",
"description": "Name of the telephony outcome set applied to the campaign.",
"example": "Auto_Loans_TelephonyOutcomes_Set"
}
}
},
"MaxAttemptRule": {
"type": "object",
"properties": {
"interval": {
"type": "string",
"description": "Interval identifier (e.g., `CLE` for Campaign List Expiry, `1D` for one day).",
"example": "1D"
},
"maxCount": {
"type": "string",
"description": "Maximum number of attempts allowed in the interval.",
"example": "4"
}
}
},
"ContactModePriority": {
"type": "object",
"properties": {
"mode": {
"type": "string",
"description": "Display name of the contact mode (e.g., `Home`, `Office`).",
"example": "Home"
},
"priority": {
"type": "integer",
"description": "Priority order for the contact mode (lower is higher priority).",
"example": 1
},
"maxCount": {
"type": "integer",
"nullable": true,
"description": "Maximum count for this contact mode."
}
}
},
"SequentialDialing": {
"type": "object",
"description": "Sequential dialing configuration for the campaign.",
"properties": {
"enabled": {
"type": "integer",
"description": "Whether sequential dialing is enabled. `1` for enabled, `0` for disabled.",
"enum": [
0,
1
],
"example": 1
},
"noOfCycles": {
"type": "integer",
"description": "Maximum number of dialing cycles.",
"example": 5
},
"cycleInterval": {
"$ref": "#/components/schemas/CycleInterval"
}
}
},
"CycleInterval": {
"type": "object",
"description": "Time between dialing cycles, expressed in days/hours/minutes.",
"properties": {
"days": {
"type": "integer",
"description": "Days component.",
"example": 0
},
"hours": {
"type": "integer",
"description": "Hours component.",
"example": 0
},
"minutes": {
"type": "integer",
"description": "Minutes component.",
"example": 30
}
}
},
"PaginationInfo": {
"type": "object",
"description": "Pagination metadata for a paged response.",
"required": [
"page",
"pageSize",
"totalCount",
"totalPages"
],
"properties": {
"page": {
"type": "integer",
"description": "Current page number (1-based).",
"example": 1
},
"pageSize": {
"type": "integer",
"description": "Number of items returned per page.",
"example": 20
},
"totalCount": {
"type": "integer",
"description": "Total number of campaigns matching the query.",
"example": 14
},
"totalPages": {
"type": "integer",
"description": "Total number of pages available for the query.",
"example": 1
}
}
},
"CreateContactListRequest": {
"type": "object",
"required": [
"supportedChannels"
],
"properties": {
"supportedChannels": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Voice",
"SMS",
"Email"
]
},
"description": "Supported channels for the contact list"
},
"activationTimeLagMinutes": {
"type": "integer",
"description": "Contact list activation time lag in minutes (0 = immediate activation, 180 = 3 hours delay). Required if activationDateTime is not provided.",
"example": 180
},
"activationDateTime": {
"type": "string",
"description": "Contact list activation DateTimeStamp (format: YYYY-MM-DDTHH:MM). Required if activationTimeLagMinutes is not provided.",
"example": "2025-09-24T18:47"
}
},
"example": {
"supportedChannels": [
"Voice"
],
"activationTimeLagMinutes": 180,
"activationDateTime": "2025-09-24T18:47:00Z"
}
},
"CreateContactListResponse": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"Success",
"Failure"
],
"description": "Outcome of the operation",
"example": "Success"
},
"statusCode": {
"type": "integer",
"description": "0 for success, non-zero for failure or validation failure",
"example": 0
},
"contactListId": {
"type": "string",
"description": "Contact List ID within the campaign (number only)",
"example": "501"
}
},
"example": {
"success": {
"summary": "Contact list created successfully",
"value": {
"outcome": "Success",
"statusCode": 0,
"contactListId": "501"
}
},
"failure": {
"summary": "Failed to create contact list",
"value": {
"outcome": "Failure",
"statusCode": 400,
"error": {
"code": "InvalidRequest",
"message": "Invalid request parameters"
}
}
}
}
},
"CreateContactRequest": {
"type": "object",
"properties": {
"contacts": {
"type": "array",
"description": "Array of contact attributes, max 10 contacts per request",
"items": {
"type": "object",
"required": [
"contactAttributes"
],
"properties": {
"contactAttributes": {
"type": "array",
"description": "Array of field mapping field name & value pairs.",
"items": {
"type": "object",
"properties": {
"fieldName": {
"type": "string",
"description": "Field name"
},
"value": {
"type": "string",
"description": "Field value"
}
},
"example": {
"fieldName": "FirstName",
"value": "John"
}
},
"example": [
{
"fieldName": "FirstName",
"value": "John"
},
{
"fieldName": "LastName",
"value": "Doe"
},
{
"fieldName": "AccountStatus",
"value": "Active"
}
]
}
}
}
}
}
},
"CreateContactResponse": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"Queued",
"Failed"
],
"description": "Outcome of the operation",
"example": "Queued"
},
"statusCode": {
"type": "integer",
"description": "0 for Queued, non-zero for Failed",
"example": 0
},
"summary": {
"type": "string",
"description": "Summary of the operation",
"example": "Queued for adding to the contact list"
}
},
"example": {
"outcome": "Queued",
"statusCode": 0,
"summary": "Queued for adding to the contact list"
}
},
"UpdateContactRequest": {
"type": "object",
"properties": {
"contactStatus": {
"type": "string",
"enum": [
"CLOSED"
],
"description": "Contact status (CLOSED)",
"example": "CLOSED"
}
}
},
"UpdateContactResponse": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"Queued",
"Failed"
],
"description": "Outcome of the operation",
"example": "Queued"
},
"statusCode": {
"type": "integer",
"description": "0 for Queued, non-zero for Failed",
"example": 0
},
"summary": {
"type": "string",
"description": "Summary of the operation",
"example": "Queued for updating the contact status"
}
},
"example": {
"outcome": "Queued",
"statusCode": 0,
"summary": "Queued for updating the contact status"
}
},
"UpdateContactStatusWithinCampaignChainRequest": {
"type": "object",
"required": [
"contactStatus"
],
"properties": {
"contactStatus": {
"type": "string",
"enum": [
"CLOSED"
],
"description": "Contact status to apply. Only CLOSED is supported.",
"example": "CLOSED"
},
"searchAcrossTheCampaignChain": {
"type": "string",
"description": "Whether to close the contact across all campaigns in the chain. When omitted, all campaigns in the chain are included by default. Set to `no` to close only in the campaign specified in the request path.",
"enum": [
"yes",
"no"
],
"example": "yes"
}
}
},
"UpdateContactStatusResponse": {
"type": "object",
"description": "Result of the \"close contact record\" request. Each item in `records` describes the outcome in the target campaign where the contact was found.",
"required": [
"outcome",
"statusCode",
"records"
],
"properties": {
"outcome": {
"type": "string",
"description": "Overall result: `Success` if closed everywhere a match was found; `PartialSuccess` if some matching contact records were closed but others were non-closeable; `NoChange` if none of the matching contact records could be closed; `Matching contact record not found.` if no match (HTTP 404).",
"enum": [
"Success",
"PartialSuccess",
"NoChange",
"Matching contact record not found."
],
"example": "Success"
},
"statusCode": {
"type": "integer",
"description": "0 for a completed API response.",
"example": 0
},
"records": {
"type": "array",
"description": "Per-campaign close outcome.",
"items": {
"$ref": "#/components/schemas/ContactCampaignUpdateResult"
}
}
}
},
"ContactCampaignUpdateResult": {
"type": "object",
"description": "Close outcome for one campaign.",
"properties": {
"updated": {
"type": "boolean",
"description": "True when the contact was closed in this campaign.",
"example": true
},
"campaignId": {
"type": "string",
"description": "Campaign ID for this record.",
"example": "CCV_1001"
},
"campaignName": {
"type": "string",
"description": "Campaign Name.",
"example": "Renewals"
},
"contactListId": {
"type": "string",
"description": "Contact list ID within the campaign where the contact was matched.",
"example": "501"
},
"matchedBy": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Field header and value used to match the contact in this campaign.",
"example": {
"ContactHome": "+12125550199"
}
},
"fields": {
"type": "object",
"additionalProperties": true,
"description": "Optional map of requested field names to values, present when the `fields` query parameter was supplied. Omitted when no fields were requested.",
"example": {
"FirstName": "John",
"LastName": "Doe",
"AmountDue": "100.00"
}
},
"comment": {
"type": "string",
"description": "Per-record result message. `Closed.` when the contact was successfully closed (`updated: true`). When matched but in sent-to-dialer status, `Cannot close; already sent to dialer.` (`updated: false`).",
"example": "Closed."
}
}
},
"UpdateContactListStatusRequest": {
"type": "object",
"properties": {
"contactListStatus": {
"type": "string",
"description": "Contact List Status (e.g., EXPIRED). Note: This value is not case-sensitive.",
"example": "EXPIRED"
}
}
},
"UpdateContactListStatusResponse": {
"type": "object",
"properties": {
"outcome": {
"type": "string",
"enum": [
"Success",
"Failure"
],
"description": "Outcome of the operation"
},
"statusCode": {
"type": "integer",
"description": "0 for success, non-zero for failure or validation failure"
},
"contactLists": {
"type": "array",
"description": "List of contact lists",
"items": {
"type": "object",
"properties": {
"contactListId": {
"type": "string",
"description": "Contact List ID",
"example": "501"
},
"contactListStatus": {
"type": "string",
"description": "Contact List Status",
"example": "Active"
},
"contactListRecordCount": {
"type": "integer",
"description": "Number of records in the contact list",
"example": 100
},
"contactListSource": {
"type": "string",
"description": "Source of the contact list",
"example": "API"
},
"dateOfCreation": {
"type": "string",
"format": "date-time",
"description": "Date of creation",
"example": "2025-08-01T10:00:00Z"
},
"dateOfActivation": {
"type": "string",
"format": "date-time",
"description": "Date of activation",
"example": "2025-08-01T12:00:00Z"
},
"dateOfExpiry": {
"type": "string",
"format": "date-time",
"description": "Date of expiry",
"example": "2025-09-01T00:00:00Z"
}
}
}
}
},
"example": {
"success": {
"summary": "Contact list status updated successfully",
"value": {
"outcome": "Success",
"statusCode": 0
}
},
"failure": {
"summary": "Failed to update contact list status",
"value": {
"outcome": "Failure",
"statusCode": 400,
"error": {
"code": "InvalidStatus",
"message": "Contact list status is invalid"
}
}
}
}
},
"GetContactListsResponse": {
"type": "object",
"description": "Response containing contact lists within a campaign, including contact counts and dialer status breakdown for each list.",
"required": [
"outcome",
"statusCode",
"contactLists"
],
"properties": {
"outcome": {
"type": "string",
"enum": [
"Success",
"Failure"
],
"description": "Outcome of the operation"
},
"statusCode": {
"type": "integer",
"description": "0 for success, non-zero for failure or validation failure"
},
"contactLists": {
"type": "array",
"description": "List of contact lists",
"items": {
"$ref": "#/components/schemas/ContactListInfo"
}
}
}
},
"ContactListInfo": {
"type": "object",
"description": "Contact list details and contact counts by processing and dialer status. Count fields are `0` when counts are not yet available for a newly created list.",
"properties": {
"contactListId": {
"type": "string",
"description": "Contact list ID within the campaign.",
"example": "501"
},
"contactListStatus": {
"type": "string",
"description": "Contact list status (for example: Active, Expired, UploadFailed).",
"example": "Active"
},
"contactListSource": {
"type": "string",
"description": "How the contact list was created (for example, API, SFTP, ManualFile).",
"example": "API"
},
"contactListSourceFileName": {
"type": "string",
"description": "Source file name for the contact list upload.",
"example": "contacts.csv"
},
"contactListCountsTimestampUtc": {
"type": "string",
"format": "date-time",
"description": "UTC timestamp when the counts were last updated.",
"example": "2025-08-01T14:30:00Z"
},
"processedContactsCount": {
"type": "integer",
"description": "Total contacts processed for this contact list.",
"example": 100
},
"invalidContactsCount": {
"type": "integer",
"description": "Number of invalid contacts.",
"example": 2
},
"validContactsCount": {
"type": "integer",
"description": "Derived: `processedContactsCount` \u2212 `invalidContactsCount`.",
"example": 98
},
"eligibleContactsCount": {
"type": "integer",
"description": "Derived: `processedContactsCount` \u2212 `invalidContactsCount` \u2212 DNC-suppressed contacts.",
"example": 95
},
"freshContactsCount": {
"type": "integer",
"description": "Number of contacts in Fresh state.",
"example": 40
},
"openContactsCount": {
"type": "integer",
"description": "Number of contacts in Open state.",
"example": 30
},
"closedContactsCount": {
"type": "integer",
"description": "Number of contacts in Closed state.",
"example": 20
},
"errorsContactsCount": {
"type": "integer",
"description": "Number of contacts in Error state.",
"example": 0
},
"readyForDialerContactsCount": {
"type": "integer",
"description": "Number of contacts ready to be sent to the dialer.",
"example": 5
},
"sentToDialerAwaitingOutcomeContactsCount": {
"type": "integer",
"description": "Number of contacts sent to the dialer and awaiting an outcome.",
"example": 3
},
"expiredContactsCount": {
"type": "integer",
"description": "Number of expired contacts.",
"example": 0
},
"blockedContactsCount": {
"type": "integer",
"description": "Number of blocked contacts.",
"example": 0
},
"closedTransferredToChainedCampaignContactsCount": {
"type": "integer",
"description": "Number of contacts closed and transferred to a chained campaign.",
"example": 0
},
"dateOfCreation": {
"type": "string",
"format": "date-time",
"description": "Date and time the contact list was created, in the campaign time zone.",
"example": "2025-08-01T10:00:00"
},
"dateOfActivation": {
"type": "string",
"format": "date-time",
"description": "Date and time the contact list was activated.",
"example": "2025-08-01T12:00:00"
},
"dateOfExpiry": {
"type": "string",
"format": "date-time",
"description": "Date and time the contact list expires.",
"example": "2025-09-01T00:00:00"
}
}
}
},
"securitySchemes": {
"oauth2": {
"flows": {
"authorizationCode": {
"authorizationUrl": "/",
"scopes": {},
"tokenUrl": "/"
}
},
"type": "oauth2"
},
"bearer-key": {
"type": "http",
"description": "e.g. Bearer YOUR_AUTHORIZATION_TOKEN",
"scheme": "bearer",
"bearerFormat": "JWT"
},
"BEARER_TOKEN_FROM_CI": {
"type": "http",
"in": "header",
"scheme": "bearer"
},
"Bearer": {
"type": "http",
"description": "e.g. Bearer YOUR_AUTHORIZATION_TOKEN",
"scheme": "bearer",
"bearerFormat": "JWT"
},
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT",
"description": "JWT bearer token authentication. Obtain your token from the Webex Developer Portal."
}
},
"parameters": {},
"responses": {},
"requestBodies": {}
}
}