Webex

Webex Contact Center

The Webex Contact Center APIs allow developers to deeply integrate, configure, and manage cloud-based contact center solutions. These APIs cover agent…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 400

Agent Summaries

  • POSTList summaries/generated-summaries/searchLists summaries based on the requested search type.

External Data Updates

  • PUTUpdate Task Global Variables/v1/data/updateExternalUpdates numeric global variable values associated with a completed Webex Contact Center task. The request must identify the organization and task along with…

Search Metadata

  • GETGet Search Metadata/search/v2/metaReturns schema metadata for the Webex Contact Center Search GraphQL API, describing supported queries, fields, nested structures, data types, filters, sorting…

Agents

  • POSTLogin/v1/agents/loginAllows 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.…
  • PUTLogout/v1/agents/logoutAllows the user to logout from their Desktop. This API needs to be called once the WSS session has been successfully established. Self logout for an agent or…
  • PUTState Change/v1/agents/session/stateAllows the user to toggle between the Idle and Available states. Self state changes for an agent, supervisor or Licensed Administrator with agent capability…
  • POSTReload/v1/agents/reloadRequests restoration of the active agent session, including agent state and assigned interaction context. This asynchronous API returns 202 Accepted when the…
  • POSTBuddy Agents List/v1/agents/buddyListReturns the list of agents in the given state and media according to agent profile settings. Requires an agent or supervisor access token with the 'cjp:user'…
  • GETGet Agent Activities/v1/agents/activities?from=1591702170000Retrieve agent activities. Requires a bearer access token authorized to access the requested organization and agent data. Results are sorted by start time in…
  • GETGet Agent Statistics/v1/agents/statistics?from=1651395600000&to=1651438800000Retrieve agent statistics for the specified time duration and interval. Requires a bearer access token authorized to access the requested organization and…
  • POSTLogin/v2/agents/loginAllows 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.…
  • PUTLogout/v2/agents/logoutAllows the user to logout from their Desktop. This API needs to be called once the WSS session has been successfully established. Self logout for an agent or…
  • PUTState Change/v2/agents/session/stateAllows the user to toggle between the Idle and Available states for the requested channels. Self state changes for an agent or supervisor require the…
  • POSTReload/v2/agents/reloadRequests restoration of the active agent session, including agent state and assigned interaction context. This asynchronous API returns 202 Accepted when the…

Callbacks

  • GETGet scheduled callbacks/v1/callbacks/organization/:orgId/scheduled-callbackAllows the user to list scheduled callbacks for a given customer number or assignee agent, excluding those whose scheduled trigger time has already passed.…
  • POSTSchedule a Callback/v1/callbacks/organization/:orgId/scheduled-callbackCreates a new callback request for a customer. Authorization requires the cjp:user scope. The callback default endpoint (EP) and default ANI must be…
  • GETGet scheduled callback by Id/v1/callbacks/organization/:orgId/scheduled-callback/:idRetrieve an existing scheduled callback by Id, excluding those whose scheduled trigger time has already passed. Requires 'cjp:user' scope for authorization.
  • PUTUpdate scheduled callback by Id/v1/callbacks/organization/:orgId/scheduled-callback/:idUpdate an existing scheduled callback by Id,those whose scheduled trigger time has already passed cannot be updated. Requires 'cjp:user' scope for…
  • DELETEDelete scheduled callback by Id/v1/callbacks/organization/:orgId/scheduled-callback/:idDelete an existing scheduled callback by Id, those whose scheduled trigger time has already passed cannot be deleted. Requires 'cjp:user' scope for…

