{ "opencollection": "1.0.0", "info": { "name": "Webex Contact Center", "version": "1.0.0" }, "items": [ { "info": { "name": "Agent Summaries", "type": "folder" }, "items": [ { "info": { "name": "List summaries", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/generated-summaries/search", "body": { "type": "json", "data": "{}" } }, "docs": "Lists summaries based on the requested search type." } ] }, { "info": { "name": "Agent Wellbeing", "type": "folder" }, "items": [ { "info": { "name": "Subscribe for realtime burnout events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agentburnout/subscribe", "headers": [ { "name": "X-ORGANIZATION-ID", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Record the realtime burnout events", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agentburnout/action", "headers": [ { "name": "X-ORGANIZATION-ID", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get specific Agent Burnout resource by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/agent-burnout/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Agent Burnout resource." } ] }, "docs": "Retrieve an existing Agent Burnout resource by ID in a given organization. Deprecated. Use GET /ai-feature/agent-burnout/{id} instead." }, { "info": { "name": "Update specific Agent Burnout resource by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/agent-burnout/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Agent Burnout resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Agent Burnout resource by ID in a given organization. Deprecated. Use PUT /ai-feature/agent-burnout/{id} instead." }, { "info": { "name": "List Agent Burnout resource(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/agent-burnout", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "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." } ] }, { "info": { "name": "Contact List Management", "type": "folder" }, "items": [ { "info": { "name": "Create contact list", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list", "params": [ { "name": "campaignId", "value": "CCV_123456789", "type": "path", "description": "Campaign ID to which the contact list belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Create contacts within a contact list", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts", "params": [ { "name": "campaignId", "value": "CCV_123456789", "type": "path", "description": "Campaign ID to which the contact list belongs." }, { "name": "contactListId", "value": "501", "type": "path", "description": "Contact List ID (as a number string)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Update a contact's status within a contact list", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/contacts/:contactId", "params": [ { "name": "campaignId", "value": "CCV_123456789", "type": "path", "description": "Campaign ID." }, { "name": "contactListId", "value": "501", "type": "path", "description": "Contact List ID (as a number string)." }, { "name": "contactId", "value": "CUST12345", "type": "path", "description": "Contact Unique ID (Customer Unique ID or Account Unique ID or Contact_Phone)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Update contact list status", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-list/:contactListId/status", "params": [ { "name": "campaignId", "value": "CCV_123456789", "type": "path", "description": "Campaign ID." }, { "name": "contactListId", "value": "501", "type": "path", "description": "Contact List ID (as a number string)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the status of a contact list (e.g., EXPIRED). Note: This value is not case-sensitive." }, { "info": { "name": "Get Contact Lists within a Campaign", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/campaign-management/campaigns/:campaignId/contact-lists", "params": [ { "name": "campaignId", "value": "CCV_123456789", "type": "path", "description": "Campaign ID." }, { "name": "status", "value": "Active", "type": "query", "description": "Contact List Status filter (Active, Expired, UploadFailed, etc.)" }, { "name": "source", "value": "API", "type": "query", "description": "Contact List Source filter (API, SFTP, ManualFile, GlobalUpload, GlobalSFTP)" } ] }, "docs": "Retrieves all contact lists within a campaign, with optional filters for status and source." } ] }, { "info": { "name": "DNC Management", "type": "folder" }, "items": [ { "info": { "name": "Add Phone Number to DNC List", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber", "params": [ { "name": "dncListName", "value": "corporate-dnc-list", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get Phone Number from DNC List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", "params": [ { "name": "dncListName", "value": "corporate-dnc-list", "type": "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." }, { "name": "phoneNumber", "value": "+1234567890", "type": "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)." } ] }, "docs": "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)." }, { "info": { "name": "Remove Phone Number from DNC List", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v3/campaign-management/dncList/:dncListName/phoneNumber/:phoneNumber", "params": [ { "name": "dncListName", "value": "corporate-dnc-list", "type": "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." }, { "name": "phoneNumber", "value": "+1234567890", "type": "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)." } ] }, "docs": "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." } ] }, { "info": { "name": "AI Feature", "type": "folder" }, "items": [ { "info": { "name": "Create a new Question mapped to AutoCSAT", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/ai-feature/auto-csat/question", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Auto CSAT mapped Question in a given organization." }, { "info": { "name": "Bulk save Question mapped to AutoCSAT", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/ai-feature/auto-csat/question/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Auto CSAT mapped Question(s) in bulk for Auto CSAT resource in a given organization." }, { "info": { "name": "Get specific Question mapped to AutoCSAT by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/ai-feature/auto-csat/question/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Auto CSAT mapped Question." } ] }, "docs": "Retrieve an existing Auto CSAT mapped Question by ID in a given organization." }, { "info": { "name": "Delete specific Question mapped to AutoCSAT by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/ai-feature/auto-csat/question/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Auto CSAT mapped Question." } ] }, "docs": "Delete an existing Auto CSAT mapped Question by ID in a given organization." }, { "info": { "name": "Get specific AI Feature resource by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/ai-feature/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the AI Feature resource." } ] }, "docs": "Retrieve an existing AI Feature resource by ID in a given organization." }, { "info": { "name": "Partially update AI Feature resource by ID", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/organization/:orgid/ai-feature/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the AI Feature resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially update AI Feature resource by ID in a given organization." }, { "info": { "name": "List AI Feature resource(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/ai-feature", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of AI Feature resource(s) in a given organization.Only one entry per organization can exist for AI Feature resource." }, { "info": { "name": "List Question mapped to AutoCSAT(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/ai-feature/auto-csat/question", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of Auto CSAT mapped Question(s) in a given organization." } ] }, { "info": { "name": "Auto CSAT", "type": "folder" }, "items": [ { "info": { "name": "Create a new Auto CSAT mapped Question", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/auto-csat/:autoCsatId/question", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "autoCsatId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Auto CSAT resource" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Auto CSAT mapped Question in a given organization. Deprecated. Use POST /ai-feature/auto-csat/question instead." }, { "info": { "name": "Bulk save Auto CSAT mapped Question(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/auto-csat/:autoCsatId/question/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "autoCsatId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Auto CSAT resource" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get specific Auto CSAT mapped Question by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/auto-csat/:autoCsatId/question/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "autoCsatId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Auto CSAT resource" }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Auto CSAT mapped Question." } ] }, "docs": "Retrieve an existing Auto CSAT mapped Question by ID in a given organization. Deprecated. Use GET /ai-feature/auto-csat/question/{id} instead." }, { "info": { "name": "Delete specific Auto CSAT mapped Question by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/auto-csat/:autoCsatId/question/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "autoCsatId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Auto CSAT resource" }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Auto CSAT mapped Question." } ] }, "docs": "Delete an existing Auto CSAT mapped Question by ID in a given organization. Deprecated. Use DELETE /ai-feature/auto-csat/question/{id} instead." }, { "info": { "name": "Get specific Auto CSAT resource by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/auto-csat/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Auto CSAT resource." } ] }, "docs": "Retrieve an existing Auto CSAT resource by ID in a given organization. Deprecated. Use GET /ai-feature/auto-csat/{id} instead." }, { "info": { "name": "Update specific Auto CSAT resource by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/auto-csat/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Auto CSAT resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Auto CSAT resource by ID in a given organization. Deprecated. Use PUT /ai-feature/auto-csat/{id} instead." }, { "info": { "name": "List Auto CSAT resource(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/auto-csat", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "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." }, { "info": { "name": "List Auto CSAT mapped Question(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/auto-csat/:autoCsatId/question", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "autoCsatId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Auto CSAT resource" }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of Auto CSAT mapped Question(s) in a given organization. Deprecated. Use GET /v2/ai-feature/auto-csat/question instead." } ] }, { "info": { "name": "Generated Summaries", "type": "folder" }, "items": [ { "info": { "name": "Get specific Generated Summaries resource by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/generated-summaries/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Generated Summaries resource." } ] }, "docs": "Retrieve an existing Generated Summaries resource by ID in a given organization. Deprecated. Use GET /ai-feature/generated-summaries/{id} instead." }, { "info": { "name": "Update specific Generated Summaries resource by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/generated-summaries/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Generated Summaries resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Generated Summaries resource by ID in a given organization. Deprecated. Use PUT /ai-feature/generated-summaries/{id} instead." }, { "info": { "name": "List Generated Summaries resource(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/generated-summaries", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "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." } ] }, { "info": { "name": "Business Hour", "type": "folder" }, "items": [ { "info": { "name": "List Business Hours resource(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/business-hours", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Business Hours resource(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." }, { "info": { "name": "Create a new Business Hours resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/business-hours", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Business Hours resource in a given organization." }, { "info": { "name": "Bulk save Business Hours resource(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/business-hours/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Business Hours resource(s) in bulk in a given organization." }, { "info": { "name": "Bulk export Business Hours resource(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/business-hours/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Export all Business Hours resource(s) in a given organization." }, { "info": { "name": "Get specific Business Hours resource by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/business-hours/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Business Hours resource." } ] }, "docs": "Retrieve an existing Business Hours resource by ID in a given organization." }, { "info": { "name": "Update specific Business Hours resource by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/business-hours/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Business Hours resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Business Hours resource by ID in a given organization." }, { "info": { "name": "Delete specific Business Hours resource by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/business-hours/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Business Hours resource." } ] }, "docs": "Delete an existing Business Hours resource by ID in a given organization." }, { "info": { "name": "List references for a specific Business Hours resource", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/business-hours/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "reference-entity", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Business Hours resource by ID in a given organization." }, { "info": { "name": "List Business Hours resource(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/business-hours", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"af9eecc5-0472-4549-9a83-2afdae0d4ba0\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." }, { "name": "sort", "value": "", "type": "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" }, { "name": "includeCount", "value": "", "type": "query", "description": "Enable the flag to get the count of workingHours" }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Business Hours resource(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." } ] }, { "info": { "name": "Holiday List", "type": "folder" }, "items": [ { "info": { "name": "List Holiday List(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/holiday-list", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Holiday List(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." }, { "info": { "name": "Create a new Holiday List", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/holiday-list", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Holiday List in a given organization." }, { "info": { "name": "Bulk save Holiday List(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/holiday-list/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Holiday List(s) in bulk in a given organization." }, { "info": { "name": "Get specific Holiday List by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/holiday-list/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Holiday List." } ] }, "docs": "Retrieve an existing Holiday List by ID in a given organization." }, { "info": { "name": "Update specific Holiday List by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/holiday-list/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Holiday List." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Holiday List by ID in a given organization." }, { "info": { "name": "Delete specific Holiday List by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/holiday-list/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Holiday List." } ] }, "docs": "Delete an existing Holiday List by ID in a given organization." }, { "info": { "name": "List references for a specific Holiday List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/holiday-list/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Holiday List by ID in a given organization." }, { "info": { "name": "List Holiday List(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/holiday-list", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "sort", "value": "", "type": "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" }, { "name": "includeCount", "value": "", "type": "query", "description": "Enable the flag to get the count of holidays" }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Holiday List(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." } ] }, { "info": { "name": "Overrides", "type": "folder" }, "items": [ { "info": { "name": "List Overrides resource(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/overrides", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Overrides resource(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." }, { "info": { "name": "Create a new Overrides resource", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/overrides", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Overrides resource in a given organization." }, { "info": { "name": "Bulk save Overrides resource(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/overrides/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Overrides resource(s) in bulk in a given organization." }, { "info": { "name": "Get specific Overrides resource by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/overrides/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Overrides resource." } ] }, "docs": "Retrieve an existing Overrides resource by ID in a given organization." }, { "info": { "name": "Update specific Overrides resource by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/overrides/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Overrides resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Overrides resource by ID in a given organization." }, { "info": { "name": "Delete specific Overrides resource by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/overrides/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Overrides resource." } ] }, "docs": "Delete an existing Overrides resource by ID in a given organization." }, { "info": { "name": "List references for a specific Overrides resource", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/overrides/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Overrides resource by ID in a given organization." }, { "info": { "name": "List Overrides resource(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/overrides", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "sort", "value": "", "type": "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" }, { "name": "includeLatestOverride", "value": "", "type": "query", "description": "Enable the flag to get the latest Override" }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Overrides resource(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." } ] }, { "info": { "name": "Address Book", "type": "folder" }, "items": [ { "info": { "name": "List Address Book(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/address-book", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Address Book(s) in a given organization. To get address book having large entries use latest apis." }, { "info": { "name": "Create a new Address Book", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/address-book", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Address Book in a given organization. To create address book having large entries use latest apis." }, { "info": { "name": "Bulk export Address Book(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/address-book/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Export all Address Book(s) in a given organization." }, { "info": { "name": "Create a new Address Book Entry", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/address-book/:addressBookId/entry", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "addressBookId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Address Book" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Address Book Entry in a given organization." }, { "info": { "name": "Bulk save Address Book Entry(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/address-book/:addressBookId/entry/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "addressBookId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Address Book" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Address Book Entry(s) in bulk for an Address Book in a given organization." }, { "info": { "name": "Get specific Address Book Entry by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/address-book/:addressBookId/entry/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "addressBookId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Address Book" }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Address Book Entry" } ] }, "docs": "Retrieve an existing Address Book Entry by ID in a given organization." }, { "info": { "name": "Update specific Address Book Entry by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/address-book/:addressBookId/entry/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "addressBookId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Address Book" }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Address Book Entry" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Address Book Entry by ID in a given organization." }, { "info": { "name": "Delete specific Address Book Entry by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/address-book/:addressBookId/entry/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "addressBookId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Address Book" }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Address Book Entry" } ] }, "docs": "Delete an existing Address Book Entry by ID in a given organization." }, { "info": { "name": "Get specific Address Book by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/address-book/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Address Book." } ] }, "docs": "Retrieve an existing Address Book by ID in a given organization. To get address book having large entries use latest apis." }, { "info": { "name": "Update specific Address Book by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/address-book/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Address Book" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Address Book by ID in a given organization. To update address book having large entries use latest apis." }, { "info": { "name": "Delete specific Address Book by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/address-book/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Address Book." } ] }, "docs": "Delete an existing Address Book by ID in a given organization. To delete address book having large entries use latest apis." }, { "info": { "name": "List references for a specific Address Book", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/address-book/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Address Book by ID in a given organization." }, { "info": { "name": "List Address Book(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/address-book", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Address Book(s) in a given organization. To get address book having large entries use latest apis." }, { "info": { "name": "List Address Book Entry(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/address-book/:addressBookId/entry", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "addressBookId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Address Book" }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Address Book Entry(s) in a given organization." }, { "info": { "name": "List Address Book(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v3/address-book", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Address Book(s) in a given organization." }, { "info": { "name": "Create a new Address Book", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/v3/address-book", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Address Book in a given organization." }, { "info": { "name": "Get specific Address Book by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v3/address-book/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Address Book." } ] }, "docs": "Retrieve an existing Address Book by ID in a given organization." }, { "info": { "name": "Update specific Address Book by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/v3/address-book/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Address Book." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Address Book by ID in a given organization." }, { "info": { "name": "Delete specific Address Book by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/v3/address-book/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Address Book." } ] }, "docs": "Delete an existing Address Book by ID in a given organization." } ] }, { "info": { "name": "Agent Personal Greeting Files", "type": "folder" }, "items": [ { "info": { "name": "Create a new Greeting File", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/agent-personal-greeting", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new agent personal greeting File for a given organization." }, { "info": { "name": "deleteReferences_1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/agent-personal-greeting/delete-reference", "params": [ { "name": "orgid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } } }, { "info": { "name": "Get specific Greeting File by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/agent-personal-greeting/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Greeting File." }, { "name": "includeUrl", "value": "true", "type": "query", "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response." } ] }, "docs": "Retrieve an existing Greeting File by ID in a given organization." }, { "info": { "name": "Update specific Greeting File by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/agent-personal-greeting/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Greeting File." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update specific Greeting File by ID in a given organization." }, { "info": { "name": "Partially update Greeting File by ID", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/organization/:orgid/agent-personal-greeting/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Greeting File." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially update Greeting File by ID in a given organization." }, { "info": { "name": "Delete specific Greeting File by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/agent-personal-greeting/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Greeting File." } ] }, "docs": "Delete an existing Greeting File by ID for a given organization." }, { "info": { "name": "getAllConfigWithMetaData", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/agent-personal-greeting", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "query", "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "includeAgentDetails", "value": "", "type": "query", "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled." } ] } }, { "info": { "name": "Create a new Greeting File using v2 API", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/v2/agent-personal-greeting", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Greeting File using v2 API" }, { "info": { "name": "Get specific Greeting File by ID using v2 API", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/agent-personal-greeting/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Greeting File." }, { "name": "includeUrl", "value": "true", "type": "query", "description": "Indicates if the URL for downloading Greeting Fileshould be included in the response." } ] }, "docs": "Retrieve an existing Greeting File by ID in a given organization." }, { "info": { "name": "Update specific Greeting File by ID using v2 API", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/v2/agent-personal-greeting/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Greeting File." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update specific Greeting File by ID in a given organization." }, { "info": { "name": "Partially update Greeting File by ID using v2 API", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/organization/:orgid/v2/agent-personal-greeting/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Greeting File." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially update Greeting File by ID in a given organization." }, { "info": { "name": "Delete specific Greeting File by ID using v2 API", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/v2/agent-personal-greeting/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Greeting File." } ] }, "docs": "Delete an existing Greeting File by ID for a given organization." }, { "info": { "name": "List Greeting File(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v3/agent-personal-greeting", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "query", "description": "Specify a filter based on which the results will be fetched. Supported fields are : firstname, lastname, email, ciUserId and attribute tag \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "includeAgentDetails", "value": "", "type": "query", "description": "If includeAgentDetails is set to true then projection, filtering, searching, and sorting on agent firstName, lastName and email will be enabled." } ] }, "docs": "Retrieve a list of Greeting File(s) in a given organization." } ] }, { "info": { "name": "Audio Files", "type": "folder" }, "items": [ { "info": { "name": "Create a new Audio File", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/audio-file", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Audio File in a given organization." }, { "info": { "name": "Get specific Audio File by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/audio-file/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Audio File." }, { "name": "includeUrl", "value": "true", "type": "query", "description": "Indicates if the URL for downloading Audio Fileshould be included in the response." } ] }, "docs": "Retrieve an existing Audio File by ID in a given organization." }, { "info": { "name": "Update specific Audio File by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/audio-file/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Audio File." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Audio File by ID in a given organization." }, { "info": { "name": "Partially update Audio File by ID", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/organization/:orgid/audio-file/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Audio File." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially update Audio File by ID in a given organization." }, { "info": { "name": "Delete specific Audio File by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/audio-file/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Audio File." } ] }, "docs": "Delete an existing Audio File by ID in a given organization." }, { "info": { "name": "List references for a specific Audio File", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/audio-file/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Audio File by ID in a given organization." }, { "info": { "name": "List Audio File(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/audio-file", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except URL" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Audio File(s) in a given organization." } ] }, { "info": { "name": "Auxiliary Code", "type": "folder" }, "items": [ { "info": { "name": "List Auxiliary Code(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/auxiliary-code", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Auxiliary Code(s) in a given organization." }, { "info": { "name": "Create a new Auxiliary Code", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/auxiliary-code", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Auxiliary Code in a given organization." }, { "info": { "name": "Bulk save Auxiliary Code(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/auxiliary-code/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Auxiliary Code(s) in bulk in a given organization." }, { "info": { "name": "Bulk partial update Auxiliary Code(s)", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/organization/:orgid/auxiliary-code/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update some or all properties for multiple Auxiliary codes in bulk in a given organization." }, { "info": { "name": "Bulk export Auxiliary Code(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/auxiliary-code/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Export all Auxiliary Code(s) in a given organization." }, { "info": { "name": "Purge inactive Auxiliary Code(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/auxiliary-code/purge-inactive-entities", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "nextStartId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "query", "description": "This is the entity ID from which items for the next purge batch with be selected." } ] }, "docs": "Purge inactive Auxiliary Code(s) older than the configured interval for a given organization." }, { "info": { "name": "Get specific Auxiliary Code by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/auxiliary-code/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Auxiliary Code" } ] }, "docs": "Retrieve an existing Auxiliary Code by ID in a given organization." }, { "info": { "name": "Update specific Auxiliary Code by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/auxiliary-code/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Auxiliary Code." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Auxiliary Code by ID in a given organization." }, { "info": { "name": "Delete specific Auxiliary Code by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/auxiliary-code/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Auxiliary Code." } ] }, "docs": "Delete an existing Auxiliary Code by ID in a given organization." }, { "info": { "name": "List references for a specific Auxiliary Code", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/auxiliary-code/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Auxiliary Code by ID in a given organization." }, { "info": { "name": "List Auxiliary Code(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/auxiliary-code", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." }, { "name": "desktopProfileFilter", "value": "", "type": "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." }, { "name": "supervisedUserId", "value": "", "type": "query", "description": "User Id of the Agent whose Agent Profile associated Idle Codes are to be fetched." } ] }, "docs": "Retrieve a list of Auxiliary Code(s) in a given organization." } ] }, { "info": { "name": "Contact Number", "type": "folder" }, "items": [ { "info": { "name": "Create a new Contact Number", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-number", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Contact Number in a given organization." }, { "info": { "name": "List all contact numbers(property - number)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-number/all-numbers", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ] }, "docs": "Retrieve a list of only contact numbers(property - number) from Contact Number(s) without pagination in a given organization." }, { "info": { "name": "Bulk save Contact Number(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-number/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Contact Number(s) in bulk in a given organization." }, { "info": { "name": "Bulk export Contact Number(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-number/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Export all Contact Number(s) in a given organization." }, { "info": { "name": "Get specific Contact Number by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-number/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Contact Number." } ] }, "docs": "Retrieve an existing Contact Number by ID in a given organization." }, { "info": { "name": "Update specific Contact Number by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/contact-number/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Contact Number." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Contact Number by ID in a given organization." }, { "info": { "name": "Delete specific Contact Number by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/contact-number/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Contact Number." } ] }, "docs": "Delete an existing Contact Number by ID in a given organization." }, { "info": { "name": "List Contact Number(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/contact-number", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "search", "value": "contact center", "type": "query", "description": "Filter data based on the search keyword." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Contact Number(s) in a given organization." } ] }, { "info": { "name": "Contact Service Queue", "type": "folder" }, "items": [ { "info": { "name": "List Contact Service Queue(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "channelTypes", "value": "TELEPHONY,CHAT", "type": "query", "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering." }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Contact Service Queue(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." }, { "info": { "name": "Create a new Contact Service Queue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Contact Service Queue in a given organization." }, { "info": { "name": "Bulk save Contact Service Queue(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Contact Service Queue(s) in bulk in a given organization." }, { "info": { "name": "Bulk partial update Contact Service Queue(s)", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update some or all properties for multiple Contact Service Queue(s) in bulk in a given organization." }, { "info": { "name": "Bulk export Contact Service Queue(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "type", "value": "INBOUND", "type": "query", "description": "Indicates the queue type; can be INBOUND or OUTBOUND." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Export all Contact Service Queue(s) in a given organization." }, { "info": { "name": "List Skill CSQs by Skill Profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-skill-profile-id/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." } ] }, "docs": "Retrieve skill-based Contact Service Queues by skill profile ID in a given organization." }, { "info": { "name": "List Internal Skill CSQs by Profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-skill-profile-id/:id/internal", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." } ] }, "docs": "Retrieve skill-based Contact Service Queues by skill profile ID for internal use in a given organization." }, { "info": { "name": "List Team CSQs by Team ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-team-id/:id/internal", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." } ] }, "docs": "Retrieve team-based Contact Service Queues by team ID for internal use in a given organization." }, { "info": { "name": "List Agent CSQs by CI User ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/by-user-ci-id/:ciUserId/internal", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "ciUserId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ciUserId" } ] }, "docs": "Retrieve agent-based Contact Service Queues by CI user ID for internal use in a given organization." }, { "info": { "name": "Delete CSQ References", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/delete-reference", "params": [ { "name": "orgid", "value": "", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete references for Contact Service Queues in a given organization." }, { "info": { "name": "List CSQs by Skills and Profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-dynamic-skills-and-skillProfile", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve skill-based Contact Service Queues by dynamic skills and skill profile in a given organization." }, { "info": { "name": "List CSQs by User and Profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-by-userId-skillProfileId", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve skill-based Contact Service Queues by user ID and skill profile ID in a given organization." }, { "info": { "name": "List Manually Assignable CSQs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/fetch-manually-assignable-queues", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve manually assignable Contact Service Queues in a given organization." }, { "info": { "name": "Purge inactive Contact Service Queue(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/purge-inactive-entities", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "nextStartId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "query", "description": "This is the entity ID from which items for the next purge batch with be selected." } ] }, "docs": "Purge inactive Contact Service Queue(s) older than the configured interval for a given organization." }, { "info": { "name": "List Skill CSQs by CI User ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/skill-based-queues/by-ci-user-id/:id/internal", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." } ] }, "docs": "Retrieve skill-based Contact Service Queues by CI user ID for internal use in a given organization." }, { "info": { "name": "Get specific Contact Service Queue by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Contact Service Queue." }, { "name": "agentsUpdatedInfo", "value": "", "type": "query", "description": "If `true`, returns the user details who has last updated the agents list in an agent based queue." } ] }, "docs": "Retrieve an existing Contact Service Queue by ID in a given organization." }, { "info": { "name": "Update specific Contact Service Queue by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Contact Service Queue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Contact Service Queue by ID in a given organization." }, { "info": { "name": "Delete specific Contact Service Queue by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Contact Service Queue." } ] }, "docs": "Delete an existing Contact Service Queue by ID in a given organization." }, { "info": { "name": "List CSQ References by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Contact Service Queue by ID in a given organization." }, { "info": { "name": "Bulk save Contact Service Queue(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/contact-service-queue/v2/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Contact Service Queue(s) in bulk in a given organization." }, { "info": { "name": "List Contact Service Queue(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "desktopProfileFilter", "value": "", "type": "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." }, { "name": "provisioningView", "value": "", "type": "query", "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false." }, { "name": "singleObjectResponse", "value": "", "type": "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." }, { "name": "includeAIMappingCount", "value": "", "type": "query", "description": "If set to true, the API response will include the count of each AI features mapped to the entity." } ] }, "docs": "Retrieve a list of Contact Service Queue(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." }, { "info": { "name": "Create a new Contact Service Queue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Contact Service Queue in a given organization." }, { "info": { "name": "List agent based Contact Service Queue(s)by user ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/by-user-id/:userid/agent-based-queues", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "userid", "value": "", "type": "path" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of agent based Contact Service Queue(s) by user iD in a given organization." }, { "info": { "name": "List skill based Contact Service Queue(s)by user ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/by-user-id/:userid/skill-based-queues", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "userid", "value": "", "type": "path" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of skill based Contact Service Queue(s) by user ID in a given organization." }, { "info": { "name": "List team based Contact Service Queue(s)by user ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/by-user-id/:userid/team-based-queues", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "userid", "value": "", "type": "path" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of team based Contact Service Queue(s) by user ID in a given organization." }, { "info": { "name": "List queue mapping summary grouped by Assistant Skill", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/fetch-by-grouped-assistant-skill", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get specific Contact Service Queue by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Contact Service Queue." }, { "name": "agentsUpdatedInfo", "value": "", "type": "query", "description": "If `true`, returns the user details who has last updated the agents list in an agent based queue." } ] }, "docs": "Retrieve an existing Contact Service Queue by ID in a given organization." }, { "info": { "name": "Update specific Contact Service Queue by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Contact Service Queue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Contact Service Queue by ID in a given organization." }, { "info": { "name": "Add or remove agents/users to/from an agent based queue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/v2/contact-service-queue/:id/reassign-agents", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Contact Service Queue." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API can be used by a contact center supervisor to add or remove agents to/from an agent based queue that they have access to by virtue of their user profile access rights. Additionally, the request payload should contain the user id(s) managed by the supervisor." }, { "info": { "name": "List Contact Service Queue(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v3/contact-service-queue", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "desktopProfileFilter", "value": "", "type": "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." }, { "name": "provisioningView", "value": "", "type": "query", "description": "If set to true, the API will only return data that user has access to, according to User Profile. This query parameter is applicable only when desktopProfileFilter query parameter is false." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Contact Service Queue(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." } ] }, { "info": { "name": "Desktop Layout", "type": "folder" }, "items": [ { "info": { "name": "Create a new Desktop Layout", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/desktop-layout", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Desktop Layout in a given organization." }, { "info": { "name": "Bulk save Desktop Layout(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Desktop Layout(s) in bulk in a given organization." }, { "info": { "name": "Bulk export Desktop Layout(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/desktop-layout/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Export all Desktop Layout(s) in a given organization." }, { "info": { "name": "Purge inactive Desktop Layout(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/desktop-layout/purge-inactive-entities", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "nextStartId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "query", "description": "This is the entity ID from which items for the next purge batch with be selected." } ] }, "docs": "Purge inactive Desktop Layout(s) older than the configured interval for a given organization." }, { "info": { "name": "Get specific Desktop Layout by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Desktop Layout." } ] }, "docs": "Retrieve an existing Desktop Layout by ID in a given organization." }, { "info": { "name": "Update specific Desktop Layout by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Desktop Layout." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Desktop Layout by ID in a given organization." }, { "info": { "name": "Delete specific Desktop Layout by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/desktop-layout/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Desktop Layout." } ] }, "docs": "Delete an existing Desktop Layout by ID in a given organization." }, { "info": { "name": "List references for a specific Desktop Layout", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/desktop-layout/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Desktop Layout by ID in a given organization." }, { "info": { "name": "List Desktop Layout(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/desktop-layout", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported." }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." }, { "name": "provisioningView", "value": "", "type": "query", "description": "If set to true, the API will only return data that user has access to, according to User Profile." } ] }, "docs": "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: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API." } ] }, { "info": { "name": "Desktop Profile", "type": "folder" }, "items": [ { "info": { "name": "List Desktop Profile(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/agent-profile", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) " }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Desktop Profile(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." }, { "info": { "name": "Create a new Desktop Profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/agent-profile", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Desktop Profile in a given organization." }, { "info": { "name": "Bulk save Desktop Profile(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/agent-profile/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Desktop Profile(s) in bulk in a given organization." }, { "info": { "name": "Bulk export Desktop Profile(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/agent-profile/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Export all Desktop Profile(s) in a given organization." }, { "info": { "name": "Purge inactive Desktop Profile(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/agent-profile/purge-inactive-entities", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "nextStartId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "query", "description": "This is the entity ID from which items for the next purge batch with be selected." } ] }, "docs": "Purge inactive Desktop Profile(s) older than the configured interval for a given organization." }, { "info": { "name": "Get specific Desktop Profile by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Desktop Profile." } ] }, "docs": "Retrieve an existing Desktop Profile by ID in a given organization." }, { "info": { "name": "Update specific Desktop Profile by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Desktop Profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Desktop Profile by ID in a given organization." }, { "info": { "name": "Delete specific Desktop Profile by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/agent-profile/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Desktop Profile." } ] }, "docs": "Delete an existing Desktop Profile by ID in a given organization." }, { "info": { "name": "List references for a specific Desktop Profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/agent-profile/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Desktop Profile by ID in a given organization." }, { "info": { "name": "List Desktop Profile(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/agent-profile", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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 space, and if so kindly bound it with quotes to apply filter.\n" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported except ( wrapUpCodes,queues, idleCodes,entryPoints, buddyTeams, dialPlans, loginVoiceOptions, viewableStatistics, thresholdRules,agentDNValidationCriterions ) " }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Desktop Profile(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." } ] }, { "info": { "name": "Dial Number", "type": "folder" }, "items": [ { "info": { "name": "List Dialed Number Mapping(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/dial-number", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of Dialed Number Mapping(s) in a given organization." }, { "info": { "name": "Create a new Dialed Number Mapping", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/dial-number", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Dialed Number Mapping in a given organization." }, { "info": { "name": "Delete all Dialed Number Mapping(s)", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/dial-number", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ] }, "docs": "Delete all Dialed Number Mapping(s) in a given organization." }, { "info": { "name": "Bulk save Dialed Number Mapping(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/dial-number/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Dialed Number Mapping(s) in bulk in a given organization." }, { "info": { "name": "Bulk export Dialed Number Mapping(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/dial-number/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Export all Dialed Number Mapping(s) in a given organization." }, { "info": { "name": "List only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/dial-number/numbers-only", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ] }, "docs": "Retrieve a list of only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s) without pagination in a given organization." }, { "info": { "name": "Get specific Dialed Number Mapping by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/dial-number/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Dialed Number Mapping." } ] }, "docs": "Retrieve an existing Dialed Number Mapping by ID in a given organization." }, { "info": { "name": "Update specific Dialed Number Mapping by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/dial-number/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Dialed Number Mapping." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Dialed Number Mapping by ID in a given organization." }, { "info": { "name": "Delete specific Dialed Number Mapping by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/dial-number/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Dialed Number Mapping." } ] }, "docs": "Delete an existing Dialed Number Mapping by ID in a given organization." }, { "info": { "name": "List references for a specific Dialed Number Mapping", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/dial-number/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Dialed Number Mapping by ID in a given organization." }, { "info": { "name": "List Dialed Number Mapping(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/dial-number", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "includeEntryPointName", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Dialed Number Mapping(s) in a given organization." }, { "info": { "name": "List Dialed Number Mapping(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v3/dial-number", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "includeEntryPointName", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Dialed Number Mapping(s) in a given organization." } ] }, { "info": { "name": "Dial Plan", "type": "folder" }, "items": [ { "info": { "name": "List Dial Plan(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/dial-plan", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Dial Plan(s) in a given organization." }, { "info": { "name": "Create a new Dial Plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/dial-plan", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Dial Plan in a given organization." }, { "info": { "name": "Bulk save Dial Plan(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/dial-plan/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Dial Plan(s) in bulk in a given organization." }, { "info": { "name": "Bulk export Dial Plan(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/dial-plan/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Export all Dial Plan(s) in a given organization." }, { "info": { "name": "Get specific Dial Plan by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Dial Plan." } ] }, "docs": "Retrieve an existing Dial Plan by ID in a given organization." }, { "info": { "name": "Update specific Dial Plan by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Dial Plan." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Dial Plan by ID in a given organization." }, { "info": { "name": "Delete specific Dial Plan by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/dial-plan/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Dial Plan." } ] }, "docs": "Delete an existing Dial Plan by ID in a given organization." }, { "info": { "name": "List references for a specific Dial Plan", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/dial-plan/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Dial Plan by ID in a given organization." }, { "info": { "name": "List Dial Plan(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/dial-plan", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Dial Plan(s) in a given organization." } ] }, { "info": { "name": "Entry Point", "type": "folder" }, "items": [ { "info": { "name": "List Entry Point(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/entry-point", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "channelTypes", "value": "TELEPHONY,CHAT", "type": "query", "description": " [DEPRECATED] Channel type(s) allowed by the system.Separate values with commas.Use uppercase. By default, there is no channel type filtering." }, { "name": "attributes", "value": "id", "type": "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) " }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "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." }, { "info": { "name": "Create a new Entry Point", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/entry-point", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Entry Point in a given organization." }, { "info": { "name": "Bulk save Entry Point(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/entry-point/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Entry Point(s) in bulk in a given organization." }, { "info": { "name": "Bulk export Entry Point(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/entry-point/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "type", "value": "INBOUND", "type": "query", "description": "Indicates the type of Entrypoint; can be INBOUND or OUTBOUND." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Export all Entry Point(s) in a given organization." }, { "info": { "name": "Purge inactive Entry Point(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/entry-point/purge-inactive-entities", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "nextStartId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "query", "description": "This is the entity ID from which items for the next purge batch with be selected." } ] }, "docs": "Purge inactive Entry Point(s) older than the configured interval for a given organization." }, { "info": { "name": "Get specific Entry Point by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/entry-point/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Entry Point." }, { "name": "includeNames", "value": "", "type": "query", "description": "Specifiy whether to include flow override settings reference variable names." } ] }, "docs": "Retrieve an existing Entry Point by ID in a given organization." }, { "info": { "name": "Update specific Entry Point by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/entry-point/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Entry Point." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Entry Point by ID in a given organization." }, { "info": { "name": "Delete specific Entry Point by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/entry-point/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Entry Point." } ] }, "docs": "Delete an existing Entry Point by ID in a given organization." }, { "info": { "name": "List references for a specific Entry Point", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/entry-point/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Entry Point by ID in a given organization." }, { "info": { "name": "List Entry Point(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/entry-point", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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) " }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." }, { "name": "desktopProfileFilter", "value": "", "type": "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." }, { "name": "provisioningView", "value": "", "type": "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. " }, { "name": "includeCount", "value": "", "type": "query", "description": "Enable the flag to get the count of DN-EP Mapping" }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "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." } ] }, { "info": { "name": "Global Variables", "type": "folder" }, "items": [ { "info": { "name": "Create a new Global Variable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/cad-variable", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Global Variable in a given organization." }, { "info": { "name": "Bulk save Global Variable(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/cad-variable/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Export all Global Variable(s) in a given organization." }, { "info": { "name": "Bulk export Global Variable(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/cad-variable/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Export all Global Variable(s) in a given organization." }, { "info": { "name": "Purge inactive Global Variable(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/cad-variable/purge-inactive-entities", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "nextStartId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "query", "description": "This is the entity ID from which items for the next purge batch with be selected." } ] }, "docs": "Purge inactive Global Variable(s) older than the configured interval for a given organization." }, { "info": { "name": "Get reportable count for Global Variable(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/cad-variable/reportable-count", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ] }, "docs": "Get count for all the reportable Global Variable(s) in a given organization." }, { "info": { "name": "Get specific Global Variable by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "ID of the Global Variable." } ] }, "docs": "Retrieve an existing Global Variable by ID in a given organization." }, { "info": { "name": "Update specific Global Variable by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "ID of the Global Variable." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Global Variable by ID in a given organization. Required fields in payload are agentEditable, variableType, agentViewable, reportable, active, defaultValue." }, { "info": { "name": "Delete specific Global Variable by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/cad-variable/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "ID of the Global Variable." } ] }, "docs": "Delete an existing Global Variable by ID in a given organization." }, { "info": { "name": "List references for a specific Global Variable", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/cad-variable/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Global Variable by ID in a given organization." }, { "info": { "name": "List Global Variable(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/cad-variable", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Global Variable(s) in a given organization." } ] }, { "info": { "name": "Multimedia Profile", "type": "folder" }, "items": [ { "info": { "name": "List Multimedia Profile(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/multimedia-profile", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Multimedia Profile(s) in a given organization." }, { "info": { "name": "Create a new Multimedia Profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/multimedia-profile", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Multimedia Profile in a given organization." }, { "info": { "name": "Bulk save Multimedia Profile(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Multimedia Profile(s) in bulk in a given organization." }, { "info": { "name": "Bulk export Multimedia Profile(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/multimedia-profile/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Export all Multimedia Profile(s) in a given organization." }, { "info": { "name": "Purge inactive Multimedia Profile(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/multimedia-profile/purge-inactive-entities", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "nextStartId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "query", "description": "This is the entity ID from which items for the next purge batch with be selected." } ] }, "docs": "Purge inactive Multimedia Profile(s) older than the configured interval for a given organization." }, { "info": { "name": "Get specific Multimedia Profile by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Multimedia Profile." } ] }, "docs": "Retrieve an existing Multimedia Profile by ID in a given organization." }, { "info": { "name": "Update specific Multimedia Profile by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Multimedia Profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Multimedia Profile by ID in a given organization." }, { "info": { "name": "Delete specific Multimedia Profile by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Multimedia Profile." } ] }, "docs": "Delete an existing Multimedia Profile by ID in a given organization." }, { "info": { "name": "List references for a specific Multimedia Profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/multimedia-profile/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Multimedia Profile by ID in a given organization." }, { "info": { "name": "List Multimedia Profile(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/multimedia-profile", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Multimedia Profile(s) in a given organization." } ] }, { "info": { "name": "Outdial ANI", "type": "folder" }, "items": [ { "info": { "name": "List Outdial ANI(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/outdial-ani", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Outdial ANI(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." }, { "info": { "name": "Create a new Outdial ANI", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/outdial-ani", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Outdial ANI in a given organization." }, { "info": { "name": "Bulk save Outdial ANI(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Outdial ANI(s) in bulk in a given organization." }, { "info": { "name": "Bulk export Outdial ANI(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/outdial-ani/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Export all Outdial ANI(s) in a given organization." }, { "info": { "name": "List Outdial ANI Entry(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/outdial-ani/entry", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported." }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of Outdial ANI Entry(s) in a given organization." }, { "info": { "name": "Get specific Outdial ANI by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Outdial ANI." } ] }, "docs": "Retrieve an existing Outdial ANI by ID in a given organization." }, { "info": { "name": "Update specific Outdial ANI by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Outdial ANI." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Outdial ANI by ID in a given organization." }, { "info": { "name": "Delete specific Outdial ANI by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/outdial-ani/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Outdial ANI." } ] }, "docs": "Delete an existing Outdial ANI by ID in a given organization." }, { "info": { "name": "List references for a specific Outdial ANI", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/outdial-ani/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Outdial ANI by ID in a given organization." }, { "info": { "name": "Create a new Outdial ANI Entry", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "outDialAniId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Outdial ANI" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Outdial ANI Entry in a given organization." }, { "info": { "name": "Bulk save Outdial ANI Entry(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "outDialAniId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Outdial ANI" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Outdial ANI Entry(s) in bulk for an Address Book in a given organization." }, { "info": { "name": "Get specific Outdial ANI Entry by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "outDialAniId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Outdial ANI" }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." } ] }, "docs": "Retrieve an existing Outdial ANI Entry by ID in a given organization." }, { "info": { "name": "Update specific Outdial ANI Entry by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "outDialAniId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Outdial ANI" }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Outdial ANI Entry by ID in a given organization." }, { "info": { "name": "Delete specific Outdial ANI Entry by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/outdial-ani/:outDialAniId/entry/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "outDialAniId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Outdial ANI" }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." } ] }, "docs": "Delete an existing Outdial ANI Entry by ID in a given organization." }, { "info": { "name": "List Outdial ANI(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/outdial-ani", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Outdial ANI(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." }, { "info": { "name": "List Outdial ANI Entry(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/outdial-ani/:outDialAniId/entry", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "outDialAniId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "Resource ID of the Outdial ANI" }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported." }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of Outdial ANI Entry(s) in a given organization." } ] }, { "info": { "name": "Resource Collection", "type": "folder" }, "items": [ { "info": { "name": "Create a new Resource Collection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/resource-collection", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new resource collection in a given organization." }, { "info": { "name": "Bulk partial update Resource Collections", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/organization/:orgid/resource-collection/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update some or all properties for resource collections in bulk for a given organization." }, { "info": { "name": "Update resource with default resource collection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/resource-collection/update-resource", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get specific Resource Collection by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/resource-collection/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Resource Collection." } ] }, "docs": "Retrieve an existing Resource Collection by ID in a given organization." }, { "info": { "name": "Update specific Resource Collection by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/resource-collection/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Resource Collection." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing resource collection by ID in a given organization." }, { "info": { "name": "Delete specific Resource Collection by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/resource-collection/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Resource Collection." } ] }, "docs": "Delete an existing resource collection by ID in a given organization." }, { "info": { "name": "List references for a specific Resource Collection", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/resource-collection/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing resource collection by ID in a given organization." }, { "info": { "name": "List Resource Collections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/resource-collection", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported." }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of resource collections in a given organization." } ] }, { "info": { "name": "Site", "type": "folder" }, "items": [ { "info": { "name": "List Site(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/site", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" } ] }, "docs": "Retrieve a list of Site(s) in a given organization." }, { "info": { "name": "Create a new Site", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/site", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Site in a given organization." }, { "info": { "name": "Bulk save Site(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/site/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Site(s) in bulk in a given organization." }, { "info": { "name": "Bulk export Site(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/site/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Export all Site(s) in a given organization." }, { "info": { "name": "Purge inactive Site(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/site/purge-inactive-entities", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "nextStartId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "query", "description": "This is the entity ID from which items for the next purge batch with be selected." } ] }, "docs": "Purge inactive Site(s) older than the configured interval for a given organization." }, { "info": { "name": "Get specific Site by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/site/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Site." } ] }, "docs": "Retrieve an existing Site by ID in a given organization." }, { "info": { "name": "Update specific Site by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/site/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Site." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Site by ID in a given organization." }, { "info": { "name": "Delete specific Site by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/site/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "Resource ID of the Site." } ] }, "docs": "Delete an existing Site by ID in a given organization." }, { "info": { "name": "List references for a specific Site", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/site/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Site by ID in a given organization." }, { "info": { "name": "List Site(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/site", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Site(s) in a given organization." } ] }, { "info": { "name": "Skill", "type": "folder" }, "items": [ { "info": { "name": "List Skill(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/skill", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "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." }, { "info": { "name": "Create a new Skill", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/skill", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "payloadDTO", "value": "[object Object]", "type": "query", "description": "Skill configuration data" } ] }, "docs": "Create a new Skill in a given organization." }, { "info": { "name": "Bulk save Skill(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/skill/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Skill(s) in bulk in a given organization." }, { "info": { "name": "Populate json-attributes field for a given skill-id of an organization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/skill/populate-json-attr/:id", "params": [ { "name": "orgid", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Populate json-attributes field for a given skill-id of an organization" }, { "info": { "name": "Purge inactive Skill(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/skill/purge-inactive-entities", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "nextStartId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "query", "description": "This is the entity ID from which items for the next purge batch with be selected." } ] }, "docs": "Purge inactive Skill(s) older than the configured interval for a given organization." }, { "info": { "name": "Get specific Skill by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/skill/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Skill." } ] }, "docs": "Retrieve an existing Skill by ID in a given organization." }, { "info": { "name": "Update specific Skill by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/skill/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Skill." }, { "name": "payloadDTO", "value": "[object Object]", "type": "query", "description": "Skill configuration data for update" } ] }, "docs": "Update an existing Skill by ID in a given organization." }, { "info": { "name": "Delete specific Skill by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/skill/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Skill." } ] }, "docs": "Delete an existing Skill by ID in a given organization." }, { "info": { "name": "List references for a specific Skill", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/skill/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Skill by ID in a given organization." }, { "info": { "name": "List Skill(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/skill", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "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." } ] }, { "info": { "name": "Skill Profile", "type": "folder" }, "items": [ { "info": { "name": "List Skill Profile(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/skill-profile", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "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." }, { "info": { "name": "Create a new Skill Profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/skill-profile", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "skillProfileDTO", "value": "[object Object]", "type": "query", "description": "Skill profile configuration data" } ] }, "docs": "Create a new Skill Profile in a given organization." }, { "info": { "name": "Bulk save Skill Profile(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/skill-profile/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Skill Profile(s) in bulk in a given organization." }, { "info": { "name": "Get specific Skill Profile by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/skill-profile/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Skill Profile." }, { "name": "includeSkillDetails", "value": "", "type": "query", "description": "If set to true returns skill details" } ] }, "docs": "Retrieve an existing Skill Profile by ID in a given organization." }, { "info": { "name": "Update specific Skill Profile by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/skill-profile/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Skill Profile." }, { "name": "skillProfileDTO", "value": "[object Object]", "type": "query", "description": "Skill profile configuration data for update" } ] }, "docs": "Update an existing Skill Profile by ID in a given organization." }, { "info": { "name": "Delete specific Skill Profile by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/skill-profile/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Skill Profile." } ] }, "docs": "Delete an existing Skill Profile by ID in a given organization." }, { "info": { "name": "List references for a specific Skill Profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/skill-profile/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Skill Profile by ID in a given organization." }, { "info": { "name": "List Skill Profile(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/skill-profile", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "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." } ] }, { "info": { "name": "Team", "type": "folder" }, "items": [ { "info": { "name": "List Team(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/team", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Team(s) in a given organization." }, { "info": { "name": "Create a new Team", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/team", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "teamDTO", "value": "", "type": "query" } ] }, "docs": "Create a new Team in a given organization." }, { "info": { "name": "Bulk save Team(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/team/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Team(s) in bulk in a given organization." }, { "info": { "name": "Purge inactive Team(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/team/purge-inactive-entities", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "nextStartId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "query", "description": "This is the entity ID from which items for the next purge batch with be selected." } ] }, "docs": "Purge inactive Team(s) older than the configured interval for a given organization." }, { "info": { "name": "Get specific Team by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/team/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Team" } ] }, "docs": "Retrieve an existing Team by ID in a given organization." }, { "info": { "name": "Update specific Team by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/team/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Team." }, { "name": "teamDTO", "value": "", "type": "query" } ] }, "docs": "Update an existing Team by ID in a given organization." }, { "info": { "name": "Delete specific Team by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/team/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the Team." } ] }, "docs": "Delete an existing Team by ID in a given organization." }, { "info": { "name": "List references for a specific Team", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/team/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Team by ID in a given organization." }, { "info": { "name": "List Team(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/team", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "query", "description": "Specify a filter based on which the results will be fetched. All the fields are supported except: organizationId, userIds, queueRankings, createdTime, lastUpdatedTime \n\nUse userId field to filter teams assocaited to provided user. \n\nThe examples below show some search queries\n- id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id!=\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"\n- id=in=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\n- id=out=(\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\",\"a421e0b2-732e-46f3-a057-39160a53afb9\")\nThis parameter uses the RSQL query syntax, a URI-friendly format for expressing criteria for filtering REST entities. For more information about RSQL in general, see this reference. For a list of supported operators, see this syntax guide.\n\nNote: values to be used in the filter syntax should not contain spaces. If they do, please enclose them in quotes to apply the filter.\n" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "supervisorView", "value": "", "type": "query", "description": "If set to true, the API will only return data that user has access to, according to User Profile" }, { "name": "provisioningView", "value": "", "type": "query", "description": "If set to true, the API will only return data that user has access to, according to User Profile." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Team(s) in a given organization." } ] }, { "info": { "name": "User Profiles", "type": "folder" }, "items": [ { "info": { "name": "List references for a specific User Profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/user-profile/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing user profile by ID in a given organization." }, { "info": { "name": "List user profiles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v3/user-profile", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "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)" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of user profiles 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." }, { "info": { "name": "Create a new User Profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/v3/user-profile", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new user profile in a given organization." }, { "info": { "name": "Bulk save User Profiles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/v3/user-profile/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete user profiles in bulk in a given organization." }, { "info": { "name": "Get specific User Profile by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the User Profile." }, { "name": "includeNames", "value": "true", "type": "query", "description": "Flag to include resource names in the response." } ] }, "docs": "Retrieve an existing user profile by ID in a given organization." }, { "info": { "name": "Update specific User Profile by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the User Profile." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing user profile by ID in a given organization." }, { "info": { "name": "Delete specific User Profile by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the User Profile." } ] }, "docs": "Delete an existing user profile by ID in a given organization." }, { "info": { "name": "Get specific User Profile ACL by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v3/user-profile/:id/acl", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the User Profile." }, { "name": "names", "value": "site,team", "type": "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" } ] }, "docs": "Retrieve an existing User Profile ACL by ID in a given organization." } ] }, { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "List User(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/user", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of User(s) in a given organization." }, { "info": { "name": "Bulk partial update Users", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/organization/:orgid/user/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update some or all properties for multiple users in bulk for a given organization." }, { "info": { "name": "Bulk update User dynamic skills", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/organization/:orgid/user/bulk/update-dynamic-skill/:skillId", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "skillId", "value": "", "type": "path", "description": "The unique identifier of the skill." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assign or unassign a dynamic skill to/from multiple users in bulk for a given organization." }, { "info": { "name": "Get specific User by CI User ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/user/by-ci-user-id/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "CI ID of the User." }, { "name": "includeUserProfile", "value": "true", "type": "query", "description": "Specifiy whether to include user profile data" } ] }, "docs": "Retrieve an existing User using the CI ID in a given organization." }, { "info": { "name": "Get users by dynamic skill ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/user/by-dynamic-skill-id/:skillId", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "skillId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "The dynamic skill ID to fetch users for" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Fetches all users assigned to a specific dynamic skill with search and pagination support. Returns user details with the specific dynamic skill value." }, { "info": { "name": "Get the agents matching skill requirements criteria", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/user/fetch-by-skill-requirements", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Fetch User details by IDs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/user/fetch-user-details-by-ids", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve an existing User's first name, last name and email by list of IDs in a given organization." }, { "info": { "name": "List Users along with profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/user/with-user-profile", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ] }, "docs": "Retrieve a list of User(s) along with their UserProfiles in a given organization." }, { "info": { "name": "Get specific User along with profile by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/user/with-user-profile/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the User." } ] }, "docs": "Retrieve an existing User along with the corresponding UserProfile by ID in a given organization." }, { "info": { "name": "Get specific User by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/user/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the User." }, { "name": "includeCount", "value": "", "type": "query", "description": "If set to true, the API response will include the count of each type of Contact Service Queues that the user is assigned to" }, { "name": "includeUserProfileType", "value": "", "type": "query", "description": "If set to true, the API response will include the user profile" }, { "name": "includeSkillProfileAudit", "value": "", "type": "query", "description": "If set to true gives skill profile modification info." }, { "name": "includeReskillAuditInfo", "value": "", "type": "query", "description": "If set to true gives skill profile and dynamic skill modification info." }, { "name": "includeSkillDetails", "value": "", "type": "query", "description": "If set to true,the response includes skill information for each dynamic skill assignment" } ] }, "docs": "Retrieve an existing Users by ID in a given organization." }, { "info": { "name": "Update specific User by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/user/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the User." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing User by ID in a given organization." }, { "info": { "name": "Partially update User by ID", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/organization/:orgid/user/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the User." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Partially update User by ID in a given organization." }, { "info": { "name": "List references for a specific User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/user/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "type_text", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing User by ID in a given organization." }, { "info": { "name": "Reskill Agents", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/organization/:orgid/user/:id/reskill", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "Resource ID of the User." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reskill agents by assigning or unassigning skills." }, { "info": { "name": "List User(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/user", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"57efb0e6-5af0-4245-a67d-d3c5045cdb6e\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned. By default, all attributes are returned along with the specified columns. All attributes are supported." }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "100", "type": "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." }, { "name": "supervisorManagedAgentsOnly", "value": "", "type": "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." }, { "name": "singleObjectResponse", "value": "", "type": "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." }, { "name": "buddyTeamAgentsOnly", "value": "", "type": "query", "description": "If set to true, returns only users who are part of buddy teams without PBAC check." }, { "name": "userInQueue", "value": "", "type": "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." }, { "name": "queueId", "value": "", "type": "query", "description": "Contact Service Queue Id for which the list of assigned/unassigned agents needs to be fetched." }, { "name": "includeAIMappingCount", "value": "", "type": "query", "description": "If set to true, the API response will include the count of each AI features mapped to the entity." }, { "name": "includeDynamicSkillsLimitReached", "value": "", "type": "query", "description": "If true, includes whether each user has reached the dynamic skills assignment limit." } ] }, "docs": "Retrieve a list of User(s) in a given organization." }, { "info": { "name": "Get specific User by CI User ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/user/by-ci-user-id/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba2", "type": "path", "description": "CI ID of the User." }, { "name": "includeUserProfile", "value": "true", "type": "query", "description": "Specifiy whether to include user profile data" }, { "name": "includeNames", "value": "true", "type": "query", "description": "Specifiy whether to include resource collection names" } ] }, "docs": "Retrieve an existing User using the CI ID in a given organization." } ] }, { "info": { "name": "Work Types", "type": "folder" }, "items": [ { "info": { "name": "Create a new Work Type", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/work-type", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Work Type in a given organization." }, { "info": { "name": "Bulk save Work Type(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/work-type/bulk", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create, Update or delete Work Type(s) in bulk in a given organization." }, { "info": { "name": "Bulk export Work Type(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/work-type/bulk-export", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Export all Work Type(s) in a given organization." }, { "info": { "name": "Purge inactive Work Type(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/organization/:orgid/work-type/purge-inactive-entities", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "nextStartId", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "query", "description": "This is the entity ID from which items for the next purge batch with be selected." } ] }, "docs": "Purge inactive Work Type(s) older than the configured interval for a given organization." }, { "info": { "name": "Get specific Work Type by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/work-type/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "ID of the work_type." } ] }, "docs": "Retrieve an existing Work Type by ID in a given organization." }, { "info": { "name": "Update specific Work Type by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/organization/:orgid/work-type/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "ID of the work_type." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing Work Type by ID in a given organization." }, { "info": { "name": "Delete specific Work Type by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/organization/:orgid/work-type/:id", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "2f9eecc5-0472-4549", "type": "path", "description": "ID of the work_type." } ] }, "docs": "Delete an existing Work Type by ID in a given organization." }, { "info": { "name": "List references for a specific Work Type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/work-type/:id/incoming-references", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "id", "value": "af9eecc5-0472-4549-9a83-2afdae0d4ba0", "type": "path", "description": "ID of this contact center resource." }, { "name": "type", "value": "reference-entity", "type": "query", "description": "Entity type of the other entity that has a reference to this specific entity." }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of all entities that have reference to an existing Work Type by ID in a given organization." }, { "info": { "name": "List Work Type(s)", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/organization/:orgid/v2/work-type", "params": [ { "name": "orgid", "value": "2f9eecc5-0472-4549-9a83-2afdae0d4ba1", "type": "path", "description": "Organization ID to be used for this operation. The specified security token must have permission to interact with the organization." }, { "name": "filter", "value": "id==\"2f9eecc5-0472-4549-9a83-2afdae0d4ba1\"", "type": "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" }, { "name": "attributes", "value": "id", "type": "query", "description": "Specify the attributes to be returned.Default all attributes are returned along with specified columns. All Attributes are supported" }, { "name": "search", "value": "contact center", "type": "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" }, { "name": "page", "value": "", "type": "query", "description": "Defines the number of displayed page. The page number starts from 0." }, { "name": "pageSize", "value": "", "type": "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." } ] }, "docs": "Retrieve a list of Work Type(s) in a given organization." } ] }, { "info": { "name": "Data Sources", "type": "folder" }, "items": [ { "info": { "name": "Register a Data Source", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/dataSources", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Retrieve All Data Sources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dataSources/" }, "docs": "Show all data sources registered for this Service App with the scope `spark-admin:datasource_read`." }, { "info": { "name": "Retrieve Data Source Schemas", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dataSources/schemas" }, "docs": "Show available schemas. No specific scope is needed to retrieve the dataSource schemas, but a valid API token should be presented." }, { "info": { "name": "Retrieve Details of a Specific Data Source Schema", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dataSources/schemas/:schemaId", "params": [ { "name": "schemaId", "value": "78efc775-dccb-45ca-9acf-989a4a59f788", "type": "path", "description": "The unique identifier for the schema." } ] }, "docs": "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." }, { "info": { "name": "Retrieve Data Source Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/dataSources/:dataSourceId", "params": [ { "name": "dataSourceId", "value": "f29bb291-5db0-411b-834a-e64f8dee0658", "type": "path", "description": "The unique identifier for the dataSource." } ] }, "docs": "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." }, { "info": { "name": "Update a Data Source", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/dataSources/:dataSourceId", "params": [ { "name": "dataSourceId", "value": "f29bb291-5db0-411b-834a-e64f8dee0658", "type": "path", "description": "The unique identifier for the data source." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete a Data Source", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/dataSources/:dataSourceId", "params": [ { "name": "dataSourceId", "value": "f29bb291-5db0-411b-834a-e64f8dee0658", "type": "path", "description": "The unique identifier for the dataSource." } ] }, "docs": "Delete a Data Source, by Data Source ID.\n\nSpecify the Data Source ID in the `dataSourceId` parameter in the URI." } ] }, { "info": { "name": "Estimated Wait Time", "type": "folder" }, "items": [ { "info": { "name": "Get Estimated Wait Time", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/ewt", "headers": [ { "name": "TrackingId", "value": "INTEGRATION-9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "queueId", "value": "AWpEGCi_SVK96XSm20PY", "type": "query", "description": "Id of the queue for which the EWT is to be returned" }, { "name": "lookbackMinutes", "value": "15", "type": "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" }, { "name": "maxCV", "value": "40", "type": "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 %" }, { "name": "minValidSamples", "value": "40", "type": "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 %" }, { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization." } ] }, "docs": "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" } ] }, { "info": { "name": "Notification", "type": "folder" }, "items": [ { "info": { "name": "Subscribe Notification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/notification/subscribe", "body": { "type": "json", "data": "{}" } }, "docs": "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" } ] }, { "info": { "name": "Queues", "type": "folder" }, "items": [ { "info": { "name": "Get Queue Statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/queues/statistics", "headers": [ { "name": "TrackingId", "value": "INTEGRATION-9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "from", "value": "1651395600000", "type": "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." }, { "name": "to", "value": "1651438800000", "type": "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)." }, { "name": "interval", "value": "15", "type": "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." }, { "name": "queueIds", "value": "89cf3b93-f020-42c6-84dc-87db6a92eae7, 89cf3b93-f020-42c6-84dc-87db6a92fae7, 89cf3b93-f020-42c6-84dc-87db4a92eae7", "type": "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." }, { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization." } ] }, "docs": "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 s" } ] }, { "info": { "name": "Realtime", "type": "folder" }, "items": [ { "info": { "name": "Subscribe Realtime Notification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/realtime/subscribe", "body": { "type": "json", "data": "{}" } }, "docs": "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" } ] }, { "info": { "name": "Search", "type": "folder" }, "items": [ { "info": { "name": "Search tasks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/search", "headers": [ { "name": "TrackingId", "value": "INTEGRATION-9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 " } ] }, { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "List Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/subscriptions", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "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." } ] }, "docs": "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." }, { "info": { "name": "Register Subscription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/subscriptions", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/subscriptions/:id", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "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." } ] }, "docs": "Retrieve a subscription for a given subscription ID. Requires `cjp:config_read` scope." }, { "info": { "name": "Update Subscription", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/subscriptions/:id", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates some of the properties in a subscription, for a given subscription ID. Requires `cjp:config_write` scope." }, { "info": { "name": "Delete Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/subscriptions/:id", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "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." } ] }, "docs": "Deletes a subscription for a given subscription ID. Requires `cjp:config_write` scope." }, { "info": { "name": "List Event Types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/event-types", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "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." } ] }, "docs": "Retrieve all available event types for an organization. Requires `cjp:config_read` scope." }, { "info": { "name": "List Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/subscriptions", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "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." } ] }, "docs": "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." }, { "info": { "name": "Register Subscription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/subscriptions", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/subscriptions/:id", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "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." } ] }, "docs": "Retrieve a subscription for a given subscription ID. Requires `cjp:config_read` scope." }, { "info": { "name": "Update Subscription", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/subscriptions/:id", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates some of the properties in a subscription, for a given subscription ID. Requires `cjp:config_write` scope." }, { "info": { "name": "Delete Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/subscriptions/:id", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "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." } ] }, "docs": "Deletes a subscription for a given subscription ID. Requires `cjp:config_write` scope." }, { "info": { "name": "List Event Types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/event-types", "headers": [ { "name": "TrackingId", "value": "NOTIFS_9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "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." } ] }, "docs": "Retrieve all available event types for an organization along with information about the currently supported resource versions. Requires `cjp:config_read` scope. " } ] }, { "info": { "name": "Agents", "type": "folder" }, "items": [ { "info": { "name": "Login", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agents/login", "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Logout", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/agents/logout", "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "State Change", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/agents/session/state", "body": { "type": "json", "data": "{}" } }, "docs": "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/c" }, { "info": { "name": "Reload", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agents/reload" }, "docs": "Allows the user to receive all the contact assigned to particular agent and state. Requires 'cjp:user' scope for authorization." }, { "info": { "name": "Buddy Agents List", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/agents/buddyList", "body": { "type": "json", "data": "{}" } }, "docs": "Returns the list of agents in the given state and media according to agent profile settings. Requires 'cjp:user' scope for authorization." }, { "info": { "name": "Get Agent Activities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/agents/activities", "headers": [ { "name": "TrackingId", "value": "INTEGRATION-9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "agentIds", "value": "89cf3b93-f020-42c6-84dc-87db6a92eae7,89cf3b93-f020-42c6-84dc-87db6a92fae7,89cf3b93-f020-42c6-84dc-87db4a92eae7", "type": "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." }, { "name": "teamIds", "value": "89cf3b93-f020-42c6-84dc-87db6a92eae7,89cf3b93-f020-42c6-84dc-87db6a92fae7,89cf3b93-f020-42c6-84dc-87db4a92eae7", "type": "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." }, { "name": "channelTypes", "value": "email,chat,telephony", "type": "query", "description": "Channel type(s) permitted in response. Separate values with commas. Must be lowercase. By default, there is no channelType filtering." }, { "name": "from", "value": "1591702170000", "type": "query", "description": "Filter agent activities created after given epoch timestamp in UTC (in milliseconds)." }, { "name": "to", "value": "1591802180000", "type": "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)" }, { "name": "pageSize", "value": "100", "type": "query", "description": "Maximum page size in response. Maximum allowed value is 1000. Defaults to 100 items per page." }, { "name": "page", "value": "1", "type": "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." }, { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization." } ] }, "docs": "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" }, { "info": { "name": "Get Agent Statistics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/agents/statistics", "headers": [ { "name": "TrackingId", "value": "INTEGRATION-9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "from", "value": "1651395600000", "type": "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." }, { "name": "to", "value": "1651438800000", "type": "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)." }, { "name": "interval", "value": "15", "type": "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." }, { "name": "agentIds", "value": "89cf3b93-f020-42c6-84dc-87db6a92eae7,89cf3b93-f020-42c6-84dc-87db6a92fae7,89cf3b93-f020-42c6-84dc-87db4a92eae7", "type": "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." }, { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization." } ] }, "docs": "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 latenc" } ] }, { "info": { "name": "Call Monitoring", "type": "folder" }, "items": [ { "info": { "name": "Create Monitoring Request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/monitor", "body": { "type": "json", "data": "{}" } }, "docs": "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'." }, { "info": { "name": "BargeIn Request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/monitor/:taskId/bargeIn", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "path", "description": "The unique ID representing the task that needs to be barged by the supervisor." } ] }, "docs": "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'." }, { "info": { "name": "End Monitoring Request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/monitor/:taskId/end", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "path", "description": "The unique ID represents the task that needs to end." } ] }, "docs": "Allows to successfully end the on-going monitoring request. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'." }, { "info": { "name": "Hold Monitoring Request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/monitor/:taskId/hold", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "path", "description": "The unique ID representing the task that needs to be held." } ] }, "docs": "Place the monitoring session on hold for a particular call. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'." }, { "info": { "name": "Unhold Monitoring Request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/monitor/:taskId/unhold", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "path", "description": "The unique ID representing the task that needs to be resumed and was on hold already." } ] }, "docs": "Resume a particular monitoring request that was on hold already. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'." }, { "info": { "name": "Fetch Monitoring Sessions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/monitor/sessions" }, "docs": "Fetches all active subscriptions for a given clientID." }, { "info": { "name": "Delete Monitoring Request", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/monitor/:requestId", "params": [ { "name": "requestId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "path", "description": "The id with which the monitoring request has been created." } ] }, "docs": "Delete a particular monitoring request that was created. Requires scope 'cloud-contact-center:pod_conv' and 'cjp.supervisor'." } ] }, { "info": { "name": "Callbacks", "type": "folder" }, "items": [ { "info": { "name": "Get scheduled callbacks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/callbacks/organization/:orgId/scheduled-callback", "params": [ { "name": "orgId", "value": "123e4567-e89b-12d3-a456-426614174000", "type": "path", "description": "The organization ID for which the callback is being scheduled. This should be a valid UUID." }, { "name": "callbackNumber", "value": "+1234567890", "type": "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." }, { "name": "assigneeAgent", "value": "123e4567-e89b-12d3-a456-426614174001", "type": "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." }, { "name": "page", "value": "1", "type": "query", "description": "The page number to retrieve." }, { "name": "pageSize", "value": "10", "type": "query", "description": "The number of items per page." }, { "name": "sortBy", "value": "scheduledTime", "type": "query", "description": "The field to sort the results by. If `sortBy` is set to `assignedTime`, the `assigneeAgent` parameter must also be provided." }, { "name": "sortOrder", "value": "asc", "type": "query", "description": "The order to sort the results in." } ] }, "docs": "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." }, { "info": { "name": "Schedule a Callback", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/callbacks/organization/:orgId/scheduled-callback", "params": [ { "name": "orgId", "value": "123e4567-e89b-12d3-a456-426614174000", "type": "path", "description": "The organization ID for which the callback is being scheduled. This should be a valid UUID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get scheduled callback by Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/callbacks/organization/:orgId/scheduled-callback/:id", "params": [ { "name": "orgId", "value": "123e4567-e89b-12d3-a456-426614174000", "type": "path", "description": "The organization ID for which the callback is being scheduled. This should be a valid UUID." }, { "name": "id", "value": "5C3E69AC-3695-4D51-899B-4B4CC3ED8ECF", "type": "path", "description": "The id with which the Scheduled Callback has been created." } ] }, "docs": "Retrieve an existing scheduled callback by Id, excluding those whose scheduled trigger time has already passed. Requires 'cjp:user' scope for authorization." }, { "info": { "name": "Update scheduled callback by Id", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/callbacks/organization/:orgId/scheduled-callback/:id", "params": [ { "name": "orgId", "value": "123e4567-e89b-12d3-a456-426614174000", "type": "path", "description": "The organization ID for which the callback is being scheduled. This should be a valid UUID." }, { "name": "id", "value": "5C3E69AC-3695-4D51-899B-4B4CC3ED8ECF", "type": "path", "description": "The id with which the Scheduled Callback has been created." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an existing scheduled callback by Id,those whose scheduled trigger time has already passed cannot be updated. Requires 'cjp:user' scope for authorization." }, { "info": { "name": "Delete scheduled callback by Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/callbacks/organization/:orgId/scheduled-callback/:id", "params": [ { "name": "orgId", "value": "123e4567-e89b-12d3-a456-426614174000", "type": "path", "description": "The organization ID for which the callback is being scheduled. This should be a valid UUID." }, { "name": "id", "value": "5C3E69AC-3695-4D51-899B-4B4CC3ED8ECF", "type": "path", "description": "The id with which the Scheduled Callback has been created." } ] }, "docs": "Delete an existing scheduled callback by Id, those whose scheduled trigger time has already passed cannot be deleted. Requires 'cjp:user' scope for authorization." } ] }, { "info": { "name": "Tasks", "type": "folder" }, "items": [ { "info": { "name": "Get Tasks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tasks", "headers": [ { "name": "TrackingId", "value": "INTEGRATION-9bcdc696-57fa-4e91-b5aa-57a66a347c23" } ], "params": [ { "name": "channelTypes", "value": "email,telephony", "type": "query", "description": "Task channel type(s) permitted in response. Separate values with commas. Use lowercase. By default, there is no channelType filtering." }, { "name": "from", "value": "1591702170000", "type": "query", "description": "Filters tasks created after the given epoch timestamp (in milliseconds)." }, { "name": "to", "value": "1591802180000", "type": "query", "description": "Filters tasks created before the given epoch timestamp (in milliseconds); queries up to the present if timestamp is not specified." }, { "name": "pageSize", "value": "100", "type": "query", "description": "Maximum page size in the response. Maximum allowed value is 1000. Defaults to 100 items per page." }, { "name": "orgId", "value": "97cdbf45-ebe2-4687-8341-44d5c7abf101", "type": "query", "description": "Organization ID to use for this operation. If unspecified, inferred from token. Token must have permission to interact with this organization." } ] }, "docs": "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 im" }, { "info": { "name": "Create Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks", "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Update Task", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/tasks/:taskId", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Accept Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/accept", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ] }, "docs": "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)." }, { "info": { "name": "End Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/end", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ] }, "docs": "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)." }, { "info": { "name": "Wrap Up Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/wrapup", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Hold Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/hold", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Resume Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/unhold", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Reject Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/reject", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Pause Recording Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/record/pause", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ] }, "docs": "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." }, { "info": { "name": "Resume Recording Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/record/resume", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Transfer Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/transfer", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Consult Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/consult", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Consult Conference Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/consult/conference", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Consult Transfer Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/consult/transfer", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Consult Accept Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/consult/accept", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ] }, "docs": "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)." }, { "info": { "name": "Assign Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/assign", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "path", "description": "The unique ID represents the task that the user want to assign." } ] }, "docs": "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)." }, { "info": { "name": "Consult End Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/consult/end", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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)." }, { "info": { "name": "Exit Conference Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/tasks/:taskId/conference/exit", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." } ] }, "docs": "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)." }, { "info": { "name": "Accept Preview Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/accept", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." }, { "name": "campaignId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "path", "description": "The unique ID represents the campaign that the user is currently working on." } ] }, "docs": "API to accept the preview campaign task offered to the agent." }, { "info": { "name": "Skip Preview Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/skip", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." }, { "name": "campaignId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "path", "description": "The unique ID represents the campaign that the user is currently working on." } ] }, "docs": "API to skip the preview campaign task offered to the agent." }, { "info": { "name": "Remove Preview Task", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dialer/campaign/:campaignId/preview-task/:taskId/remove", "params": [ { "name": "taskId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "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." }, { "name": "campaignId", "value": "315fbb91-2288-427c-9588-ec764cd46ea4", "type": "path", "description": "The unique ID represents the campaign that the user is currently working on." } ] }, "docs": "API to remove the preview campaign task offered to the agent" } ] }, { "info": { "name": "Journey - Customer Identification API", "type": "folder" }, "items": [ { "info": { "name": "Add/Remove/Replace details of a Person", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "personId", "value": "638844db13272c52239c525d", "type": "path", "description": "Person ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Delete specific Person by id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/person-id/:personId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "personId", "value": "638844db13272c52239c525d", "type": "path", "description": "Person ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Add one/more Identities to a person", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/admin/v1/api/person/add-identities/workspace-id/:workspaceId/person-id/:personId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "personId", "value": "638844db13272c52239c525d", "type": "path", "description": "Person ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Remove one/more Identities from a person", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/admin/v1/api/person/remove-identities/workspace-id/:workspaceId/person-id/:personId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "personId", "value": "638844db13272c52239c525d", "type": "path", "description": "Person ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Get all or a specific Person Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "personId", "value": "1eb65fdfsadw34ae0e10f", "type": "query", "description": "Person ID" }, { "name": "filter", "value": "firstName==Ram", "type": "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)." }, { "name": "sortBy", "value": "firstName", "type": "query", "description": "Sort By Field" }, { "name": "sort", "value": "DESC", "type": "query", "description": "Sort direction" }, { "name": "page", "value": "0", "type": "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." }, { "name": "pageSize", "value": "10", "type": "query", "description": "Number of items to be displayed on a page" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Create a Person", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Merges Identities to a Primary Identity", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/v1/api/person/merge/workspace-id/:workspaceId/primary-person-id/:primaryPersonId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "primaryPersonId", "value": "638844db13272c52239c525d", "type": "path", "description": "Primary Person ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Merges one/more Identities to a **Primary** Individual in JDS. \n\nRole and Scope: Requires id full admin role with cjp:config_write scope." }, { "info": { "name": "Creates or merges aliases to an Individual in JDS", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/v1/api/person/merge-identities/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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 p" }, { "info": { "name": "Search for an Identity via aliases", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/person/workspace-id/:workspaceId/aliases/:aliases", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "aliases", "value": "johndoe@domain1.com,2771154", "type": "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." }, { "name": "sortBy", "value": "firstName", "type": "query", "description": "Sort By Field" }, { "name": "sort", "value": "DESC", "type": "query", "description": "Sort direction" }, { "name": "page", "value": "0", "type": "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." }, { "name": "pageSize", "value": "10", "type": "query", "description": "Number of items to be displayed on a page." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." } ] }, { "info": { "name": "Journey - Data Ingestion API", "type": "folder" }, "items": [ { "info": { "name": "Journey Event Posting", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/publish/v1/api/event", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "query", "description": "Workspace ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." } ] }, { "info": { "name": "Journey - Profile Creation & Insights API", "type": "folder" }, "items": [ { "info": { "name": "Get A specific Template searched by template id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "638844db13272c52239c525d", "type": "path", "description": "Template ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Update existing ProfileViewTemplate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "638844db13272c52239c525d", "type": "path", "description": "Template ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update existing Profile View Template in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope." }, { "info": { "name": "Delete Template by template Id", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "638844db13272c52239c525d", "type": "path", "description": "Template ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Template By template id in JDS. \n\nRole and Scope: Requires id full admin or any role with cjp:config_write scope." }, { "info": { "name": "Get All Template Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "filter", "value": "createdBy==satjonna@cisco.com", "type": "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)." }, { "name": "sort", "value": "DESC", "type": "query", "description": "Sort direction" }, { "name": "sortBy", "value": "updatedAt", "type": "query", "description": "Sort By Field" }, { "name": "page", "value": "0", "type": "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." }, { "name": "pageSize", "value": "10", "type": "query", "description": "Number of items to be displayed on a page." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Create Template", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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 \"aggreg" }, { "info": { "name": "Get A specific Template searched by template name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/profile-view-template/workspace-id/:workspaceId/template-name/:templateName", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateName", "value": "sample-template", "type": "path", "description": "Template Name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Historic Progressive Profile View by Template Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-name/:templateName", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "personId", "value": "56fghn344678defjs878", "type": "path", "description": "Person ID" }, { "name": "templateName", "value": "insurance-template", "type": "path", "description": "Template Name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Historic Progressive Profile View", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/person-id/:personId/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "personId", "value": "56fghn344678defjs878", "type": "path", "description": "Person ID" }, { "name": "templateId", "value": "56fghn344678defjs878", "type": "path", "description": "Template ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Historic Progressive Profile View By Template Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "identity", "value": "ram@cisco.com", "type": "path", "description": "Identity" }, { "name": "templateName", "value": "insurance-template", "type": "path", "description": "Template Name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Historic Progressive Profile View By Template Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/progressive-profile-view/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "identity", "value": "ram@cisco.com", "type": "path", "description": "identity" }, { "name": "templateId", "value": "56fghn344678defjs878", "type": "path", "description": "Template ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Stream Progressive profile Views By Template Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-name/:templateName", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "identity", "value": "srindura@gmail.com", "type": "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." }, { "name": "templateName", "value": "insurance-template", "type": "path", "description": "Template Name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Stream Progressive profile Views By Template Id", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/progressive-profile-view/stream/workspace-id/:workspaceId/identity/:identity/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "identity", "value": "srindura@gmail.com", "type": "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." }, { "name": "templateId", "value": "56fghn344678defjs878", "type": "path", "description": "Template ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Historic Journey Events", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/events/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "identity", "value": "ram@cisco.com", "type": "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." }, { "name": "sortBy", "value": "identity", "type": "query", "description": "sort By Field" }, { "name": "sort", "value": "desc", "type": "query", "description": "sort direction" }, { "name": "filter", "value": "identityType=='phone'", "type": "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)." }, { "name": "data", "value": "agentid=='3224343fddfdfdf'", "type": "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)." }, { "name": "page", "value": "0", "type": "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." }, { "name": "pageSize", "value": "10", "type": "query", "description": "Number of items to be displayed on a page." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Stream Events By Identity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/api/events/stream/workspace-id/:workspaceId/identity/:identity", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" }, { "name": "identity", "value": "ram@cisco.com", "type": "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." }, { "name": "filter", "value": "identityType=='phone'", "type": "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)." }, { "name": "data", "value": "agentid=='3224343fddfdfdf'", "type": "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)." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." } ] }, { "info": { "name": "Journey - Subscription API", "type": "folder" }, "items": [ { "info": { "name": "Get WXCC Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Create WXCC Subscription", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Delete WXCC Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/v1/api/wxcc-subscription/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" } ] }, { "info": { "name": "Journey - Trigger Actions API", "type": "folder" }, "items": [ { "info": { "name": "Get all Journey Actions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "sortBy", "value": "updatedAt", "type": "query", "description": "Sort By Field" }, { "name": "sort", "value": "ASC", "type": "query", "description": "Sort direction" }, { "name": "page", "value": "0", "type": "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." }, { "name": "pageSize", "value": "10", "type": "query", "description": "Number of items to be displayed on a page." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Get all Journey Actions for a template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "56n3ugx44678998djs878", "type": "path", "description": "Template ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Create a new Journey Action", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "56n3ugx44678998djs878", "type": "path", "description": "Template ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Get specific Journey Action By Name", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-name/:actionName", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "56n3ugx44678998djs878", "type": "path", "description": "Template ID" }, { "name": "actionName", "value": "demo action", "type": "path", "description": "Action Name" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Get specific Journey Action By ActionId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "56n3ugx44678998djs878", "type": "path", "description": "Template ID" }, { "name": "actionId", "value": "73n3ugx12678998djs878", "type": "path", "description": "Action ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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." }, { "info": { "name": "Update existing Journey Action", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "56n3ugx44678998djs878", "type": "path", "description": "Template ID" }, { "name": "actionId", "value": "73n3ugx12678998djs878", "type": "path", "description": "Action ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update existing Journey Action in JDS. \n\nRole and Scope: It requires id full admin or any role with cjp:config_write scope." }, { "info": { "name": "Delete Journey Action configuration By ActionId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/v1/api/journey-actions/workspace-id/:workspaceId/template-id/:templateId/action-id/:actionId", "params": [ { "name": "workspaceId", "value": "63feryn344678998djs878", "type": "path", "description": "Workspace ID" }, { "name": "templateId", "value": "56n3ugx44678998djs878", "type": "path", "description": "Template ID" }, { "name": "actionId", "value": "73n3ugx12678998djs878", "type": "path", "description": "Action ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete Journey Action configuration By ActionId in JDS. \n\nRole and Scope: It requires id full admin role with cjp:config_write scope." } ] }, { "info": { "name": "Journey - Workspace management API", "type": "folder" }, "items": [ { "info": { "name": "Get Workspace", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Update Workspace", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Delete Workspace", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/admin/v1/api/workspace/workspace-id/:workspaceId", "params": [ { "name": "workspaceId", "value": "6377dafe02e7cc19b03a71b7", "type": "path", "description": "Workspace ID" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Get All Workspaces", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/admin/v1/api/workspace", "params": [ { "name": "filter", "value": "workspaces.name==Customer-Journey-Widget", "type": "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)." }, { "name": "sortBy", "value": "name", "type": "query", "description": "Sort By Field" }, { "name": "sort", "value": "DESC", "type": "query", "description": "Sort direction" }, { "name": "page", "value": "0", "type": "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." }, { "name": "pageSize", "value": "10", "type": "query", "description": "Number of items to be displayed on a page." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" }, { "info": { "name": "Create Workspace", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/admin/v1/api/workspace", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "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" } ] }, { "info": { "name": "Campaign Manager", "type": "folder" }, "items": [ { "info": { "name": "Start Campaign Request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/dialer/campaign", "body": { "type": "json", "data": "{}" } }, "docs": "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'" }, { "info": { "name": "Update Campaign Request", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/dialer/campaign/:campaignId", "params": [ { "name": "campaignId", "value": "Campaign1", "type": "path", "description": "The unique request id of the campaign that needs to be updated" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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 aut" }, { "info": { "name": "Stop Campaign Request", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/dialer/campaign/:campaignId", "params": [ { "name": "campaignId", "value": "Campaign1", "type": "path", "description": "The unique request id of the campaign that needs to be stopped" } ] }, "docs": "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." } ] }, { "info": { "name": "Captures", "type": "folder" }, "items": [ { "info": { "name": "List Captures", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/captures/query", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve a list of Captures given a set of task IDs" } ] }, { "info": { "name": "Flow", "type": "folder" }, "items": [ { "info": { "name": "List Flows or Subflows", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows", "params": [ { "name": "flowType", "value": "FLOW", "type": "query", "description": "Either of 'FLOW' or 'SUBFLOW'." }, { "name": "ids", "value": "668e4b2d928d471e41da03d1,668e3ee2928d471e41da03cb", "type": "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." }, { "name": "orgId", "value": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8", "type": "path", "description": "Organization ID." }, { "name": "page", "value": "0", "type": "query", "description": "Defines the number of the displayed page. The page number starts from 0." }, { "name": "partialNameSearch", "value": "flow1", "type": "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." }, { "name": "projectId", "value": "5e5c9ad6d61f870d6d778c1b", "type": "path", "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b." }, { "name": "size", "value": "10", "type": "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." }, { "name": "includePagination", "value": "false", "type": "query", "description": "If set to 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\"." } ] }, "docs": "Returns a list of flows in response.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]" }, { "info": { "name": "Export a Flow or Subflow", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/:flowId:export", "params": [ { "name": "flowId", "value": "661c7bc712eaf357de7e4aeb", "type": "path", "description": "ID of the flow/subflow to export." }, { "name": "orgId", "value": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8", "type": "path", "description": "Organization ID." }, { "name": "projectId", "value": "5e5c9ad6d61f870d6d778c1b", "type": "path", "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b." }, { "name": "version", "value": "Version ID: 6679cb15f3398d4d1070a1e6.", "type": "query", "description": "Version ID. Possible values are 'draft', 'latest' or version ID like '64b92c004ccd9f3d1c680709'. Defaulted to 'latest'." } ] }, "docs": "Returns the exported flow/subflow in response.\n\nScope: `cjp:config_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]" }, { "info": { "name": "Publish a Flow or Subflow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows/:flowId:publish", "headers": [ { "name": "TrackingId", "value": "491fed1e-de7f-11ef-9cd2-0242ac120002" } ], "params": [ { "name": "flowId", "value": "661c7bc712eaf357de7e4aeb", "type": "path", "description": "ID of the flow/subflow to export." }, { "name": "orgId", "value": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8", "type": "path", "description": "Organization ID." }, { "name": "projectId", "value": "5e5c9ad6d61f870d6d778c1b", "type": "path", "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b." } ], "body": { "type": "json", "data": "{}" } }, "docs": "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_read`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]" }, { "info": { "name": "Import a Flow or Subflow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/flow-store/:orgId/project/:projectId/flows:import", "headers": [ { "name": "Content-Length", "value": "10" } ], "params": [ { "name": "orgId", "value": "8eb7da9a-c81c-4d13-b08b-38fdeb7330d8", "type": "path", "description": "Organization ID." }, { "name": "projectId", "value": "5e5c9ad6d61f870d6d778c1b", "type": "path", "description": "Project ID. System generated value which is the same across orgs and environments. Always use: 5e5c9ad6d61f870d6d778c1b." }, { "name": "overwrite", "value": "yes", "type": "query", "description": "Determines whether to overwrite the existing flow or not. Possible values: yes/no." }, { "name": "flowType", "value": "FLOW", "type": "query", "description": "Either of 'FLOW' or 'SUBFLOW'." } ], "body": { "type": "multipart-form", "data": [ { "name": "file", "type": "text", "value": "" } ] } }, "docs": "Returns the imported flow/subflow in response.\n\nScope: `cjp:config_write`. Roles: [`Organizational Full Admin`, `Supervisor`, `Contact Center Service Admin`, `User Admin`]" } ] } ], "bundled": true }