Tasks

  • GETGet Tasks/v1/tasks?from=1591702170000Retrieve open and closed tasks. Sorted by createdTime ascending. Uses offset-based pagination. For this API, response compression using gzip can be enabled by…
  • POSTCreate Task/v1/tasksThis API is to create a task for work or handling assignments. Represents both inbound tasks (originating from customer-facing channels) and outbound tasks…
  • PATCHUpdate Task/v1/tasks/:taskIdThis API is to update a task. Represents both inbound tasks (originating from customer-facing channels) and outbound tasks (originating from contact center to…
  • POSTAccept Task/v1/tasks/:taskId/acceptAccess 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…
  • POSTEnd Task/v1/tasks/:taskId/endAccess this endpoint when the user has to end either an inbound or an outbound requests. Requires one of the following scopes 'cjp:user' or…
  • POSTWrap Up Task/v1/tasks/:taskId/wrapupAccess 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…
  • POSTHold Task/v1/tasks/:taskId/holdAccess 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…
  • POSTUnhold Task/v1/tasks/:taskId/unholdAccess 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…
  • POSTPause Task/v1/tasks/:taskId/pauseAccess this endpoint when users such as administrators, supervisors, or agents with an agent license need to pause a task that cannot be handled immediately.…
  • POSTResume Task/v1/tasks/:taskId/resumeAccess this endpoint when users such as administrators, supervisors, or agents with an agent license need to resume a previously paused task. This API is…
  • POSTReject Task/v1/tasks/:taskId/rejectAccess 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…
  • POSTPause Recording Task/v1/tasks/:taskId/record/pauseWhen configured by the administrator, telephony tasks are often being recorded for various reasons. When an user is handling sensitive customer information,…
  • POSTResume Recording Task/v1/tasks/:taskId/record/resumeWhen configured by the administrator, telephony tasks are often being recorded for various reasons. When an user is handling sensitive customer information,…
  • POSTTransfer Task/v1/tasks/:taskId/transferAccess 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'…
  • POSTConsult Task/v1/tasks/:taskId/consultAccess 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'…
  • POSTConsult Conference Task/v1/tasks/:taskId/consult/conferenceAccess this endpoint when the user has to initiate a conference with the consulting user. Requires one of the following scopes 'cjp:user' or…
  • POSTConsult Transfer Task/v1/tasks/:taskId/consult/transferAccess this endpoint when the user has to transfer a call to the consulting user. Requires one of the following scopes 'cjp:user' or…
  • POSTConsult Accept Task/v1/tasks/:taskId/consult/acceptAccess this endpoint when the user has to accept a call to the consulting user. Requires one of the following scopes 'cjp:user' or…
  • POSTAssign Task/v1/tasks/:taskId/assignAccess this endpoint when users such as administrators, supervisors, or agents with an agent license need to assign tasks to themselves. Authorization…
  • POSTConsult End Task/v1/tasks/:taskId/consult/endAccess this endpoint when the user has to end a call with the consulting user. Requires one of the following scopes 'cjp:user' or…
  • POSTExit Conference Task/v1/tasks/:taskId/conference/exitAccess 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'…
  • POSTDrop Participant From Conference/v1/tasks/:taskId/conference/participants/:participantId/dropAccess this endpoint when the user needs to drop a specific participant from an active conference associated with a task. This operation removes only the…
  • POSTAccept Preview Task/v1/dialer/campaign/:campaignId/preview-task/:taskId/acceptAPI to accept the preview campaign task offered to the agent.
  • POSTSkip Preview Task/v1/dialer/campaign/:campaignId/preview-task/:taskId/skipAPI to skip the preview campaign task offered to the agent.
  • POSTRemove Preview Task/v1/dialer/campaign/:campaignId/preview-task/:taskId/removeAPI to remove the preview campaign task offered to the agent
  • POSTCreate Task/v2/tasksThis feature is currently in Beta. Contact your Cisco team if you want access to this feature. Creates a new contact center task using the v2 task contract.…
  • POSTAppend Task Message/v2/tasks/:taskId/messagesThis feature is currently in Beta. Contact your Cisco team if you want access to this feature. Appends an inbound message to an existing workItem or…

DNC Management

  • POSTAdd Phone Number to DNC List/v3/campaign-management/dncList/:dncListName/phoneNumberAdds a phone number to the specified Do Not Contact (DNC) list. This operation helps ensure compliance with applicable rules & regulations by preventing…
  • GETGet Phone Number from DNC List/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumberRetrieves 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…
  • DELETERemove Phone Number from DNC List/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumberRemoves a phone number from the specified Do Not Contact (DNC) list. This operation allows administrators to remove numbers that should no longer be blocked…

Campaign Group

  • GETList Campaigns by Campaign Group/v3/campaign-management/campaign-groups/:campaignGroupName/campaignsRetrieves the list of campaigns that belong to the specified campaign group. Results are paginated and can optionally be filtered by campaign status. Note:…

Contact List Management

  • POSTCreate contact list/v3/campaign-management/campaigns/:campaignId/contact-listCreates and activates a contact list for a campaign. The system can activate a contact list even if there are no contact records within it.
  • POSTCreate contacts within a contact list/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contactsCreates 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…
  • PATCHUpdate a contact's status within a contact list/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts/:contactIdUpdates a contact's status within a contact list. After update, system overwrites 'Latest Telephony Outcome' to blank and 'Latest Business Outcome' to 'Closed…
  • PATCHUpdate contact status across the campaign chain/v3/campaign-management/campaigns/:campaignId/contacts/:contactIdSynchronously closes the specified contacts and returns the outcome in the same response. Contacts are identified using the same unique identifiers configured…
  • PATCHUpdate contact list status/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/statusUpdates the status of a contact list (e.g., EXPIRED). Note: This value is not case-sensitive.
  • GETGet Contact Lists within a Campaign/v3/campaign-management/campaigns/:campaignId/contact-listsRetrieves all contact lists within a campaign, with optional filters for status and source. This is the v3 endpoint. Each contact list entry includes…
  • GETGet Contact Lists within a Campaign/v4/campaign-management/campaigns/:campaignId/contact-listsRetrieves all contact lists within a campaign. Use the optional status and source query parameters to filter results. Each contact list in the response…

Agent Wellbeing

  • POSTSubscribe for realtime burnout events/v1/agentburnout/subscribeThis 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…
  • POSTRecord the realtime burnout events/v1/agentburnout/actionThe 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…
  • GETGet specific Agent Burnout resource by ID/organization/:orgid/agent-burnout/:idDeprecated. Retrieve an existing Agent Burnout resource by ID in a given organization. Deprecated. Use GET /ai-feature/agent-burnout/{id} instead.
  • PUTUpdate specific Agent Burnout resource by ID/organization/:orgid/agent-burnout/:idDeprecated. Update an existing Agent Burnout resource by ID in a given organization. Deprecated. Use PUT /ai-feature/agent-burnout/{id} instead.
  • GETList Agent Burnout resource(s)/organization/:orgid/v2/agent-burnoutDeprecated. Retrieve a list of Agent Burnout resource(s) in a given organization.Only one entry per organization can exist for Agent Burnout resource.…

AI Feature

  • POSTCreate a new Question mapped to AutoCSAT/organization/:orgid/ai-feature/auto-csat/questionCreate a new Auto CSAT mapped Question in a given organization.
  • POSTBulk save Question mapped to AutoCSAT/organization/:orgid/ai-feature/auto-csat/question/bulkCreate, Update or delete Auto CSAT mapped Question(s) in bulk for Auto CSAT resource in a given organization.
  • GETGet specific Question mapped to AutoCSAT by ID/organization/:orgid/ai-feature/auto-csat/question/:idRetrieve an existing Auto CSAT mapped Question by ID in a given organization.
  • DELETEDelete specific Question mapped to AutoCSAT by ID/organization/:orgid/ai-feature/auto-csat/question/:idDelete an existing Auto CSAT mapped Question by ID in a given organization.
  • GETGet specific AI Feature resource by ID/organization/:orgid/ai-feature/:idRetrieve an existing AI Feature resource by ID in a given organization.
  • PATCHPartially update AI Feature resource by ID/organization/:orgid/ai-feature/:idPartially update AI Feature resource by ID in a given organization.
  • GETList AI Feature resource(s)/organization/:orgid/v2/ai-featureRetrieve a list of AI Feature resource(s) in a given organization.Only one entry per organization can exist for AI Feature resource.
  • GETList Question mapped to AutoCSAT(s)/organization/:orgid/v2/ai-feature/auto-csat/questionRetrieve a list of Auto CSAT mapped Question(s) in a given organization.

Auto CSAT

  • POSTCreate a new Auto CSAT mapped Question/organization/:orgid/auto-csat/:autoCsatId/questionDeprecated. Create a new Auto CSAT mapped Question in a given organization. Deprecated. Use POST /ai-feature/auto-csat/question instead.
  • POSTBulk save Auto CSAT mapped Question(s)/organization/:orgid/auto-csat/:autoCsatId/question/bulkDeprecated. Create, Update or delete Auto CSAT mapped Question(s) in bulk for Auto CSAT resource in a given organization. Deprecated. Use POST…
  • GETGet specific Auto CSAT mapped Question by ID/organization/:orgid/auto-csat/:autoCsatId/question/:idDeprecated. Retrieve an existing Auto CSAT mapped Question by ID in a given organization. Deprecated. Use GET /ai-feature/auto-csat/question/{id} instead.
  • DELETEDelete specific Auto CSAT mapped Question by ID/organization/:orgid/auto-csat/:autoCsatId/question/:idDeprecated. Delete an existing Auto CSAT mapped Question by ID in a given organization. Deprecated. Use DELETE /ai-feature/auto-csat/question/{id} instead.
  • GETGet specific Auto CSAT resource by ID/organization/:orgid/auto-csat/:idDeprecated. Retrieve an existing Auto CSAT resource by ID in a given organization. Deprecated. Use GET /ai-feature/auto-csat/{id} instead.
  • PUTUpdate specific Auto CSAT resource by ID/organization/:orgid/auto-csat/:idDeprecated. Update an existing Auto CSAT resource by ID in a given organization. Deprecated. Use PUT /ai-feature/auto-csat/{id} instead.
  • GETList Auto CSAT resource(s)/organization/:orgid/v2/auto-csatDeprecated. 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…
  • GETList Auto CSAT mapped Question(s)/organization/:orgid/v2/auto-csat/:autoCsatId/questionDeprecated. Retrieve a list of Auto CSAT mapped Question(s) in a given organization. Deprecated. Use GET /v2/ai-feature/auto-csat/question instead.

Generated Summaries

  • GETGet specific Generated Summaries resource by ID/organization/:orgid/generated-summaries/:idDeprecated. Retrieve an existing Generated Summaries resource by ID in a given organization. Deprecated. Use GET /ai-feature/generated-summaries/{id} instead.
  • PUTUpdate specific Generated Summaries resource by ID/organization/:orgid/generated-summaries/:idDeprecated. Update an existing Generated Summaries resource by ID in a given organization. Deprecated. Use PUT /ai-feature/generated-summaries/{id} instead.
  • GETList Generated Summaries resource(s)/organization/:orgid/v2/generated-summariesDeprecated. Retrieve a list of Generated Summaries resource(s) in a given organization.Only one entry per organization can exist for Generated Summaries…

Business Hour

  • GETList Business Hours resources/organization/:orgid/business-hoursRetrieve a list of Business Hours resources in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To…
  • POSTCreate a new Business Hours resource/organization/:orgid/business-hoursCreate a new Business Hours resource in a given organization.
  • POSTBulk save Business Hours resources/organization/:orgid/business-hours/bulkCreate, Update or delete Business Hours resources in bulk in a given organization.
  • GETGet specific Business Hours resource by ID/organization/:orgid/business-hours/:idRetrieve an existing Business Hours resource by ID in a given organization.
  • PUTUpdate specific Business Hours resource by ID/organization/:orgid/business-hours/:idUpdate an existing Business Hours resource by ID in a given organization.
  • DELETEDelete specific Business Hours resource by ID/organization/:orgid/business-hours/:idDelete an existing Business Hours resource by ID in a given organization.
  • GETList references for a specific Business Hours resource/organization/:orgid/business-hours/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Business Hours resource by ID in a given organization.
  • GETList Business Hours resources/organization/:orgid/v2/business-hoursRetrieve a list of Business Hours resources in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To…

Holiday List

  • GETList Holiday Lists/organization/:orgid/holiday-listRetrieve a list of Holiday Lists in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the…
  • POSTCreate a new Holiday List/organization/:orgid/holiday-listCreate a new Holiday List in a given organization.
  • POSTBulk save Holiday Lists/organization/:orgid/holiday-list/bulkCreate, Update or delete Holiday Lists in bulk in a given organization.
  • GETGet specific Holiday List by ID/organization/:orgid/holiday-list/:idRetrieve an existing Holiday List by ID in a given organization.
  • PUTUpdate specific Holiday List by ID/organization/:orgid/holiday-list/:idUpdate an existing Holiday List by ID in a given organization.
  • DELETEDelete specific Holiday List by ID/organization/:orgid/holiday-list/:idDelete an existing Holiday List by ID in a given organization.
  • GETList references for a specific Holiday List/organization/:orgid/holiday-list/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Holiday List by ID in a given organization.
  • GETList Holiday Lists/organization/:orgid/v2/holiday-listRetrieve a list of Holiday Lists in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the…

Overrides

  • GETList Overrides resource(s)/organization/:orgid/overridesRetrieve a list of Overrides resource(s) in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve…
  • POSTCreate a new Overrides resource/organization/:orgid/overridesCreate a new Overrides resource in a given organization.
  • POSTBulk save Overrides resource(s)/organization/:orgid/overrides/bulkCreate, Update or delete Overrides resource(s) in bulk in a given organization.
  • GETGet specific Overrides resource by ID/organization/:orgid/overrides/:idRetrieve an existing Overrides resource by ID in a given organization.
  • PUTUpdate specific Overrides resource by ID/organization/:orgid/overrides/:idUpdate an existing Overrides resource by ID in a given organization.
  • DELETEDelete specific Overrides resource by ID/organization/:orgid/overrides/:idDelete an existing Overrides resource by ID in a given organization.
  • GETList references for a specific Overrides resource/organization/:orgid/overrides/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Overrides resource by ID in a given organization.
  • GETList Overrides resource(s)/organization/:orgid/v2/overridesRetrieve a list of Overrides resource(s) in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve…

Address Book

  • GETList Address Book(s)/organization/:orgid/address-bookDeprecated. Retrieve a list of Address Book(s) in a given organization. To get address book having large entries use latest apis.
  • POSTCreate a new Address Book/organization/:orgid/address-bookDeprecated. Create a new Address Book in a given organization. To create address book having large entries use latest apis.
  • GETBulk export Address Book(s)/organization/:orgid/address-book/bulk-exportDeprecated. Export all Address Book(s) in a given organization.
  • POSTCreate a new Address Book Entry/organization/:orgid/address-book/:addressBookId/entryCreate a new Address Book Entry in a given organization.
  • POSTBulk save Address Book Entry(s)/organization/:orgid/address-book/:addressBookId/entry/bulkCreate, Update or delete Address Book Entry(s) in bulk for an Address Book in a given organization.
  • GETGet specific Address Book Entry by ID/organization/:orgid/address-book/:addressBookId/entry/:idRetrieve an existing Address Book Entry by ID in a given organization.
  • PUTUpdate specific Address Book Entry by ID/organization/:orgid/address-book/:addressBookId/entry/:idUpdate an existing Address Book Entry by ID in a given organization.
  • DELETEDelete specific Address Book Entry by ID/organization/:orgid/address-book/:addressBookId/entry/:idDelete an existing Address Book Entry by ID in a given organization.
  • GETGet specific Address Book by ID/organization/:orgid/address-book/:idDeprecated. Retrieve an existing Address Book by ID in a given organization. To get address book having large entries use latest apis.
  • PUTUpdate specific Address Book by ID/organization/:orgid/address-book/:idDeprecated. Update an existing Address Book by ID in a given organization. To update address book having large entries use latest apis.
  • DELETEDelete specific Address Book by ID/organization/:orgid/address-book/:idDeprecated. Delete an existing Address Book by ID in a given organization. To delete address book having large entries use latest apis.
  • GETList references for a specific Address Book/organization/:orgid/address-book/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Address Book by ID in a given organization.
  • GETList Address Book(s)/organization/:orgid/v2/address-bookDeprecated. Retrieve a list of Address Book(s) in a given organization. To get address book having large entries use latest apis.
  • GETList Address Book Entry(s)/organization/:orgid/v2/address-book/:addressBookId/entryRetrieve a list of Address Book Entry(s) in a given organization.
  • GETList Address Book(s)/organization/:orgid/v3/address-bookRetrieve a list of Address Book(s) in a given organization.
  • POSTCreate a new Address Book/organization/:orgid/v3/address-bookCreate a new Address Book in a given organization.
  • GETGet specific Address Book by ID/organization/:orgid/v3/address-book/:idRetrieve an existing Address Book by ID in a given organization.
  • PUTUpdate specific Address Book by ID/organization/:orgid/v3/address-book/:idUpdate an existing Address Book by ID in a given organization.
  • DELETEDelete specific Address Book by ID/organization/:orgid/v3/address-book/:idDelete an existing Address Book by ID in a given organization.

Agent Personal Greeting Files

  • POSTCreate a new Greeting File/organization/:orgid/agent-personal-greetingDeprecated. Create a new Greeting File in a given organization.
  • POSTDelete references of an agent from greeting files/organization/:orgid/agent-personal-greeting/delete-referenceRemoves all references of the specified agent (ciUserId) from greeting files in the given organization. Typically invoked when an agent is deleted or…
  • GETGet specific Greeting File by ID/organization/:orgid/agent-personal-greeting/:idDeprecated. Retrieve an existing Greeting File by ID in a given organization.
  • PUTUpdate specific Greeting File by ID/organization/:orgid/agent-personal-greeting/:idDeprecated. Update an existing Greeting File by ID in a given organization.
  • DELETEDelete specific Greeting File by ID/organization/:orgid/agent-personal-greeting/:idDeprecated. Delete an existing Greeting File by ID in a given organization.
  • PATCHPartially update Greeting File by ID/organization/:orgid/agent-personal-greeting/:idDeprecated. Partially update Greeting File by ID in a given organization.
  • GETList Greeting Files/organization/:orgid/v2/agent-personal-greetingRetrieve a list of Greeting Files in a given organization.
  • POSTCreate a new Greeting File/organization/:orgid/v2/agent-personal-greetingCreate a new Greeting File in a given organization.
  • GETGet specific Greeting File by ID/organization/:orgid/v2/agent-personal-greeting/:idRetrieve an existing Greeting File by ID in a given organization.
  • PUTUpdate specific Greeting File by ID/organization/:orgid/v2/agent-personal-greeting/:idUpdate an existing Greeting File by ID in a given organization.
  • DELETEDelete specific Greeting File by ID/organization/:orgid/v2/agent-personal-greeting/:idDelete an existing Greeting File by ID in a given organization.
  • PATCHPartially update Greeting File by ID/organization/:orgid/v2/agent-personal-greeting/:idPartially update Greeting File by ID in a given organization.
  • GETList Greeting Files/organization/:orgid/v3/agent-personal-greetingRetrieve a list of Greeting Files in a given organization.

Asset

  • POSTCreate a new Asset/organization/:orgid/assetCreate a new Asset in a given organization. Supports work item assets with the specified channel and data schema.
  • POSTBulk save Assets/organization/:orgid/asset/bulkCreate, Update or delete Assets in bulk in a given organization. Supports CREATE, UPDATE, and DELETE actions in a single request.
  • GETGet specific Asset by ID/organization/:orgid/asset/:idRetrieve an existing Asset by ID in a given organization. Set includeChannelName to true to include the channel name in the response.
  • PUTUpdate specific Asset by ID/organization/:orgid/asset/:idUpdate an existing Asset by ID in a given organization. Supported for WORK_ITEM assets. For CUSTOM_MESSAGING assets, use PATCH instead.
  • DELETEDelete specific Asset by ID/organization/:orgid/asset/:idDelete an existing Asset by ID in a given organization. Validates whether the asset is associated with any flow before deletion.
  • PATCHPartially update Asset by ID/organization/:orgid/asset/:idPartially update Asset by ID in a given organization. Supported only for CUSTOM_MESSAGING assets. Send only the fields to change; absent fields retain their…
  • GETList references for a specific Asset/organization/:orgid/asset/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Asset by ID in a given organization. For example, Entry Points.
  • GETList Assets/organization/:orgid/v2/assetRetrieve a list of Assets in a given organization. Supports pagination metadata. Set includeChannelName to true to include the channel name in the response.…

Audio Files

  • POSTCreate a new Audio File/organization/:orgid/audio-fileCreate a new Audio File in a given organization.
  • GETGet specific Audio File by ID/organization/:orgid/audio-file/:idRetrieve an existing Audio File by ID in a given organization.
  • PUTUpdate specific Audio File by ID/organization/:orgid/audio-file/:idUpdate an existing Audio File by ID in a given organization.
  • DELETEDelete specific Audio File by ID/organization/:orgid/audio-file/:idDelete an existing Audio File by ID in a given organization.
  • PATCHPartially update Audio File by ID/organization/:orgid/audio-file/:idPartially update Audio File by ID in a given organization.
  • GETList references for a specific Audio File/organization/:orgid/audio-file/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Audio File by ID in a given organization.
  • GETList Audio File(s)/organization/:orgid/v2/audio-fileRetrieve a list of Audio File(s) in a given organization.

Auxiliary Code

  • GETList Auxiliary Code(s)/organization/:orgid/auxiliary-codeDeprecated. Retrieve a list of Auxiliary Code(s) in a given organization.
  • POSTCreate a new Auxiliary Code/organization/:orgid/auxiliary-codeCreate a new Auxiliary Code in a given organization.
  • POSTBulk save Auxiliary Code(s)/organization/:orgid/auxiliary-code/bulkCreate, Update or delete Auxiliary Code(s) in bulk in a given organization.
  • PATCHBulk partial update Auxiliary Code(s)/organization/:orgid/auxiliary-code/bulkUpdate some or all properties for multiple Auxiliary codes in bulk in a given organization.
  • GETBulk export Auxiliary Code(s)/organization/:orgid/auxiliary-code/bulk-exportDeprecated. Export all Auxiliary Code(s) in a given organization.
  • POSTPurge inactive Auxiliary Code(s)/organization/:orgid/auxiliary-code/purge-inactive-entitiesPurge inactive Auxiliary Code(s) older than the configured interval for a given organization.
  • GETGet specific Auxiliary Code by ID/organization/:orgid/auxiliary-code/:idRetrieve an existing Auxiliary Code by ID in a given organization.
  • PUTUpdate specific Auxiliary Code by ID/organization/:orgid/auxiliary-code/:idUpdate an existing Auxiliary Code by ID in a given organization.
  • DELETEDelete specific Auxiliary Code by ID/organization/:orgid/auxiliary-code/:idDelete an existing Auxiliary Code by ID in a given organization.
  • GETList references for a specific Auxiliary Code/organization/:orgid/auxiliary-code/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Auxiliary Code by ID in a given organization.
  • GETList Auxiliary Code(s)/organization/:orgid/v2/auxiliary-codeRetrieve a list of Auxiliary Code(s) in a given organization.

Call Monitoring Request

  • POSTCreate a new Call Monitoring/organization/:orgid/call-monitoringCreate a new Call Monitoring in a given organization.
  • POSTdeleteReferencesCallMonitoring/organization/:orgid/call-monitoring/delete-reference
  • GETGet specific Call Monitoring by ID/organization/:orgid/call-monitoring/:idRetrieve an existing Call Monitoring by ID in a given organization.
  • PUTUpdate specific Call Monitoring by ID/organization/:orgid/call-monitoring/:idUpdate an existing Call Monitoring by ID in a given organization.
  • DELETEDelete specific Call Monitoring by ID/organization/:orgid/call-monitoring/:idDelete an existing Call Monitoring by ID in a given organization.
  • PATCHPartially update Call Monitoring by ID/organization/:orgid/call-monitoring/:idPartially update Call Monitoring by ID in a given organization.
  • GETList Call Monitoring Configurations/organization/:orgid/v2/call-monitoringRetrieve a list of Call Monitoring Configurations in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To…

Channel

  • POSTCreate a new Channel/organization/:orgid/channelCreate a new Channel in a given organization. Supports custom channels for work items.
  • POSTBulk save Channels/organization/:orgid/channel/bulkCreate, Update or delete Channels in bulk in a given organization.
  • GETGet specific Channel by ID/organization/:orgid/channel/:idRetrieve an existing Channel by ID in a given organization. Set includeLogoUrlVersioned to true to include logoUrlVersioned in the response.
  • PUTUpdate specific Channel by ID/organization/:orgid/channel/:idUpdate an existing Channel by ID in a given organization.
  • DELETEDelete specific Channel by ID/organization/:orgid/channel/:idDelete an existing Channel by ID in a given organization.
  • PATCHPartially update Channel by ID/organization/:orgid/channel/:idPartially update a channel by ID. Only the supplied fields are changed; absent fields retain their current values. Patchable fields: name, description,…
  • GETList references for a specific Channel/organization/:orgid/channel/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Channel by ID in a given organization. Includes Asset and Entry Point entities that…
  • GETList Channels/organization/:orgid/v2/channelRetrieve a list of Channels in a given organization. Supports pagination metadata. Set includeLogoUrlVersioned to true to include logoUrlVersioned in the…

Contact Number

  • POSTCreate a new Contact Number/organization/:orgid/contact-numberCreate a new Contact Number in a given organization.
  • GETList all contact numbers(property - number)/organization/:orgid/contact-number/all-numbersRetrieve a list of only contact numbers(property - number) from Contact Number(s) without pagination in a given organization.
  • POSTBulk save Contact Number(s)/organization/:orgid/contact-number/bulkCreate, Update or delete Contact Number(s) in bulk in a given organization.
  • GETBulk export Contact Number(s)/organization/:orgid/contact-number/bulk-exportDeprecated. Export all Contact Number(s) in a given organization.
  • GETGet specific Contact Number by ID/organization/:orgid/contact-number/:idRetrieve an existing Contact Number by ID in a given organization.
  • PUTUpdate specific Contact Number by ID/organization/:orgid/contact-number/:idUpdate an existing Contact Number by ID in a given organization.
  • DELETEDelete specific Contact Number by ID/organization/:orgid/contact-number/:idDelete an existing Contact Number by ID in a given organization.
  • GETList Contact Number(s)/organization/:orgid/v2/contact-numberRetrieve a list of Contact Number(s) in a given organization.

Contact Service Queue

  • GETList Contact Service Queues/organization/:orgid/contact-service-queueDeprecated. Retrieve a list of Contact Service Queues in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated.…
  • POSTBulk save Contact Service Queues/organization/:orgid/contact-service-queue/bulkCreate, Update or delete Contact Service Queues in bulk in a given organization.
  • PATCHBulk partial update Contact Service Queues/organization/:orgid/contact-service-queue/bulkUpdate some or all properties for multiple Contact Service Queues in bulk in a given organization.
  • GETList skill-based Contact Service Queues by skill profile ID (public)/organization/:orgid/contact-service-queue/by-skill-profile-id/:idRetrieve a list of skill-based Contact Service Queues associated with a given skill profile ID, accessible to authorized clients in a given organization.
  • POSTDelete references from Contact Service Queues/organization/:orgid/contact-service-queue/delete-referenceRemoves the references to the specified entities (such as teams, sites, or agents) from Contact Service Queues for a given organization.
  • POSTList skill-based Contact Service Queues by dynamic skills and skill profile/organization/:orgid/contact-service-queue/fetch-by-dynamic-skills-and-skillProfileRetrieve a list of skill-based Contact Service Queues that match the given dynamic skills and skill profile criteria in a given organization.
  • POSTList skill-based Contact Service Queues by skill profile ID and user ID/organization/:orgid/contact-service-queue/fetch-by-userId-skillProfileIdRetrieve a list of skill-based Contact Service Queues associated with the given skill profile ID and user ID combination in a given organization.
  • POSTList manually assignable Contact Service Queues/organization/:orgid/contact-service-queue/fetch-manually-assignable-queuesRetrieve a list of Contact Service Queues that are eligible for manual contact assignment based on the provided criteria in a given organization.
  • POSTPurge inactive Contact Service Queues/organization/:orgid/contact-service-queue/purge-inactive-entitiesPurge inactive Contact Service Queues older than the configured interval for a given organization.
  • GETGet specific Contact Service Queue by ID/organization/:orgid/contact-service-queue/:idRetrieve an existing Contact Service Queue by ID in a given organization.
  • DELETEDelete specific Contact Service Queue by ID/organization/:orgid/contact-service-queue/:idDelete an existing Contact Service Queue by ID in a given organization.
  • GETList references for a specific Contact Service Queue/organization/:orgid/contact-service-queue/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Contact Service Queue by ID in a given organization.
  • POSTBulk save Contact Service Queues/organization/:orgid/contact-service-queue/v2/bulkCreate, Update or delete Contact Service Queues in bulk in a given organization.
  • GETList Contact Service Queues/organization/:orgid/v2/contact-service-queueRetrieve a list of Contact Service Queues in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve…
  • POSTCreate a new Contact Service Queue/organization/:orgid/v2/contact-service-queueCreate a new Contact Service Queue in a given organization.
  • GETList agent-based Contact Service Queues by user ID/organization/:orgid/v2/contact-service-queue/by-user-id/:userid/agent-based-queuesRetrieve a list of agent-based Contact Service Queues by user ID in a given organization.
  • GETList skill-based Contact Service Queues by user ID/organization/:orgid/v2/contact-service-queue/by-user-id/:userid/skill-based-queuesRetrieve a list of skill-based Contact Service Queues by user ID in a given organization.
  • GETList team-based Contact Service Queues by user ID/organization/:orgid/v2/contact-service-queue/by-user-id/:userid/team-based-queuesRetrieve a list of team-based Contact Service Queues by user ID in a given organization.
  • POSTList queue mapping summary grouped by Assistant Skill/organization/:orgid/v2/contact-service-queue/fetch-by-grouped-assistant-skillRetrieve a list of queue mapping summary for a specified list of Assistant Skills specified in a given organization. The summary currently includes mapped…
  • GETGet specific Contact Service Queue by ID/organization/:orgid/v2/contact-service-queue/:idRetrieve an existing Contact Service Queue by ID in a given organization.
  • PUTUpdate specific Contact Service Queue by ID/organization/:orgid/v2/contact-service-queue/:idUpdate an existing Contact Service Queue by ID in a given organization.
  • POSTAdd or remove agents/users to/from an agent based queue/organization/:orgid/v2/contact-service-queue/:id/reassign-agentsThis 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…
  • GETList Contact Service Queues/organization/:orgid/v3/contact-service-queueDeprecated. Retrieve a list of Contact Service Queues in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated.…

Desktop Layout

  • POSTCreate a new Desktop Layout/organization/:orgid/desktop-layoutCreate a new Desktop Layout in a given organization.
  • POSTBulk save Desktop Layout(s)/organization/:orgid/desktop-layout/bulkCreate, Update or delete Desktop Layout(s) in bulk in a given organization.
  • POSTPurge inactive Desktop Layout(s)/organization/:orgid/desktop-layout/purge-inactive-entitiesPurge inactive Desktop Layout(s) older than the configured interval for a given organization.
  • GETGet specific Desktop Layout by ID/organization/:orgid/desktop-layout/:idRetrieve an existing Desktop Layout by ID in a given organization.
  • PUTUpdate specific Desktop Layout by ID/organization/:orgid/desktop-layout/:idUpdate an existing Desktop Layout by ID in a given organization.
  • DELETEDelete specific Desktop Layout by ID/organization/:orgid/desktop-layout/:idDelete an existing Desktop Layout by ID in a given organization.
  • GETList references for a specific Desktop Layout/organization/:orgid/desktop-layout/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Desktop Layout by ID in a given organization.
  • GETList Desktop Layout(s)/organization/:orgid/v2/desktop-layoutRetrieve 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…

Desktop Profile

  • GETList Desktop Profiles/organization/:orgid/agent-profileDeprecated. Retrieve a list of Desktop Profiles in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To…
  • POSTCreate a new Desktop Profile/organization/:orgid/agent-profile?agentProfileDTO={"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}Create a new Desktop Profile in a given organization.
  • POSTBulk save Desktop Profiles/organization/:orgid/agent-profile/bulkCreate, Update or delete Desktop Profiles in bulk in a given organization.
  • POSTPurge inactive Desktop Profiles/organization/:orgid/agent-profile/purge-inactive-entitiesPurge inactive Desktop Profiles older than the configured interval for a given organization.
  • GETGet specific Desktop Profile by ID/organization/:orgid/agent-profile/:idRetrieve an existing Desktop Profile by ID in a given organization.
  • PUTUpdate specific Desktop Profile by ID/organization/:orgid/agent-profile/:id?agentProfileDTO={"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}Update an existing Desktop Profile by ID in a given organization.
  • DELETEDelete specific Desktop Profile by ID/organization/:orgid/agent-profile/:idDelete an existing Desktop Profile by ID in a given organization.
  • GETList references for a specific Desktop Profile/organization/:orgid/agent-profile/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Desktop Profile by ID in a given organization.
  • GETList Desktop Profiles/organization/:orgid/v2/agent-profileRetrieve a list of Desktop Profiles in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the…

Dial Number

  • GETList Dialed Number Mapping(s)/organization/:orgid/dial-numberRetrieve a list of Dialed Number Mapping(s) in a given organization.
  • POSTCreate a new Dialed Number Mapping/organization/:orgid/dial-numberCreate a new Dialed Number Mapping in a given organization.
  • DELETEDelete all Dialed Number Mapping(s)/organization/:orgid/dial-numberDelete all Dialed Number Mapping(s) in a given organization.
  • POSTBulk save Dialed Number Mapping(s)/organization/:orgid/dial-number/bulkCreate, Update or delete Dialed Number Mapping(s) in bulk in a given organization.
  • GETBulk export Dialed Number Mapping(s)/organization/:orgid/dial-number/bulk-exportDeprecated. Export all Dialed Number Mapping(s) in a given organization.
  • GETList only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s)/organization/:orgid/dial-number/numbers-onlyRetrieve a list of only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s) without pagination in a given organization.
  • GETGet specific Dialed Number Mapping by ID/organization/:orgid/dial-number/:idRetrieve an existing Dialed Number Mapping by ID in a given organization.
  • PUTUpdate specific Dialed Number Mapping by ID/organization/:orgid/dial-number/:idUpdate an existing Dialed Number Mapping by ID in a given organization.
  • DELETEDelete specific Dialed Number Mapping by ID/organization/:orgid/dial-number/:idDelete an existing Dialed Number Mapping by ID in a given organization.
  • GETList references for a specific Dialed Number Mapping/organization/:orgid/dial-number/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Dialed Number Mapping by ID in a given organization.
  • GETList Dialed Number Mapping(s)/organization/:orgid/v2/dial-numberRetrieve a list of Dialed Number Mapping(s) in a given organization.
  • GETList Dialed Number Mapping(s)/organization/:orgid/v3/dial-numberRetrieve a list of Dialed Number Mapping(s) in a given organization.

Dial Plan

  • GETList Dial Plans/organization/:orgid/dial-planDeprecated. Retrieve a list of Dial Plans in a given organization. Deprecated: Dial Plan configuration is deprecated. Dial Plan is no longer available as an…
  • POSTCreate a new Dial Plan/organization/:orgid/dial-planDeprecated. Create a new Dial Plan in a given organization. Deprecated: Dial Plan configuration is deprecated. Dial Plan is no longer available as an Agent…
  • POSTBulk save Dial Plans/organization/:orgid/dial-plan/bulkDeprecated. Create, Update or delete Dial Plans in bulk in a given organization. Deprecated: Dial Plan configuration is deprecated. Dial Plan is no longer…
  • GETGet specific Dial Plan by ID/organization/:orgid/dial-plan/:idDeprecated. Retrieve an existing Dial Plan by ID in a given organization. Deprecated: Dial Plan configuration is deprecated. Dial Plan is no longer available…
  • PUTUpdate specific Dial Plan by ID/organization/:orgid/dial-plan/:idDeprecated. Update an existing Dial Plan by ID in a given organization. Deprecated: Dial Plan configuration is deprecated. Dial Plan is no longer available as…
  • DELETEDelete specific Dial Plan by ID/organization/:orgid/dial-plan/:idDeprecated. Delete an existing Dial Plan by ID in a given organization. Deprecated: Dial Plan configuration is deprecated. Dial Plan is no longer available as…
  • GETList references for a specific Dial Plan/organization/:orgid/dial-plan/:id/incoming-referencesDeprecated. Retrieve a list of all entities that have reference to an existing Dial Plan by ID in a given organization. Deprecated: Dial Plan configuration is…
  • GETList Dial Plans/organization/:orgid/v2/dial-planDeprecated. Retrieve a list of Dial Plans in a given organization. Deprecated: Dial Plan configuration is deprecated. Dial Plan is no longer available as an…

Entry Point

  • GETList Entry Point(s)/organization/:orgid/entry-pointDeprecated. Retrieve a list of Entry Point(s) in a given organization. Note: Array fields are removed from List API. If all fields are required please fetch…
  • POSTCreate a new Entry Point/organization/:orgid/entry-pointCreate a new Entry Point in a given organization.
  • POSTBulk save Entry Point(s)/organization/:orgid/entry-point/bulkCreate, Update or delete Entry Point(s) in bulk in a given organization.
  • GETBulk export Entry Point(s)/organization/:orgid/entry-point/bulk-export?type=INBOUNDDeprecated. Export all Entry Point(s) in a given organization.
  • POSTPurge inactive Entry Point(s)/organization/:orgid/entry-point/purge-inactive-entitiesPurge inactive Entry Point(s) older than the configured interval for a given organization.
  • GETGet specific Entry Point by ID/organization/:orgid/entry-point/:idRetrieve an existing Entry Point by ID in a given organization.
  • PUTUpdate specific Entry Point by ID/organization/:orgid/entry-point/:idUpdate an existing Entry Point by ID in a given organization.
  • DELETEDelete specific Entry Point by ID/organization/:orgid/entry-point/:idDelete an existing Entry Point by ID in a given organization.
  • GETList references for a specific Entry Point/organization/:orgid/entry-point/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Entry Point by ID in a given organization.
  • GETList Entry Point(s)/organization/:orgid/v2/entry-pointRetrieve a list of Entry Point(s) in a given organization. Note: Array fields are removed from List API. If all fields are required please fetch Id's and use…

Global Variables

  • POSTCreate a new Global Variable/organization/:orgid/cad-variableCreate a new Global Variable in a given organization.
  • POSTBulk save Global Variable(s)/organization/:orgid/cad-variable/bulkExport all Global Variable(s) in a given organization.
  • GETBulk export Global Variable(s)/organization/:orgid/cad-variable/bulk-exportDeprecated. Export all Global Variable(s) in a given organization.
  • POSTPurge inactive Global Variable(s)/organization/:orgid/cad-variable/purge-inactive-entitiesPurge inactive Global Variable(s) older than the configured interval for a given organization.
  • GETGet reportable count for Global Variable(s)/organization/:orgid/cad-variable/reportable-countGet count for all the reportable Global Variable(s) in a given organization.
  • GETGet specific Global Variable by ID/organization/:orgid/cad-variable/:idRetrieve an existing Global Variable by ID in a given organization.
  • PUTUpdate specific Global Variable by ID/organization/:orgid/cad-variable/:idUpdate an existing Global Variable by ID in a given organization. Required fields in payload are agentEditable, variableType, agentViewable, reportable,…
  • DELETEDelete specific Global Variable by ID/organization/:orgid/cad-variable/:idDelete an existing Global Variable by ID in a given organization.
  • GETList references for a specific Global Variable/organization/:orgid/cad-variable/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Global Variable by ID in a given organization.
  • GETList Global Variable(s)/organization/:orgid/v2/cad-variableRetrieve a list of Global Variable(s) in a given organization.

Multimedia Profile

  • GETList Multimedia Profile(s)/organization/:orgid/multimedia-profileRetrieve a list of Multimedia Profile(s) in a given organization.
  • POSTCreate a new Multimedia Profile/organization/:orgid/multimedia-profileCreate a new Multimedia Profile in a given organization.
  • POSTBulk save Multimedia Profile(s)/organization/:orgid/multimedia-profile/bulkCreate, Update or delete Multimedia Profile(s) in bulk in a given organization.
  • GETBulk export Multimedia Profile(s)/organization/:orgid/multimedia-profile/bulk-exportDeprecated. Export all Multimedia Profile(s) in a given organization.
  • POSTPurge inactive Multimedia Profile(s)/organization/:orgid/multimedia-profile/purge-inactive-entitiesPurge inactive Multimedia Profile(s) older than the configured interval for a given organization.
  • GETGet specific Multimedia Profile by ID/organization/:orgid/multimedia-profile/:idRetrieve an existing Multimedia Profile by ID in a given organization.
  • PUTUpdate specific Multimedia Profile by ID/organization/:orgid/multimedia-profile/:idUpdate an existing Multimedia Profile by ID in a given organization.
  • DELETEDelete specific Multimedia Profile by ID/organization/:orgid/multimedia-profile/:idDelete an existing Multimedia Profile by ID in a given organization.
  • GETList references for a specific Multimedia Profile/organization/:orgid/multimedia-profile/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Multimedia Profile by ID in a given organization.
  • GETList Multimedia Profile(s)/organization/:orgid/v2/multimedia-profileRetrieve a list of Multimedia Profile(s) in a given organization.

Organization Setting

  • GETList Organization Settings/organization/:orgid/organization-settingDeprecated. Retrieve a list of Organization Settings in a given organization. Deprecated. Use GET /v2/organization-setting instead.
  • GETGet specific Organization Setting by ID/organization/:orgid/organization-setting/:idRetrieve an existing Organization Setting by ID in a given organization.
  • PUTUpdate specific Organization Setting by ID/organization/:orgid/organization-setting/:idUpdate an existing Organization Setting by ID in a given organization. Requests authenticated with a user token can modify only fields designated as…
  • PATCHPartially update Organization Setting by ID/organization/:orgid/organization-setting/:idPartially update Organization Setting by ID in a given organization. Requests authenticated with a user token can modify only fields designated as…
  • GETList Organization Settings/organization/:orgid/v2/organization-settingRetrieve a list of Organization Settings in a given organization.

Outdial ANI

  • GETList Outdial ANIs/organization/:orgid/outdial-aniRetrieve a list of Outdial ANIs in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the…
  • POSTCreate a new Outdial ANI/organization/:orgid/outdial-aniCreate a new Outdial ANI in a given organization.
  • POSTBulk save Outdial ANIs/organization/:orgid/outdial-ani/bulkCreate, Update or delete Outdial ANIs in bulk in a given organization.
  • GETList Outdial ANI Entries/organization/:orgid/outdial-ani/entryRetrieve a list of Outdial ANI Entries in a given organization.
  • GETGet specific Outdial ANI by ID/organization/:orgid/outdial-ani/:idRetrieve an existing Outdial ANI by ID in a given organization.
  • PUTUpdate specific Outdial ANI by ID/organization/:orgid/outdial-ani/:idUpdate an existing Outdial ANI by ID in a given organization.
  • DELETEDelete specific Outdial ANI by ID/organization/:orgid/outdial-ani/:idDelete an existing Outdial ANI by ID in a given organization.
  • GETList references for a specific Outdial ANI/organization/:orgid/outdial-ani/:id/incoming-referencesRetrieve a list of all entities that have reference to an existing Outdial ANI by ID in a given organization.
  • POSTCreate a new Outdial ANI Entry/organization/:orgid/outdial-ani/:outDialAniId/entryCreate a new Outdial ANI Entry in a given organization.
  • POSTBulk save Outdial ANI Entries/organization/:orgid/outdial-ani/:outDialAniId/entry/bulkCreate, Update or delete Outdial ANI Entries in bulk for an Address Book in a given organization.
  • GETGet specific Outdial ANI Entry by ID/organization/:orgid/outdial-ani/:outDialAniId/entry/:idRetrieve an existing Outdial ANI Entry by ID in a given organization.
  • PUTUpdate specific Outdial ANI Entry by ID/organization/:orgid/outdial-ani/:outDialAniId/entry/:idUpdate an existing Outdial ANI Entry by ID in a given organization.
  • DELETEDelete specific Outdial ANI Entry by ID/organization/:orgid/outdial-ani/:outDialAniId/entry/:idDelete an existing Outdial ANI Entry by ID in a given organization.
  • GETList Outdial ANIs/organization/:orgid/v2/outdial-aniRetrieve a list of Outdial ANIs in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the…
  • GETList Outdial ANI Entries/organization/:orgid/v2/outdial-ani/:outDialAniId/entryRetrieve a list of Outdial ANI Entries in a given organization.

Resource Collection

  • POSTCreate a new Resource Collection/organization/:orgid/resource-collectionCreate a new resource collection in a given organization.
  • PATCHBulk partial update Resource Collections/organization/:orgid/resource-collection/bulkUpdate some or all properties for resource collections in bulk for a given organization.
  • POSTUpdate resource with default resource collection/organization/:orgid/resource-collection/update-resourceUpdate resource with default resource collection. Ensure resource should not associated to any resource collection and resource should not be updated and not…
  • GETGet specific Resource Collection by ID/organization/:orgid/resource-collection/:idRetrieve an existing Resource Collection by ID in a given organization.

Showing 300 of 400 endpoints. Fork the collection to see all of them.

API details

Authentication
A bearer token in the Authorization header
OAuth 2.0 (authorization code flow)
A bearer token in the Authorization header
A bearer token in the Authorization header
A bearer token in the Authorization header
Operations
491 operations on 356 pathsGET 213POST 155PUT 49DELETE 49PATCH 25
55 marked deprecated
Main resources
Tasks 27Contact Service Queue 23Address Book 19Users 17Outdial ANI 15Journey - Profile Creation & Insights API 14Agent Personal Greeting Files 13Flows 13Dial Number 12Subscriptions 12
Response formats
application/json */* application/hal+json application/octet-stream
Description format
OpenAPI 3.0.0, API version 1.0.0

How to test the Webex Contact Center in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Webex Contact Center collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List summaries” (POST /generated-summaries/search), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Webex Contact Center?

The Webex Contact Center APIs allow developers to deeply integrate, configure, and manage cloud-based contact center solutions. These APIs cover agent… It is listed under Communication and has 491 endpoints.

Who publishes the Webex Contact Center?

It is listed from Webex's public API description (an OpenAPI document), not published by Webex on Swastik Codes. Anyone who controls webex.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Webex Contact Center?

It accepts 5 methods: A bearer token in the Authorization header; OAuth 2.0 (authorization code flow); A bearer token in the Authorization header; A bearer token in the Authorization header; A bearer token in the Authorization header.

How many endpoints does the Webex Contact Center have?

491 operations on 356 paths (213 GET, 155 POST, 49 PUT, 49 DELETE, 25 PATCH). The largest groups are Tasks, Contact Service Queue, Address Book, Users. This listing's collection holds the first 400.

Is forking the Webex Contact Center free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.