diff --git a/docs/integration/remote-http-services.md b/docs/integration/remote-http-services.md
new file mode 100644
index 0000000..23dc6b4
--- /dev/null
+++ b/docs/integration/remote-http-services.md
@@ -0,0 +1,292 @@
+# Remote HTTP Service APIs
+
+The Remote HTTP Service APIs let you configure outbound HTTP integrations used by RingCX routing and scripting flows. Use them to maintain service groups, services, service inputs, activation state, and external authentication configurations from code.
+
+## Strategic Overview
+
+Remote HTTP services define reusable external endpoints that RingCX can call from IVR, scripting, or integration workflows. They are useful when the same CRM, middleware, or data-enrichment service must be configured consistently across many queues, scripts, or sub-accounts.
+
+IVR WWW nodes, scripting nodes, and other workflow steps reference these service definitions so the workflow does not need to duplicate endpoint URLs, headers, credentials, and input mappings.
+
+### Key Use Cases
+
+* **Integration Provisioning:** Create service definitions during customer onboarding.
+* **Credential Rotation:** Update OAuth or external auth configurations without rebuilding scripts.
+* **Environment Promotion:** Clone or update service definitions as configurations move from test to production.
+* **Operational Control:** Activate or deactivate a remote service during outages or endpoint migrations.
+
+### Required Permissions & Scopes
+
+#### 1. Configure OAuth Scopes
+
+To authenticate, your application must be configured with the following permission in the [Developer Portal](https://developers.ringcentral.com/my-account.html#/applications):
+
+* **`ReadAccounts`**: Required to validate account context and access RingCX integration configuration APIs.
+
+#### 2. Enable RingCX Admin Access
+
+The authenticating user must have RingCX permissions that match the action being performed. Each endpoint in this set declares the permission it requires (`READ on Account`, `CREATE on Account`, `READ`, `UPDATE`, `DELETE`, etc., on the Remote HTTP Service Group, HTTP Service, HTTP Service Input, or External Auth Config resource). Grant the corresponding role permissions in the **RingCX Admin Portal** under **Users & Permissions**.
+
+!!! warning "Common Authorization Errors"
+ If the OAuth token is valid but the RingCX user lacks integration configuration access, the API returns an error similar to:
+ ```json
+ {
+ "errorCode": "access.denied.exception",
+ "generalMessage": "You do not have permission to access this resource",
+ "timestamp": 1611847650696
+ }
+ ```
+
+## Manage Service Groups
+
+Service groups organize related remote HTTP services.
+
+| Operation | Method and Path | API Reference |
+| --- | --- | --- |
+| List groups | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/getHttpServiceGroupList) |
+| Create group | `POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/createHttpServiceGroup) |
+| List groups with services | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/withChildren` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/getHttpServiceGroupListWithChildren) |
+| Get group | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/getHttpServiceGroup) |
+| Update group | `PUT https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/updateHttpServiceGroup) |
+
+## Manage HTTP Services
+
+HTTP service records describe the external endpoint and how RingCX calls it.
+
+| Operation | Method and Path | API Reference |
+| --- | --- | --- |
+| List services | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/getHttpServiceList) |
+| Create service | `POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/createHttpService) |
+| Get service | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/getHttpService) |
+| Update service | `PUT https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/updateHttpService) |
+| Clone service | `POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}/clone` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/cloneHttpService) |
+| Set active state | `PUT https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}/setIsActive` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/setHttpServiceIsActive) |
+
+## Configure Service Inputs
+
+Inputs define the values RingCX passes into the remote service request. Keep these in sync with the service contract expected by your external endpoint.
+
+| Operation | Method and Path | API Reference |
+| --- | --- | --- |
+| List inputs | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}/inputs` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/getHttpServiceInputList) |
+| Create input | `POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}/inputs` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/createHttpServiceInput) |
+| Get input | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}/inputs/{inputId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/getHttpServiceInput) |
+| Delete input | `DELETE https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}/inputs/{inputId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/deleteHttpServiceInput) |
+
+## External Auth Configurations
+
+External auth configurations store reusable authentication settings for remote services. Use these APIs when integrations require OAuth or other reusable credentials.
+
+| Operation | Method and Path | API Reference |
+| --- | --- | --- |
+| List auth configs | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/external/authConfigs` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/getExternalAuthConfigsList) |
+| Get auth config | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/{authConfigId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/getExternalAuthConfigById) |
+| Delete auth config | `DELETE https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/{authConfigId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/deleteExternalAuthConfigById) |
+| Create API key auth | `POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/{authConfigId}/apiKey` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/createExternalAccountAuthConfigApiKey) |
+| Create basic auth | `POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/{authConfigId}/basic` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/createExternalAccountAuthConfigBasic) |
+| Create OAuth auth | `POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/{authConfigId}/oauth` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Remote-HTTP-Services/createExternalAccountAuthConfigOAuth) |
+
+## Recommended Workflow
+
+1. Create or select a service group.
+2. Create the remote HTTP service with the external endpoint details.
+3. Add service inputs that map RingCX values into the outbound request.
+4. Attach or update external auth configuration when the service requires credentials.
+5. Activate the service after validation.
+6. Clone the service when creating a similar integration for another environment or workflow.
+
+!!! important
+ Treat remote service changes like production integration changes. Validate the external endpoint, authentication, and expected response shape before activating the service in a live routing flow.
+
+!!! important "Rate Limiting & Stability"
+ Remote HTTP service changes can affect live IVR and scripting flows. Batch provisioning updates, activate services only after validation, and use exponential backoff on `429 Too Many Requests` responses.
+
+## Request Examples
+
+### Create a Service Group
+
+`POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups`
+
+```json
+{
+ "groupName": "CRM enrichment",
+ "isDefault": false
+}
+```
+
+### Create an HTTP Service
+
+`POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices`
+
+The `serviceType` enum controls how RingCX calls the remote endpoint. For SOAP services populate `soapEndpoint` plus the SOAP-specific fields (`soapPortname`, `soapServicename`, `soapOperationname`, `soapAction`, `targetNamespace`); for HTTP services populate `httpServiceConfig` with the full HTTP request specification (URL, headers, etc.). Reusable credentials are linked through `authConfigId`.
+
+```json
+{
+ "accountId": "123456",
+ "serviceType": "HTTP_POST",
+ "serviceDescription": "Lookup customer by ANI",
+ "httpServiceConfig": "{\"url\":\"https://api.example.com/customers/lookup\",\"headers\":{\"Content-Type\":\"application/json\"}}",
+ "authConfigId": "60629848-0ddf-4757-8868-de5b76d54bb7",
+ "isEnabled": false,
+ "isDebug": false,
+ "enableMappings": true
+}
+```
+
+### Create a Service Input
+
+`POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}/inputs`
+
+```json
+[
+ {
+ "name": "ani",
+ "type": "PARAMETER",
+ "simpleDataType": "STRING",
+ "value": "",
+ "rank": "0"
+ }
+]
+```
+
+The service input save endpoint accepts an array of `RemoteHttpServiceInput` objects.
+
+### Create API Key Auth
+
+`POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/{authConfigId}/apiKey`
+
+`providerName` and `apiKey` are required. `authConfigId` is supplied as a path parameter and does not need to appear in the body for create operations.
+
+```json
+{
+ "providerName": "CRM API key",
+ "description": "Service account key for the CRM lookup integration",
+ "authType": "APIKEY",
+ "apiKey": "secret-value"
+}
+```
+
+### Create Basic Auth
+
+`POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/{authConfigId}/basic`
+
+`providerName`, `username`, and `password` are required.
+
+```json
+{
+ "providerName": "CRM basic auth",
+ "description": "Basic credentials for CRM lookup",
+ "authType": "BASIC",
+ "username": "ringcx-service",
+ "password": "secret-value"
+}
+```
+
+### Create OAuth Auth
+
+`POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/{authConfigId}/oauth`
+
+`providerName`, `clientId`, `secret`, `tokenUrl`, and `grantType` are required. The client secret field is named `secret` (not `clientSecret`).
+
+```json
+{
+ "providerName": "CRM OAuth",
+ "description": "OAuth credentials for CRM lookup",
+ "authType": "OAUTH",
+ "grantType": "CLIENT_CREDENTIALS",
+ "clientId": "ringcx-client",
+ "secret": "secret-value",
+ "tokenUrl": "https://auth.example.com/oauth/token",
+ "clientCredentialsSupplyIn": "BODY"
+}
+```
+
+### Example HTTP Service Response
+
+```json
+{
+ "serviceId": 4567,
+ "accountId": "123456",
+ "serviceType": "HTTP_POST",
+ "serviceDescription": "Lookup customer by ANI",
+ "httpServiceConfig": "{\"url\":\"https://api.example.com/customers/lookup\",\"headers\":{\"Content-Type\":\"application/json\"}}",
+ "authConfigId": "60629848-0ddf-4757-8868-de5b76d54bb7",
+ "isEnabled": false,
+ "isDebug": false,
+ "enableMappings": true,
+ "permissions": ["READ", "UPDATE"]
+}
+```
+
+## Resource Notes
+
+| Resource | Key Fields | Notes |
+| --- | --- | --- |
+| Service group (`RemoteHttpServiceGroup`) | `serviceGroupId`, `groupName`, `isDefault`, `services` | Logical container for related services. There is no description or active flag on the group itself. |
+| HTTP service (`RemoteHttpService`) | `serviceId`, `accountId`, `serviceType`, `serviceDescription`, `soapEndpoint`/`httpServiceConfig`, `authConfigId`, `isEnabled`, `isDebug`, `enableMappings` | `serviceType` is one of `SOAP`, `HTTP_POST`, `HTTP_GET`, `HTTP`. SOAP services use `soapEndpoint` plus the `soap*` and `targetNamespace` fields; HTTP services use `httpServiceConfig`. |
+| Service input (`RemoteHttpServiceInput`) | `inputId`, `name`, `type`, `value`, `simpleDataType`, `rank` | Maps RingCX runtime values into the request. Inputs are saved as an array. |
+| Auth config | `authConfigId`, `authType` (`APIKEY`/`JWT`/`BASIC`/`OAUTH`/`CUSTOM_AUTH`), `providerName`, `description` | Stores reusable credentials for outbound calls. Auth-type-specific fields live on `AuthConfigApiKey`, `AuthConfigBasic`, `AuthConfigOAuth`, `AuthConfigJwt`, and `AuthConfigCustomAuth`. |
+
+## Common Errors
+
+| Status | Cause | Resolution |
+| --- | --- | --- |
+| `400 Bad Request` | Malformed URL, method, auth payload, or input mapping. | Validate service definitions before activating them. |
+| `403 Forbidden` | User lacks integration configuration permissions. | Grant remote service and external auth permissions in the Admin portal. |
+| `404 Not Found` | Service group, service, input, or auth config is not under the account. | Re-list parent resources and use IDs from the same account. |
+| `409 Conflict` | Service is inactive, duplicated, or referenced by a workflow that prevents deletion. | Clone/update safely and activate only after validation. |
+
+## Sample Implementation (Python)
+
+```python
+import json
+import requests
+
+BASE_URL = "https://ringcx.ringcentral.com/voice/api"
+
+def provision_remote_service(token, account_id, auth_config_id):
+ headers = {"Authorization": f"Bearer {token}"}
+
+ group = requests.post(
+ f"{BASE_URL}/v1/admin/accounts/{account_id}/httpServiceGroups",
+ headers=headers,
+ json={"groupName": "CRM enrichment", "isDefault": False},
+ )
+ group.raise_for_status()
+ group_id = group.json()["serviceGroupId"]
+
+ service = requests.post(
+ f"{BASE_URL}/v1/admin/accounts/{account_id}/httpServiceGroups/{group_id}/httpServices",
+ headers=headers,
+ json={
+ "accountId": account_id,
+ "serviceType": "HTTP_POST",
+ "serviceDescription": "Lookup customer by ANI",
+ "httpServiceConfig": json.dumps({
+ "url": "https://api.example.com/customers/lookup",
+ "headers": {"Content-Type": "application/json"},
+ }),
+ "authConfigId": auth_config_id,
+ "isEnabled": False,
+ "enableMappings": True,
+ },
+ )
+ service.raise_for_status()
+ service_id = service.json()["serviceId"]
+
+ input_response = requests.post(
+ f"{BASE_URL}/v1/admin/accounts/{account_id}/httpServiceGroups/{group_id}/httpServices/{service_id}/inputs",
+ headers=headers,
+ json=[
+ {
+ "name": "ani",
+ "type": "PARAMETER",
+ "simpleDataType": "STRING",
+ "value": "",
+ "rank": "0",
+ }
+ ],
+ )
+ input_response.raise_for_status()
+ return {"group": group.json(), "service": service.json(), "input": input_response.json()}
+```
diff --git a/docs/routing/knowledge-base.md b/docs/routing/knowledge-base.md
new file mode 100644
index 0000000..2e5d3a8
--- /dev/null
+++ b/docs/routing/knowledge-base.md
@@ -0,0 +1,231 @@
+# Knowledge Base APIs
+
+The Knowledge Base APIs let you maintain RingCX knowledge base groups, categories, and articles from an external content system. Use them when help content must be synchronized from another source of truth.
+
+## Strategic Overview
+
+Knowledge base content is organized into groups, categories, and articles. These APIs are configuration APIs for content management, not analytics APIs. They are most useful when an organization already manages support content in a CMS and needs RingCX content to follow the same lifecycle.
+
+### Key Use Cases
+
+* **Content Synchronization:** Publish approved support articles from an external CMS into RingCX.
+* **Category Management:** Keep category structure aligned across sub-accounts or environments.
+* **Bulk Maintenance:** Update article text, metadata, or grouping without manual portal edits.
+* **Audit Support:** Compare RingCX knowledge content against a source repository.
+
+### Required Permissions & Scopes
+
+#### 1. Configure OAuth Scopes
+
+To authenticate, your application must be configured with the following permission in the [Developer Portal](https://developers.ringcentral.com/my-account.html#/applications):
+
+* **`ReadAccounts`**: Required to validate account context and access RingCX administrative APIs.
+
+#### 2. Enable RingCX Admin Access
+
+The authenticating user must have RingCX permissions that match the action being performed. Category creation requires `CREATE` on Knowledge Base Group, while article creation requires `CREATE` on Scripting.
+
+!!! warning "Common Authorization Errors"
+ If the application has the right OAuth scope but the user lacks knowledge base management permissions, the API returns an error similar to:
+ ```json
+ {
+ "errorCode": "access.denied.exception",
+ "generalMessage": "You do not have permission to access this resource",
+ "timestamp": 1611847650696
+ }
+ ```
+
+## Knowledge Base Groups
+
+| Operation | Method and Path | API Reference |
+| --- | --- | --- |
+| List groups with children | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/withChildren` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/getKnowledgeBaseGroupListWithChildren) |
+| Get group | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/getKnowledgeBaseGroup) |
+| Update group | `PUT https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/updateKnowledgeBaseGroup) |
+| Delete group | `DELETE https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/deleteKnowledgeBaseGroup) |
+
+## Categories
+
+Categories organize articles within a knowledge base group.
+
+| Operation | Method and Path | API Reference |
+| --- | --- | --- |
+| List categories | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/getKnowledgeBaseCategoryList) |
+| Create category | `POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/createKnowledgeBaseCategory) |
+| List categories with articles | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories/withChildren` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/getKnowledgeBaseCategoryListWithChildren) |
+| Get category | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories/{knowledgeBaseCategoryId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/getKnowledgeBaseCategory) |
+| Update category | `PUT https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories/{knowledgeBaseCategoryId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/updateKnowledgeBaseCategory) |
+| Delete category | `DELETE https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories/{knowledgeBaseCategoryId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/deleteKnowledgeBaseCategory) |
+
+## Articles
+
+Articles are managed within a category.
+
+Article permissions are tied to Scripting because knowledge articles can be used in agent and routing workflows. See the [IVR Scripting node](ivr/scripting-node.md) documentation when content changes are part of a scripting workflow.
+
+| Operation | Method and Path | API Reference |
+| --- | --- | --- |
+| List articles | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories/{knowledgeBaseCategoryId}/knowledgeBaseArticles` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/getKnowledgeBaseArticleList) |
+| Create article | `POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories/{knowledgeBaseCategoryId}/knowledgeBaseArticles` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/createKnowledgeBaseArticle) |
+| Get article | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories/{knowledgeBaseCategoryId}/knowledgeBaseArticles/{knowledgeBaseArticleId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/getKnowledgeBaseArticle) |
+| Update article | `PUT https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories/{knowledgeBaseCategoryId}/knowledgeBaseArticles/{knowledgeBaseArticleId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/updateKnowledgeBaseArticle) |
+| Delete article | `DELETE https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories/{knowledgeBaseCategoryId}/knowledgeBaseArticles/{knowledgeBaseArticleId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Knowledge-Base/deleteKnowledgeBaseArticle) |
+
+## Recommended Workflow
+
+1. Read the group and category tree with the `withChildren` endpoints.
+2. Create missing categories before creating articles.
+3. Upsert articles from the external content source.
+4. Update categories or articles when content metadata changes.
+5. Delete only after confirming no downstream workflow depends on the content.
+
+!!! important
+ Keep an external content identifier in article metadata when available. That makes synchronization idempotent and helps prevent duplicate articles.
+
+!!! important "Rate Limiting & Stability"
+ Synchronize knowledge base content in batches, especially when importing from an external CMS. Read the group/category tree first, update only changed articles, and use exponential backoff on `429 Too Many Requests` responses.
+
+## Identifiers and Parameters
+
+| Parameter | Type | Requirement | Description |
+| --- | --- | --- | --- |
+| `accountId` | String | **Required** | RingCX account that owns the knowledge base. |
+| `knowledgeBaseGroupId` | Integer | **Required** | Group that contains categories. |
+| `knowledgeBaseCategoryId` | Integer | **Required for category/article operations** | Category that contains articles. |
+| `knowledgeBaseArticleId` | Integer | **Required for article read/update/delete** | Article identifier. |
+
+## Request Examples
+
+### Create a Category
+
+`POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories`
+
+The category display name is `title`, not `name`. `KnowledgeBaseGroup` is the resource whose display name is `name`; categories and articles both use `title`.
+
+```json
+{
+ "title": "Billing",
+ "description": "Billing and invoice support articles",
+ "active": true,
+ "order": 10
+}
+```
+
+### Create an Article
+
+`POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories/{knowledgeBaseCategoryId}/knowledgeBaseArticles`
+
+```json
+{
+ "title": "Update invoice contact",
+ "content": "Open Billing, select the account, and update the invoice contact.
",
+ "labels": "billing,invoice",
+ "active": true,
+ "showSend": true,
+ "order": 20
+}
+```
+
+### Update an Article
+
+```json
+{
+ "knowledgeBaseArticleId": 9876,
+ "title": "Update invoice contact",
+ "content": "Open Billing, select the account, and update the invoice contact.
Save your changes.
",
+ "labels": "billing,invoice,admin",
+ "active": true,
+ "showSend": true,
+ "order": 20
+}
+```
+
+### Example Article Response
+
+```json
+{
+ "knowledgeBaseArticleId": 9876,
+ "title": "Update invoice contact",
+ "content": "Open Billing, select the account, and update the invoice contact.
",
+ "contentPlain": "Open Billing, select the account, and update the invoice contact.",
+ "labels": "billing,invoice",
+ "active": true,
+ "showSend": true,
+ "order": 20,
+ "knowledgeBaseCategory": {
+ "knowledgeBaseCategoryId": 1234,
+ "title": "Billing"
+ }
+}
+```
+
+## Article and Category Schema Notes
+
+Knowledge base article content is stored in the `content` field as HTML. The service also exposes a plain-text projection as `contentPlain` in list/detail views where supported.
+
+### `KnowledgeBaseArticle`
+
+| Field | Type | Description |
+| --- | --- | --- |
+| `knowledgeBaseArticleId` | Integer | Article identifier. |
+| `title` | String | Article title. |
+| `content` | String | HTML article body. |
+| `contentPlain` | String | HTML-stripped article content returned by the service. |
+| `labels` | String | Label text used for filtering or categorization. |
+| `active` | Boolean | Whether the article is available. |
+| `showSend` | Boolean | Whether agents can send the article where supported by the UI. |
+| `order` | Integer | Sort order within the category. |
+| `knowledgeBaseCategory` | Object | Parent category reference (`KnowledgeBaseCategory`). |
+
+### `KnowledgeBaseCategory`
+
+| Field | Type | Description |
+| --- | --- | --- |
+| `knowledgeBaseCategoryId` | Integer | Category identifier. |
+| `title` | String | Category title. The group display name is `name`; categories and articles both use `title`. |
+| `description` | String | Free-form description. |
+| `active` | Boolean | Whether the category is available. |
+| `order` | Integer | Sort order within the group. |
+| `groupId` | Integer | Parent group identifier. |
+| `knowledgeBaseGroup` | Object | Parent group reference (`KnowledgeBaseGroup`). |
+| `knowledgeBaseArticles` | Array | Articles in the category, returned by the `withChildren` list endpoint. |
+| `permissions` | Array | Per-resource CRUD permissions for the authenticated user. |
+
+!!! info "Content Format"
+ The implementation cleans saved HTML content, including link handling. Avoid sending unsupported scripts or raw external markup; sanitize CMS content before synchronizing it into RingCX.
+
+## Common Errors
+
+| Status | Cause | Resolution |
+| --- | --- | --- |
+| `400 Bad Request` | Missing category/article fields or invalid content. | Validate HTML and required fields before submitting. |
+| `403 Forbidden` | Caller lacks knowledge base permissions. | Grant Admin portal permission for knowledge base management. |
+| `404 Not Found` | Group, category, or article ID is not under the account. | Read the tree with `withChildren` before updating nested resources. |
+| `409 Conflict` | Duplicate content or deletion blocked by downstream dependencies. | Use an external CMS identifier in labels or metadata and confirm before deletion. |
+
+## Sample Implementation (Python)
+
+```python
+import requests
+
+BASE_URL = "https://ringcx.ringcentral.com/voice/api"
+
+def sync_cms_article(token, account_id, group_id, category_id, cms_article):
+ headers = {"Authorization": f"Bearer {token}"}
+ body = {
+ "title": cms_article["title"],
+ "content": cms_article["html"],
+ "labels": f"cms,{cms_article['id']}",
+ "active": True,
+ "showSend": True,
+ "order": cms_article.get("order", 0),
+ }
+ response = requests.post(
+ f"{BASE_URL}/v1/admin/accounts/{account_id}/knowledgeBaseGroups/{group_id}"
+ f"/knowledgeBaseCategories/{category_id}/knowledgeBaseArticles",
+ headers=headers,
+ json=body,
+ )
+ response.raise_for_status()
+ return response.json()
+```
diff --git a/docs/routing/phone-number-management.md b/docs/routing/phone-number-management.md
new file mode 100644
index 0000000..ff0e2d9
--- /dev/null
+++ b/docs/routing/phone-number-management.md
@@ -0,0 +1,246 @@
+# Phone Number Management APIs
+
+The Phone Number Management APIs let you manage DNIS pools, product assignments, and tracking numbers used by RingCX routing. Use these APIs when phone-number inventory is managed outside the Admin portal or must be synchronized across environments.
+
+## Strategic Overview
+
+Phone numbers are shared by many RingCX features. Voice DNIS can be assigned to queues, IVRs, and cloud route profiles. Tracking numbers add another routing layer for campaigns or attribution workflows.
+
+### Key Use Cases
+
+* **Bulk Number Provisioning:** Upload or update large DNIS inventories without manual entry.
+* **Routing Assignment:** Assign voice numbers to queues, IVRs, or cloud route profiles.
+* **Inventory Search:** Search pools and identify existing assignments before making changes.
+* **Tracking Number Maintenance:** Maintain tracking-number groups and schedule overrides.
+
+### Required Permissions & Scopes
+
+#### 1. Configure OAuth Scopes
+
+To authenticate, your application must be configured with the following permission in the [Developer Portal](https://developers.ringcentral.com/my-account.html#/applications):
+
+* **`ReadAccounts`**: Required to validate account context and access RingCX administrative APIs.
+
+#### 2. Enable RingCX Admin Access
+
+In the RingCX Admin portal, the authenticating user must have permission to read and update telephone-number inventory and the destination product being assigned, such as queues, Visual IVRs, or cloud route profiles.
+
+!!! warning "Common Authorization Errors"
+ If the user can authenticate but cannot manage the target number or destination product, the API returns an error similar to:
+ ```json
+ {
+ "errorCode": "access.denied.exception",
+ "generalMessage": "You do not have permission to access this resource",
+ "timestamp": 1611847650696
+ }
+ ```
+
+## Manage DNIS Pools
+
+DNIS pool endpoints create, update, search, upload, and delete phone-number inventory.
+
+| Operation | Method and Path | API Reference |
+| --- | --- | --- |
+| Search DNIS | `POST https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/searchDnis` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/searchDnis) |
+| Search pools | `POST https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/search` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/search) |
+| Create DNIS pool records | `POST https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/dnisPool` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/createDnisPool) |
+| Update a DNIS pool record | `PUT https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/dnisPool` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/updateDnisPool) |
+| Upload DNIS pool records | `POST https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/uploadDnisPool` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/uploadDnisPool) |
+| Bulk update DNIS pools | `PUT https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/updateBulkDnisPool` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/updateBulkDnisPool) |
+
+## Assign Voice DNIS
+
+Use assigned DNIS endpoints to connect numbers to voice routing products.
+
+| Destination | Method and Path | API Reference |
+| --- | --- | --- |
+| Queue | `PUT https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/assignedDnis/gates/{gateId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/updateAssignedDnisForGate) |
+| Visual IVR | `PUT https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/assignedDnis/visualIvrs/{visualIvrId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/updateAssignedDnisForVisualIvr) |
+| Cloud route profile | `PUT https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/assignedDnis/cloudRouteProfiles/{cloudRouteProfileId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/updateAssignedDnisForCloudRouteProfile) |
+| Existing assignment | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/assignedDnis/{dnis}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/getAssignedDnis) |
+| Remove assignment | `DELETE https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/assignedDnis/{dnis}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/deleteAssignedDnis) |
+
+## Tracking Numbers
+
+Tracking numbers are managed under tracking-number groups.
+
+| Operation | Method and Path | API Reference |
+| --- | --- | --- |
+| List groups with numbers | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/tracGroups/withChildren` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/getTracGroupListWithChildren) |
+| Get group | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/tracGroups/{tracGroupId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/getTracGroup) |
+| Update group | `PUT https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/tracGroups/{tracGroupId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/updateTracGroup) |
+| List numbers | `GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/tracGroups/{tracGroupId}/tracNumbers` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/getTracNumberList) |
+| Create number | `POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/tracGroups/{tracGroupId}/tracNumbers` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/createTracNumber) |
+| Update number | `PUT https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/tracGroups/{tracGroupId}/tracNumbers/{tracId}` | [Reference](https://developers.ringcentral.com/engage/voice/api-reference/Phone-Number-Management/updateTracNumber) |
+
+## Recommended Workflow
+
+1. Search existing DNIS inventory before adding new records.
+2. Create or upload missing DNIS pool records.
+3. Assign voice DNIS to the correct queue, IVR, or cloud route profile.
+4. For tracking-number workflows, update tracking groups and schedule overrides separately.
+5. Verify assignments before deleting or reassigning numbers.
+
+!!! warning
+ Reassigning or deleting a phone number can immediately affect customer routing. Confirm the target product and maintenance window before applying bulk changes.
+
+!!! important "Rate Limiting & Stability"
+ Treat number inventory changes as provisioning operations. Search first, update only changed records, and batch bulk uploads so retries do not duplicate or reassign numbers unexpectedly.
+
+## Primary Parameters
+
+| Parameter | Type | Requirement | Description |
+| --- | --- | --- | --- |
+| `dnis` | String | **Required** | Phone number in DNIS inventory. Use a normalized E.164-style value when possible. |
+| `gateId` | Integer | Required for queue assignment | Voice queue identifier. |
+| `visualIvrId` | Integer | Required for Visual IVR assignment | Visual IVR identifier. |
+| `cloudRouteProfileId` | Integer | Required for cloud routing assignment | Cloud route profile identifier. |
+| `page`, `size`, `sort` | Integer/String | Optional | Search controls for paginated inventory lookups. |
+| `file` | File | Required for `uploadDnisPool` | Bulk DNIS pool upload payload (sent as `multipart/form-data`, not a query string). |
+| `fileType` | String enum | Required for `uploadDnisPool` | Delimiter format. Currently `COMMA`. |
+
+## Request and Response Examples
+
+### Create DNIS Pool Records
+
+`POST https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/dnisPool`
+
+The body is an **array** of `DnisPool` objects; the endpoint creates the list atomically and returns the saved records. The description field on a DnisPool is `dnisDescription` and the owning account is `reservedAccountId` (string). Use `notes` for free-form internal notes.
+
+```json
+[
+ {
+ "dnis": "15551234567",
+ "reservedAccountId": "123456",
+ "dnisDescription": "Main support line",
+ "dnisCategory": "VOICE",
+ "active": true
+ }
+]
+```
+
+### Upload a DNIS Pool File
+
+`POST https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/uploadDnisPool`
+
+This endpoint accepts a delimited file as a `multipart/form-data` upload. The `fileType` query parameter declares the delimiter (`COMMA`). Use `quoteCharacter` when fields contain the delimiter.
+
+```bash
+curl -X POST \
+ "https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/uploadDnisPool?fileType=COMMA" \
+ -H "Authorization: Bearer " \
+ -F "file=@dnis_pool.csv"
+```
+
+### Assign Voice DNIS to a Queue
+
+`PUT https://ringcx.ringcentral.com/voice/api/v1/admin/utilities/tnManager/assignedDnis/gates/{gateId}`
+
+The body is an **array** of `AssignedDnis` objects. Each entry must use `dnisDescription` (not `description`) and `isActive`.
+
+```json
+[
+ {
+ "dnis": "15551234567",
+ "isActive": true,
+ "dnisDescription": "Primary support routing"
+ }
+]
+```
+
+### Search Result (`searchDnis`)
+
+The shape returned by `getCustomerDnisPoolList` is `DnisSearchResultDTO`. Fields below are illustrative; refer to the API reference for the full set returned for a given account.
+
+```json
+{
+ "records": [
+ {
+ "dnis": "15551234567",
+ "dnisE164": "+15551234567",
+ "reservedAccountId": "123456",
+ "dnisCategory": "VOICE",
+ "active": true
+ }
+ ],
+ "totalElements": 1
+}
+```
+
+### Assignment Lookup (`getDnisAssignment`)
+
+Returns a single `AssignedDnis`. The product is signalled by which of `gate`, `visualIvr`, `cloudRouteProfile`, or `tracNumber` is populated.
+
+```json
+{
+ "dnis": "15551234567",
+ "isActive": true,
+ "dnisDescription": "Primary support routing",
+ "gate": {
+ "gateId": 4567,
+ "gateName": "Support queue"
+ }
+}
+```
+
+## Resource Schema Summary
+
+| Resource | Key Fields | Notes |
+| --- | --- | --- |
+| DNIS pool record (`DnisPool`) | `dnis`, `dnisE164`, `reservedAccountId`, `dnisDescription`, `dnisCategory`, `notes`, `active` | Inventory record for a phone number before or after assignment. |
+| Voice assignment (`AssignedDnis`) | `dnis`, `isActive`, `dnisDescription`, plus one of `gate` / `visualIvr` / `cloudRouteProfile` / `tracNumber` | The destination object embedded on the response tells you which product owns the assignment. |
+| Tracking number (`TracNumber`) | `tracId`, `tracGroupId`, `dnis`, `dnisDescription`, `active` | Tracking-number configuration used for attribution or routing. |
+
+## Common Errors
+
+| Status | Cause | Resolution |
+| --- | --- | --- |
+| `400 Bad Request` | DNIS format is invalid or the target destination ID is missing. | Normalize numbers and validate target IDs before assignment. |
+| `403 Forbidden` | Caller lacks telephone-number or destination-product permissions. | Grant inventory and target product permissions in the Admin portal. |
+| `404 Not Found` | DNIS or destination product does not exist. | Search inventory and list the destination product before assigning. |
+| `409 Conflict` | DNIS is already assigned or duplicated in a bulk upload. | Inspect the current assignment and remove or update it intentionally. |
+
+## Sample Implementation (Python)
+
+```python
+import requests
+
+BASE_URL = "https://ringcx.ringcentral.com/voice/api"
+
+def search_then_assign_voice_dnis(token, dnis, gate_id, description="Primary support routing"):
+ headers = {"Authorization": f"Bearer {token}"}
+
+ search = requests.post(
+ f"{BASE_URL}/v1/admin/utilities/tnManager/searchDnis",
+ headers=headers,
+ json={"dnis": dnis},
+ )
+ search.raise_for_status()
+
+ assignment = requests.put(
+ f"{BASE_URL}/v1/admin/utilities/tnManager/assignedDnis/gates/{gate_id}",
+ headers=headers,
+ json=[
+ {
+ "dnis": dnis,
+ "isActive": True,
+ "dnisDescription": description,
+ }
+ ],
+ )
+ assignment.raise_for_status()
+ return assignment.json() if assignment.content else None
+
+
+def upload_dnis_pool(token, file_path, file_type="COMMA"):
+ headers = {"Authorization": f"Bearer {token}"}
+ with open(file_path, "rb") as fh:
+ response = requests.post(
+ f"{BASE_URL}/v1/admin/utilities/tnManager/uploadDnisPool",
+ headers=headers,
+ params={"fileType": file_type},
+ files={"file": fh},
+ )
+ response.raise_for_status()
+ return response.json()
+```
diff --git a/mkdocs.yml b/mkdocs.yml
index 2033e71..6862c8d 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -52,6 +52,8 @@ nav:
- 'Queue Events': routing/queues/queue-events.md
- 'Queue Groups': routing/queues/queue-groups.md
- 'Group Skills': routing/queues/group-skills.md
+ - 'Knowledge Base': routing/knowledge-base.md
+ - 'Phone Number Management': routing/phone-number-management.md
- 'Cloud Routing': routing/cloud-routing.md
- 'IVR':
- 'Overview': routing/ivr/index.md
@@ -108,6 +110,7 @@ nav:
- 'Overview': integration/index.md
- 'Reports': integration/reports-orig.md
- 'Administration': integration/admin.md
+ - 'Remote HTTP Services': integration/remote-http-services.md
- 'Agent State Subscriptions': integration/agent-state-subscriptions.md
- 'Routing': integration/agent-avail.md
- 'SDKs': sdks.md
diff --git a/specs/engage-voice_openapi3.json b/specs/engage-voice_openapi3.json
index 6141630..c01a44b 100644
--- a/specs/engage-voice_openapi3.json
+++ b/specs/engage-voice_openapi3.json
@@ -1,34922 +1,41573 @@
{
- "components": {
- "requestBodies": {
- "Gate": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Gate"
- }
- }
- },
- "description": "gate",
- "required": true
- },
- "GateDisposition": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateDisposition"
- }
- }
- },
- "description": "gateDisposition",
- "required": true
- },
- "GateGroup": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateGroup"
- }
- }
- },
- "description": "gateGroup",
- "required": true
- },
- "GateGroupSkill": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateGroupSkill"
- }
- }
- },
- "description": "skill",
- "required": true
- },
- "GateQueueDtmfEvent": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateQueueDtmfEvent"
- }
- }
- },
- "description": "postPayload",
- "required": true
- },
- "GateQueueEvent": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateQueueEvent"
- }
- }
- },
- "description": "queueEvent",
- "required": true
- },
- "GateScheduleOverride": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateScheduleOverride"
- }
- }
- },
- "description": "scheduleOverride",
- "required": true
- },
- "PhoneBookEntry": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PhoneBookEntry"
- }
- }
- },
- "description": "entry",
- "required": true
+ "components": {
+ "requestBodies": {
+ "Gate": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Gate"
}
+ }
},
- "schemas": {
- "AccessTokenUserDetails": {
- "properties": {
- "accessToken": {
- "type": "string"
- },
- "adminId": {
- "format": "int32",
- "type": "integer"
- },
- "adminPasswordReset": {
- "type": "boolean"
- },
- "adminUrl": {
- "type": "string"
- },
- "agentDetails": {
- "items": {
- "$ref": "#/components/schemas/AgentV2"
- },
- "type": "array"
- },
- "agentUrl": {
- "type": "string"
- },
- "analyticsUrl": {
- "type": "string"
- },
- "iqUrl": {
- "type": "string"
- },
- "isAdminPasswordReset": {
- "type": "boolean"
- },
- "loginHashcode": {
- "type": "string"
- },
- "mainAccountId": {
- "type": "string"
- },
- "platformId": {
- "type": "string"
- },
- "port": {
- "format": "int32",
- "type": "integer"
- },
- "rcUser": {
- "$ref": "#/components/schemas/Contact"
- },
- "redirectUrl": {
- "type": "string"
- },
- "refreshToken": {
- "type": "string"
- },
- "ssoLogin": {
- "type": "boolean"
- },
- "tokenType": {
- "type": "string"
- }
- },
- "title": "AccessTokenUserDetails",
- "type": "object"
- },
- "Account": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "accountName": {
- "type": "string"
- },
- "amdDefaultProfile": {
- "format": "int32",
- "type": "integer"
- },
- "archivedAccount": {
- "type": "boolean"
- },
- "audioRetentionDays": {
- "format": "int32",
- "type": "integer"
- },
- "concurrentLogins": {
- "format": "int32",
- "type": "integer"
- },
- "crmHost": {
- "type": "string"
- },
- "crmInstance": {
- "type": "string"
- },
- "crmPwd": {
- "type": "string"
- },
- "crmUid": {
- "type": "string"
- },
- "dataRetentionDays": {
- "format": "int32",
- "type": "integer"
- },
- "databaseShardId": {
- "type": "string"
- },
- "defaultCallerid": {
- "type": "string"
- },
- "defaultHold": {
- "type": "string"
- },
- "defaultIntellidialServerId": {
- "format": "int32",
- "type": "integer"
- },
- "defaultOutdialServerGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "dncOrgId": {
- "type": "string"
- },
- "dncOrgIdConfirmed": {
- "type": "boolean"
- },
- "emailFromAddress": {
- "type": "string"
- },
- "enable247Dialing": {
- "type": "boolean"
- },
- "enableAgentRankRouting": {
- "type": "boolean"
- },
- "enableAmdProfiles": {
- "type": "boolean"
- },
- "enableBlankCallerid": {
- "type": "boolean"
- },
- "enableCallEventTracking": {
- "type": "boolean"
- },
- "enableCellScrubbing": {
- "type": "boolean"
- },
- "enableCentralizedData": {
- "type": "boolean"
- },
- "enableChat": {
- "type": "boolean"
- },
- "enableCloudRouting": {
- "type": "boolean"
- },
- "enableCorporateDirectory": {
- "type": "boolean"
- },
- "enableCrmExport": {
- "type": "boolean"
- },
- "enableFifo": {
- "type": "boolean"
- },
- "enableFolderMode": {
- "type": "boolean"
- },
- "enableForceLegacy": {
- "type": "boolean"
- },
- "enableGoodData": {
- "type": "boolean"
- },
- "enableHciDialer": {
- "type": "boolean"
- },
- "enableInbound": {
- "type": "boolean"
- },
- "enableIntlOutbound": {
- "type": "boolean"
- },
- "enableListLoading": {
- "type": "boolean"
- },
- "enableMultiuser": {
- "type": "boolean"
- },
- "enableOutbound": {
- "type": "boolean"
- },
- "enableOutboundPredictive": {
- "type": "boolean"
- },
- "enableScheduledTasks": {
- "type": "boolean"
- },
- "enableSoftphones": {
- "type": "boolean"
- },
- "enableTaskMode": {
- "type": "boolean"
- },
- "enableTcpaSafeMachineDetect": {
- "type": "boolean"
- },
- "enableTracking": {
- "type": "boolean"
- },
- "enableVisualIvr": {
- "type": "boolean"
- },
- "enableVoiceBroadcast": {
- "type": "boolean"
- },
- "endDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "ftpHost": {
- "type": "string"
- },
- "ftpPwd": {
- "type": "string"
- },
- "ftpUid": {
- "type": "string"
- },
- "ivrAppsEnabled": {
- "type": "boolean"
- },
- "mainAccount": {
- "$ref": "#/components/schemas/MainAccount"
- },
- "mainAccountId": {
- "type": "string"
- },
- "mainAccountName": {
- "type": "string"
- },
- "maxBreakTime": {
- "format": "int32",
- "type": "integer"
- },
- "maxLunchTime": {
- "format": "int32",
- "type": "integer"
- },
- "maxOutPortsPerAgent": {
- "format": "int32",
- "type": "integer"
- },
- "minimumSec": {
- "format": "int32",
- "type": "integer"
- },
- "notificationEmail": {
- "type": "string"
- },
- "offHookHold": {
- "type": "string"
- },
- "offHookWhisper": {
- "type": "string"
- },
- "offHookWhisperGhost": {
- "type": "string"
- },
- "offhookCallerid": {
- "type": "string"
- },
- "outboundManualDefaultRingtime": {
- "format": "int32",
- "type": "integer"
- },
- "outboundPrepay": {
- "type": "boolean"
- },
- "overrideDispositions": {
- "format": "int32",
- "type": "integer"
- },
- "pciCompliance": {
- "type": "boolean"
- },
- "pciComplianceRequest": {
- "type": "boolean"
- },
- "phoneRecordingPin": {
- "format": "int32",
- "type": "integer"
- },
- "primaryTimezone": {
- "format": "int32",
- "type": "integer"
- },
- "rcAccountAccess": {
- "enum": [
- "DISABLED",
- "ENABLED",
- "REQUIRED"
- ],
- "type": "string"
- },
- "recordingAccessMode": {
- "enum": [
- "ANONYMOUS",
- "ACCOUNT",
- "RIGHTS_DOC",
- "DISABLED"
- ],
- "type": "string"
- },
- "recordingFilenameFormat": {
- "type": "string"
- },
- "recordingsDelivery": {
- "type": "string"
- },
- "rounding": {
- "format": "int32",
- "type": "integer"
- },
- "securityKey": {
- "type": "string"
- },
- "softphoneHost": {
- "type": "string"
- },
- "softphoneWsdl": {
- "type": "string"
- },
- "startDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "tcpaSafeMode": {
- "type": "boolean"
- },
- "usePowerBy": {
- "type": "boolean"
- },
- "weekOffset": {
- "format": "int32",
- "type": "integer"
- },
- "wfmType": {
- "enum": [
- "GENERIC",
- "GENERIC_UDP",
- "ASPECT",
- "AC2",
- "PIPKINS",
- "MONET",
- "NONE"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountAuxState": {
- "properties": {
- "agentAuxState": {
- "type": "string"
- },
- "baseAgentState": {
- "$ref": "#/components/schemas/BaseAgentState"
- },
- "description": {
- "type": "string"
- },
- "isActive": {
- "type": "boolean"
- },
- "isAgentSelectable": {
- "type": "boolean"
- },
- "isRequired": {
- "type": "boolean"
- },
- "rank": {
- "format": "int32",
- "type": "integer"
- },
- "stateId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "AccountCallerId": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "callerId": {
- "type": "string"
- },
- "callerIdId": {
- "format": "int32",
- "type": "integer"
- },
- "description": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountCreationRequest": {
- "properties": {
- "accountName": {
- "type": "string"
- },
- "databaseShardId": {
- "type": "string"
- },
- "defaultIntellidialServerId": {
- "format": "int32",
- "type": "integer"
- },
- "defaultOutdialServerGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "mainAccountId": {
- "type": "string"
- },
- "pciCompliance": {
- "type": "boolean"
- },
- "tcpaSafeMode": {
- "type": "boolean"
- }
- },
- "required": [
- "accountName",
- "databaseShardId",
- "defaultIntellidialServerId",
- "defaultOutdialServerGroupId",
- "mainAccountId",
- "pciCompliance",
- "tcpaSafeMode"
- ],
- "type": "object"
- },
- "AccountIntegrationBase": {
- "properties": {
- "_type": {
- "type": "string"
- },
- "accountId": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "integrationType": {
- "type": "string"
- },
- "isActive": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AccountPrepayProfile": {
- "properties": {
- "account": {
- "$ref": "#/components/schemas/Account"
- },
- "accountId": {
- "type": "string"
- },
- "agent": {
- "format": "double",
- "type": "number"
- },
- "agentVoip": {
- "format": "double",
- "type": "number"
- },
- "inbound": {
- "format": "double",
- "type": "number"
- },
- "inboundTf": {
- "format": "double",
- "type": "number"
- },
- "machineMsgs": {
- "format": "double",
- "type": "number"
- },
- "monitoring": {
- "format": "double",
- "type": "number"
- },
- "offHook": {
- "format": "double",
- "type": "number"
- },
- "offHookVoip": {
- "format": "double",
- "type": "number"
- },
- "outbound": {
- "format": "double",
- "type": "number"
- },
- "transfer": {
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "AccountSkillStats": {
- "properties": {
- "accountId": {
- "format": "int32",
- "type": "integer"
- },
- "accountName": {
- "type": "string"
- },
- "availableCount": {
- "format": "int32",
- "type": "integer"
- },
- "onlineCount": {
- "format": "int32",
- "type": "integer"
- },
- "skillName": {
- "type": "string"
- },
- "staffedCount": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "AccountView": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "accountName": {
- "type": "string"
- },
- "databaseShardId": {
- "type": "string"
- },
- "defaultIntellidialServerId": {
- "format": "int32",
- "type": "integer"
- },
- "defaultOutdialServerGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "emailFromAddress": {
- "type": "string"
- },
- "enable247Dialing": {
- "type": "boolean"
- },
- "enableAgentRankRouting": {
- "type": "boolean"
- },
- "enableAmdProfiles": {
- "type": "boolean"
- },
- "enableChat": {
- "type": "boolean"
- },
- "enableCloudRouting": {
- "type": "boolean"
- },
- "enableFifo": {
- "type": "boolean"
- },
- "enableFolderMode": {
- "type": "boolean"
- },
- "enableGoodData": {
- "type": "boolean"
- },
- "enableHciDialer": {
- "type": "boolean"
- },
- "enableInbound": {
- "type": "boolean"
- },
- "enableMultiUser": {
- "type": "boolean"
- },
- "enableOutbound": {
- "type": "boolean"
- },
- "enableSoftphones": {
- "type": "boolean"
- },
- "enableTaskMode": {
- "type": "boolean"
- },
- "enableTcpaSafeMachineDetect": {
- "type": "boolean"
- },
- "enableTracking": {
- "type": "boolean"
- },
- "enableVisualIvr": {
- "type": "boolean"
- },
- "enableVoiceBroadcast": {
- "type": "boolean"
- },
- "engageAccountId": {
- "type": "string"
- },
- "ivrAppsEnabled": {
- "type": "boolean"
- },
- "mainAccountId": {
- "type": "string"
- },
- "mainAccountName": {
- "type": "string"
- },
- "outboundPrepay": {
- "type": "boolean"
- },
- "rcAccountAccess": {
- "enum": [
- "DISABLED",
- "ENABLED",
- "REQUIRED"
- ],
- "type": "string"
- },
- "rcAccountId": {
- "type": "string"
- },
- "tcpaSafeMode": {
- "type": "boolean"
- },
- "usePowerBy": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AcdStats": {
- "properties": {
- "abandoned": {
- "format": "int32",
- "type": "integer"
- },
- "accepted": {
- "format": "int32",
- "type": "integer"
- },
- "accountId": {
- "type": "string"
- },
- "active": {
- "format": "int32",
- "type": "integer"
- },
- "available": {
- "format": "int32",
- "type": "integer"
- },
- "deflected": {
- "format": "int32",
- "type": "integer"
- },
- "gateGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "gateId": {
- "format": "int32",
- "type": "integer"
- },
- "gateName": {
- "type": "string"
- },
- "groupName": {
- "type": "string"
- },
- "inQueue": {
- "format": "int32",
- "type": "integer"
- },
- "lastUpdate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "longCall": {
- "format": "int32",
- "type": "integer"
- },
- "longestInQueue": {
- "format": "int32",
- "type": "integer"
- },
- "presented": {
- "format": "int32",
- "type": "integer"
- },
- "routing": {
- "format": "int32",
- "type": "integer"
- },
- "schedule": {
- "type": "string"
- },
- "scheduleOverride": {
- "type": "string"
- },
- "selectable": {
- "type": "boolean"
- },
- "shortAbandon": {
- "format": "int32",
- "type": "integer"
- },
- "shortCall": {
- "format": "int32",
- "type": "integer"
- },
- "slaFail": {
- "format": "int32",
- "type": "integer"
- },
- "slaPass": {
- "format": "int32",
- "type": "integer"
- },
- "staffed": {
- "format": "int32",
- "type": "integer"
- },
- "successDispositions": {
- "format": "int32",
- "type": "integer"
- },
- "totalAbandonTime": {
- "format": "int64",
- "type": "integer"
- },
- "totalAnswerTime": {
- "format": "int64",
- "type": "integer"
- },
- "totalQueueTime": {
- "format": "int64",
- "type": "integer"
- },
- "totalTalkTime": {
- "format": "int64",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ActiveCall": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "activeCallSessions": {
- "items": {
- "$ref": "#/components/schemas/ActiveCallSession"
- },
- "type": "array"
- },
- "agentDisposition": {
- "type": "string"
- },
- "ani": {
- "type": "string"
- },
- "archive": {
- "type": "boolean"
- },
- "auxPhone": {
- "type": "string"
- },
- "billingKey": {
- "type": "string"
- },
- "callFinalResult": {
- "format": "int32",
- "type": "integer"
- },
- "callState": {
- "type": "string"
- },
- "callType": {
- "type": "string"
- },
- "campaign": {
- "$ref": "#/components/schemas/Campaign"
- },
- "campaignLead": {
- "$ref": "#/components/schemas/CampaignLead"
- },
- "cloudProfileId": {
- "format": "int32",
- "type": "integer"
- },
- "currDequeueEventId": {
- "format": "int32",
- "type": "integer"
- },
- "dequeueAgentSession": {
- "$ref": "#/components/schemas/ActiveCallSession"
- },
- "dequeueAttempts": {
- "format": "int32",
- "type": "integer"
- },
- "dequeueTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "dialType": {
- "format": "int32",
- "type": "integer"
- },
- "dialerSourceKey": {
- "type": "string"
- },
- "dnis": {
- "type": "string"
- },
- "dnisE164": {
- "type": "string"
- },
- "enqueueTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "extraUrlData": {
- "type": "string"
- },
- "gate": {
- "$ref": "#/components/schemas/Gate"
- },
- "iqServerId": {
- "type": "string"
- },
- "isLongCall": {
- "type": "boolean"
- },
- "isShortAbandon": {
- "type": "boolean"
- },
- "isShortCall": {
- "type": "boolean"
- },
- "nextDequeueTime": {
- "$ref": "#/components/schemas/Timestamp"
- },
- "nextSessionId": {
- "format": "int32",
- "type": "integer"
- },
- "optOut": {
- "type": "boolean"
- },
- "originatingDnis": {
- "type": "string"
- },
- "outboundDisposition": {
- "type": "string"
- },
- "outboundExternid": {
- "type": "string"
- },
- "primarySession": {
- "$ref": "#/components/schemas/ActiveCallSession"
- },
- "priorityQueueEvent": {
- "type": "string"
- },
- "recordingDeleted": {
- "format": "int32",
- "type": "integer"
- },
- "recordingUrl": {
- "type": "string"
- },
- "safeArchiveDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "skillOverride": {
- "type": "string"
- },
- "slaPassed": {
- "type": "boolean"
- },
- "slaQualified": {
- "type": "boolean"
- },
- "sourceAppId": {
- "type": "string"
- },
- "tracId": {
- "format": "int32",
- "type": "integer"
- },
- "uii": {
- "type": "string"
- },
- "visualIvrId": {
- "format": "int32",
- "type": "integer"
- },
- "vruSourceKey": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ActiveCallEventHistory": {
- "properties": {
- "ani": {
- "type": "string"
- },
- "callEventDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "callEventId": {
- "format": "int32",
- "type": "integer"
- },
- "callEventType": {
- "type": "string"
- },
- "destDnis": {
- "type": "string"
- },
- "destDnisE164": {
- "type": "string"
- },
- "destId": {
- "format": "int32",
- "type": "integer"
- },
- "destName": {
- "type": "string"
- },
- "destType": {
- "enum": [
- "CLOUD-PROFILE",
- "CLOUD-DESTINATION",
- "GATE",
- "TRAC",
- "CAMPAIGN",
- "AGENT",
- "IVR",
- "VIVR"
- ],
- "type": "string"
- },
- "destUii": {
- "type": "string"
- },
- "dtmfTrap": {
- "type": "string"
- },
- "eventLog": {
- "type": "string"
- },
- "origDnis": {
- "type": "string"
- },
- "origDnisE164": {
- "type": "string"
- },
- "origId": {
- "format": "int32",
- "type": "integer"
- },
- "origName": {
- "type": "string"
- },
- "origType": {
- "enum": [
- "CLOUD-PROFILE",
- "CLOUD-DESTINATION",
- "GATE",
- "TRAC",
- "CAMPAIGN",
- "AGENT",
- "IVR",
- "VIVR"
- ],
- "type": "string"
- },
- "origUii": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ActiveCallHistory": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "activeCallEventHistories": {
- "items": {
- "$ref": "#/components/schemas/ActiveCallEventHistory"
- },
- "type": "array"
- },
- "activeCallSessionHistories": {
- "items": {
- "$ref": "#/components/schemas/ActiveCallSessionHistory"
- },
- "type": "array"
- },
- "agentDisposition": {
- "type": "string"
- },
- "agentNameAndType": {
- "$ref": "#/components/schemas/AgentNameAndType"
- },
- "ani": {
- "type": "string"
- },
- "archive": {
- "format": "int32",
- "type": "integer"
- },
- "auxPhone": {
- "type": "string"
- },
- "billingKey": {
- "type": "string"
- },
- "callFinalResult": {
- "format": "int32",
- "type": "integer"
- },
- "callState": {
- "type": "string"
- },
- "callType": {
- "type": "string"
- },
- "currDequeueEventId": {
- "format": "int32",
- "type": "integer"
- },
- "dequeueAttempts": {
- "format": "int32",
- "type": "integer"
- },
- "dequeueTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "dialType": {
- "format": "int32",
- "type": "integer"
- },
- "dialTypeString": {
- "type": "string"
- },
- "dialerSourceKey": {
- "type": "string"
- },
- "dnis": {
- "type": "string"
- },
- "dnisE164": {
- "type": "string"
- },
- "enqueueTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "extraUrlData": {
- "type": "string"
- },
- "historySource": {
- "$ref": "#/components/schemas/HistorySource"
- },
- "iqServerId": {
- "type": "string"
- },
- "isLongCall": {
- "type": "boolean"
- },
- "isShortAbandon": {
- "type": "boolean"
- },
- "isShortCall": {
- "type": "boolean"
- },
- "leadId": {
- "format": "int32",
- "type": "integer"
- },
- "nextDequeueTime": {
- "$ref": "#/components/schemas/Timestamp"
- },
- "nextSessionId": {
- "format": "int32",
- "type": "integer"
- },
- "optOut": {
- "type": "boolean"
- },
- "originatingDnis": {
- "type": "string"
- },
- "outboundDisposition": {
- "type": "string"
- },
- "outboundExternid": {
- "type": "string"
- },
- "priorityQueueEvent": {
- "type": "string"
- },
- "recordingDeleted": {
- "format": "int32",
- "type": "integer"
- },
- "recordingUrl": {
- "type": "string"
- },
- "safeArchiveDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "scriptResult": {
- "type": "string"
- },
- "skillOverride": {
- "type": "string"
- },
- "slaPassed": {
- "type": "boolean"
- },
- "slaQualified": {
- "type": "boolean"
- },
- "sourceAppId": {
- "type": "string"
- },
- "uii": {
- "type": "string"
- },
- "vruSourceKey": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ActiveCallListResponse": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "agentFirstName": {
- "type": "string"
- },
- "agentLastName": {
- "type": "string"
- },
- "ani": {
- "type": "string"
- },
- "archive": {
- "type": "boolean"
- },
- "callState": {
- "type": "string"
- },
- "cnam": {
- "type": "string"
- },
- "dequeueTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "destinationName": {
- "type": "string"
- },
- "dnis": {
- "type": "string"
- },
- "dnisE164": {
- "type": "string"
- },
- "enqueueTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "externalId": {
- "type": "string"
- },
- "uii": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ActiveCallSession": {
- "properties": {
- "agentDisposition": {
- "type": "string"
- },
- "agentLogin": {
- "$ref": "#/components/schemas/AgentLogin"
- },
- "agentNotes": {
- "type": "string"
- },
- "archive": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "callDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "callerName": {
- "type": "string"
- },
- "carrier": {
- "type": "string"
- },
- "cloudDestinationId": {
- "format": "int32",
- "type": "integer"
- },
- "dialDisposition": {
- "type": "string"
- },
- "dialDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "dialDuration": {
- "format": "int32",
- "type": "integer"
- },
- "duration": {
- "format": "int32",
- "type": "integer"
- },
- "iqServerId": {
- "type": "string"
- },
- "isDequeueAgent": {
- "format": "int32",
- "type": "integer"
- },
- "isMonitoring": {
- "format": "int32",
- "type": "integer"
- },
- "onHold": {
- "format": "int32",
- "type": "integer"
- },
- "phone": {
- "type": "string"
- },
- "pk": {
- "$ref": "#/components/schemas/ActiveCallSessionPK"
- },
- "recordingUrl": {
- "type": "string"
- },
- "safeArchiveDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "sessionId": {
- "type": "string"
- },
- "sessionType": {
- "type": "string"
- },
- "skillProfileId": {
- "format": "int32",
- "type": "integer"
- },
- "termParty": {
- "type": "string"
- },
- "termReason": {
- "type": "string"
- },
- "transferFlag": {
- "format": "int32",
- "type": "integer"
- },
- "wrapTime": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ActiveCallSessionHistory": {
- "properties": {
- "agentLoginId": {
- "format": "int32",
- "type": "integer"
- },
- "agentNotes": {
- "type": "string"
- },
- "archive": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "callDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "callerName": {
- "type": "string"
- },
- "carrier": {
- "type": "string"
- },
- "cloudDestinationId": {
- "format": "int32",
- "type": "integer"
- },
- "dialDisposition": {
- "type": "string"
- },
- "dialDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "dialDuration": {
- "format": "int32",
- "type": "integer"
- },
- "duration": {
- "format": "int32",
- "type": "integer"
- },
- "iqServerId": {
- "type": "string"
- },
- "isDequeueAgent": {
- "format": "int32",
- "type": "integer"
- },
- "isMonitoring": {
- "format": "int32",
- "type": "integer"
- },
- "onHold": {
- "format": "int32",
- "type": "integer"
- },
- "phone": {
- "type": "string"
- },
- "pk": {
- "$ref": "#/components/schemas/ActiveCallSessionPK"
- },
- "recordingUrl": {
- "type": "string"
- },
- "safeArchiveDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "sessionId": {
- "type": "string"
- },
- "sessionType": {
- "type": "string"
- },
- "skillProfileId": {
- "format": "int32",
- "type": "integer"
- },
- "termParty": {
- "type": "string"
- },
- "termReason": {
- "type": "string"
- },
- "transferFlag": {
- "format": "int32",
- "type": "integer"
- },
- "wrapTime": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ActiveCallSessionPK": {
- "properties": {
- "sessionId": {
- "type": "string"
- },
- "uii": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ActiveCallUniqueId": {
- "properties": {
- "ani": {
- "type": "string"
- },
- "dnis": {
- "type": "string"
- },
- "dnisE164": {
- "type": "string"
- },
- "originatingDnis": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ActiveChat": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "activeChatSessions": {
- "items": {
- "$ref": "#/components/schemas/ActiveChatSession"
- },
- "type": "array"
- },
- "agentDisposition": {
- "type": "string"
- },
- "ani": {
- "type": "string"
- },
- "archive": {
- "format": "int32",
- "type": "integer"
- },
- "billingKey": {
- "type": "string"
- },
- "browserInfo": {
- "type": "string"
- },
- "channelType": {
- "type": "string"
- },
- "chatQueueId": {
- "format": "int32",
- "type": "integer"
- },
- "chatState": {
- "enum": [
- "CHAT_PREQUEUED",
- "CHAT_QUEUED",
- "CHAT_DEQUEUE_1",
- "CHAT_DEQUEUE_2",
- "CHAT_ACTIVE",
- "CHAT_COMPLETED",
- "CHAT_PQUEUED",
- "CHAT_END",
- "CHAT_IP_BLOCKED",
- "CHAT_QUEUE_CLOSED",
- "CHAT_NO_AGENTS",
- "CHAT_MAX_QUEUE",
- "CHAT_THROTTLE",
- "CHAT_DISCONNECT"
- ],
- "type": "string"
- },
- "currDequeueEventId": {
- "format": "int32",
- "type": "integer"
- },
- "dequeueAgentSession": {
- "$ref": "#/components/schemas/ActiveChatSession"
- },
- "dequeueAttempts": {
- "format": "int32",
- "type": "integer"
- },
- "dequeueTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "dnis": {
- "type": "string"
- },
- "dnisE164": {
- "type": "string"
- },
- "enqueueTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "jsonBaggage": {
- "type": "string"
- },
- "nextDequeueTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "safeArchiveDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "skillOverride": {
- "type": "string"
- },
- "sourceIp": {
- "type": "string"
- },
- "uii": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ActiveChatSession": {
- "properties": {
- "agentDisposition": {
- "type": "string"
- },
- "agentLogin": {
- "$ref": "#/components/schemas/AgentLogin"
- },
- "agentNotes": {
- "type": "string"
- },
- "archive": {
- "type": "boolean"
- },
- "dequeueAgent": {
- "type": "boolean"
- },
- "iqServerId": {
- "type": "string"
- },
- "isDequeueAgent": {
- "type": "boolean"
- },
- "safeArchiveDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "sessionEnd": {
- "$ref": "#/components/schemas/DateTime"
- },
- "sessionId": {
- "format": "int32",
- "type": "integer"
- },
- "sessionStart": {
- "$ref": "#/components/schemas/DateTime"
- },
- "sessionType": {
- "type": "string"
- },
- "skillProfileId": {
- "format": "int32",
- "type": "integer"
- },
- "termParty": {
- "type": "string"
- },
- "termReason": {
- "type": "string"
- },
- "uii": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ActiveState_boolean_": {
- "properties": {
- "isActive": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "ActiveStateboolean": {
- "properties": {
- "isActive": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "ActiveStateint": {
- "properties": {
- "isActive": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "AdminUserRequest": {
- "properties": {
- "children": {
- "items": {
- "$ref": "#/components/schemas/User"
- },
- "type": "array"
- },
- "creationDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "enabled": {
- "type": "boolean"
- },
- "firstName": {
- "type": "string"
- },
- "fullName": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "parentPath": {
- "type": "string"
- },
- "phoneNumber": {
- "type": "string"
- },
- "phoneNumberE164": {
- "type": "string"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- },
- "rcAccountId": {
- "type": "string"
- },
- "rcUserId": {
- "format": "int64",
- "type": "integer"
- },
- "regionalSettings": {
- "$ref": "#/components/schemas/RegionalSettingRequestResponse"
- },
- "roles": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Role"
- }
- },
- "rootUser": {
- "type": "boolean"
- },
- "userId": {
- "format": "int32",
- "type": "integer"
- },
- "userManagedByRC": {
- "type": "boolean"
- },
- "userName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "Agent": {
- "properties": {
- "accountAccess": {
- "$ref": "#/components/schemas/CollectionAgentAccountAccess"
- },
- "active": {
- "type": "boolean"
- },
- "agentAccountAccess": {
- "items": {
- "$ref": "#/components/schemas/AgentAccountAccess"
- },
- "type": "array"
- },
- "agentChatGroupAccess": {
- "items": {
- "$ref": "#/components/schemas/AgentChatGroupAccess"
- },
- "type": "array"
- },
- "agentChatQueueAccesses": {
- "$ref": "#/components/schemas/CollectionAgentChatQueueAccess"
- },
- "agentDialGroupMembers": {
- "$ref": "#/components/schemas/CollectionAgentDialGroupMember"
- },
- "agentGateAccess": {
- "$ref": "#/components/schemas/CollectionAgentGateAccess"
- },
- "agentGateGroupAccess": {
- "items": {
- "$ref": "#/components/schemas/AgentGateGroupAccess"
- },
- "type": "array"
- },
- "agentGroup": {
- "$ref": "#/components/schemas/AgentGroup"
- },
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "agentLoadBalance": {
- "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember"
- },
- "agentLoadBalanceMembers": {
- "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember"
- },
- "agentRank": {
- "format": "int32",
- "type": "integer"
- },
- "agentSkillProfiles": {
- "$ref": "#/components/schemas/CollectionAgentSkillProfile"
- },
- "agentType": {
- "enum": [
- "AGENT",
- "SUPERVISOR",
- "MULTI_USER",
- "MULTI_SUPERVISOR"
- ],
- "type": "string"
- },
- "allowAgentReports": {
- "type": "boolean"
- },
- "allowAgentStats": {
- "type": "boolean"
- },
- "allowAutoAnswer": {
- "type": "boolean"
- },
- "allowBlended": {
- "type": "boolean"
- },
- "allowCallControl": {
- "type": "boolean"
- },
- "allowCampStats": {
- "type": "boolean"
- },
- "allowChat": {
- "type": "boolean"
- },
- "allowChatStats": {
- "type": "boolean"
- },
- "allowChatVoiceConcurrent": {
- "type": "boolean"
- },
- "allowCrossGateRequeue": {
- "type": "boolean"
- },
- "allowDirectAgentTransfer": {
- "enum": [
- "DIRECT_TRANSFER_DISABLED",
- "ALLOW_DIRECT_TRANSFER_TO_SAME_GROUP",
- "ALLOW_DIRECT_TRANSFER_TO_ANY_GROUP"
- ],
- "type": "string"
- },
- "allowEndcallforeveryone": {
- "type": "boolean"
- },
- "allowExternalChat": {
- "type": "boolean"
- },
- "allowFromIpAddresses": {
- "type": "string"
- },
- "allowGateStats": {
- "type": "boolean"
- },
- "allowHangup": {
- "type": "boolean"
- },
- "allowHistoricalDialing": {
- "type": "boolean"
- },
- "allowHold": {
- "type": "boolean"
- },
- "allowInbound": {
- "type": "boolean"
- },
- "allowInboundIntlTransfer": {
- "type": "boolean"
- },
- "allowLeadInserts": {
- "type": "boolean"
- },
- "allowLoginControl": {
- "type": "boolean"
- },
- "allowLoginUpdates": {
- "type": "boolean"
- },
- "allowManualCalls": {
- "type": "boolean"
- },
- "allowManualIntlCalls": {
- "type": "boolean"
- },
- "allowManualIntlTransfer": {
- "type": "boolean"
- },
- "allowManualOutboundGates": {
- "type": "boolean"
- },
- "allowManualPass": {
- "type": "boolean"
- },
- "allowOffHook": {
- "type": "boolean"
- },
- "allowOutbound": {
- "type": "boolean"
- },
- "allowRequeue": {
- "type": "boolean"
- },
- "allowSelfAgentStats": {
- "type": "boolean"
- },
- "allowTransfer": {
- "type": "boolean"
- },
- "altDefaultLoginDest": {
- "type": "string"
- },
- "chatQueueAssignments": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "createdOn": {
- "$ref": "#/components/schemas/DateTime"
- },
- "defaultAutoAnswerOn": {
- "type": "boolean"
- },
- "defaultLoginDest": {
- "type": "string"
- },
- "dialGroupAssignments": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "directAgentExtension": {
- "type": "string"
- },
- "disableSupervisorMonitoring": {
- "type": "boolean"
- },
- "email": {
- "type": "string"
- },
- "enableSoftphone": {
- "type": "boolean"
- },
- "externalAgentId": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "gateAssignments": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "gatesControlAgentVisibility": {
- "type": "boolean"
- },
- "ghostRnaAction": {
- "type": "string"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "initLoginBaseState": {
- "type": "string"
- },
- "initLoginBaseStateId": {
- "format": "int32",
- "type": "integer"
- },
- "isActive": {
- "type": "boolean"
- },
- "lastLoginDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "lastName": {
- "type": "string"
- },
- "loadBalanceEnabled": {
- "type": "boolean"
- },
- "location": {
- "type": "string"
- },
- "manualOutboundDefaultCallerId": {
- "type": "string"
- },
- "manualOutboundDefaultCallerIdE164": {
- "type": "string"
- },
- "manualOutboundDefaultGate": {
- "$ref": "#/components/schemas/Gate"
- },
- "maxChats": {
- "format": "int32",
- "type": "integer"
- },
- "multiAccountAgent": {
- "type": "boolean"
- },
- "parentAgentId": {
- "format": "int32",
- "type": "integer"
- },
- "password": {
- "type": "string"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "phoneLoginDialGroup": {
- "$ref": "#/components/schemas/DialGroup"
- },
- "phoneLoginPin": {
- "type": "string"
- },
- "rcUserId": {
- "format": "int64",
- "type": "integer"
- },
- "regionalSettings": {
- "$ref": "#/components/schemas/RegionalSettingRequestResponse"
- },
- "showLeadHistory": {
- "type": "boolean"
- },
- "sipPassword": {
- "type": "string"
- },
- "sipSafeUsername": {
- "type": "string"
- },
- "softphoneId": {
- "format": "int32",
- "type": "integer"
- },
- "team": {
- "type": "string"
- },
- "transientAgent": {
- "type": "boolean"
- },
- "transientDelete": {
- "type": "boolean"
- },
- "transientDeleteDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "userManagedByRC": {
- "type": "boolean"
- },
- "username": {
- "type": "string"
- },
- "whereSupervisee": {
- "items": {
- "$ref": "#/components/schemas/AgentSupervisor"
- },
- "type": "array"
- },
- "whereSupervisor": {
- "$ref": "#/components/schemas/CollectionAgentSupervisor"
- }
- },
- "type": "object"
- },
- "ActiveStateBoolean": {
- "properties": {
- "isActive": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AgentAccountAccess": {
- "properties": {
- "account": {
- "$ref": "#/components/schemas/Account"
- },
- "accountId": {
- "type": "string"
- },
- "accountName": {
- "type": "string"
- },
- "agent": {
- "$ref": "#/components/schemas/Agent"
- },
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "AgentBlockMonitor": {
- "properties": {
- "blockMonitorId": {
- "type": "string"
- },
- "duration": {
- "format": "int32",
- "type": "integer"
- },
- "endTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "reason": {
- "type": "string"
- },
- "recordingUrl": {
- "type": "string"
- },
- "requestedBy": {
- "type": "string"
- },
- "result": {
- "type": "string"
- },
- "startTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "uii": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "AgentChatGroupAccess": {
- "properties": {
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "chatGroupId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "AgentChatQueueAccess": {
- "properties": {
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "chatQueue": {
- "$ref": "#/components/schemas/ChatQueue"
- },
- "chatQueueId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "AgentDetailsResult": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "accountName": {
- "type": "string"
- },
- "agentGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "agentType": {
- "enum": [
- "AGENT",
- "SUPERVISOR",
- "MULTI_USER",
- "MULTI_SUPERVISOR"
- ],
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "location": {
- "type": "string"
- },
- "rcUserId": {
- "format": "int64",
- "type": "integer"
- },
- "team": {
- "type": "string"
- },
- "username": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "AgentDialGroupMember": {
- "properties": {
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "dialGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "hciClicker": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AgentGateAccess": {
- "properties": {
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "agentRank": {
- "format": "int32",
- "type": "integer"
- },
- "defaultDestOverride": {
- "type": "string"
- },
- "gateId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "AgentGateGroupAccess": {
- "properties": {
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "gateGroupId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "AgentGateLoginRequest": {
- "properties": {
- "action": {
- "enum": [
- "ADD",
- "REMOVE"
- ],
- "type": "string"
- },
- "agentGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "gateIds": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AgentGroup": {
- "properties": {
- "account": {
- "$ref": "#/components/schemas/Account"
- },
- "agentGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "agents": {
- "$ref": "#/components/schemas/CollectionAgent"
- },
- "groupName": {
- "type": "string"
- },
- "isDefault": {
- "type": "boolean"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AgentImportRequest": {
- "properties": {
- "active": {
- "type": "boolean"
- },
- "agentType": {
- "type": "string"
- },
- "allowChat": {
- "type": "boolean"
- },
- "allowInbound": {
- "type": "boolean"
- },
- "allowOutbound": {
- "type": "boolean"
- },
- "chatQueueAssignmentIds": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "dialGroupAssignmentIds": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "isActive": {
- "type": "boolean"
- },
- "queueAssignmentIds": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "rcAccountId": {
- "type": "string"
- },
- "rcOfficeUsers": {
- "items": {
- "$ref": "#/components/schemas/RcOfficeUser"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AgentLoadBalanceMember": {
- "properties": {
- "masterAgentId": {
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "slaveAccountId": {
- "type": "string"
- },
- "slaveAgentId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "AgentLoadBalanceMemberPK": {
- "properties": {
- "masterAgentId": {
- "format": "int32",
- "type": "integer"
- },
- "slaveAgentId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "AgentLogin": {
- "properties": {
- "agent": {
- "$ref": "#/components/schemas/Agent"
- },
- "agentAuxState": {
- "type": "string"
- },
- "agentBlockMonitor": {
- "$ref": "#/components/schemas/CollectionAgentBlockMonitor"
- },
- "agentChatState": {
- "type": "string"
- },
- "agentLoginChatQueues": {
- "$ref": "#/components/schemas/CollectionAgentLoginChatQueues"
- },
- "agentLoginGates": {
- "$ref": "#/components/schemas/CollectionAgentLoginGate"
- },
- "agentLoginId": {
- "format": "int32",
- "type": "integer"
- },
- "agentLoginType": {
- "type": "string"
- },
- "agentOffhookSessions": {
- "items": {
- "$ref": "#/components/schemas/AgentOffhookSession"
- },
- "type": "array"
- },
- "agentPhone": {
- "type": "string"
- },
- "agentRank": {
- "format": "int32",
- "type": "integer"
- },
- "agentSkillProfile": {
- "$ref": "#/components/schemas/AgentSkillProfile"
- },
- "agentState": {
- "type": "string"
- },
- "availableTime": {
- "format": "int32",
- "type": "integer"
- },
- "awayTime": {
- "format": "int32",
- "type": "integer"
- },
- "breakTime": {
- "format": "int32",
- "type": "integer"
- },
- "callsHandled": {
- "format": "int32",
- "type": "integer"
- },
- "chatAvailableTime": {
- "format": "int32",
- "type": "integer"
- },
- "chatEngagedTime": {
- "format": "int32",
- "type": "integer"
- },
- "chatPresentedTime": {
- "format": "int32",
- "type": "integer"
- },
- "chatRnaTime": {
- "format": "int32",
- "type": "integer"
- },
- "chatsHandled": {
- "format": "int32",
- "type": "integer"
- },
- "currentChatCount": {
- "format": "int32",
- "type": "integer"
- },
- "dialGroup": {
- "$ref": "#/components/schemas/DialGroup"
- },
- "engagedTime": {
- "format": "int32",
- "type": "integer"
- },
- "exportFlag": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "holdTime": {
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "format": "int32",
- "type": "integer"
- },
- "ipMapKey": {
- "type": "string"
- },
- "iqServerId": {
- "type": "string"
- },
- "isGhostLogin": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "lastArchiveStateDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "lastCallDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "loginDialGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "loginDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "loginHashcode": {
- "type": "string"
- },
- "logoutDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "lunchTime": {
- "format": "int32",
- "type": "integer"
- },
- "manualDials": {
- "format": "int32",
- "type": "integer"
- },
- "monitorAgentId": {
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "nextCallTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "parentAgentId": {
- "format": "int32",
- "type": "integer"
- },
- "pendingDispTime": {
- "format": "int32",
- "type": "integer"
- },
- "pendingDisposition": {
- "type": "boolean"
- },
- "previewDials": {
- "format": "int32",
- "type": "integer"
- },
- "reservedDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "reservedUii": {
- "type": "string"
- },
- "ringTime": {
- "format": "int32",
- "type": "integer"
- },
- "rnaCount": {
- "format": "int32",
- "type": "integer"
- },
- "rnaTime": {
- "format": "int32",
- "type": "integer"
- },
- "stateDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "trainTime": {
- "format": "int32",
- "type": "integer"
- },
- "workTime": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "AgentLoginAuthVerifyResult": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "agentLoginId": {
- "format": "int32",
- "type": "integer"
- },
- "authTokens": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- "integrations": {
- "items": {
- "$ref": "#/components/schemas/AccountIntegrationBase"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AgentLoginChatQueues": {
- "properties": {
- "agentLoginChatQueueId": {
- "format": "int64",
- "type": "integer"
- },
- "chatQueue": {
- "$ref": "#/components/schemas/ChatQueue"
- }
- },
- "type": "object"
- },
- "AgentLoginGate": {
- "properties": {
- "agentLoginGateId": {
- "format": "int64",
- "type": "integer"
- },
- "agentRank": {
- "format": "int32",
- "type": "integer"
- },
- "destOverride": {
- "type": "string"
- },
- "gate": {
- "$ref": "#/components/schemas/Gate"
- }
- },
- "type": "object"
- },
- "AgentLoginProductView": {
- "properties": {
- "agentGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "agentLoginId": {
- "format": "int32",
- "type": "integer"
- },
- "agentLoginType": {
- "type": "string"
- },
- "agentPhone": {
- "type": "string"
- },
- "agentRank": {
- "format": "int32",
- "type": "integer"
- },
- "agentState": {
- "type": "string"
- },
- "agentType": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "isGhostLogin": {
- "type": "boolean"
- },
- "isOffhook": {
- "type": "boolean"
- },
- "lastName": {
- "type": "string"
- },
- "loginDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "pendingDisposition": {
- "type": "boolean"
- },
- "stateDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "username": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "AgentLoginRequest": {
- "properties": {
- "defaultDialDest": {
- "type": "string"
- },
- "gateIds": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AgentNameAndType": {
- "properties": {
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "agentName": {
- "type": "string"
- },
- "agentType": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "AgentOffhookSession": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "ani": {
- "type": "string"
- },
- "archive": {
- "format": "int32",
- "type": "integer"
- },
- "carrier": {
- "type": "string"
- },
- "dnis": {
- "type": "string"
- },
- "dnisE164": {
- "type": "string"
- },
- "endDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "iqServerId": {
- "format": "int32",
- "type": "integer"
- },
- "monitoring": {
- "format": "int32",
- "type": "integer"
- },
- "offhookUii": {
- "type": "string"
- },
- "safeArchiveDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "startDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "vruSourceKey": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "AgentRequest": {
- "properties": {
- "accountAccess": {
- "items": {
- "$ref": "#/components/schemas/AgentAccountAccess"
- },
- "type": "array"
- },
- "active": {
- "type": "boolean"
- },
- "agentAccountAccess": {
- "items": {
- "$ref": "#/components/schemas/AgentAccountAccess"
- },
- "type": "array"
- },
- "agentChatGroupAccess": {
- "items": {
- "$ref": "#/components/schemas/AgentChatGroupAccess"
- },
- "type": "array"
- },
- "agentChatQueueAccesses": {
- "$ref": "#/components/schemas/CollectionAgentChatQueueAccess"
- },
- "agentDialGroupMembers": {
- "$ref": "#/components/schemas/CollectionAgentDialGroupMember"
- },
- "agentGateAccess": {
- "items": {
- "$ref": "#/components/schemas/AgentGateAccess"
- },
- "type": "array"
- },
- "agentGateGroupAccess": {
- "items": {
- "$ref": "#/components/schemas/AgentGateGroupAccess"
- },
- "type": "array"
- },
- "agentGroup": {
- "$ref": "#/components/schemas/AgentGroup"
- },
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "agentLoadBalance": {
- "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember"
- },
- "agentLoadBalanceMembers": {
- "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember"
- },
- "agentRank": {
- "format": "int32",
- "type": "integer"
- },
- "agentSkillProfiles": {
- "items": {
- "$ref": "#/components/schemas/AgentSkillProfile"
- },
- "type": "array"
- },
- "agentType": {
- "enum": [
- "AGENT",
- "SUPERVISOR",
- "MULTI_USER",
- "MULTI_SUPERVISOR"
- ],
- "type": "string"
- },
- "allowAgentReports": {
- "type": "boolean"
- },
- "allowAgentStats": {
- "type": "boolean"
- },
- "allowAutoAnswer": {
- "type": "boolean"
- },
- "allowBlended": {
- "type": "boolean"
- },
- "allowCallControl": {
- "type": "boolean"
- },
- "allowCampStats": {
- "type": "boolean"
- },
- "allowChat": {
- "type": "boolean"
- },
- "allowChatStats": {
- "type": "boolean"
- },
- "allowChatVoiceConcurrent": {
- "type": "boolean"
- },
- "allowCrossGateRequeue": {
- "type": "boolean"
- },
- "allowDirectAgentTransfer": {
- "enum": [
- "DIRECT_TRANSFER_DISABLED",
- "ALLOW_DIRECT_TRANSFER_TO_SAME_GROUP",
- "ALLOW_DIRECT_TRANSFER_TO_ANY_GROUP"
- ],
- "type": "string"
- },
- "allowEndcallforeveryone": {
- "type": "boolean"
- },
- "allowExternalChat": {
- "type": "boolean"
- },
- "allowFromIpAddresses": {
- "type": "string"
- },
- "allowGateStats": {
- "type": "boolean"
- },
- "allowHangup": {
- "type": "boolean"
- },
- "allowHistoricalDialing": {
- "type": "boolean"
- },
- "allowHold": {
- "type": "boolean"
- },
- "allowInbound": {
- "type": "boolean"
- },
- "allowInboundIntlTransfer": {
- "type": "boolean"
- },
- "allowLeadInserts": {
- "type": "boolean"
- },
- "allowLoginControl": {
- "type": "boolean"
- },
- "allowLoginUpdates": {
- "type": "boolean"
- },
- "allowManualCalls": {
- "type": "boolean"
- },
- "allowManualIntlCalls": {
- "type": "boolean"
- },
- "allowManualIntlTransfer": {
- "type": "boolean"
- },
- "allowManualOutboundGates": {
- "type": "boolean"
- },
- "allowManualPass": {
- "type": "boolean"
- },
- "allowOffHook": {
- "type": "boolean"
- },
- "allowOutbound": {
- "type": "boolean"
- },
- "allowRequeue": {
- "type": "boolean"
- },
- "allowSelfAgentStats": {
- "type": "boolean"
- },
- "allowTransfer": {
- "type": "boolean"
- },
- "altDefaultLoginDest": {
- "type": "string"
- },
- "chatQueueAssignments": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "createdOn": {
- "$ref": "#/components/schemas/DateTime"
- },
- "defaultAutoAnswerOn": {
- "type": "boolean"
- },
- "defaultLoginDest": {
- "type": "string"
- },
- "dialGroupAssignments": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "directAgentExtension": {
- "type": "string"
- },
- "disableSupervisorMonitoring": {
- "type": "boolean"
- },
- "email": {
- "type": "string"
- },
- "enableSoftphone": {
- "type": "boolean"
- },
- "externalAgentId": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "gateAssignments": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "gatesControlAgentVisibility": {
- "type": "boolean"
- },
- "ghostRnaAction": {
- "type": "string"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "initLoginBaseState": {
- "type": "string"
- },
- "initLoginBaseStateId": {
- "format": "int32",
- "type": "integer"
- },
- "isActive": {
- "type": "boolean"
- },
- "lastLoginDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "lastName": {
- "type": "string"
- },
- "loadBalanceEnabled": {
- "type": "boolean"
- },
- "location": {
- "type": "string"
- },
- "manualOutboundDefaultCallerId": {
- "type": "string"
- },
- "manualOutboundDefaultCallerIdE164": {
- "type": "string"
- },
- "manualOutboundDefaultGate": {
- "$ref": "#/components/schemas/Gate"
- },
- "maxChats": {
- "format": "int32",
- "type": "integer"
- },
- "multiAccountAgent": {
- "type": "boolean"
- },
- "parentAgentId": {
- "format": "int32",
- "type": "integer"
- },
- "password": {
- "type": "string"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "phoneLoginDialGroup": {
- "$ref": "#/components/schemas/DialGroup"
- },
- "phoneLoginPin": {
- "type": "string"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- },
- "rcUserId": {
- "format": "int64",
- "type": "integer"
- },
- "regionalSettings": {
- "$ref": "#/components/schemas/RegionalSettingRequestResponse"
- },
- "showLeadHistory": {
- "type": "boolean"
- },
- "sipPassword": {
- "type": "string"
- },
- "sipSafeUsername": {
- "type": "string"
- },
- "softphoneId": {
- "format": "int32",
- "type": "integer"
- },
- "team": {
- "type": "string"
- },
- "transientAgent": {
- "type": "boolean"
- },
- "transientDelete": {
- "type": "boolean"
- },
- "transientDeleteDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "userManagedByRC": {
- "type": "boolean"
- },
- "username": {
- "type": "string"
- },
- "whereSupervisee": {
- "items": {
- "$ref": "#/components/schemas/AgentSupervisor"
- },
- "type": "array"
- },
- "whereSupervisor": {
- "$ref": "#/components/schemas/CollectionAgentSupervisor"
- }
- },
- "type": "object"
- },
- "AgentSkillProfile": {
- "properties": {
- "chatGroupSkills": {
- "items": {
- "$ref": "#/components/schemas/ChatGroupSkill"
- },
- "type": "array"
- },
- "createdOn": {
- "$ref": "#/components/schemas/DateTime"
- },
- "default": {
- "type": "boolean"
- },
- "gateGroupSkills": {
- "items": {
- "$ref": "#/components/schemas/GateGroupSkill"
- },
- "type": "array"
- },
- "groupSkills": {
- "items": {
- "$ref": "#/components/schemas/GateGroupSkill"
- },
- "type": "array"
- },
- "isDefault": {
- "type": "boolean"
- },
- "profileDesc": {
- "type": "string"
- },
- "profileId": {
- "format": "int32",
- "type": "integer"
- },
- "profileName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "AgentStats": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "accountName": {
- "type": "string"
- },
- "agentChatState": {
- "type": "string"
- },
- "agentGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "agentGroupName": {
- "type": "string"
- },
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "agentLoginId": {
- "format": "int32",
- "type": "integer"
- },
- "agentLoginType": {
- "type": "string"
- },
- "agentPhone": {
- "type": "string"
- },
- "agentState": {
- "type": "string"
- },
- "agentType": {
- "type": "string"
- },
- "callAni": {
- "type": "string"
- },
- "callDnis": {
- "type": "string"
- },
- "callSource": {
- "type": "string"
- },
- "callSourceDesc": {
- "type": "string"
- },
- "callUii": {
- "type": "string"
- },
- "callsHandled": {
- "format": "int32",
- "type": "integer"
- },
- "campaignId": {
- "format": "int32",
- "type": "integer"
- },
- "chatsHandled": {
- "format": "int32",
- "type": "integer"
- },
- "currentChatCount": {
- "format": "int32",
- "type": "integer"
- },
- "email": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "gateId": {
- "format": "int32",
- "type": "integer"
- },
- "isDequeueAgent": {
- "format": "int32",
- "type": "integer"
- },
- "isGhostLogin": {
- "format": "int32",
- "type": "integer"
- },
- "isOffhook": {
- "format": "int32",
- "type": "integer"
- },
- "lastName": {
- "type": "string"
- },
- "lastUpdate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "loginDialGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "loginTime": {
- "format": "int32",
- "type": "integer"
- },
- "onHoldDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "pendingDisposition": {
- "format": "int32",
- "type": "integer"
- },
- "pendingDispositionTime": {
- "format": "int32",
- "type": "integer"
- },
- "profileName": {
- "type": "string"
- },
- "rna": {
- "format": "int32",
- "type": "integer"
- },
- "selectable": {
- "type": "boolean"
- },
- "stateTime": {
- "format": "int32",
- "type": "integer"
- },
- "successDispositions": {
- "format": "int32",
- "type": "integer"
- },
- "totalChatTime": {
- "format": "int32",
- "type": "integer"
- },
- "totalTalkTime": {
- "format": "int32",
- "type": "integer"
- },
- "username": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "AgentSupervisor": {
- "properties": {
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "supervisorId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "AgentSupervisorPK": {
- "properties": {
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "supervisorId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "AgentV2": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "accountName": {
- "type": "string"
- },
- "agentGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "agentRank": {
- "format": "int32",
- "type": "integer"
- },
- "agentType": {
- "type": "string"
- },
- "allowLoginControl": {
- "type": "boolean"
- },
- "allowLoginUpdates": {
- "type": "boolean"
- },
- "altDefaultLoginDest": {
- "type": "string"
- },
- "directAgentExtension": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "enableSoftphone": {
- "type": "boolean"
- },
- "externalAgentId": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "ghostRnaAction": {
- "type": "string"
- },
- "initLoginBaseState": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "location": {
- "type": "string"
- },
- "manualOutboundDefaultCallerId": {
- "type": "string"
- },
- "maxChats": {
- "format": "int32",
- "type": "integer"
- },
- "password": {
- "type": "string"
- },
- "phoneLoginPin": {
- "type": "string"
- },
- "rcUserId": {
- "format": "int64",
- "type": "integer"
- },
- "team": {
- "type": "string"
- },
- "username": {
- "type": "string"
- }
- },
- "title": "AgentV2",
- "type": "object"
- },
- "AgentsLoggedInGatesView": {
- "properties": {
- "gateGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "gateId": {
- "format": "int32",
- "type": "integer"
- },
- "gateName": {
- "type": "string"
- },
- "groupName": {
- "type": "string"
- },
- "id": {
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "Alert": {
- "properties": {
- "alertId": {
- "format": "int32",
- "type": "integer"
- },
- "alertMessageBody": {
- "type": "string"
- },
- "alertMessageSubject": {
- "type": "string"
- },
- "alertName": {
- "type": "string"
- },
- "alertScript": {
- "type": "string"
- },
- "intervalMin": {
- "format": "int32",
- "type": "integer"
- },
- "itemIds": {
- "type": "string"
- },
- "jsonBlob": {
- "type": "string"
- },
- "nextRunTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "productType": {
- "enum": [
- "ACCOUNT",
- "ACD",
- "AGENT",
- "CHAT_QUEUE",
- "OUTBOUND",
- "VISUAL_IVR",
- "CLOUD_PROFILE",
- "CLOUD_DESTINATION",
- "TRAC_NUMBER",
- "HTTP_SERVICES",
- "SCRIPTING",
- "TN_MANAGER",
- "SURVEY",
- "DNIS",
- "TEAMS",
- "KNOWLEDGE_BASE",
- "UTILITIES"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "AmdProfile": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "amdAfterGreetingSilence": {
- "format": "int32",
- "type": "integer"
- },
- "amdBetweenWordSilence": {
- "format": "int32",
- "type": "integer"
- },
- "amdGreeting": {
- "format": "int32",
- "type": "integer"
- },
- "amdInitSilence": {
- "format": "int32",
- "type": "integer"
- },
- "amdMaxWords": {
- "format": "int32",
- "type": "integer"
- },
- "amdMinWordLength": {
- "format": "int32",
- "type": "integer"
- },
- "amdProfileId": {
- "format": "int32",
- "type": "integer"
- },
- "amdProfileName": {
- "type": "string"
- },
- "amdSilenceThreshold": {
- "format": "int32",
- "type": "integer"
- },
- "amdTotalTime": {
- "format": "int32",
- "type": "integer"
- },
- "countOfCampaigns": {
- "format": "int32",
- "type": "integer"
- },
- "systemDefault": {
- "type": "boolean"
- },
- "systemProfile": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "ApplicationContext": {
- "properties": {
- "applicationName": {
- "type": "string"
- },
- "autowireCapableBeanFactory": {
- "$ref": "#/components/schemas/AutowireCapableBeanFactory"
- },
- "beanDefinitionCount": {
- "format": "int32",
- "type": "integer"
- },
- "beanDefinitionNames": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "classLoader": {
- "$ref": "#/components/schemas/ClassLoader"
- },
- "displayName": {
- "type": "string"
- },
- "environment": {
- "$ref": "#/components/schemas/Environment"
- },
- "id": {
- "type": "string"
- },
- "parent": {
- "$ref": "#/components/schemas/ApplicationContext"
- },
- "parentBeanFactory": {
- "$ref": "#/components/schemas/BeanFactory"
- },
- "startupDate": {
- "format": "int64",
- "type": "integer"
- }
- },
- "title": "ApplicationContext",
- "type": "object"
- },
- "AssignedDnis": {
- "properties": {
- "cloudRouteProfile": {
- "$ref": "#/components/schemas/CloudRouteProfileSkinny"
- },
- "dnis": {
- "type": "string"
- },
- "dnisDescription": {
- "type": "string"
- },
- "dnisE164": {
- "type": "string"
- },
- "endDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "endPointId": {
- "type": "string"
- },
- "endPointType": {
- "type": "string"
- },
- "gate": {
- "$ref": "#/components/schemas/GateSkinnyAssignable"
- },
- "isActive": {
- "type": "boolean"
- },
- "originatingDnis": {
- "type": "string"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- },
- "startDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "tracNumber": {
- "$ref": "#/components/schemas/TracNumberSkinny"
- },
- "visualIvr": {
- "$ref": "#/components/schemas/VisualIvrSkinny"
- }
- },
- "type": "object"
- },
- "AssignedSmsDnis": {
- "properties": {
- "chatQueue": {
- "$ref": "#/components/schemas/ChatQueueSkinny"
- },
- "dnis": {
- "type": "string"
- },
- "dnisDescription": {
- "type": "string"
- },
- "dnisE164": {
- "type": "string"
- },
- "dnisPool": {
- "$ref": "#/components/schemas/DnisPoolV2"
- },
- "endDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "isActive": {
- "type": "boolean"
- },
- "originatingDnis": {
- "type": "string"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- },
- "startDate": {
- "$ref": "#/components/schemas/DateTime"
- }
- },
- "type": "object"
- },
- "AudioFileView": {
- "properties": {
- "fileName": {
- "type": "string"
- },
- "fileSize": {
- "format": "int64",
- "type": "integer"
- },
- "lastModified": {
- "format": "date-time",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AuditLog": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "actionType": {
- "enum": [
- "DELETE",
- "CREATE",
- "UPDATE"
- ],
- "type": "string"
- },
- "affectedEntityJson": {
- "type": "string"
- },
- "auditLogResultList": {
- "items": {
- "$ref": "#/components/schemas/AuditLogResult"
- },
- "type": "array"
- },
- "auditedEntityDescription": {
- "type": "object"
- },
- "auditedEntityId": {
- "type": "object"
- },
- "authUser": {
- "$ref": "#/components/schemas/AuditLogAuthenticatedUser"
- },
- "createTime": {
- "format": "int64",
- "type": "integer"
- },
- "createTimeAsDateTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "description": {
- "type": "string"
- },
- "id": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "AuditLogAuthenticatedUser": {
- "properties": {
- "firstName": {
- "type": "string"
- },
- "fullJson": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "sourceId": {
- "type": "string"
- },
- "userId": {
- "type": "string"
- },
- "userName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "AuditLogResult": {
- "properties": {
- "attributeName": {
- "type": "string"
- },
- "classType": {
- "type": "string"
- },
- "newValue": {
- "type": "object"
- },
- "originalValue": {
- "type": "object"
- }
- },
- "type": "object"
- },
- "AuditLogSearchCriteria": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "ascOrDesc": {
- "enum": [
- "ASCENDING",
- "DESCENDING"
- ],
- "type": "string"
- },
- "auditActions": {
- "items": {
- "enum": [
- "DELETE",
- "CREATE",
- "UPDATE"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "auditedEntityId": {
- "type": "string"
- },
- "createUserId": {
- "type": "string"
- },
- "endDateTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "endDateTimeAsUnix": {
- "format": "int64",
- "type": "integer"
- },
- "orderBy": {
- "type": "string"
- },
- "searchEntities": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "startDateTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "startDateTimeAsUnix": {
- "format": "int64",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "Auditable": {
- "properties": {
- "fullPath": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "AuthConfig": {
- "properties": {
- "authType": {
- "enum": [
- "APIKEY",
- "JWT",
- "BASIC",
- "OAUTH",
- "CUSTOM_AUTH"
- ],
- "type": "string"
- },
- "apiKey": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "AuthenticatedUser": {
- "properties": {
- "authToken": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "id": {
- "type": "string"
- },
- "isApiToken": {
- "type": "boolean"
- },
- "masterRightsDocs": {
- "additionalProperties": {
- "$ref": "#/components/schemas/RightsDocument"
- },
- "type": "object"
- },
- "masterRightsDocsValues": {
- "$ref": "#/components/schemas/CollectionRightsDocument"
- },
- "name": {
- "type": "string"
- },
- "rightsDocs": {
- "additionalProperties": {
- "$ref": "#/components/schemas/RightsDocument"
- },
- "type": "object"
- },
- "sourceIp": {
- "type": "string"
- },
- "stayLoggedIn": {
- "type": "boolean"
- },
- "superUser": {
- "type": "boolean"
- },
- "user": {
- "$ref": "#/components/schemas/User"
- }
- },
- "type": "object"
- },
- "AutowireCapableBeanFactory": {
- "title": "AutowireCapableBeanFactory",
- "type": "object"
- },
- "BaseAgentState": {
- "properties": {
- "colKey": {
- "type": "string"
- },
- "colLabel": {
- "type": "string"
- },
- "id": {
- "format": "int32",
- "type": "integer"
- },
- "isCore": {
- "type": "boolean"
- },
- "isRequired": {
- "type": "boolean"
- },
- "name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "BaseCsvDto": {
- "type": "object"
- },
- "BatchOperationResult": {
- "properties": {
- "result": {
- "items": {
- "$ref": "#/components/schemas/ProductOperationResult"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "BeanFactory": {
- "title": "BeanFactory",
- "type": "object"
- },
- "Blob": {
- "properties": {
- "binaryStream": {
- "$ref": "#/components/schemas/InputStream"
- }
- },
- "type": "object"
- },
- "BlockedANI": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "ani": {
- "type": "string"
- },
- "aniE164": {
- "type": "string"
- },
- "dateCreated": {
- "$ref": "#/components/schemas/DateTime"
- },
- "notes": {
- "type": "string"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "BlockedANIDeleteRequest": {
- "properties": {
- "ani": {
- "type": "string"
- },
- "aniE164": {
- "type": "string"
- },
- "effectiveAni": {
- "type": "string"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "BlockedIP": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "dateCreated": {
- "$ref": "#/components/schemas/DateTime"
- },
- "ipAddress": {
- "type": "string"
- },
- "mask": {
- "type": "string"
- },
- "notes": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CallerIdBucket": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "active": {
- "type": "boolean"
- },
- "bucketId": {
- "format": "int32",
- "type": "integer"
- },
- "bucketName": {
- "type": "string"
- },
- "bwOrderId": {
- "type": "string"
- },
- "callerIdBucketNumbers": {
- "items": {
- "$ref": "#/components/schemas/CallerIdBucketNumber"
- },
- "type": "array"
- },
- "callerIdName": {
- "type": "string"
- },
- "createDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "excludedStates": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "forwardingDid": {
- "type": "string"
- },
- "forwardingDidE164": {
- "type": "string"
- },
- "isActive": {
- "type": "boolean"
- },
- "orderStatus": {
- "enum": [
- "PENDING",
- "COMPLETE",
- "FAILED",
- "DISCONNECT"
- ],
- "type": "string"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "CallerIdBucketNumber": {
- "properties": {
- "city": {
- "type": "string"
- },
- "lat": {
- "format": "double",
- "type": "number"
- },
- "lon": {
- "format": "double",
- "type": "number"
- },
- "numberId": {
- "format": "int32",
- "type": "integer"
- },
- "state": {
- "type": "string"
- },
- "tnNumber": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "Campaign": {
- "properties": {
- "abandonMsg": {
- "type": "string"
- },
- "afterCallBaseState": {
- "type": "string"
- },
- "afterCallState": {
- "$ref": "#/components/schemas/AccountAuxState"
- },
- "agentConnectSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "agentPopMessage": {
- "type": "string"
- },
- "agentTermSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "allowLeadInserts": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "allowLeadUpdates": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "amdProfileId": {
- "$ref": "#/components/schemas/AmdProfile"
- },
- "appUrl": {
- "type": "string"
- },
- "aux1Label": {
- "type": "string"
- },
- "aux2Label": {
- "type": "string"
- },
- "aux3Label": {
- "type": "string"
- },
- "aux4Label": {
- "type": "string"
- },
- "aux5Label": {
- "type": "string"
- },
- "billingCode": {
- "type": "string"
- },
- "callerId": {
- "type": "string"
- },
- "callerIdBucket": {
- "$ref": "#/components/schemas/CallerIdBucket"
- },
- "campaignDesc": {
- "type": "string"
- },
- "campaignDispositions": {
- "$ref": "#/components/schemas/CollectionCampaignDisposition"
- },
- "campaignFilterStates": {
- "$ref": "#/components/schemas/CollectionCampaignFilterStates"
- },
- "campaignFilterTimezones": {
- "$ref": "#/components/schemas/CollectionCampaignFilterTimezones"
- },
- "campaignId": {
- "format": "int32",
- "type": "integer"
- },
- "campaignName": {
- "type": "string"
- },
- "campaignPriority": {
- "format": "int32",
- "type": "integer"
- },
- "campaignRequeueShortcuts": {
- "$ref": "#/components/schemas/CollectionRequeueShortcut"
- },
- "campaignResultDest": {
- "$ref": "#/components/schemas/ResultFileDestination"
- },
- "campaignUnlimitedFieldGroup": {
- "$ref": "#/components/schemas/CampaignUnlimitedFieldGroup"
- },
- "campaignWhitelistTagMembers": {
- "$ref": "#/components/schemas/CollectionWhitelistTagMembers"
- },
- "countryId": {
- "type": "string"
- },
- "customDialZoneGroup": {
- "$ref": "#/components/schemas/CustomDialZoneGroups"
- },
- "dialGroup": {
- "$ref": "#/components/schemas/DialGroup"
- },
- "dialLoadedOrder": {
- "format": "int32",
- "type": "integer"
- },
- "dispositionTimeout": {
- "format": "int32",
- "type": "integer"
- },
- "dncScrubOption": {
- "enum": [
- "DO_NOT_SCRUB",
- "INTERNAL_AND_NATIONAL",
- "INTERNAL_ONLY",
- "CELLULAR_AND_INTERNAL",
- "CELLULAR_ONLY"
- ],
- "type": "string"
- },
- "enableGlobalPhoneBook": {
- "type": "boolean"
- },
- "endCallMsg": {
- "type": "string"
- },
- "endDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "exportFlag": {
- "type": "boolean"
- },
- "filterEnabled": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "filterType": {
- "type": "string"
- },
- "friSched": {
- "type": "string"
- },
- "genericKeyValuePairs": {
- "type": "string"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "hangupOnDisposition": {
- "format": "int32",
- "type": "integer"
- },
- "isActive": {
- "format": "int32",
- "type": "integer"
- },
- "lastPassDts": {
- "$ref": "#/components/schemas/Timestamp"
- },
- "liveAnswerMsg": {
- "type": "string"
- },
- "machAnswerMsg": {
- "type": "string"
- },
- "machineDetect": {
- "type": "boolean"
- },
- "maxDailyPasses": {
- "format": "int32",
- "type": "integer"
- },
- "maxDailyPassesInclude": {
- "type": "string"
- },
- "maxDialLimit": {
- "format": "int32",
- "type": "integer"
- },
- "maxPasses": {
- "format": "int32",
- "type": "integer"
- },
- "maxPassesExclude": {
- "type": "string"
- },
- "maxRingTime": {
- "format": "int32",
- "type": "integer"
- },
- "maxRingTimeTransfer": {
- "format": "int32",
- "type": "integer"
- },
- "minPredictiveCallsHistory": {
- "format": "int32",
- "type": "integer"
- },
- "monSched": {
- "type": "string"
- },
- "onHoldMsg": {
- "type": "string"
- },
- "passDelayMin": {
- "format": "int32",
- "type": "integer"
- },
- "pauseRecordingSec": {
- "format": "int32",
- "type": "integer"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "perspectiveRecordingMode": {
- "enum": [
- "DISABLED",
- "ALL_AGENT_LEGS"
- ],
- "type": "string"
- },
- "postCallSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "postDispSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "quotaGroup": {
- "$ref": "#/components/schemas/QuotaGroup"
- },
- "realtimeDncUrl": {
- "type": "string"
- },
- "recordCall": {
- "format": "int32",
- "type": "integer"
- },
- "recordingInConference": {
- "type": "boolean"
- },
- "recordingSettings": {
- "enum": [
- "RECORD_FULL_CALL",
- "AGENT_FULL_CONTROL_DEFAULT_ON",
- "AGENT_FULL_CONTROL_DEFAULT_OFF",
- "AGENT_PAUSE"
- ],
- "type": "string"
- },
- "requeueType": {
- "enum": [
- "ADVANCED",
- "RESTRICTED"
- ],
- "type": "string"
- },
- "rescrubInterval": {
- "format": "int32",
- "type": "integer"
- },
- "satSched": {
- "type": "string"
- },
- "script": {
- "$ref": "#/components/schemas/Script"
- },
- "scrubDisconnectNoanswer": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "seedAbandonRate": {
- "format": "double",
- "type": "number"
- },
- "seedSuccessRate": {
- "format": "double",
- "type": "number"
- },
- "showLeadInfo": {
- "format": "int32",
- "type": "integer"
- },
- "showLeadPasses": {
- "type": "boolean"
- },
- "showListName": {
- "type": "boolean"
- },
- "singleChannelEnabled": {
- "type": "boolean"
- },
- "startDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "stopRecordingOnTransfer": {
- "type": "boolean"
- },
- "sunSched": {
- "type": "string"
- },
- "survey": {
- "$ref": "#/components/schemas/Survey"
- },
- "surveyPopType": {
- "type": "string"
- },
- "targetAbandonRate": {
- "format": "double",
- "type": "number"
- },
- "thuSched": {
- "type": "string"
- },
- "trackSpeedToLead": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "transferCallerId": {
- "type": "string"
- },
- "transferTermSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "tueSched": {
- "type": "string"
- },
- "useGlobalWhitelist": {
- "type": "boolean"
- },
- "wedSched": {
- "type": "string"
- },
- "whisperMsg": {
- "type": "string"
- },
- "callingConfiguration": {
- "description": "Calling preference mode for the campaign. Use SIMPLE for standard lead-phone dialing or STRATEGIC for persona-based phone selection. This setting is selected when the campaign is created and cannot be changed later.",
- "enum": [
- "SIMPLE",
- "STRATEGIC"
- ],
- "type": "string"
- },
- "personaCallSchedules": {
- "description": "Persona-based calling windows and phone-priority rules for STRATEGIC campaigns.",
- "items": {
- "$ref": "#/components/schemas/PersonaCallSchedule"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "CampaignCriteriaGroupAccess": {
- "properties": {
- "campaignId": {
- "format": "int32",
- "type": "integer"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "CampaignDisposition": {
- "properties": {
- "campaign": {
- "$ref": "#/components/schemas/Campaign"
- },
- "contactForwarding": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "createCopy": {
- "type": "boolean"
- },
- "destCampaign": {
- "$ref": "#/components/schemas/Campaign"
- },
- "dispSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "disposition": {
- "type": "string"
- },
- "dispositionId": {
- "format": "int32",
- "type": "integer"
- },
- "dncTagLabel": {
- "type": "string"
- },
- "doNotCall": {
- "type": "boolean"
- },
- "dtmfMapping": {
- "type": "string"
- },
- "emailDestinations": {
- "type": "string"
- },
- "emailTemplate": {
- "$ref": "#/components/schemas/EmailTemplate"
- },
- "excludeAbandon": {
- "type": "boolean"
- },
- "isComplete": {
- "type": "boolean"
- },
- "isContact": {
- "type": "boolean"
- },
- "isDefault": {
- "type": "boolean"
- },
- "isDisabled": {
- "type": "boolean"
- },
- "isRequeued": {
- "format": "int32",
- "type": "integer"
- },
- "isSuccess": {
- "type": "boolean"
- },
- "mergeOriginal": {
- "type": "boolean"
- },
- "rank": {
- "format": "int32",
- "type": "integer"
- },
- "requeueDelay": {
- "format": "int32",
- "type": "integer"
- },
- "requireNote": {
- "type": "boolean"
- },
- "saveSurvey": {
- "type": "boolean"
- },
- "setAgentFlag": {
- "type": "boolean"
- },
- "termMessage": {
- "type": "string"
- },
- "timeout": {
- "format": "int32",
- "type": "integer"
- },
- "xfer": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "xferDest": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CampaignFilterStates": {
- "properties": {
- "campaign": {
- "$ref": "#/components/schemas/Campaign"
- },
- "campaignId": {
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "state": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CampaignFilterTimezones": {
- "properties": {
- "campaign": {
- "$ref": "#/components/schemas/Campaign"
- },
- "campaignId": {
- "format": "int32",
- "type": "integer"
- },
- "timezone": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CampaignLead": {
- "properties": {
- "address1": {
- "type": "string"
- },
- "address2": {
- "type": "string"
- },
- "auxData1": {
- "type": "string"
- },
- "auxData2": {
- "type": "string"
- },
- "auxData3": {
- "type": "string"
- },
- "auxData4": {
- "type": "string"
- },
- "auxData5": {
- "type": "string"
- },
- "auxExternalUrl": {
- "type": "string"
- },
- "auxGreeting": {
- "type": "string"
- },
- "auxPhone": {
- "type": "string"
- },
- "callerId": {
- "type": "string"
- },
- "campaign": {
- "$ref": "#/components/schemas/Campaign"
- },
- "campaignRedials": {
- "items": {
- "$ref": "#/components/schemas/CampaignRedial"
- },
- "type": "array"
- },
- "city": {
- "type": "string"
- },
- "dupeKeyOverride": {
- "format": "int64",
- "type": "integer"
- },
- "email": {
- "type": "string"
- },
- "extendedLeadData": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- "externId": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "gateKeeper": {
- "type": "string"
- },
- "id": {
- "format": "int32",
- "type": "integer"
- },
- "lastName": {
- "type": "string"
- },
- "lastPassDisposition": {
- "enum": [
- "ANSWER",
- "NOANSWER",
- "BUSY",
- "MACHINE",
- "INTERCEPT",
- "DISCONNECT",
- "ABANDON",
- "CONGESTION",
- "MANUAL_PASS",
- "INBOUND_CALLBACK",
- "APP_DNC",
- "APP_REQUEUE",
- "APP_REQUEUE_COMPLETE",
- "APP_REQUEUE_ABANDON",
- "INBOUND_ABANDON",
- "API_BLOCKED",
- "API_ERROR"
- ],
- "type": "string"
- },
- "lastPassDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "leadId": {
- "format": "int32",
- "type": "integer"
- },
- "leadPasses": {
- "format": "int32",
- "type": "integer"
- },
- "leadPhone": {
- "description": "Primary lead phone number. For accounts enabled for E.164 or international phone-number handling, provide the primary phone in leadPhoneE164.",
- "type": "string"
- },
- "leadPhoneE164": {
- "description": "Primary lead phone number in E.164 format. Required for direct lead loading when the account uses E.164 or international phone-number handling.",
- "type": "string"
- },
- "leadPriority": {
- "format": "int32",
- "type": "integer"
- },
- "leadState": {
- "enum": [
- "ACTIVE",
- "AGENT-CALLBACK",
- "CALLBACK-CANCELLED",
- "CALLBACK",
- "CANCELLED",
- "COMPLETE",
- "DISCONNECTED",
- "DO-NOT-CALL",
- "INTERCEPT",
- "MAX-DIAL-LIMIT",
- "PAUSED",
- "PENDING-CALLBACK",
- "PENDING-ERR",
- "PENDING-HCI",
- "PENDING",
- "READY",
- "TRANSITIONED",
- "WHITELIST"
- ],
- "type": "string"
- },
- "leadTimezone": {
- "type": "string"
- },
- "liveAnswerMessage": {
- "type": "string"
- },
- "loadedDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "machAnswerMessage": {
- "type": "string"
- },
- "maxPasses": {
- "format": "int32",
- "type": "integer"
- },
- "midName": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "nextDialTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "quotaTargetIds": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "quotaTargets": {
- "$ref": "#/components/schemas/CollectionQuotaTarget"
- },
- "reserveAgent": {
- "description": "Agent ID to reserve this lead for during direct lead loading. If the value is blank, null, omitted, invalid, or refers to an agent without access to the account, the lead is still accepted. Invalid or inaccessible assignments are counted in failedAgentAssignment.",
- "example": "980",
- "nullable": true,
- "type": "string",
- "writeOnly": true
- },
- "sortCol": {
- "type": "string"
- },
- "state": {
- "type": "string"
- },
- "stateDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "suffix": {
- "type": "string"
- },
- "suppressed": {
- "type": "boolean"
- },
- "title": {
- "type": "string"
- },
- "zip": {
- "type": "string"
- },
- "personaMapping": {
- "description": "Stored mapping of lead phone values to persona phone IDs.",
- "readOnly": true,
- "type": "string"
- },
- "personaPhoneConfig": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Additional phone numbers for direct lead loading. Keys must exactly match configured persona phone labels, and values are phone numbers for that lead.",
- "type": "object"
- }
- },
- "type": "object"
- },
- "CampaignLeadList": {
- "properties": {
- "deleteLeads": {
- "type": "boolean"
- },
- "deletedDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "dncTagList": {
- "type": "string"
- },
- "exportFlag": {
- "type": "boolean"
- },
- "lastDncScrubDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "leadsAccepted": {
- "format": "int32",
- "type": "integer"
- },
- "leadsConverted": {
- "format": "int32",
- "type": "integer"
- },
- "leadsDoNotCall": {
- "format": "int32",
- "type": "integer"
- },
- "leadsSupplied": {
- "format": "int32",
- "type": "integer"
- },
- "leadsWhitelist": {
- "format": "int32",
- "type": "integer"
- },
- "listDesc": {
- "type": "string"
- },
- "listId": {
- "format": "int32",
- "type": "integer"
- },
- "listPriority": {
- "format": "int32",
- "type": "integer"
- },
- "listState": {
- "enum": [
- "ACTIVE",
- "PAUSED",
- "PENDING_DNC",
- "LOADING",
- "DELETED",
- "READY",
- "CALLBACKS",
- "CALLBACKS_AGENT",
- "DUPLICATES_NOT_MERGED",
- "DUPLICATES_NOT_MOVED"
- ],
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "originalFormat": {
- "type": "string"
- },
- "result": {
- "type": "string"
- },
- "unloadFilename": {
- "type": "string"
- },
- "uploadDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "uploadedBy": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CampaignLeadSearchCriteria": {
- "properties": {
- "address1": {
- "type": "string"
- },
- "address2": {
- "type": "string"
- },
- "agentDispositions": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "auxData1": {
- "type": "string"
- },
- "auxData2": {
- "type": "string"
- },
- "auxData3": {
- "type": "string"
- },
- "auxData4": {
- "type": "string"
- },
- "auxData5": {
- "type": "string"
- },
- "callerId": {
- "type": "string"
- },
- "campaignIds": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "city": {
- "type": "string"
- },
- "emailAddress": {
- "type": "string"
- },
- "externIds": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "firstName": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "lastPassTimeCriteria": {
- "$ref": "#/components/schemas/DateTimeComparableSearchField"
- },
- "leadIds": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "leadPassesCriteria": {
- "$ref": "#/components/schemas/ComparableSearchField"
- },
- "leadPhoneNum": {
- "type": "string"
- },
- "leadPhoneNumbers": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "leadStates": {
- "items": {
- "enum": [
- "ACTIVE",
- "AGENT-CALLBACK",
- "CALLBACK-CANCELLED",
- "CALLBACK",
- "CANCELLED",
- "COMPLETE",
- "DISCONNECTED",
- "DO-NOT-CALL",
- "INTERCEPT",
- "MAX-DIAL-LIMIT",
- "PAUSED",
- "PENDING-CALLBACK",
- "PENDING-ERR",
- "PENDING-HCI",
- "PENDING",
- "READY",
- "TRANSITIONED",
- "WHITELIST"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "leadTimezones": {
- "items": {
- "$ref": "#/components/schemas/Timezone"
- },
- "type": "array"
- },
- "listIds": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "loadedDtsEnd": {
- "$ref": "#/components/schemas/DateTime"
- },
- "loadedDtsStart": {
- "$ref": "#/components/schemas/DateTime"
- },
- "nextDialTimeCriteria": {
- "$ref": "#/components/schemas/DateTimeComparableSearchField"
- },
- "orphanedLeadsOnly": {
- "type": "boolean"
- },
- "pendingAgentId": {
- "format": "int32",
- "type": "integer"
- },
- "physicalStates": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "suppressed": {
- "enum": [
- "ONLY_SUPPRESSED",
- "ONLY_UNSUPPRESSED",
- "ALL"
- ],
- "type": "string"
- },
- "systemDispositions": {
- "items": {
- "enum": [
- "ANSWER",
- "NOANSWER",
- "BUSY",
- "MACHINE",
- "INTERCEPT",
- "DISCONNECT",
- "ABANDON",
- "CONGESTION",
- "MANUAL_PASS",
- "INBOUND_CALLBACK",
- "APP_DNC",
- "APP_REQUEUE",
- "APP_REQUEUE_COMPLETE",
- "APP_REQUEUE_ABANDON",
- "INBOUND_ABANDON",
- "API_BLOCKED",
- "API_ERROR"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "zip": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CampaignLeadSearchResultsView": {
- "properties": {
- "address1": {
- "type": "string"
- },
- "address2": {
- "type": "string"
- },
- "agentDispostion": {
- "type": "string"
- },
- "auxData1": {
- "type": "string"
- },
- "auxData2": {
- "type": "string"
- },
- "auxData3": {
- "type": "string"
- },
- "auxData4": {
- "type": "string"
- },
- "auxData5": {
- "type": "string"
- },
- "auxExternalUrl": {
- "type": "string"
- },
- "auxGreeting": {
- "type": "string"
- },
- "auxPhone": {
- "type": "string"
- },
- "callerId": {
- "type": "string"
- },
- "campaignId": {
- "format": "int32",
- "type": "integer"
- },
- "campaignLead": {
- "$ref": "#/components/schemas/CampaignLead"
- },
- "campaignName": {
- "type": "string"
- },
- "city": {
- "type": "string"
- },
- "dialGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "dupeKeyOverride": {
- "format": "int64",
- "type": "integer"
- },
- "email": {
- "type": "string"
- },
- "externId": {
- "type": "string"
- },
- "extraData": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "gateKeeper": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "lastPassAgentName": {
- "type": "string"
- },
- "lastPassDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "lastPassDispo": {
- "type": "string"
- },
- "lastPassDisposition": {
- "type": "string"
- },
- "lastPassDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "leadId": {
- "format": "int32",
- "type": "integer"
- },
- "leadPasses": {
- "format": "int32",
- "type": "integer"
- },
- "leadPhone": {
- "type": "string"
- },
- "leadState": {
- "type": "string"
- },
- "leadTimezone": {
- "type": "string"
- },
- "listDesc": {
- "type": "string"
- },
- "listId": {
- "format": "int32",
- "type": "integer"
- },
- "liveAnswerMessage": {
- "type": "string"
- },
- "loadedDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "machAnswerMessage": {
- "type": "string"
- },
- "maxPasses": {
- "format": "int32",
- "type": "integer"
- },
- "midName": {
- "type": "string"
- },
- "nextDialTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "pendingAgentName": {
- "type": "string"
- },
- "sortCol": {
- "type": "string"
- },
- "speedToLeadAgentConn": {
- "format": "int32",
- "type": "integer"
- },
- "speedToLeadFirstPass": {
- "format": "int32",
- "type": "integer"
- },
- "state": {
- "type": "string"
- },
- "stateDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "suffix": {
- "type": "string"
- },
- "suppressed": {
- "type": "boolean"
- },
- "title": {
- "type": "string"
- },
- "uploadDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "uploadedBy": {
- "type": "string"
- },
- "zip": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CampaignPass": {
- "properties": {
- "agent": {
- "$ref": "#/components/schemas/Agent"
- },
- "agentDisposition": {
- "type": "string"
- },
- "agentNotes": {
- "type": "string"
- },
- "callStart": {
- "$ref": "#/components/schemas/DateTime"
- },
- "campaignRedials": {
- "items": {
- "$ref": "#/components/schemas/CampaignRedial"
- },
- "type": "array"
- },
- "dialDuration": {
- "format": "int32",
- "type": "integer"
- },
- "dialType": {
- "type": "boolean"
- },
- "duration": {
- "format": "int32",
- "type": "integer"
- },
- "export": {
- "type": "boolean"
- },
- "exportFlag": {
- "type": "boolean"
- },
- "leadPhone": {
- "type": "string"
- },
- "passDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "passDisposition": {
- "enum": [
- "ANSWER",
- "NOANSWER",
- "BUSY",
- "MACHINE",
- "INTERCEPT",
- "DISCONNECT",
- "ABANDON",
- "CONGESTION",
- "MANUAL_PASS",
- "INBOUND_CALLBACK",
- "APP_DNC",
- "APP_REQUEUE",
- "APP_REQUEUE_COMPLETE",
- "APP_REQUEUE_ABANDON",
- "INBOUND_ABANDON",
- "API_BLOCKED",
- "API_ERROR"
- ],
- "type": "string"
- },
- "passNumber": {
- "format": "int32",
- "type": "integer"
- },
- "passUii": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CampaignPassDisposition": {
- "properties": {
- "createCopy": {
- "type": "boolean"
- },
- "destCampaign": {
- "$ref": "#/components/schemas/Campaign"
- },
- "isComplete": {
- "type": "boolean"
- },
- "machineDetect": {
- "format": "int32",
- "type": "integer"
- },
- "mergeOriginal": {
- "type": "boolean"
- },
- "pass": {
- "format": "int32",
- "type": "integer"
- },
- "passDispositionId": {
- "format": "int32",
- "type": "integer"
- },
- "passEnd": {
- "format": "int32",
- "type": "integer"
- },
- "requeueDelay": {
- "format": "int32",
- "type": "integer"
- },
- "requeueType": {
- "enum": [
- "DEFAULT",
- "NONE",
- "STANDARD",
- "PRIORITY"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "CampaignRedial": {
- "properties": {
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "callBackDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "callBackPhone": {
- "type": "string"
- },
- "campaignLead": {
- "$ref": "#/components/schemas/CampaignLead"
- },
- "campaignPass": {
- "$ref": "#/components/schemas/CampaignPass"
- },
- "id": {
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "redialId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "CampaignStats": {
- "properties": {
- "campaignId": {
- "format": "int32",
- "type": "integer"
- },
- "campaignName": {
- "type": "string"
- },
- "complete": {
- "format": "int32",
- "type": "integer"
- },
- "doNotCall": {
- "format": "int32",
- "type": "integer"
- },
- "endDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "maxPasses": {
- "format": "int32",
- "type": "integer"
- },
- "other": {
- "format": "int32",
- "type": "integer"
- },
- "paused": {
- "format": "int32",
- "type": "integer"
- },
- "readyFuture": {
- "format": "int32",
- "type": "integer"
- },
- "readyNow": {
- "format": "int32",
- "type": "integer"
- },
- "startDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "suppressed": {
- "format": "int32",
- "type": "integer"
- },
- "targetId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "CampaignTimeZoneDialCount": {
- "properties": {
- "dialFuture": {
- "format": "int32",
- "type": "integer"
- },
- "dialNow": {
- "format": "int32",
- "type": "integer"
- },
- "suppressed": {
- "format": "int32",
- "type": "integer"
- },
- "timezone": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CampaignTimeZoneDialCountWrapper": {
- "properties": {
- "campaignId": {
- "format": "int32",
- "type": "integer"
- },
- "campaignName": {
- "type": "string"
- },
- "dialGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "dialGroupName": {
- "type": "string"
- },
- "dialMode": {
- "enum": [
- "PREVIEW",
- "CLICK_TO_TALK",
- "PREDICTIVE",
- "POWER",
- "TCPA_SAFE_MODE"
- ],
- "type": "string"
- },
- "endDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "leadData": {
- "items": {
- "$ref": "#/components/schemas/CampaignTimeZoneDialCount"
- },
- "type": "array"
- },
- "maxPasses": {
- "format": "int32",
- "type": "integer"
- },
- "passDelayMin": {
- "format": "int32",
- "type": "integer"
- },
- "startDate": {
- "$ref": "#/components/schemas/DateTime"
- }
- },
- "type": "object"
- },
- "CampaignUnlimitedFieldGroup": {
- "properties": {
- "campaigns": {
- "items": {
- "$ref": "#/components/schemas/Campaign"
- },
- "type": "array"
- },
- "extraDataMappings": {
- "type": "string"
- },
- "groupName": {
- "type": "string"
- },
- "unlimitedFieldGroupId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ChatGroup": {
- "properties": {
- "billingKey": {
- "type": "string"
- },
- "chatGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "chatGroupSkills": {
- "items": {
- "$ref": "#/components/schemas/ChatGroupSkill"
- },
- "type": "array"
- },
- "chatGroups": {
- "items": {
- "$ref": "#/components/schemas/ChatQueue"
- },
- "type": "array"
- },
- "chatQueues": {
- "items": {
- "$ref": "#/components/schemas/ChatQueue"
- },
- "type": "array"
- },
- "createdOn": {
- "$ref": "#/components/schemas/DateTime"
- },
- "groupName": {
- "type": "string"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ChatGroupSkill": {
- "properties": {
- "active": {
- "type": "boolean"
- },
- "agentSkillProfiles": {
- "$ref": "#/components/schemas/CollectionAgentSkillProfile"
- },
- "chatRequeueShortcuts": {
- "items": {
- "$ref": "#/components/schemas/ChatRequeueShortcut"
- },
- "type": "array"
- },
- "createdOn": {
- "$ref": "#/components/schemas/DateTime"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "skillDesc": {
- "type": "string"
- },
- "skillId": {
- "format": "int32",
- "type": "integer"
- },
- "skillName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ChatPriorityGroup": {
- "properties": {
- "chatPriorityGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "chatQueues": {
- "items": {
- "$ref": "#/components/schemas/ChatQueue"
- },
- "type": "array"
- },
- "priorityGroupName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ChatQueue": {
- "properties": {
- "account": {
- "$ref": "#/components/schemas/Account"
- },
- "accountId": {
- "type": "string"
- },
- "active": {
- "type": "boolean"
- },
- "agentConnectHttpService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "agentConnectMsg": {
- "type": "string"
- },
- "agentFrom": {
- "type": "string"
- },
- "agentMaxAcceptTime": {
- "format": "int32",
- "type": "integer"
- },
- "agentTermHttpService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "agentWrapTime": {
- "format": "int32",
- "type": "integer"
- },
- "appUrl": {
- "type": "string"
- },
- "callbackCampaign": {
- "$ref": "#/components/schemas/Campaign"
- },
- "chatGroup": {
- "$ref": "#/components/schemas/ChatGroup"
- },
- "chatPriorityGroup": {
- "$ref": "#/components/schemas/ChatPriorityGroup"
- },
- "chatQueueDescription": {
- "type": "string"
- },
- "chatQueueId": {
- "format": "int32",
- "type": "integer"
- },
- "chatQueueName": {
- "type": "string"
- },
- "chatQueueOpen": {
- "type": "boolean"
- },
- "clientFrom": {
- "type": "string"
- },
- "companyLogo": {
- "$ref": "#/components/schemas/Blob"
- },
- "createdOn": {
- "$ref": "#/components/schemas/DateTime"
- },
- "dequeueHttpService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "dispTimeout": {
- "format": "int32",
- "type": "integer"
- },
- "friSched": {
- "type": "string"
- },
- "gateQueueAnips": {
- "items": {
- "$ref": "#/components/schemas/ChatQueueAnip"
- },
- "type": "array"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "idleTimeout": {
- "format": "int32",
- "type": "integer"
- },
- "isActive": {
- "type": "boolean"
- },
- "longChatTime": {
- "format": "int32",
- "type": "integer"
- },
- "maxQueueEvent": {
- "type": "string"
- },
- "maxQueueLimit": {
- "format": "int32",
- "type": "integer"
- },
- "monSched": {
- "type": "string"
- },
- "newChatHttpService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "noAgentEvent": {
- "type": "string"
- },
- "observeDst": {
- "type": "boolean"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "postChatHttpService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "postDispHttpService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "queueClosedEvent": {
- "type": "string"
- },
- "queuePriority": {
- "format": "int32",
- "type": "integer"
- },
- "requeueShortcutAccess": {
- "items": {
- "$ref": "#/components/schemas/ChatRequeueShortcutGroupChatQueueAccess"
- },
- "type": "array"
- },
- "requeueType": {
- "type": "string"
- },
- "requireCaptcha": {
- "type": "boolean"
- },
- "satSched": {
- "type": "string"
- },
- "script": {
- "$ref": "#/components/schemas/Script"
- },
- "shortChatTime": {
- "format": "int32",
- "type": "integer"
- },
- "slaTime": {
- "format": "int32",
- "type": "integer"
- },
- "specialIpEvent": {
- "type": "string"
- },
- "sunSched": {
- "type": "string"
- },
- "surveyId": {
- "format": "int32",
- "type": "integer"
- },
- "surveyPopType": {
- "type": "string"
- },
- "throttleCalls": {
- "format": "int32",
- "type": "integer"
- },
- "throttleDays": {
- "format": "int32",
- "type": "integer"
- },
- "throttleIpEvent": {
- "type": "string"
- },
- "thuSched": {
- "type": "string"
- },
- "tueSched": {
- "type": "string"
- },
- "wedSched": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ChatQueueAnip": {
- "properties": {
- "anip": {
- "type": "string"
- },
- "chatQueueId": {
- "format": "int32",
- "type": "integer"
- },
- "dateAdded": {
- "$ref": "#/components/schemas/DateTime"
- },
- "recordType": {
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ChatQueueChatWidgetAccess": {
- "properties": {
- "chatQueue": {
- "$ref": "#/components/schemas/ChatQueue"
- },
- "chatQueueId": {
- "format": "int32",
- "type": "integer"
- },
- "chatWidget": {
- "$ref": "#/components/schemas/ChatWidget"
- },
- "guid": {
- "type": "string"
- },
- "jsonMetadata": {
- "type": "string"
- },
- "widgetId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ChatQueueClosedMessage": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "chatQueueClosedMessageId": {
- "format": "int32",
- "type": "integer"
- },
- "chatQueueId": {
- "format": "int32",
- "type": "integer"
- },
- "jsonBaggage": {
- "type": "string"
- },
- "sourceIp": {
- "type": "string"
- },
- "timeStamp": {
- "$ref": "#/components/schemas/DateTime"
- }
- },
- "type": "object"
- },
- "ChatQueueDisposition": {
- "properties": {
- "chatGroupSkill": {
- "$ref": "#/components/schemas/ChatGroupSkill"
- },
- "chatQueue": {
- "$ref": "#/components/schemas/ChatQueue"
- },
- "destChatQueue": {
- "$ref": "#/components/schemas/ChatQueue"
- },
- "dispServiceId": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "disposition": {
- "type": "string"
- },
- "dispositionId": {
- "format": "int32",
- "type": "integer"
- },
- "emailDestinations": {
- "type": "string"
- },
- "emailTemplate": {
- "$ref": "#/components/schemas/EmailTemplate"
- },
- "isComplete": {
- "type": "boolean"
- },
- "isDefault": {
- "type": "boolean"
- },
- "isDisabled": {
- "type": "boolean"
- },
- "isSuccess": {
- "type": "boolean"
- },
- "rank": {
- "format": "int32",
- "type": "integer"
- },
- "timeout": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ChatQueueEvent": {
- "properties": {
- "chatQueue": {
- "$ref": "#/components/schemas/ChatQueue"
- },
- "eventDuration": {
- "format": "int32",
- "type": "integer"
- },
- "eventId": {
- "format": "int32",
- "type": "integer"
- },
- "eventRank": {
- "format": "int32",
- "type": "integer"
- },
- "queueEvent": {
- "type": "string"
- },
- "sendMessage": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ChatQueueScheduleOverride": {
- "properties": {
- "chatQueue": {
- "$ref": "#/components/schemas/ChatQueue"
- },
- "overrideClosedEvent": {
- "type": "string"
- },
- "overrideDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "overrideLabel": {
- "type": "string"
- },
- "overrideSched": {
- "type": "string"
- },
- "scheduleOverrideId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ChatQueueSkinny": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "chatGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "chatQueueId": {
- "format": "int32",
- "type": "integer"
- },
- "chatQueueName": {
- "type": "string"
- },
- "isActive": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "ChatQueueSpecialAnip": {
- "properties": {
- "anip": {
- "type": "string"
- },
- "dateAdded": {
- "$ref": "#/components/schemas/DateTime"
- },
- "id": {
- "type": "object"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ChatRequeueShortcut": {
- "properties": {
- "chatGroupSkill": {
- "$ref": "#/components/schemas/ChatGroupSkill"
- },
- "chatRequeueShortcutId": {
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "rank": {
- "format": "int32",
- "type": "integer"
- },
- "requeueGroup": {
- "$ref": "#/components/schemas/ChatGroup"
- },
- "requeueQueue": {
- "$ref": "#/components/schemas/ChatQueue"
- }
- },
- "type": "object"
- },
- "ChatRequeueShortcutGroup": {
- "properties": {
- "chatRequeueShortcutGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ChatRequeueShortcutGroupChatQueueAccess": {
- "properties": {
- "chatQueue": {
- "$ref": "#/components/schemas/ChatQueue"
- },
- "chatQueueId": {
- "format": "int32",
- "type": "integer"
- },
- "chatRequeueShortcutGroup": {
- "$ref": "#/components/schemas/ChatRequeueShortcutGroup"
- },
- "chatRequeueShortcutGroupId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ChatRoom": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "permissionType": {
- "enum": [
- "ALL",
- "EXPLICIT"
- ],
- "type": "string"
- },
- "roomDesc": {
- "type": "string"
- },
- "roomId": {
- "format": "int32",
- "type": "integer"
- },
- "roomName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ChatStats": {
- "properties": {
- "abandoned": {
- "format": "int32",
- "type": "integer"
- },
- "accepted": {
- "format": "int32",
- "type": "integer"
- },
- "accountId": {
- "type": "string"
- },
- "active": {
- "format": "int32",
- "type": "integer"
- },
- "available": {
- "format": "int32",
- "type": "integer"
- },
- "chatQueueGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "chatQueueGroupName": {
- "type": "string"
- },
- "chatQueueId": {
- "format": "int32",
- "type": "integer"
- },
- "chatQueueName": {
- "type": "string"
- },
- "deflected": {
- "format": "int32",
- "type": "integer"
- },
- "inQueue": {
- "format": "int32",
- "type": "integer"
- },
- "lastUpdate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "longestInQueue": {
- "format": "int32",
- "type": "integer"
- },
- "presented": {
- "format": "int32",
- "type": "integer"
- },
- "routing": {
- "format": "int32",
- "type": "integer"
- },
- "schedule": {
- "type": "string"
- },
- "scheduleOverride": {
- "type": "string"
- },
- "selectable": {
- "type": "boolean"
- },
- "staffed": {
- "format": "int32",
- "type": "integer"
- },
- "totalAbandonTime": {
- "format": "int64",
- "type": "integer"
- },
- "totalAnswerTime": {
- "format": "int64",
- "type": "integer"
- },
- "totalChatTime": {
- "format": "int64",
- "type": "integer"
- },
- "totalQueueTime": {
- "format": "int64",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ChatWidget": {
- "properties": {
- "chatWidgetId": {
- "format": "int32",
- "type": "integer"
- },
- "createdDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "json": {
- "type": "string"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "updatedDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "widgetDesc": {
- "type": "string"
- },
- "widgetId": {
- "format": "int32",
- "type": "integer"
- },
- "widgetName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "Chronology": {
- "properties": {
- "zone": {
- "$ref": "#/components/schemas/DateTimeZone"
- }
- },
- "type": "object"
- },
- "ClassLoader": {
- "properties": {
- "parent": {
- "$ref": "#/components/schemas/ClassLoader"
- }
- },
- "title": "ClassLoader",
- "type": "object"
- },
- "CloudRouteAssignedDestination": {
- "properties": {
- "allocationPercent": {
- "format": "int32",
- "type": "integer"
- },
- "allocationPercentHours": {
- "type": "string"
- },
- "assignedDestinationId": {
- "format": "int32",
- "type": "integer"
- },
- "cloudDestination": {
- "$ref": "#/components/schemas/CloudRouteDestination"
- },
- "cloudProfile": {
- "$ref": "#/components/schemas/CloudRouteProfile"
- },
- "countryCode": {
- "$ref": "#/components/schemas/CountryCode"
- },
- "destinationType": {
- "enum": [
- "STANDARD",
- "DID",
- "SIP",
- "IN_NETWORK_DID",
- "ACD",
- "IVR",
- "IVR_STUDIO"
- ],
- "type": "string"
- },
- "dtmfEventsEnabled": {
- "type": "boolean"
- },
- "enablePrerouteHttp": {
- "type": "boolean"
- },
- "forceAcdQueue": {
- "type": "boolean"
- },
- "outboundCallerId": {
- "type": "string"
- },
- "overrideFlag": {
- "type": "boolean"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "rank": {
- "format": "int32",
- "type": "integer"
- },
- "repeatIndexStart": {
- "format": "int32",
- "type": "integer"
- },
- "ringDuration": {
- "format": "int32",
- "type": "integer"
- },
- "routeDestination": {
- "type": "string"
- },
- "takeBackDtmf": {
- "type": "string"
- },
- "ttAccept": {
- "type": "boolean"
- },
- "ttAcceptTime": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "CloudRouteAssignedOverride": {
- "properties": {
- "assignedDestination": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- },
- "assignedOverrideId": {
- "format": "int32",
- "type": "integer"
- },
- "countryId": {
- "type": "string"
- },
- "dnis": {
- "type": "string"
- },
- "routeDestination": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CloudRouteDestination": {
- "properties": {
- "active": {
- "type": "boolean"
- },
- "address": {
- "type": "string"
- },
- "authKey": {
- "type": "string"
- },
- "city": {
- "type": "string"
- },
- "cloudDestinationId": {
- "format": "int32",
- "type": "integer"
- },
- "cloudRouteGroup": {
- "$ref": "#/components/schemas/CloudRouteGroup"
- },
- "countryCode": {
- "$ref": "#/components/schemas/CountryCode"
- },
- "deleted": {
- "type": "boolean"
- },
- "destinationDesc": {
- "type": "string"
- },
- "destinationName": {
- "type": "string"
- },
- "destinationType": {
- "enum": [
- "STANDARD",
- "DID",
- "SIP",
- "IN_NETWORK_DID",
- "ACD",
- "IVR",
- "IVR_STUDIO"
- ],
- "type": "string"
- },
- "endDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "forceAcdQueue": {
- "type": "boolean"
- },
- "friSched": {
- "type": "string"
- },
- "isActive": {
- "type": "boolean"
- },
- "isDeleted": {
- "type": "boolean"
- },
- "lat": {
- "format": "double",
- "type": "number"
- },
- "lon": {
- "format": "double",
- "type": "number"
- },
- "maxConcurrent": {
- "format": "int32",
- "type": "integer"
- },
- "maxConcurrentHours": {
- "type": "string"
- },
- "maxConcurrentType": {
- "type": "string"
- },
- "monSched": {
- "type": "string"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "prerouteHttpUrl": {
- "type": "string"
- },
- "ringDuration": {
- "format": "int32",
- "type": "integer"
- },
- "routeDestination": {
- "type": "string"
- },
- "satSched": {
- "type": "string"
- },
- "startDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "state": {
- "type": "string"
- },
- "sunSched": {
- "type": "string"
- },
- "thuSched": {
- "type": "string"
- },
- "ttAccept": {
- "type": "boolean"
- },
- "ttAcceptTime": {
- "format": "int32",
- "type": "integer"
- },
- "tueSched": {
- "type": "string"
- },
- "wedSched": {
- "type": "string"
- },
- "zip": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CloudRouteDestinationOverride": {
- "properties": {
- "cloudDestination": {
- "$ref": "#/components/schemas/CloudRouteDestination"
- },
- "countryId": {
- "type": "string"
- },
- "destOverrideId": {
- "format": "int32",
- "type": "integer"
- },
- "dnis": {
- "type": "string"
- },
- "routeDestination": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CloudRouteDtmfEvent": {
- "properties": {
- "cloudRouteDtmfId": {
- "format": "int32",
- "type": "integer"
- },
- "dtmfCode": {
- "format": "int32",
- "type": "integer"
- },
- "dtmfEventData": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CloudRouteGroup": {
- "properties": {
- "cloudGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "cloudRouteDestinations": {
- "$ref": "#/components/schemas/CollectionCloudRouteDestination"
- },
- "cloudRouteProfiles": {
- "$ref": "#/components/schemas/CollectionCloudRouteProfile"
- },
- "groupName": {
- "type": "string"
- },
- "isDefault": {
- "type": "boolean"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "CloudRouteProfile": {
- "properties": {
- "billingCode": {
- "type": "string"
- },
- "billingKey": {
- "type": "string"
- },
- "callConnSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "callEndSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "callStartSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "cloudProfileId": {
- "format": "int32",
- "type": "integer"
- },
- "cloudRouteGroup": {
- "$ref": "#/components/schemas/CloudRouteGroup"
- },
- "dequeueDelay": {
- "format": "int32",
- "type": "integer"
- },
- "endcallMsg": {
- "type": "string"
- },
- "geoMaxDistance": {
- "format": "int32",
- "type": "integer"
- },
- "introMsg": {
- "type": "string"
- },
- "isActive": {
- "type": "boolean"
- },
- "isDeleted": {
- "type": "boolean"
- },
- "longCall": {
- "format": "int32",
- "type": "integer"
- },
- "outboundCallerId": {
- "type": "string"
- },
- "percentAllocType": {
- "type": "string"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "profileDesc": {
- "type": "string"
- },
- "profileName": {
- "type": "string"
- },
- "recordCall": {
- "type": "boolean"
- },
- "repeatCount": {
- "format": "int32",
- "type": "integer"
- },
- "repeatDelay": {
- "format": "int32",
- "type": "integer"
- },
- "revMatch": {
- "type": "boolean"
- },
- "routeExhaustedAction": {
- "type": "string"
- },
- "routingType": {
- "type": "string"
- },
- "shortCall": {
- "format": "int32",
- "type": "integer"
- },
- "stickyDestinationType": {
- "type": "string"
- },
- "takeBackMsg": {
- "type": "string"
- },
- "voicemailEmail": {
- "type": "string"
- },
- "whisperMsg": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CloudRouteProfileSkinny": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "cloudGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "cloudProfileId": {
- "format": "int32",
- "type": "integer"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "isActive": {
- "type": "boolean"
- },
- "isDeleted": {
- "type": "boolean"
- },
- "profileName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CollectionAgent": {
- "type": "object"
- },
- "CollectionAgentAccountAccess": {
- "type": "object"
- },
- "CollectionAgentBlockMonitor": {
- "type": "object"
- },
- "CollectionAgentChatQueueAccess": {
- "type": "object"
- },
- "CollectionAgentDialGroupMember": {
- "type": "object"
- },
- "CollectionAgentGateAccess": {
- "type": "object"
- },
- "CollectionAgentLoadBalanceMember": {
- "type": "object"
- },
- "CollectionAgentLoginChatQueues": {
- "type": "object"
- },
- "CollectionAgentLoginGate": {
- "type": "object"
- },
- "CollectionAgentSkillProfile": {
- "type": "object"
- },
- "CollectionAgentSupervisor": {
- "type": "object"
- },
- "CollectionCampaign": {
- "type": "object"
- },
- "CollectionCampaignDisposition": {
- "type": "object"
- },
- "CollectionCampaignFilterStates": {
- "type": "object"
- },
- "CollectionCampaignFilterTimezones": {
- "type": "object"
- },
- "CollectionCloudRouteDestination": {
- "type": "object"
- },
- "CollectionCloudRouteProfile": {
- "type": "object"
- },
- "CollectionCustomCriteriaPlan": {
- "type": "object"
- },
- "CollectionCustomDialZone": {
- "type": "object"
- },
- "CollectionCustomDialZoneGroups": {
- "type": "object"
- },
- "CollectionDncTag": {
- "type": "object"
- },
- "CollectionJobInfo": {
- "type": "object"
- },
- "CollectionMultipartFile": {
- "type": "object"
- },
- "CollectionQuotaTarget": {
- "type": "object"
- },
- "CollectionRemoteHttpService": {
- "type": "object"
- },
- "CollectionRemoteHttpServiceInput": {
- "type": "object"
- },
- "CollectionReportMetaData": {
- "type": "object"
- },
- "CollectionRequeueShortcut": {
- "type": "object"
- },
- "CollectionRightsDocument": {
- "type": "object"
- },
- "CollectionState": {
- "type": "object"
- },
- "CollectionSurvey": {
- "type": "object"
- },
- "CollectionTracLocation": {
- "type": "object"
- },
- "CollectionVisualIvr": {
- "type": "object"
- },
- "CollectionWhitelistTagMembers": {
- "type": "object"
- },
- "Collection_AgentAccountAccess_": {
- "type": "object"
- },
- "Collection_AgentChatQueueAccess_": {
- "type": "object"
- },
- "Collection_AgentDialGroupMember_": {
- "type": "object"
- },
- "Collection_AgentGateAccess_": {
- "type": "object"
- },
- "Collection_AgentLoadBalanceMember_": {
- "type": "object"
- },
- "Collection_AgentSkillProfile_": {
- "type": "object"
- },
- "Collection_AgentSupervisor_": {
- "type": "object"
- },
- "Collection_Agent_": {
- "type": "object"
- },
- "Collection_CampaignDisposition_": {
- "type": "object"
- },
- "Collection_CampaignFilterStates_": {
- "type": "object"
- },
- "Collection_CampaignFilterTimezones_": {
- "type": "object"
- },
- "Collection_Campaign_": {
- "type": "object"
- },
- "Collection_CustomDialZone_": {
- "type": "object"
- },
- "Collection_GateSkinny_": {
- "type": "object"
- },
- "Collection_QuotaTarget_": {
- "type": "object"
- },
- "Collection_RequeueShortcut_": {
- "type": "object"
- },
- "Collection_WhitelistTagMembers_": {
- "type": "object"
- },
- "ComparableSearchField": {
- "properties": {
- "operator": {
- "enum": [
- "GREATER_THAN",
- "LESS_THAN",
- "EQUALS"
- ],
- "type": "string"
- },
- "value": {
- "type": "object"
- }
- },
- "type": "object"
- },
- "Contact": {
- "properties": {
- "businessPhone": {
- "type": "string"
- },
- "company": {
- "type": "string"
- },
- "department": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "emailAsLoginName": {
- "type": "boolean"
- },
- "firstName": {
- "type": "string"
- },
- "jobTitle": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "mobilePhone": {
- "type": "string"
- }
- },
- "title": "Contact",
- "type": "object"
- },
- "Country": {
- "properties": {
- "countryCode": {
- "type": "string"
- },
- "countryId": {
- "description": "Country code i ISO 3166-1 alpha-3 format",
- "type": "string"
- },
- "countryName": {
- "type": "string"
- },
- "maxAniLength": {
- "format": "int32",
- "type": "integer"
- },
- "maxUtcOffset": {
- "format": "int32",
- "type": "integer"
- },
- "minAniLength": {
- "format": "int32",
- "type": "integer"
- },
- "minUtcOffset": {
- "format": "int32",
- "type": "integer"
- }
- },
- "required": [
- "countryCode"
- ],
- "type": "object"
- },
- "CountryCode": {
- "properties": {
- "countryCode": {
- "type": "string"
- },
- "countryId": {
- "type": "string"
- },
- "countryName": {
- "type": "string"
- },
- "maxAniLength": {
- "format": "int32",
- "type": "integer"
- },
- "maxUtcOffset": {
- "format": "int32",
- "type": "integer"
- },
- "minAniLength": {
- "format": "int32",
- "type": "integer"
- },
- "minUtcOffset": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "CustomCriteriaGroup": {
- "properties": {
- "active": {
- "type": "boolean"
- },
- "customCriteriaPlan": {
- "$ref": "#/components/schemas/CollectionCustomCriteriaPlan"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "groupName": {
- "type": "string"
- },
- "isActive": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "CustomCriteriaPlan": {
- "properties": {
- "criteriaJson": {
- "type": "string"
- },
- "endDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "planId": {
- "format": "int32",
- "type": "integer"
- },
- "planName": {
- "type": "string"
- },
- "startDate": {
- "$ref": "#/components/schemas/DateTime"
- }
- },
- "type": "object"
- },
- "CustomDialZone": {
- "properties": {
- "fridaySchedule": {
- "type": "string"
- },
- "mondaySchedule": {
- "type": "string"
- },
- "saturdaySchedule": {
- "type": "string"
- },
- "sundaySchedule": {
- "type": "string"
- },
- "thursdaySchedule": {
- "type": "string"
- },
- "tuesdaySchedule": {
- "type": "string"
- },
- "wednesdaySchedule": {
- "type": "string"
- },
- "zoneDesc": {
- "type": "string"
- },
- "zoneGroup": {
- "$ref": "#/components/schemas/CustomDialZoneGroups"
- },
- "zoneGroups": {
- "$ref": "#/components/schemas/CustomDialZoneGroups"
- },
- "zoneId": {
- "format": "int32",
- "type": "integer"
- },
- "zoneKey": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "CustomDialZoneGroups": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "baseTimezone": {
- "type": "string"
- },
- "customDialZones": {
- "$ref": "#/components/schemas/CollectionCustomDialZone"
- },
- "zoneGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "zoneGroupName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "Dashboard": {
- "properties": {
- "creationDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "data": {
- "$ref": "#/components/schemas/JsonNode"
- },
- "id": {
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "shared": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "Role": {
- "type": "object",
- "properties": {
- "description": {
- "type": "string"
- },
- "roleType": {
- "type": "string",
- "enum": [
- "SUPER_USER",
- "USER",
- "MANAGE_USERS",
- "MANAGE_RIGHTS",
- "ACCESS_SIBLINGS",
- "ACCESS_AUDIT_LOG",
- "ACCESS_GOODDATA_ADMIN",
- "ACCESS_GOODDATA_EDITOR",
- "ACCESS_GOODDATA_EXPLORER",
- "ACCESS_GOODDATA_VIEWER",
- "ACCESS_GOODDATA_EMBEDDED_EXPLORER",
- "ACCESS_GOODDATA_EMBEDDED_DASHBOARD",
- "ASSUME_USERS",
- "REPORT_ADMINISTRATIVE_USER",
- "NO_ACCESS"
- ]
- }
- }
- },
- "DateTime": {
- "properties": {
- "afterNow": {
- "type": "boolean"
- },
- "beforeNow": {
- "type": "boolean"
- },
- "centuryOfEra": {
- "format": "int32",
- "type": "integer"
- },
- "chronology": {
- "$ref": "#/components/schemas/Chronology"
- },
- "dayOfMonth": {
- "format": "int32",
- "type": "integer"
- },
- "dayOfWeek": {
- "format": "int32",
- "type": "integer"
- },
- "dayOfYear": {
- "format": "int32",
- "type": "integer"
- },
- "equalNow": {
- "type": "boolean"
- },
- "era": {
- "format": "int32",
- "type": "integer"
- },
- "hourOfDay": {
- "format": "int32",
- "type": "integer"
- },
- "millis": {
- "format": "int64",
- "type": "integer"
- },
- "millisOfDay": {
- "format": "int32",
- "type": "integer"
- },
- "millisOfSecond": {
- "format": "int32",
- "type": "integer"
- },
- "minuteOfDay": {
- "format": "int32",
- "type": "integer"
- },
- "minuteOfHour": {
- "format": "int32",
- "type": "integer"
- },
- "monthOfYear": {
- "format": "int32",
- "type": "integer"
- },
- "secondOfDay": {
- "format": "int32",
- "type": "integer"
- },
- "secondOfMinute": {
- "format": "int32",
- "type": "integer"
- },
- "weekOfWeekyear": {
- "format": "int32",
- "type": "integer"
- },
- "weekyear": {
- "format": "int32",
- "type": "integer"
- },
- "year": {
- "format": "int32",
- "type": "integer"
- },
- "yearOfCentury": {
- "format": "int32",
- "type": "integer"
- },
- "yearOfEra": {
- "format": "int32",
- "type": "integer"
- },
- "zone": {
- "$ref": "#/components/schemas/DateTimeZone"
- }
- },
- "type": "object"
- },
- "DateTimeComparableSearchField": {
- "properties": {
- "operator": {
- "enum": [
- "GREATER_THAN",
- "LESS_THAN",
- "EQUALS"
- ],
- "type": "string"
- },
- "value": {
- "$ref": "#/components/schemas/DateTime"
- }
- },
- "type": "object"
- },
- "DateTimeField": {
- "properties": {
- "durationField": {
- "$ref": "#/components/schemas/DurationField"
- },
- "leapDurationField": {
- "$ref": "#/components/schemas/DurationField"
- },
- "lenient": {
- "type": "boolean"
- },
- "maximumValue": {
- "format": "int32",
- "type": "integer"
- },
- "minimumValue": {
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "rangeDurationField": {
- "$ref": "#/components/schemas/DurationField"
- },
- "supported": {
- "type": "boolean"
- },
- "type": {
- "$ref": "#/components/schemas/DateTimeFieldType"
- }
- },
- "type": "object"
- },
- "DateTimeFieldType": {
- "properties": {
- "durationType": {
- "$ref": "#/components/schemas/DurationFieldType"
- },
- "name": {
- "type": "string"
- },
- "rangeDurationType": {
- "$ref": "#/components/schemas/DurationFieldType"
- }
- },
- "type": "object"
- },
- "DateTimeZone": {
- "properties": {
- "fixed": {
- "type": "boolean"
- },
- "id": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "DeferredResultMessage": {
- "properties": {
- "result": {
- "type": "object"
- },
- "setOrExpired": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "DeleteDnisRequest": {
- "properties": {
- "dnis": {
- "type": "string"
- },
- "dnisE164": {
- "type": "string"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "DestinationCampaignRequest": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "campaignId": {
- "format": "int32",
- "type": "integer"
- },
- "dialGroupId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "DestinationParams": {
- "properties": {
- "destinationType": {
- "enum": [
- "EMAIL",
- "FILE_TRANSFER",
- "SECURE_FILE_TRANSFER"
- ],
- "type": "string"
- },
- "isCompress": {
- "type": "boolean"
- },
- "titleDateTimeFormat": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "Device": {
- "properties": {
- "id": {
- "type": "string"
- },
- "linePooling": {
- "type": "string"
- },
- "phoneLines": {
- "items": {
- "type": "object"
- },
- "type": "array"
- },
- "status": {
- "type": "string"
- },
- "type": {
- "type": "string"
- },
- "uri": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "DialGroup": {
- "properties": {
- "agentDialGroupMembers": {
- "$ref": "#/components/schemas/CollectionAgentDialGroupMember"
- },
- "agentsReady": {
- "format": "int32",
- "type": "integer"
- },
- "allowLeadSearch": {
- "type": "string"
- },
- "allowPreviewLeadFilters": {
- "type": "boolean"
- },
- "billingKey": {
- "type": "string"
- },
- "campaigns": {
- "$ref": "#/components/schemas/CollectionCampaign"
- },
- "dialGroupDesc": {
- "type": "string"
- },
- "dialGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "dialGroupName": {
- "type": "string"
- },
- "dialMode": {
- "enum": [
- "PREVIEW",
- "CLICK_TO_TALK",
- "PREDICTIVE",
- "POWER",
- "TCPA_SAFE_MODE"
- ],
- "type": "string"
- },
- "enableAbsolutePriority": {
- "type": "boolean"
- },
- "enableAgentFilter": {
- "type": "boolean"
- },
- "enableCallbacksAfterMaxDailyPass": {
- "type": "boolean"
- },
- "enableCallbacksAfterMaxpass": {
- "type": "boolean"
- },
- "enableListPriority": {
- "type": "boolean"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "hciEnabled": {
- "enum": [
- "DISABLED",
- "HCI_FETCH",
- "HCI_PACING"
- ],
- "type": "string"
- },
- "isActive": {
- "type": "boolean"
- },
- "maxLeadsReturned": {
- "format": "int32",
- "type": "integer"
- },
- "maxPorts": {
- "format": "int32",
- "type": "integer"
- },
- "minPredictiveAgents": {
- "format": "int32",
- "type": "integer"
- },
- "outdialServerGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "progressiveCallDelay": {
- "format": "int32",
- "type": "integer"
- },
- "progressiveEnabled": {
- "type": "boolean"
- },
- "realTimeAgentData": {
- "type": "boolean"
- },
- "requireFetchedLeadsCalled": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "DialGroupTimeZoneDialCountWrapper": {
- "properties": {
- "dialGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "dialGroupName": {
- "type": "string"
- },
- "dialMode": {
- "enum": [
- "PREVIEW",
- "CLICK_TO_TALK",
- "PREDICTIVE",
- "POWER",
- "TCPA_SAFE_MODE"
- ],
- "type": "string"
- },
- "leadData": {
- "items": {
- "$ref": "#/components/schemas/CampaignTimeZoneDialCount"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "DncListEntry": {
- "properties": {
- "addedBy": {
- "type": "string"
- },
- "addedDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "countryCode": {
- "$ref": "#/components/schemas/CountryCode"
- },
- "dncTagId": {
- "format": "int32",
- "type": "integer"
- },
- "phone": {
- "type": "string"
- },
- "reason": {
- "type": "string"
- },
- "tag": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "DncTag": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "dncTagId": {
- "format": "int32",
- "type": "integer"
- },
- "dncTagLabel": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "DnisBulkUpdateRespose": {
- "properties": {
- "message": {
- "type": "string"
- },
- "status": {
- "type": "string"
- },
- "updatedRows": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "DnisListPreviewResponse": {
- "properties": {
- "records": {
- "items": {
- "$ref": "#/components/schemas/BaseCsvDto"
- },
- "type": "array"
- },
- "uploadStatus": {
- "$ref": "#/components/schemas/DnisResponseValidation"
- }
- },
- "type": "object"
- },
- "DnisListRequest": {
- "properties": {
- "accountIds": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "dnisState": {
- "type": "string"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- },
- "searchText": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "DnisMigrationResult": {
- "properties": {
- "tbl_acd_dnis_pool": {
- "$ref": "#/components/schemas/DnisMigrationResultEntry"
- },
- "tbl_acd_gate_dnis": {
- "$ref": "#/components/schemas/DnisMigrationResultEntry"
- },
- "tbl_acd_sms_dnis": {
- "$ref": "#/components/schemas/DnisMigrationResultEntry"
- }
- },
- "type": "object"
- },
- "DnisMigrationResultEntry": {
- "properties": {
- "converted": {
- "format": "int32",
- "type": "integer"
- },
- "convertedAsIs": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "total": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "DnisNotification": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "dnis": {
- "type": "string"
- },
- "missCall": {
- "type": "boolean"
- },
- "notificationId": {
- "format": "int32",
- "type": "integer"
- },
- "notifyDest": {
- "type": "string"
- },
- "shortCall": {
- "type": "boolean"
- },
- "voicemail": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "DnisPool": {
- "properties": {
- "active": {
- "type": "boolean"
- },
- "assignedDnis": {
- "$ref": "#/components/schemas/AssignedDnis"
- },
- "assignedSmsDnis": {
- "$ref": "#/components/schemas/AssignedSmsDnis"
- },
- "carrier": {
- "type": "string"
- },
- "customAppString": {
- "type": "string"
- },
- "dateCreated": {
- "$ref": "#/components/schemas/DateTime"
- },
- "dnis": {
- "type": "string"
- },
- "dnisCategory": {
- "type": "string"
- },
- "dnisDescription": {
- "type": "string"
- },
- "dnisE164": {
- "type": "string"
- },
- "dnisManagedByRC": {
- "type": "boolean"
- },
- "inboundContext": {
- "type": "string"
- },
- "lastModified": {
- "$ref": "#/components/schemas/DateTime"
- },
- "lastModifiedBy": {
- "type": "string"
- },
- "mediaCode": {
- "type": "string"
- },
- "mediaFormat": {
- "type": "string"
- },
- "mediaIsci": {
- "type": "string"
- },
- "mediaLength": {
- "type": "string"
- },
- "mediaMarket": {
- "type": "string"
- },
- "mediaNetwork": {
- "type": "string"
- },
- "mediaUrl": {
- "type": "string"
- },
- "mediaVersion": {
- "type": "string"
- },
- "mediaWebSourcecode": {
- "type": "string"
- },
- "notes": {
- "type": "string"
- },
- "originatingDnis": {
- "type": "string"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- },
- "platformId": {
- "type": "string"
- },
- "reservedAccount": {
- "$ref": "#/components/schemas/Account"
- },
- "reservedAccountId": {
- "type": "string"
- },
- "resporg": {
- "type": "string"
- },
- "smsEnabled": {
- "type": "boolean"
- },
- "twilioApiKey": {
- "type": "string"
- },
- "vendorId": {
- "type": "string"
- },
- "vruNetworkId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "DnisPoolUpdateRequest": {
- "properties": {
- "chatQueueId": {
- "format": "int32",
- "type": "integer"
- },
- "dnisPool": {
- "$ref": "#/components/schemas/DnisPoolV2"
- },
- "endDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "product": {
- "enum": [
- "ACCOUNT",
- "ACD",
- "AGENT",
- "CHAT_QUEUE",
- "OUTBOUND",
- "VISUAL_IVR",
- "CLOUD_PROFILE",
- "CLOUD_DESTINATION",
- "TRAC_NUMBER",
- "HTTP_SERVICES",
- "SCRIPTING",
- "TN_MANAGER",
- "SURVEY",
- "DNIS",
- "TEAMS",
- "KNOWLEDGE_BASE",
- "UTILITIES"
- ],
- "type": "string"
- },
- "productId": {
- "format": "int32",
- "type": "integer"
- },
- "smsEndDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "smsStartDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "startDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "unassignProduct": {
- "type": "boolean"
- },
- "unassignSmsProduct": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "DnisPoolV2": {
- "properties": {
- "active": {
- "type": "boolean"
- },
- "assignedDnis": {
- "$ref": "#/components/schemas/AssignedDnis"
- },
- "assignedSmsDnis": {
- "$ref": "#/components/schemas/AssignedSmsDnis"
- },
- "carrier": {
- "type": "string"
- },
- "customAppString": {
- "type": "string"
- },
- "dateCreated": {
- "$ref": "#/components/schemas/DateTime"
- },
- "dnis": {
- "type": "string"
- },
- "dnisCategory": {
- "type": "string"
- },
- "dnisDescription": {
- "type": "string"
- },
- "dnisE164": {
- "type": "string"
- },
- "inboundContext": {
- "type": "string"
- },
- "lastModified": {
- "$ref": "#/components/schemas/DateTime"
- },
- "lastModifiedBy": {
- "type": "string"
- },
- "mediaCode": {
- "type": "string"
- },
- "mediaFormat": {
- "type": "string"
- },
- "mediaIsci": {
- "type": "string"
- },
- "mediaLength": {
- "type": "string"
- },
- "mediaMarket": {
- "type": "string"
- },
- "mediaNetwork": {
- "type": "string"
- },
- "mediaUrl": {
- "type": "string"
- },
- "mediaVersion": {
- "type": "string"
- },
- "mediaWebSourcecode": {
- "type": "string"
- },
- "notes": {
- "type": "string"
- },
- "originatingDnis": {
- "type": "string"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- },
- "platformId": {
- "type": "string"
- },
- "reservedAccount": {
- "$ref": "#/components/schemas/Account"
- },
- "reservedAccountId": {
- "type": "string"
- },
- "resporg": {
- "type": "string"
- },
- "smsEnabled": {
- "type": "boolean"
- },
- "twilioApiKey": {
- "type": "string"
- },
- "vendorId": {
- "type": "string"
- },
- "vruNetworkId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "DnisResponseValidation": {
- "properties": {
- "errorCode": {
- "type": "string"
- },
- "errorMessage": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "totalRecords": {
- "format": "int64",
- "type": "integer"
- },
- "validRecords": {
- "format": "int64",
- "type": "integer"
- },
- "validated": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "DurationField": {
- "properties": {
- "name": {
- "type": "string"
- },
- "precise": {
- "type": "boolean"
- },
- "supported": {
- "type": "boolean"
- },
- "type": {
- "$ref": "#/components/schemas/DurationFieldType"
- },
- "unitMillis": {
- "format": "int64",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "DurationFieldType": {
- "properties": {
- "name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "EVUser": {
- "properties": {
- "email": {
- "type": "string"
- },
- "ev_user_type": {
- "enum": [
- "admin",
- "agent"
- ],
- "type": "string"
- },
- "ev_user_uid": {
- "type": "string"
- },
- "first_name": {
- "type": "string"
- },
- "is_active": {
- "type": "boolean"
- },
- "last_name": {
- "type": "string"
- },
- "rc_sync": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "Element": {
- "properties": {
- "elements": {
- "items": {
- "$ref": "#/components/schemas/Element"
- },
- "type": "array"
- },
- "isComplex": {
- "type": "boolean"
- },
- "name": {
- "type": "string"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "EmailTemplate": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "allowBccChange": {
- "type": "boolean"
- },
- "allowBodyChange": {
- "type": "boolean"
- },
- "allowCcChange": {
- "type": "boolean"
- },
- "allowFromChange": {
- "type": "boolean"
- },
- "allowSubjectChange": {
- "type": "boolean"
- },
- "allowToChange": {
- "type": "boolean"
- },
- "emailBcc": {
- "type": "string"
- },
- "emailCc": {
- "type": "string"
- },
- "emailFrom": {
- "type": "string"
- },
- "emailRte": {
- "type": "string"
- },
- "emailSubject": {
- "type": "string"
- },
- "emailTemplateId": {
- "format": "int32",
- "type": "integer"
- },
- "emailTo": {
- "type": "string"
- },
- "sendFormat": {
- "type": "string"
- },
- "templateName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "EmailTemplateAttachment": {
- "properties": {
- "attachmentId": {
- "format": "int32",
- "type": "integer"
- },
- "attachmentName": {
- "type": "string"
- },
- "attachmentSize": {
- "format": "int64",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "EmbeddedChatWidget": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "isOpen": {
- "type": "boolean"
- },
- "open": {
- "type": "boolean"
- },
- "showPoweredBy": {
- "type": "boolean"
- },
- "widgetConfiguration": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "Environment": {
- "properties": {
- "activeProfiles": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "defaultProfiles": {
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "title": "Environment",
- "type": "object"
- },
- "Error": {
- "properties": {
- "details": {
- "type": "string"
- },
- "generalMessage": {
- "type": "string"
- },
- "requestUri": {
- "type": "string"
- },
- "timestamp": {
- "format": "int64",
- "type": "integer"
- }
- }
- },
- "Errors": {
- "properties": {
- "cause": {
- "type": "string"
- },
- "details": {
- "type": "string"
- },
- "developerMessage": {
- "type": "string"
- },
- "generalMessage": {
- "type": "string"
- },
- "requestUri": {
- "type": "string"
- },
- "timestamp": {
- "format": "int64",
- "type": "integer"
- },
- "validationErrors": {
- "items": {
- "$ref": "#/components/schemas/ValidationErrorData"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ExtendedLeadData": {
- "properties": {
- "important": {
- "type": "string"
- },
- "interested": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "FilteredIdView": {
- "properties": {
- "permission": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "products": {
- "items": {
- "enum": [
- "ACCOUNT",
- "ACD",
- "AGENT",
- "CHAT_QUEUE",
- "OUTBOUND",
- "VISUAL_IVR",
- "CLOUD_PROFILE",
- "CLOUD_DESTINATION",
- "TRAC_NUMBER",
- "HTTP_SERVICES",
- "SCRIPTING",
- "TN_MANAGER",
- "SURVEY",
- "DNIS",
- "TEAMS",
- "KNOWLEDGE_BASE",
- "UTILITIES"
- ],
- "type": "string"
- },
- "type": "array"
- }
- },
- "required": [
- "permission",
- "products"
- ],
- "type": "object"
- },
- "Gate": {
- "properties": {
- "abandonCampaign": {
- "$ref": "#/components/schemas/Campaign"
- },
- "acceptTime": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "afterCallBaseState": {
- "type": "string"
- },
- "afterCallState": {
- "$ref": "#/components/schemas/AccountAuxState"
- },
- "agentConnSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "agentGateAccess": {
- "items": {
- "$ref": "#/components/schemas/AgentGateAccess"
- },
- "type": "array"
- },
- "agentPopMessage": {
- "type": "string"
- },
- "agentTermSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "appUrl": {
- "type": "string"
- },
- "backupAppUrl": {
- "type": "string"
- },
- "billingCode": {
- "type": "string"
- },
- "blockedAniMessage": {
- "type": "string"
- },
- "callbackCampaign": {
- "$ref": "#/components/schemas/Campaign"
- },
- "createdOn": {
- "$ref": "#/components/schemas/DateTime"
- },
- "dequeueDelay": {
- "format": "int32",
- "type": "integer"
- },
- "dequeueSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "dispositionTimeout": {
- "format": "int32",
- "type": "integer"
- },
- "enableGlobalPhoneBook": {
- "type": "boolean"
- },
- "enableIvrTokens": {
- "type": "boolean"
- },
- "endCallMessage": {
- "type": "string"
- },
- "fifoDisabled": {
- "type": "boolean"
- },
- "friSched": {
- "type": "string"
- },
- "gateClosedEvent": {
- "type": "string"
- },
- "gateDesc": {
- "type": "string"
- },
- "gateGroup": {
- "$ref": "#/components/schemas/GateGroup"
- },
- "gateId": {
- "format": "int32",
- "type": "integer"
- },
- "gateName": {
- "type": "string"
- },
- "gateOpen": {
- "type": "boolean"
- },
- "gatePriority": {
- "format": "int32",
- "type": "integer"
- },
- "gatePriorityGroup": {
- "$ref": "#/components/schemas/GatePriorityGroup"
- },
- "gateQueueEvents": {
- "items": {
- "$ref": "#/components/schemas/GateQueueEvent"
- },
- "type": "array"
- },
- "hangupOnDisposition": {
- "type": "boolean"
- },
- "isActive": {
- "type": "boolean"
- },
- "longCallTime": {
- "format": "int32",
- "type": "integer"
- },
- "manualCallerId": {
- "type": "string"
- },
- "manualCallerIdE164": {
- "type": "string"
- },
- "maxQueueEvent": {
- "type": "string"
- },
- "maxQueueLimit": {
- "format": "int32",
- "type": "integer"
- },
- "monSched": {
- "type": "string"
- },
- "noAgentEvent": {
- "type": "string"
- },
- "observeDst": {
- "type": "boolean"
- },
- "onHoldMessage": {
- "type": "string"
- },
- "outboundCallerId": {
- "type": "string"
- },
- "pauseRecordingSec": {
- "format": "int32",
- "type": "integer"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "perspectiveRecordingMode": {
- "enum": [
- "DISABLED",
- "ALL_AGENT_LEGS"
- ],
- "type": "string"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- },
- "postCallSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "postDispSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "recordCall": {
- "format": "int32",
- "type": "integer"
- },
- "recordingInConference": {
- "type": "boolean"
- },
- "recordingSettings": {
- "enum": [
- "RECORD_FULL_CALL",
- "AGENT_FULL_CONTROL_DEFAULT_ON",
- "AGENT_FULL_CONTROL_DEFAULT_OFF",
- "AGENT_PAUSE"
- ],
- "type": "string"
- },
- "requeueType": {
- "enum": [
- "ADVANCED",
- "RESTRICTED"
- ],
- "type": "string"
- },
- "resultFileDestination": {
- "$ref": "#/components/schemas/ResultFileDestination"
- },
- "revMatch": {
- "type": "boolean"
- },
- "satSched": {
- "type": "string"
- },
- "script": {
- "$ref": "#/components/schemas/Script"
- },
- "shortAbandonTime": {
- "format": "int32",
- "type": "integer"
- },
- "shortCallTime": {
- "format": "int32",
- "type": "integer"
- },
- "singleChannelEnabled": {
- "type": "boolean"
- },
- "slaTime": {
- "format": "int32",
- "type": "integer"
- },
- "specialAniEvent": {
- "type": "string"
- },
- "stopRecordingOnTransfer": {
- "type": "boolean"
- },
- "sunSched": {
- "type": "string"
- },
- "survey": {
- "$ref": "#/components/schemas/Survey"
- },
- "surveyPopType": {
- "type": "string"
- },
- "syncQueueWait": {
- "format": "int32",
- "type": "integer"
- },
- "throttleCalls": {
- "format": "int32",
- "type": "integer"
- },
- "throttleDays": {
- "format": "int32",
- "type": "integer"
- },
- "throttlingAniEvent": {
- "type": "string"
- },
- "thuSched": {
- "type": "string"
- },
- "transferCallerId": {
- "type": "string"
- },
- "transferCallerIdE164": {
- "type": "string"
- },
- "transferTermSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "ttAccept": {
- "type": "boolean"
- },
- "tueSched": {
- "type": "string"
- },
- "wedSched": {
- "type": "string"
- },
- "whisperMessage": {
- "type": "string"
- },
- "wrapTime": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "GateDisposition": {
- "properties": {
- "destCampaign": {
- "$ref": "#/components/schemas/Campaign"
- },
- "dispSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "disposition": {
- "type": "string"
- },
- "dncTagLabel": {
- "type": "string"
- },
- "doNotCall": {
- "type": "boolean"
- },
- "dtmfMapping": {
- "type": "string"
- },
- "emailDestinations": {
- "type": "string"
- },
- "emailTemplate": {
- "$ref": "#/components/schemas/EmailTemplate"
- },
- "gateDispositionId": {
- "format": "int32",
- "type": "integer"
- },
- "isComplete": {
- "type": "boolean"
- },
- "isContact": {
- "type": "boolean"
- },
- "isDefault": {
- "type": "boolean"
- },
- "isDisabled": {
- "type": "boolean"
- },
- "isRequeued": {
- "format": "int32",
- "type": "integer"
- },
- "isSuccess": {
- "type": "boolean"
- },
- "rank": {
- "format": "int32",
- "type": "integer"
- },
- "requeueDelay": {
- "format": "int32",
- "type": "integer"
- },
- "requireNote": {
- "type": "boolean"
- },
- "saveSurvey": {
- "type": "boolean"
- },
- "setAgentFlag": {
- "type": "boolean"
- },
- "timeout": {
- "format": "int32",
- "type": "integer"
- },
- "xfer": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "xferDest": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "GateGroup": {
- "properties": {
- "billingKey": {
- "type": "string"
- },
- "createdOn": {
- "$ref": "#/components/schemas/DateTime"
- },
- "endDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "gateGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "gates": {
- "items": {
- "$ref": "#/components/schemas/Gate"
- },
- "type": "array"
- },
- "groupName": {
- "type": "string"
- },
- "groupSkills": {
- "items": {
- "$ref": "#/components/schemas/GateGroupSkill"
- },
- "type": "array"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "startDate": {
- "$ref": "#/components/schemas/DateTime"
- }
- },
- "type": "object"
- },
- "GateGroupSkill": {
- "properties": {
- "active": {
- "type": "boolean"
- },
- "agentSkillProfiles": {
- "$ref": "#/components/schemas/CollectionAgentSkillProfile"
- },
- "createdOn": {
- "$ref": "#/components/schemas/DateTime"
- },
- "requeueShortcut": {
- "items": {
- "$ref": "#/components/schemas/RequeueShortcut"
- },
- "type": "array"
- },
- "skillDesc": {
- "type": "string"
- },
- "skillId": {
- "format": "int32",
- "type": "integer"
- },
- "skillName": {
- "type": "string"
- },
- "whisperAudio": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "GateGroupSkinny": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "gateGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "gates": {
- "$ref": "#/components/schemas/Collection_GateSkinny_"
- },
- "groupName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "GateGroupV2": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "billingKey": {
- "type": "string"
- },
- "gateGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "groupName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "GatePriorityGroup": {
- "properties": {
- "gatePriorityGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "gatePriorityGroupName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "GateQueueDtmfEvent": {
- "properties": {
- "dtmf": {
- "type": "string"
- },
- "dtmfEvent": {
- "type": "string"
- },
- "dtmfEventId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "GateQueueEvent": {
- "properties": {
- "enableDtmf": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "eventDuration": {
- "format": "int32",
- "type": "integer"
- },
- "eventId": {
- "format": "int32",
- "type": "integer"
- },
- "eventRank": {
- "format": "int32",
- "type": "integer"
- },
- "gate": {
- "$ref": "#/components/schemas/Gate"
- },
- "queueEvent": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "GateScheduleOverride": {
- "properties": {
- "overrideClosedEvent": {
- "type": "string"
- },
- "overrideDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "overrideLabel": {
- "type": "string"
- },
- "overrideSched": {
- "type": "string"
- },
- "scheduleOverrideId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "GateSkinny": {
- "properties": {
- "gateGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "gateId": {
- "format": "int32",
- "type": "integer"
- },
- "gateName": {
- "type": "string"
- },
- "isActive": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "GateSkinnyAssignable": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "gateGroup": {
- "$ref": "#/components/schemas/GateGroupV2"
- },
- "gateGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "gateId": {
- "format": "int32",
- "type": "integer"
- },
- "gateName": {
- "type": "string"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "isActive": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "GateSpecialAni": {
- "properties": {
- "ani": {
- "type": "string"
- },
- "aniE164": {
- "type": "string"
- },
- "dateAdded": {
- "$ref": "#/components/schemas/DateTime"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "GateSpecialAniDeleteRequest": {
- "properties": {
- "ani": {
- "type": "string"
- },
- "aniE164": {
- "type": "string"
- },
- "effectiveAni": {
- "type": "string"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- },
- "type": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "GatesLoggedInAgentsView": {
- "properties": {
- "agentGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "firstName": {
- "type": "string"
- },
- "groupName": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "username": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "GatesSelection": {
- "properties": {
- "gateIds": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "Generic": {
- "properties": {
- "description": {
- "type": "string"
- },
- "id": {
- "format": "int64",
- "type": "integer"
- }
- }
- },
- "GenericEmail": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "attachments": {
- "$ref": "#/components/schemas/CollectionMultipartFile"
- },
- "emailBcc": {
- "type": "string"
- },
- "emailCc": {
- "type": "string"
- },
- "emailFrom": {
- "type": "string"
- },
- "emailPlainText": {
- "type": "string"
- },
- "emailRte": {
- "type": "string"
- },
- "emailSubject": {
- "type": "string"
- },
- "emailTo": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "GetRcLinkedAdminsRequest": {
- "properties": {
- "rcAccountId": {
- "type": "string"
- },
- "rcExtensionIds": {
- "items": {
- "format": "int64",
- "type": "integer"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "HistorySource": {
- "properties": {
- "sourceDescription": {
- "type": "string"
- },
- "sourceGroupDescription": {
- "type": "string"
- },
- "sourceGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "sourceGroupName": {
- "type": "string"
- },
- "sourceId": {
- "format": "int32",
- "type": "integer"
- },
- "sourceName": {
- "type": "string"
- },
- "sourceType": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "HttpServiceMapping": {
- "properties": {
- "originalValue": {
- "type": "string"
- },
- "replacementValue": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "IVRApplication": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "appDesc": {
- "type": "string"
- },
- "appId": {
- "format": "int32",
- "type": "integer"
- },
- "appName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ImportNumber": {
- "properties": {
- "customAppString": {
- "type": "string"
- },
- "dnis": {
- "type": "string"
- },
- "dnisDescription": {
- "type": "string"
- },
- "dnisE164": {
- "type": "string"
- },
- "inboundContext": {
- "type": "string"
- },
- "notes": {
- "type": "string"
- },
- "originatingDnis": {
- "type": "string"
- },
- "resporg": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ImportNumbersRequest": {
- "properties": {
- "numbersForImport": {
- "items": {
- "$ref": "#/components/schemas/ImportNumber"
- },
- "type": "array"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- },
- "rcAccountId": {
- "type": "string"
- },
- "subAccountId": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "InputStream": {
- "type": "object"
- },
- "IvrStats": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "active": {
- "format": "int32",
- "type": "integer"
- },
- "connected": {
- "format": "int32",
- "type": "integer"
- },
- "ivrGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "ivrGroupName": {
- "type": "string"
- },
- "lastUpdate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "presented": {
- "format": "int32",
- "type": "integer"
- },
- "selectable": {
- "type": "boolean"
- },
- "transferCloud": {
- "format": "int32",
- "type": "integer"
- },
- "transferGate": {
- "format": "int32",
- "type": "integer"
- },
- "transferTrac": {
- "format": "int32",
- "type": "integer"
- },
- "visualIvrId": {
- "format": "int32",
- "type": "integer"
- },
- "visualIvrName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "JobInfo": {
- "properties": {
- "finalFireTimeMillis": {
- "format": "int64",
- "type": "integer"
- },
- "jobId": {
- "format": "int32",
- "type": "integer"
- },
- "jobParam": {
- "$ref": "#/components/schemas/JobParamobject"
- },
- "jobState": {
- "enum": [
- "NONE",
- "NORMAL",
- "PAUSED",
- "COMPLETE",
- "ERROR",
- "BLOCKED"
- ],
- "type": "string"
- },
- "jobType": {
- "enum": [
- "DNC_DOWNLOAD",
- "ALERTING_JOB",
- "LIST_DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "lastRunDateTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "name": {
- "type": "string"
- },
- "nextFireTimeMillis": {
- "format": "int64",
- "type": "integer"
- },
- "nextRunDateTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "ownerId": {
- "format": "int32",
- "type": "integer"
- },
- "schedule": {
- "$ref": "#/components/schemas/Schedule"
- }
- },
- "type": "object"
- },
- "JobParamobject": {
- "properties": {
- "data": {
- "type": "object"
- }
- },
- "type": "object"
- },
- "JsonNode": {
- "properties": {
- "array": {
- "type": "boolean"
- },
- "bigDecimal": {
- "type": "boolean"
- },
- "bigInteger": {
- "type": "boolean"
- },
- "binary": {
- "type": "boolean"
- },
- "boolean": {
- "type": "boolean"
- },
- "containerNode": {
- "type": "boolean"
- },
- "double": {
- "type": "boolean"
- },
- "empty": {
- "type": "boolean"
- },
- "float": {
- "type": "boolean"
- },
- "floatingPointNumber": {
- "type": "boolean"
- },
- "int": {
- "type": "boolean"
- },
- "integralNumber": {
- "type": "boolean"
- },
- "long": {
- "type": "boolean"
- },
- "missingNode": {
- "type": "boolean"
- },
- "nodeType": {
- "enum": [
- "ARRAY",
- "BINARY",
- "BOOLEAN",
- "MISSING",
- null,
- "NUMBER",
- "OBJECT",
- "POJO",
- "STRING"
- ],
- "type": "string"
- },
- "null": {
- "type": "boolean"
- },
- "number": {
- "type": "boolean"
- },
- "object": {
- "type": "boolean"
- },
- "pojo": {
- "type": "boolean"
- },
- "short": {
- "type": "boolean"
- },
- "textual": {
- "type": "boolean"
- },
- "valueNode": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "KnowledgeBaseArticle": {
- "properties": {
- "active": {
- "type": "boolean"
- },
- "content": {
- "type": "string"
- },
- "contentPlain": {
- "type": "string"
- },
- "createdOn": {
- "$ref": "#/components/schemas/DateTime"
- },
- "knowledgeBaseArticleId": {
- "format": "int32",
- "type": "integer"
- },
- "knowledgeBaseCategory": {
- "$ref": "#/components/schemas/KnowledgeBaseCategory"
- },
- "labels": {
- "type": "string"
- },
- "order": {
- "format": "int32",
- "type": "integer"
- },
- "showSend": {
- "type": "boolean"
- },
- "title": {
- "type": "string"
- },
- "updatedOn": {
- "$ref": "#/components/schemas/DateTime"
- }
- },
- "type": "object"
- },
- "KnowledgeBaseCategory": {
- "properties": {
- "active": {
- "type": "boolean"
- },
- "createdOn": {
- "$ref": "#/components/schemas/DateTime"
- },
- "description": {
- "type": "string"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "knowledgeBaseArticles": {
- "items": {
- "$ref": "#/components/schemas/KnowledgeBaseArticle"
- },
- "type": "array"
- },
- "knowledgeBaseCategoryId": {
- "format": "int32",
- "type": "integer"
- },
- "knowledgeBaseGroup": {
- "$ref": "#/components/schemas/KnowledgeBaseGroup"
- },
- "order": {
- "format": "int32",
- "type": "integer"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "title": {
- "type": "string"
- },
- "updatedOn": {
- "$ref": "#/components/schemas/DateTime"
- }
- },
- "type": "object"
- },
- "KnowledgeBaseGroup": {
- "properties": {
- "knowledgeBaseCategories": {
- "items": {
- "$ref": "#/components/schemas/KnowledgeBaseCategory"
- },
- "type": "array"
- },
- "knowledgeBaseGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Lead": {
- "properties": {
- "address1": {
- "type": "string"
- },
- "address2": {
- "type": "string"
- },
- "auxData1": {
- "type": "string"
- },
- "auxData2": {
- "type": "string"
- },
- "auxData3": {
- "type": "string"
- },
- "auxData4": {
- "type": "string"
- },
- "auxData5": {
- "type": "string"
- },
- "auxPhone": {
- "type": "string"
- },
- "city": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "extendedLeadData": {
- "$ref": "#/components/schemas/ExtendedLeadData"
- },
- "externId": {
- "format": "int64",
- "type": "integer"
- },
- "firstName": {
- "type": "string"
- },
- "gateKeeper": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "leadPhone": {
- "description": "multiple values can be submitted with a pipe delimiter between phone numbers",
- "type": "string"
- },
- "midName": {
- "type": "string"
- },
- "state": {
- "type": "string"
- },
- "suffix": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "zip": {
- "type": "string"
- }
- },
- "required": [
- "externId"
- ],
- "type": "object"
- },
- "LeadActionParams": {
- "properties": {
- "paramMap": {
- "type": "object"
- }
- },
- "type": "object"
- },
- "LeadActionResult": {
- "properties": {
- "dialerRefreshed": {
- "type": "boolean"
- },
- "errorMessage": {
- "type": "string"
- },
- "leadActionType": {
- "type": "string"
- },
- "leadDeleteCount": {
- "format": "int32",
- "type": "integer"
- },
- "leadUpdateCount": {
- "format": "int32",
- "type": "integer"
- },
- "redialDeleteCount": {
- "format": "int32",
- "type": "integer"
- },
- "success": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "LeadListPagePreview": {
- "properties": {
- "pageName": {
- "type": "string"
- },
- "pageNumber": {
- "format": "int32",
- "type": "integer"
- },
- "rowData": {
- "items": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LeadListPreviewResponse": {
- "properties": {
- "mappingColumns": {
- "items": {
- "enum": [
- "LEAD_PHONE",
- "EXTERN_ID",
- "STATE",
- "LEAD_TIMEZONE",
- "PENDING_AGENT_ID",
- "TITLE",
- "FIRST_NAME",
- "MID_NAME",
- "LAST_NAME",
- "SUFFIX",
- "EMAIL",
- "ADDRESS1",
- "ADDRESS2",
- "CITY",
- "ZIP",
- "GATE_KEEPER",
- "AUX_DATA1",
- "AUX_DATA2",
- "AUX_DATA3",
- "AUX_DATA4",
- "AUX_DATA5",
- "AUX_PHONE",
- "AUX_EXTERNAL_URL",
- "AUX_GREETING",
- "LIVE_ANSWER_MESSAGE",
- "MACH_ANSWER_MESSAGE",
- "CALLER_ID",
- "LEAD_PRIORITY",
- "COUNTRY"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "pagePreviews": {
- "items": {
- "$ref": "#/components/schemas/LeadListPagePreview"
- },
- "type": "array"
- },
- "transactionId": {
- "type": "string"
- },
- "personaPhoneConfig": {
- "description": "Configured additional persona phone fields available for mapping when the campaign uses strategic calling configuration.",
- "items": {
- "$ref": "#/components/schemas/PersonaPhoneConfigFields"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LeadListProcessingRequest": {
- "properties": {
- "description": {
- "type": "string"
- },
- "dialPriority": {
- "enum": [
- "IMMEDIATE",
- "NORMAL"
- ],
- "type": "string"
- },
- "dncTags": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "duplicateHandling": {
- "enum": [
- "RETAIN_ALL",
- "REMOVE_ALL_EXISTING",
- "REMOVE_FROM_LIST"
- ],
- "type": "string"
- },
- "extendedLeadDataMappings": {
- "additionalProperties": {
- "format": "int32",
- "type": "integer"
- },
- "type": "object"
- },
- "fileContainsHeaders": {
- "type": "boolean"
- },
- "fileType": {
- "enum": [
- "EXCEL",
- "PIPE",
- "COMMA",
- "TAB"
- ],
- "type": "string"
- },
- "listState": {
- "enum": [
- "ACTIVE",
- "PAUSED",
- "PENDING_DNC",
- "LOADING",
- "DELETED",
- "READY",
- "CALLBACKS",
- "CALLBACKS_AGENT",
- "DUPLICATES_NOT_MERGED",
- "DUPLICATES_NOT_MOVED",
- "ARCHIVED"
- ],
- "type": "string"
- },
- "pageColumnMappings": {
- "additionalProperties": {
- "format": "int32",
- "type": "integer"
- },
- "type": "object"
- },
- "pageNumber": {
- "format": "int32",
- "type": "integer"
- },
- "quoteChar": {
- "type": "string"
- },
- "timeZoneOption": {
- "enum": [
- "NPA_NXX",
- "ZIPCODE",
- "EXPLICIT",
- "COUNTRY",
- "NOT_APPLICABLE"
- ],
- "type": "string"
- },
- "transactionId": {
- "type": "string"
- },
- "uploadLeads": {
- "items": {
- "$ref": "#/components/schemas/CampaignLead"
- },
- "type": "array"
- },
- "additionalPhoneMappings": {
- "additionalProperties": {
- "format": "int32",
- "type": "integer"
- },
- "description": "Maps persona phone IDs to the source column indexes used by leadLoader/process. JSON object keys are persona phone IDs, and values are column indexes from the uploaded file preview.",
- "type": "object"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- },
- "internationalNumberFormat": {
- "type": "boolean"
- },
- "numberOriginCountry": {
- "type": "string"
- },
- "scheduleArchiveDts": {
- "format": "date-time",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LeadListProcessingResult": {
- "properties": {
- "deletedCount": {
- "format": "int32",
- "type": "integer"
- },
- "dncReturnedCount": {
- "format": "int32",
- "type": "integer"
- },
- "dncUploadCount": {
- "format": "int32",
- "type": "integer"
- },
- "failedAgentAssignment": {
- "description": "Number of accepted leads whose reserveAgent value could not be assigned because the agent ID was invalid or the agent does not have access to the account.",
- "format": "int32",
- "type": "integer"
- },
- "hasDeletedLeads": {
- "type": "boolean"
- },
- "internalDncCount": {
- "format": "int32",
- "type": "integer"
- },
- "leadsAccepted": {
- "format": "int32",
- "type": "integer"
- },
- "leadsConverted": {
- "format": "int32",
- "type": "integer"
- },
- "leadsInserted": {
- "format": "int32",
- "type": "integer"
- },
- "leadsSupplied": {
- "format": "int32",
- "type": "integer"
- },
- "listState": {
- "enum": [
- "ACTIVE",
- "PAUSED",
- "PENDING_DNC",
- "LOADING",
- "DELETED",
- "READY",
- "CALLBACKS",
- "CALLBACKS_AGENT",
- "DUPLICATES_NOT_MERGED",
- "DUPLICATES_NOT_MOVED"
- ],
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "processingResult": {
- "type": "string"
- },
- "processingStatus": {
- "enum": [
- "NO_LEADS_PASSED_VALIDATION",
- "DNC_ACCOUNT_SETTINGS",
- "DNC_UPLOAD_FAILED",
- "DEFAULT_NOT_A_FAILURE",
- "DNC_GREATER_ONE_DAY",
- "GENERAL_FAILURE"
- ],
- "type": "string"
- },
- "quotaCount": {
- "format": "int32",
- "type": "integer"
- },
- "rejectedRows": {
- "items": {
- "$ref": "#/components/schemas/RejectedRow"
- },
- "type": "array"
- },
- "timeZoneOption": {
- "enum": [
- "NPA_NXX",
- "ZIPCODE",
- "EXPLICIT",
- "NOT_APPLICABLE"
- ],
- "type": "string"
- },
- "uploadFileName": {
- "type": "string"
- },
- "whitelistCount": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "LeadManagerRequest": {
- "properties": {
- "campaignLeadSearchCriteria": {
- "$ref": "#/components/schemas/CampaignLeadSearchCriteria"
- },
- "leadActionParams": {
- "$ref": "#/components/schemas/LeadActionParams"
- }
- },
- "type": "object"
- },
- "LocalTime": {
- "properties": {
- "chronology": {
- "$ref": "#/components/schemas/Chronology"
- },
- "fieldTypes": {
- "items": {
- "$ref": "#/components/schemas/DateTimeFieldType"
- },
- "type": "array"
- },
- "fields": {
- "items": {
- "$ref": "#/components/schemas/DateTimeField"
- },
- "type": "array"
- },
- "hourOfDay": {
- "format": "int32",
- "type": "integer"
- },
- "millisOfDay": {
- "format": "int32",
- "type": "integer"
- },
- "millisOfSecond": {
- "format": "int32",
- "type": "integer"
- },
- "minuteOfHour": {
- "format": "int32",
- "type": "integer"
- },
- "secondOfMinute": {
- "format": "int32",
- "type": "integer"
- },
- "values": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LoggedInAgentsByQueue": {
- "properties": {
- "loggedInAgentCount": {
- "format": "int32",
- "type": "integer"
- },
- "queueId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "MainAccount": {
- "properties": {
- "dataRetentionDays": {
- "format": "int32",
- "type": "integer"
- },
- "enableAmdProfiles": {
- "type": "boolean"
- },
- "enableConsultCall": {
- "type": "boolean"
- },
- "enablePhoneNumbersI18n": {
- "type": "boolean"
- },
- "engageAccountId": {
- "type": "string"
- },
- "isActive": {
- "format": "int32",
- "type": "integer"
- },
- "mainAccountId": {
- "type": "string"
- },
- "mainAccountName": {
- "type": "string"
- },
- "rcAccountId": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "MainAccountCreationDto": {
- "properties": {
- "dataRetentionDays": {
- "format": "int32",
- "type": "integer"
- },
- "engageAccountId": {
- "type": "string"
- },
- "enterpriseAccountId": {
- "type": "string"
- },
- "mainAccountId": {
- "type": "string"
- },
- "mainAccountName": {
- "type": "string"
- },
- "rcAccountId": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "MainAccountDto": {
- "properties": {
- "dataRetentionDays": {
- "format": "int32",
- "type": "integer"
- },
- "engageAccountId": {
- "type": "string"
- },
- "isActive": {
- "format": "int32",
- "type": "integer"
- },
- "mainAccountId": {
- "type": "string"
- },
- "mainAccountName": {
- "type": "string"
- },
- "rcAccountId": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "MainAccountUpdateDto": {
- "properties": {
- "engageAccountId": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "MappingTemplate": {
- "properties": {
- "account": {
- "$ref": "#/components/schemas/Account"
- },
- "createdBy": {
- "format": "int32",
- "type": "integer"
- },
- "dateCreated": {
- "$ref": "#/components/schemas/DateTime"
- },
- "lastUpdated": {
- "$ref": "#/components/schemas/DateTime"
- },
- "mappingData": {
- "type": "string"
- },
- "mappingId": {
- "format": "int32",
- "type": "integer"
- },
- "mappingName": {
- "type": "string"
- },
- "updatedBy": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "MediaCodeValuesOnDnisPool": {
- "properties": {
- "category": {
- "type": "string"
- },
- "code": {
- "type": "string"
- },
- "duration": {
- "type": "string"
- },
- "format": {
- "type": "string"
- },
- "isci": {
- "type": "string"
- },
- "market": {
- "type": "string"
- },
- "network": {
- "type": "string"
- },
- "sourceCode": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "version": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "Message": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "actionType": {
- "enum": [
- "INITIALIZE",
- "CONNECT",
- "DISCONNECT",
- "TYPING",
- "MESSAGE",
- "DELIVERED",
- "SENT",
- "ACTIVE",
- "MONITOR_START",
- "MONITOR_STOP",
- "CHAT_HISTORY"
- ],
- "type": "string"
- },
- "activeChatUii": {
- "type": "string"
- },
- "apiKey": {
- "type": "string"
- },
- "browserInfo": {
- "type": "string"
- },
- "chatQueueId": {
- "format": "int32",
- "type": "integer"
- },
- "chatWebsocketConnectUri": {
- "type": "string"
- },
- "chatWidgetAccessGuid": {
- "type": "string"
- },
- "destinationJmsQueue": {
- "type": "string"
- },
- "mediaLinks": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "originatingHost": {
- "type": "string"
- },
- "payload": {
- "type": "string"
- },
- "recipient": {
- "type": "string"
- },
- "referer": {
- "type": "string"
- },
- "sender": {
- "type": "string"
- },
- "senderType": {
- "type": "string"
- },
- "sessionGuid": {
- "type": "string"
- },
- "status": {
- "enum": [
- "SUCCESS",
- "FAILED"
- ],
- "type": "string"
- },
- "statusMessage": {
- "type": "string"
- },
- "textMessageDirection": {
- "type": "string"
- },
- "textMessageType": {
- "enum": [
- "SMS",
- "MMS"
- ],
- "type": "string"
- },
- "time": {
- "$ref": "#/components/schemas/DateTime"
- },
- "type": {
- "enum": [
- "SMS",
- "WEB_CHAT",
- "CHAT_ADMIN",
- "SMS_TWILIO"
- ],
- "type": "string"
- },
- "whisper": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "NextivaAccountIntegration": {
- "properties": {
- "_type": {
- "type": "string"
- },
- "accountId": {
- "type": "string"
- },
- "corpAcctNumber": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "encryptedAuthToken": {
- "type": "string"
- },
- "hasAccess": {
- "type": "boolean"
- },
- "integrationType": {
- "type": "string"
- },
- "isActive": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "NotificationGroup": {
- "properties": {
- "description": {
- "type": "string"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "groupName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "NotificationTarget": {
- "properties": {
- "notificationGroup": {
- "$ref": "#/components/schemas/NotificationGroup"
- },
- "smsOrEmail": {
- "type": "string"
- },
- "targetId": {
- "format": "int32",
- "type": "integer"
- },
- "type": {
- "enum": [
- "SMS",
- "EMAIL",
- "USER"
- ],
- "type": "string"
- },
- "user": {
- "$ref": "#/components/schemas/User"
- }
- },
- "type": "object"
- },
- "Operation": {
- "properties": {
- "bindingName": {
- "type": "string"
- },
- "operation": {
- "type": "string"
- },
- "parts": {
- "items": {
- "$ref": "#/components/schemas/Element"
- },
- "type": "array"
- },
- "portName": {
- "type": "string"
- },
- "soapAction": {
- "type": "string"
- },
- "style": {
- "type": "string"
- },
- "tagetNamespace": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "OutboundAndInboundDailyCallData": {
- "properties": {
- "inboundCallTotal": {
- "format": "int32",
- "type": "integer"
- },
- "outboundCallTotal": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "OutboundStats": {
- "properties": {
- "abandon": {
- "format": "int32",
- "type": "integer"
- },
- "accountId": {
- "type": "string"
- },
- "active": {
- "format": "int32",
- "type": "integer"
- },
- "answer": {
- "format": "int32",
- "type": "integer"
- },
- "available": {
- "format": "int32",
- "type": "integer"
- },
- "busy": {
- "format": "int32",
- "type": "integer"
- },
- "campaignId": {
- "format": "int32",
- "type": "integer"
- },
- "campaignName": {
- "type": "string"
- },
- "complete": {
- "format": "int32",
- "type": "integer"
- },
- "connects": {
- "format": "int32",
- "type": "integer"
- },
- "dialGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "dialGroupName": {
- "type": "string"
- },
- "dnc": {
- "format": "int32",
- "type": "integer"
- },
- "fax": {
- "format": "int32",
- "type": "integer"
- },
- "intercept": {
- "format": "int32",
- "type": "integer"
- },
- "lastUpdate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "machine": {
- "format": "int32",
- "type": "integer"
- },
- "noanswer": {
- "format": "int32",
- "type": "integer"
- },
- "notHumanAnswers": {
- "format": "int32",
- "type": "integer"
- },
- "other": {
- "format": "int32",
- "type": "integer"
- },
- "pending": {
- "format": "int32",
- "type": "integer"
- },
- "ready": {
- "format": "int32",
- "type": "integer"
- },
- "selectable": {
- "type": "boolean"
- },
- "staffed": {
- "format": "int32",
- "type": "integer"
- },
- "successDispositions": {
- "format": "int32",
- "type": "integer"
- },
- "totalTalkTime": {
- "format": "int64",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "PassDispositionRequest": {
- "properties": {
- "destinationCampaignRequest": {
- "$ref": "#/components/schemas/DestinationCampaignRequest"
- },
- "passDisposition": {
- "$ref": "#/components/schemas/CampaignPassDisposition"
- }
- },
- "type": "object"
- },
- "PbxDirectoryFilter": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "contactCenterExtension": {
- "enum": [
- "INCLUDE_ALL",
- "EXCLUDE_AGENTS_ONLY",
- "EXCLUDE_AGENTS_AND_SUPERVISORS"
- ],
- "type": "string"
- },
- "corporateExtension": {
- "enum": [
- "INCLUDE_ALL",
- "INCLUDE_SPECIFIC_RANGES",
- "EXCLUDE_SPECIFIC_RANGES"
- ],
- "type": "string"
- },
- "corporateExtensionRange": {
- "type": "string"
- },
- "id": {
- "format": "int32",
- "type": "integer"
- },
- "includeInactiveExtensions": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "PbxDirectoryFilterMailbox": {
- "properties": {
- "mailboxDetails": {
- "items": {
- "$ref": "#/components/schemas/PbxDirectoryMailboxDetail"
- },
- "type": "array"
- },
- "pbxDirectoryEnable": {
- "type": "boolean"
- },
- "pbxDirectoryFilter": {
- "$ref": "#/components/schemas/PbxDirectoryFilter"
- }
- },
- "type": "object"
- },
- "PbxDirectoryMailboxDetail": {
- "properties": {
- "agentType": {
- "enum": [
- "AGENT",
- "SUPERVISOR",
- "MULTI_USER",
- "MULTI_SUPERVISOR"
- ],
- "type": "string"
- },
- "mailboxId": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "PhoneBookEntry": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "countryId": {
- "type": "string"
- },
- "dateCreated": {
- "$ref": "#/components/schemas/DateTime"
- },
- "destName": {
- "type": "string"
- },
- "destination": {
- "type": "string"
- },
- "entryId": {
- "format": "int32",
- "type": "integer"
- },
- "notes": {
- "type": "string"
- },
- "type": {
- "enum": [
- "GATE",
- "GLOBAL",
- "CAMPAIGN"
- ],
- "type": "string"
- },
- "typeId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "PhoneNumbersI18nMigrationStatusInfoResponse": {
- "properties": {
- "errorMessage": {
- "type": "string"
- },
- "finalStatus": {
- "type": "string"
- },
- "startTime": {
- "format": "int64",
- "type": "integer"
- },
- "subStatuses": {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- "taskId": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "PhoneNumbersI18nMigrationTaskResponse": {
- "properties": {
- "finalStatus": {
- "type": "string"
- },
- "mainAccount": {
- "$ref": "#/components/schemas/MainAccount"
- },
- "taskId": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "Platform": {
- "properties": {
- "id": {
- "format": "int32",
- "type": "integer"
- },
- "iqPort": {
- "format": "int32",
- "type": "integer"
- },
- "iqSslPort": {
- "format": "int32",
- "type": "integer"
- },
- "iqUrl": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "platformDesc": {
- "type": "string"
- },
- "platformId": {
- "type": "string"
- },
- "telePlatformId": {
- "type": "string"
- },
- "webSocketPort": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "PlatformDialer": {
- "properties": {
- "dialerDesc": {
- "type": "string"
- },
- "dialerId": {
- "format": "int32",
- "type": "integer"
- },
- "dialerType": {
- "type": "string"
- },
- "id": {
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "tcpaSafeMode": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "PoolUsage": {
- "properties": {
- "active": {
- "type": "boolean"
- },
- "mode": {
- "enum": [
- "PREVIEW",
- "CLICK_TO_TALK",
- "PREDICTIVE",
- "POWER",
- "TCPA_SAFE_MODE"
- ],
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "usageType": {
- "enum": [
- "OUTBOUND",
- "INBOUND"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "PrepayMinutePool": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "notificationEmail": {
- "type": "string"
- },
- "poolDesc": {
- "type": "string"
- },
- "poolName": {
- "type": "string"
- },
- "poolTime": {
- "format": "int32",
- "type": "integer"
- },
- "tenPercentWarn": {
- "type": "boolean"
- },
- "twentyPercentWarn": {
- "type": "boolean"
- },
- "usedTime": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "PrepayTransaction": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "address1": {
- "type": "string"
- },
- "city": {
- "type": "string"
- },
- "comments": {
- "type": "string"
- },
- "country": {
- "type": "string"
- },
- "dollarAmount": {
- "format": "double",
- "type": "number"
- },
- "email": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "minutes": {
- "format": "int32",
- "type": "integer"
- },
- "phone": {
- "type": "string"
- },
- "poolName": {
- "type": "string"
- },
- "state": {
- "type": "string"
- },
- "transDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "transType": {
- "type": "string"
- },
- "transactionId": {
- "format": "int32",
- "type": "integer"
- },
- "transactionName": {
- "type": "string"
- },
- "zip": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "PrerouteCheckStatus": {
- "properties": {
- "reason": {
- "type": "string"
- },
- "status": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "ProductOperationResult": {
- "properties": {
- "id": {
- "format": "int32",
- "type": "integer"
- },
- "success": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "ProductPermission": {
- "properties": {
- "cascade": {
- "type": "boolean"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "product": {
- "enum": [
- "ACCOUNT",
- "ACD",
- "AGENT",
- "CHAT_QUEUE",
- "OUTBOUND",
- "VISUAL_IVR",
- "CLOUD_PROFILE",
- "CLOUD_DESTINATION",
- "TRAC_NUMBER",
- "HTTP_SERVICES",
- "SCRIPTING",
- "TN_MANAGER",
- "SURVEY",
- "DNIS",
- "TEAMS",
- "KNOWLEDGE_BASE",
- "UTILITIES"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductsSelection": {
- "properties": {
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "ids": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "QuotaGroup": {
- "properties": {
- "active": {
- "type": "boolean"
- },
- "campaigns": {
- "$ref": "#/components/schemas/CollectionCampaign"
- },
- "isActive": {
- "type": "boolean"
- },
- "quotaGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "quotaGroupName": {
- "type": "string"
- },
- "quotaTargets": {
- "$ref": "#/components/schemas/CollectionQuotaTarget"
- }
- },
- "type": "object"
- },
- "QuotaManagementGroup": {
- "properties": {
- "quotaGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "quotaGroupName": {
- "type": "string"
- },
- "quotaTargetStats": {
- "items": {
- "$ref": "#/components/schemas/QuotaTargetStats"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "QuotaTarget": {
- "properties": {
- "clientMetadata": {
- "type": "string"
- },
- "criteriaJs": {
- "type": "string"
- },
- "currentCount": {
- "format": "int32",
- "type": "integer"
- },
- "quotaGroup": {
- "$ref": "#/components/schemas/QuotaGroup"
- },
- "quotaMetOn": {
- "$ref": "#/components/schemas/DateTime"
- },
- "quotaTargetId": {
- "format": "int32",
- "type": "integer"
- },
- "targetCount": {
- "format": "int32",
- "type": "integer"
- },
- "targetName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "QuotaTargetStats": {
- "properties": {
- "campaigns": {
- "items": {
- "$ref": "#/components/schemas/CampaignStats"
- },
- "type": "array"
- },
- "currentCount": {
- "format": "int32",
- "type": "integer"
- },
- "quotaGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "quotaMetOn": {
- "$ref": "#/components/schemas/DateTime"
- },
- "quotaTargetId": {
- "format": "int32",
- "type": "integer"
- },
- "quotaTargetName": {
- "type": "string"
- },
- "targetCount": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "RTASubscriptionRequest": {
- "required": [
- "subscriptionName",
- "notificationUrl"
- ],
- "properties": {
- "subscriptionName": {
- "description": "Subscription name.",
- "type": "string"
- },
- "description": {
- "description": "Human-readable description.",
- "type": "string"
- },
- "retryCount": {
- "description": "Maximum delivery retry count. Maximum allowed value is 10. Default is 3.",
- "format": "int32",
- "type": "integer"
- },
- "notificationUrl": {
- "description": "HTTP or HTTPS endpoint that receives agent-state notifications.",
- "type": "string"
- },
- "authConfigId": {
- "description": "Auth configuration ID used when RingCX sends notification requests to the receiver.",
- "format": "uuid",
- "type": "string"
- },
- "active": {
- "description": "Whether the subscription is active.",
- "type": "boolean"
- },
- "customHeaders": {
- "additionalProperties": {
- "type": "object"
- },
- "description": "Additional headers to send with notification requests.",
- "type": "object"
- },
- "expiresAt": {
- "description": "Expiration time as epoch seconds. Use 0 for no configured expiration.",
- "format": "int64",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "RTASubscriptionResponse": {
- "properties": {
- "subscriptionId": {
- "format": "uuid",
- "type": "string"
- },
- "mainAccountId": {
- "type": "string"
- },
- "subAccountId": {
- "type": "string"
- },
- "subscriptionName": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "notificationUrl": {
- "type": "string"
- },
- "authConfigId": {
- "format": "uuid",
- "type": "string"
- },
- "active": {
- "type": "boolean"
- },
- "maxRetryCount": {
- "format": "int32",
- "type": "integer"
- },
- "customHeaders": {
- "additionalProperties": {
- "type": "object"
- },
- "type": "object"
- },
- "expiresAt": {
- "format": "int64",
- "type": "integer"
- },
- "createdBy": {
- "type": "string"
- },
- "createdAt": {
- "format": "date-time",
- "type": "string"
- },
- "updatedBy": {
- "type": "string"
- },
- "updatedAt": {
- "format": "date-time",
- "type": "string"
- },
- "authConfig": {
- "$ref": "#/components/schemas/AuthConfig"
- }
- },
- "type": "object"
- },
- "RcAccountAccessResponse": {
- "properties": {
- "errorMessage": {
- "type": "string"
- },
- "hasAccess": {
- "type": "boolean"
- },
- "rcAccountId": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "RcExtensionRegionalSettings": {
- "properties": {
- "greetingsLanguageId": {
- "format": "int32",
- "type": "integer"
- },
- "greetingsLanguageLocaleCode": {
- "type": "string"
- },
- "greetingsLanguageName": {
- "type": "string"
- },
- "homeCountryCode": {
- "type": "string"
- },
- "homeCountryId": {
- "format": "int32",
- "type": "integer"
- },
- "homeCountryName": {
- "type": "string"
- },
- "regionalFormatId": {
- "format": "int32",
- "type": "integer"
- },
- "regionalFormatLocaleCode": {
- "type": "string"
- },
- "regionalFormatName": {
- "type": "string"
- },
- "timeFormat": {
- "type": "string"
- },
- "timeZoneBias": {
- "type": "string"
- },
- "timeZoneDescription": {
- "type": "string"
- },
- "timeZoneId": {
- "format": "int32",
- "type": "integer"
- },
- "userLanguageId": {
- "format": "int32",
- "type": "integer"
- },
- "userLanguageLocaleCode": {
- "type": "string"
- },
- "userLanguageName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "RcOfficeUser": {
- "properties": {
- "email": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "rcUserId": {
- "format": "int64",
- "type": "integer"
- },
- "regionalSettings": {
- "$ref": "#/components/schemas/RcExtensionRegionalSettings"
- }
- },
- "type": "object"
- },
- "RcUserMappingResponse": {
- "properties": {
- "ev_users": {
- "items": {
- "$ref": "#/components/schemas/EVUser"
- },
- "type": "array"
- },
- "rc_user_uid": {
- "format": "int64",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "RcUserSyncUpdateRequest": {
- "properties": {
- "active": {
- "type": "boolean"
- },
- "email": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "isActive": {
- "type": "boolean"
- },
- "lastName": {
- "type": "string"
- },
- "rcSync": {
- "type": "boolean"
- },
- "regionalSettings": {
- "$ref": "#/components/schemas/RcExtensionRegionalSettings"
- }
- },
- "type": "object"
- },
- "RecordingDestinationV2": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "destDir": {
- "type": "string"
- },
- "destType": {
- "enum": [
- "SFTP",
- "S3",
- "FTP",
- "UNKNOWN"
- ],
- "type": "string"
- },
- "destinationId": {
- "format": "int32",
- "type": "integer"
- },
- "destinationJson": {
- "type": "string"
- },
- "destinationName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "RecordingTaskV2": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "active": {
- "type": "boolean"
- },
- "deleted": {
- "type": "boolean"
- },
- "filterConfig": {
- "type": "string"
- },
- "lastDaySync": {
- "$ref": "#/components/schemas/DateTime"
- },
- "lastPushTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "lastQueryTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "nextPushTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "nextQueryTime": {
- "$ref": "#/components/schemas/DateTime"
- },
- "pushStatusDesc": {
- "type": "string"
- },
- "queryStatusDesc": {
- "type": "string"
- },
- "recordingDestinationV2": {
- "$ref": "#/components/schemas/RecordingDestinationV2"
- },
- "recordingFilename": {
- "type": "string"
- },
- "taskDesc": {
- "type": "string"
- },
- "taskId": {
- "format": "int32",
- "type": "integer"
- },
- "taskName": {
- "type": "string"
- },
- "taskStart": {
- "$ref": "#/components/schemas/DateTime"
- },
- "taskState": {
- "enum": [
- "READY",
- "TEST",
- "RUNNING",
- "FAILED",
- "DISABLED",
- "UNKNOWN"
- ],
- "type": "string"
- },
- "taskType": {
- "enum": [
- "INTELLITASK_RECORDING_PUSH"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "RedirectView": {
- "properties": {
- "applicationContext": {
- "$ref": "#/components/schemas/ApplicationContext"
- },
- "attributesMap": {
- "type": "object"
- },
- "beanName": {
- "type": "string"
- },
- "contentType": {
- "type": "string"
- },
- "exposePathVariables": {
- "type": "boolean"
- },
- "hosts": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "propagateQueryProperties": {
- "type": "boolean"
- },
- "redirectView": {
- "type": "boolean"
- },
- "requestContextAttribute": {
- "type": "string"
- },
- "staticAttributes": {
- "type": "object"
- },
- "url": {
- "type": "string"
- }
- },
- "title": "RedirectView",
- "type": "object"
- },
- "RegionalSettingRequestResponse": {
- "properties": {
- "formattingLocale": {
- "type": "string"
- },
- "greetingLanguage": {
- "type": "string"
- },
- "homeCountry": {
- "format": "int32",
- "type": "integer"
- },
- "homeCountryCode": {
- "type": "string"
- },
- "language": {
- "type": "string"
- },
- "timeFormat": {
- "type": "string"
- },
- "timezone": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "RejectedRow": {
- "properties": {
- "message": {
- "type": "string"
- },
- "rowData": {
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "RemoteHttpService": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "enableMappings": {
- "type": "boolean"
- },
- "httpPassword": {
- "type": "string"
- },
- "httpServiceConfig": {
- "type": "string"
- },
- "httpServiceGroup": {
- "$ref": "#/components/schemas/RemoteHttpServiceGroup"
- },
- "httpServiceInputs": {
- "$ref": "#/components/schemas/CollectionRemoteHttpServiceInput"
- },
- "httpUsername": {
- "type": "string"
- },
- "isDebug": {
- "type": "boolean"
- },
- "isEnabled": {
- "type": "boolean"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "returntype": {
- "type": "string"
- },
- "sendAllSurveyData": {
- "type": "boolean"
- },
- "serviceDescription": {
- "type": "string"
- },
- "serviceId": {
- "format": "int32",
- "type": "integer"
- },
- "serviceType": {
- "enum": [
- "SOAP",
- "HTTP_POST",
- "HTTP_GET",
- "HTTP"
- ],
- "type": "string"
- },
- "soapAction": {
- "type": "string"
- },
- "soapEndpoint": {
- "type": "string"
- },
- "soapOperationname": {
- "type": "string"
- },
- "soapPortname": {
- "type": "string"
- },
- "soapServicename": {
- "type": "string"
- },
- "targetNamespace": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "RemoteHttpServiceGroup": {
- "properties": {
- "groupName": {
- "type": "string"
- },
- "isDefault": {
- "type": "boolean"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "serviceGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "services": {
- "$ref": "#/components/schemas/CollectionRemoteHttpService"
- }
- },
- "type": "object"
- },
- "RemoteHttpServiceInput": {
- "properties": {
- "inputId": {
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "rank": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "simpleDataType": {
- "type": "string"
- },
- "type": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReportCriteria": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "criteriaType": {
- "enum": [
- "DIALER_RESULT_DOWNLOAD_CRITERIA",
- "GLOBAL_CALL_TYPE_CRITERIA",
- "IVR_DETAIL_CRITERIA",
- "TFN_DID_MANAGER_CRITERIA",
- "ALL_CALLS_CRITERIA",
- "CASPER_CRITERIA"
- ],
- "type": "string"
- },
- "databaseTimezone": {
- "type": "string"
- },
- "endDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "endDateRange": {
- "$ref": "#/components/schemas/TimeRange"
- },
- "scheduleTimezoneName": {
- "type": "string"
- },
- "startDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "startDateRange": {
- "$ref": "#/components/schemas/TimeRange"
- },
- "timezoneName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReportMetaData": {
- "properties": {
- "cciReport": {
- "type": "boolean"
- },
- "parameterList": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "reportGroup": {
- "type": "string"
- },
- "reportName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReportParams": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "compressReport": {
- "type": "boolean"
- },
- "delimiter": {
- "enum": [
- "PIPE",
- "COMMA",
- "TAB",
- "EXCEL",
- "HTML"
- ],
- "type": "string"
- },
- "destination": {
- "$ref": "#/components/schemas/DestinationParams"
- },
- "maxRows": {
- "format": "int32",
- "type": "integer"
- },
- "reportCriteria": {
- "$ref": "#/components/schemas/ReportCriteria"
- },
- "reportName": {
- "type": "string"
- },
- "reportType": {
- "enum": [
- "DIALER_RESULT_DOWNLOAD",
- "GLOBAL_CALL_TYPE_EXCEL",
- "GLOBAL_CALL_TYPE_DELIMITED",
- "ALL_CALLS",
- "IVR_DETAIL",
- "TFN_DID_MANAGER_SUPERUSER_EXCEL",
- "TFN_DID_MANAGER_EXCEL",
- "TFN_DID_MANAGER_DELIMITED",
- "CASPER_REPORT"
- ],
- "type": "string"
- },
- "requestUser": {
- "$ref": "#/components/schemas/User"
- },
- "schedule": {
- "$ref": "#/components/schemas/Schedule"
- },
- "scheduledReport": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "RequeueShortcut": {
- "properties": {
- "campaign": {
- "$ref": "#/components/schemas/Campaign"
- },
- "gate": {
- "$ref": "#/components/schemas/Gate"
- },
- "groupSkill": {
- "$ref": "#/components/schemas/GateGroupSkill"
- },
- "name": {
- "type": "string"
- },
- "rank": {
- "format": "int32",
- "type": "integer"
- },
- "requeueGate": {
- "$ref": "#/components/schemas/Gate"
- },
- "requeueGateGroup": {
- "$ref": "#/components/schemas/GateGroup"
- },
- "requeueShortcutId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ResourcePermission": {
- "properties": {
- "cascade": {
- "type": "boolean"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "resourceId": {
- "format": "int32",
- "type": "integer"
- },
- "resourceType": {
- "enum": [
- "ACCOUNT",
- "GATE_GROUP",
- "GATE",
- "AGENT",
- "AGENT_GROUP",
- "OUTBOUND_DIAL_GROUP",
- "OUTBOUND_CAMPAIGN",
- "VISUAL_IVR",
- "VISUAL_IVR_GROUP",
- "TRAC_NUMBER",
- "TRAC_GROUP",
- "CLOUD_PROFILE",
- "CLOUD_DESTINATION",
- "CLOUD_PROFILE_GROUP",
- "CLOUD_GROUP",
- "CLOUD_DESTINATION_GROUP",
- "HTTP_SERVICE",
- "HTTP_SERVICE_GROUP",
- "SCRIPT",
- "SCRIPT_GROUP",
- "TN_MANAGER",
- "UTILITIES",
- "CHAT_QUEUE",
- "CHAT_GROUP",
- "KNOWLEDGEBASE_GROUP",
- "KNOWLEDGEBASE_CATEGORY"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "ResponseEntity": {
- "properties": {
- "body": {
- "type": "object"
- },
- "statusCode": {
- "enum": [
- "100",
- "101",
- "102",
- "103",
- "200",
- "201",
- "202",
- "203",
- "204",
- "205",
- "206",
- "207",
- "208",
- "226",
- "300",
- "301",
- "302",
- "303",
- "304",
- "305",
- "307",
- "308",
- "400",
- "401",
- "402",
- "403",
- "404",
- "405",
- "406",
- "407",
- "408",
- "409",
- "410",
- "411",
- "412",
- "413",
- "414",
- "415",
- "416",
- "417",
- "418",
- "419",
- "420",
- "421",
- "422",
- "423",
- "424",
- "426",
- "428",
- "429",
- "431",
- "451",
- "500",
- "501",
- "502",
- "503",
- "504",
- "505",
- "506",
- "507",
- "508",
- "509",
- "510",
- "511"
- ],
- "type": "string"
- },
- "statusCodeValue": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ResultFileDestination": {
- "properties": {
- "aggregateOutput": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "destType": {
- "type": "string"
- },
- "destinationId": {
- "format": "int32",
- "type": "integer"
- },
- "destinationName": {
- "type": "string"
- },
- "emailDest": {
- "type": "string"
- },
- "ftpDir": {
- "type": "string"
- },
- "ftpPwd": {
- "type": "string"
- },
- "ftpServer": {
- "type": "string"
- },
- "ftpUid": {
- "type": "string"
- },
- "passive": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "sendEmptyFiles": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "sftp": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RightsDocTable": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "creationDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "isMaster": {
- "type": "boolean"
- },
- "owner": {
- "$ref": "#/components/schemas/User"
- },
- "rightsDocJson": {
- "type": "string"
- },
- "rightsDocName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "RightsDocument": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "accountPermissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "assigned": {
- "type": "boolean"
- },
- "cascade": {
- "type": "boolean"
- },
- "isMaster": {
- "type": "boolean"
- },
- "ownerId": {
- "format": "int32",
- "type": "integer"
- },
- "productPermissions": {
- "items": {
- "$ref": "#/components/schemas/ProductPermission"
- },
- "type": "array"
- },
- "resourcePermissions": {
- "items": {
- "$ref": "#/components/schemas/ResourcePermission"
- },
- "type": "array"
- },
- "rightsDocId": {
- "format": "int32",
- "type": "integer"
- },
- "rightsDocName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "SIPRegistrationResult": {
- "properties": {
- "device": {
- "$ref": "#/components/schemas/Device"
- },
- "sipErrorCodes": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "sipFlags": {
- "$ref": "#/components/schemas/SipFlags"
- },
- "sipInfo": {
- "items": {
- "$ref": "#/components/schemas/SipInfo"
- },
- "type": "array"
- },
- "sipInfoPstn": {
- "items": {
- "type": "object"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Schedule": {
- "properties": {
- "dayOfTheMonth": {
- "format": "int32",
- "type": "integer"
- },
- "daysOfWeek": {
- "items": {
- "enum": [
- "SUNDAY",
- "MONDAY",
- "TUESDAY",
- "WEDNESDAY",
- "THURSDAY",
- "FRIDAY",
- "SATURDAY"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "endDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "endTime": {
- "$ref": "#/components/schemas/LocalTime"
- },
- "interval": {
- "format": "int32",
- "type": "integer"
- },
- "month": {
- "enum": [
- "JANUARY",
- "FEBRUARY",
- "MARCH",
- "APRIL",
- "MAY",
- "JUNE",
- "JULY",
- "AUGUST",
- "SEPTEMBER",
- "OCTOBER",
- "NOVEMBER",
- "DECEMBER"
- ],
- "type": "string"
- },
- "repeatOption": {
- "enum": [
- "SINGLE",
- "MINUTE",
- "HOURLY",
- "DAILY",
- "WEEKLY",
- "MONTHLY",
- "CALENDAR",
- "YEARLY"
- ],
- "type": "string"
- },
- "scheduleTimezoneName": {
- "type": "string"
- },
- "startDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "startTime": {
- "$ref": "#/components/schemas/LocalTime"
- },
- "versionNum": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "SchedulerStateResponse": {
- "properties": {
- "currentState": {
- "enum": [
- "RUN",
- "PAUSE"
- ],
- "type": "string"
- },
- "message": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "Script": {
- "properties": {
- "account": {
- "$ref": "#/components/schemas/Account"
- },
- "created": {
- "$ref": "#/components/schemas/DateTime"
- },
- "description": {
- "type": "string"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "isActive": {
- "type": "boolean"
- },
- "name": {
- "type": "string"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "scriptGroup": {
- "$ref": "#/components/schemas/ScriptGroup"
- },
- "scriptId": {
- "format": "int32",
- "type": "integer"
- },
- "updated": {
- "$ref": "#/components/schemas/DateTime"
- }
- },
- "type": "object"
- },
- "ScriptConfig": {
- "properties": {
- "account": {
- "$ref": "#/components/schemas/Account"
- },
- "description": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "scriptId": {
- "format": "int32",
- "type": "integer"
- },
- "scriptJson": {
- "type": "string"
- },
- "updated": {
- "$ref": "#/components/schemas/DateTime"
- }
- },
- "type": "object"
- },
- "ScriptGroup": {
- "properties": {
- "account": {
- "$ref": "#/components/schemas/Account"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "scripts": {
- "items": {
- "$ref": "#/components/schemas/Script"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "SecurityStrategyModel": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "fullPermission": {
- "type": "boolean"
- },
- "productIds": {
- "items": {
- "format": "int32",
- "type": "integer"
- },
- "type": "array"
- },
- "redshiftProduct": {
- "enum": [
- "ACCOUNT",
- "AGENT",
- "AGENT_DISPOSITION",
- "AGENT_EXTERNAL_ID",
- "AGENT_GROUP_ID",
- "AGENT_TEAM",
- "ANI",
- "CALL_ID",
- "CAMPAIGN",
- "CHAT_QUEUE",
- "CHAT_QUEUE_GROUP",
- "CLOUD_DESTINATION",
- "CLOUD_DESTINATION_GROUP_ID",
- "CLOUD_PROFILE",
- "CLOUD_PROFILE_GROUP_ID",
- "DIAL_GROUP",
- "DIAL_TYPE",
- "DNC_TAG",
- "DNIS",
- "GATE",
- "GATE_GROUP",
- "INCLUDE_DIAL_GROUP",
- "INCLUDE_MEDIA",
- "INTERNAL_CHAT",
- "LIST_STATE",
- "LEAD_LIST",
- "OPT_OUT",
- "OUTBOUND_DISPOSITION",
- "ROLLUP_AGENT",
- "SCRIPTING",
- "SCRIPT_GROUP_ID",
- "STARTS_WITH_NPA_EXCLUDE",
- "STARTS_WITH_NPA_INCLUDE",
- "SURVEY",
- "TRACK_GROUP_ID",
- "TRACK_NUMBER",
- "USERNAME",
- "VISUAL_IVR",
- "VISUAL_IVR_GROUP_ID",
- "WHITELIST_TAG"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "SecurityStrategyView": {
- "properties": {
- "accountIds": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "fullPermission": {
- "type": "boolean"
- },
- "redshiftProducts": {
- "items": {
- "enum": [
- "ACCOUNT",
- "AGENT",
- "AGENT_DISPOSITION",
- "AGENT_EXTERNAL_ID",
- "AGENT_GROUP_ID",
- "AGENT_TEAM",
- "ANI",
- "CALL_ID",
- "CAMPAIGN",
- "CHAT_QUEUE",
- "CHAT_QUEUE_GROUP",
- "CLOUD_DESTINATION",
- "CLOUD_DESTINATION_GROUP_ID",
- "CLOUD_PROFILE",
- "CLOUD_PROFILE_GROUP_ID",
- "DIAL_GROUP",
- "DIAL_TYPE",
- "DNC_TAG",
- "DNIS",
- "GATE",
- "GATE_GROUP",
- "INCLUDE_DIAL_GROUP",
- "INCLUDE_MEDIA",
- "INTERNAL_CHAT",
- "LIST_STATE",
- "LEAD_LIST",
- "OPT_OUT",
- "OUTBOUND_DISPOSITION",
- "ROLLUP_AGENT",
- "SCRIPTING",
- "SCRIPT_GROUP_ID",
- "STARTS_WITH_NPA_EXCLUDE",
- "STARTS_WITH_NPA_INCLUDE",
- "SURVEY",
- "TRACK_GROUP_ID",
- "TRACK_NUMBER",
- "USERNAME",
- "VISUAL_IVR",
- "VISUAL_IVR_GROUP_ID",
- "WHITELIST_TAG"
- ],
- "type": "string"
- },
- "type": "array"
- }
- },
- "required": [
- "accountIds",
- "fullPermission",
- "redshiftProducts"
- ],
- "type": "object"
- },
- "SimplePostgresChild": {
- "properties": {
- "accountId": {
- "format": "int32",
- "type": "integer"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "groupName": {
- "type": "string"
- },
- "objId": {
- "format": "int32",
- "type": "integer"
- },
- "objectName": {
- "type": "string"
- },
- "objectTimestamp": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "SimplePostgresParent": {
- "properties": {
- "accountId": {
- "format": "int32",
- "type": "integer"
- },
- "children": {
- "items": {
- "$ref": "#/components/schemas/SimplePostgresChild"
- },
- "type": "array"
- },
- "filters": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "groupName": {
- "type": "string"
- },
- "objectTimestamp": {
- "format": "int64",
- "type": "integer"
- },
- "product": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "SipFlags": {
- "properties": {
- "dcspVoice": {
- "format": "int32",
- "type": "integer"
- },
- "dscpEnabled": {
- "type": "boolean"
- },
- "dscpSignaling": {
- "format": "int32",
- "type": "integer"
- },
- "dscpVideo": {
- "format": "int32",
- "type": "integer"
- },
- "outboundCallsEnabled": {
- "type": "boolean"
- },
- "voipCountryBlocked": {
- "type": "boolean"
- },
- "voipFeatureEnabled": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "SipInfo": {
- "properties": {
- "authorizationId": {
- "type": "string"
- },
- "domain": {
- "type": "string"
- },
- "outboundProxy": {
- "type": "string"
- },
- "password": {
- "type": "string"
- },
- "transport": {
- "type": "string"
- },
- "username": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "State": {
- "properties": {
- "description": {
- "type": "string"
- },
- "state": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "StateProvince": {
- "properties": {
- "code": {
- "type": "string"
- },
- "searchString": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "SuppressedType": {
- "properties": {
- "name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "Survey": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "active": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "enableTokens": {
- "format": "int32",
- "type": "integer"
- },
- "exportFlag": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "headingCss": {
- "type": "string"
- },
- "lastModified": {
- "$ref": "#/components/schemas/Timestamp"
- },
- "name": {
- "type": "string"
- },
- "submitText": {
- "type": "string"
- },
- "surveyDesc": {
- "type": "string"
- },
- "surveyId": {
- "format": "int32",
- "type": "integer"
- },
- "surveyName": {
- "type": "string"
- },
- "tableCss": {
- "type": "string"
- },
- "textCss": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "SurveyGroup": {
- "properties": {
- "groupName": {
- "type": "string"
- },
- "isDefault": {
- "format": "byte",
- "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "surveyGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "surveys": {
- "$ref": "#/components/schemas/CollectionSurvey"
- }
- },
- "type": "object"
- },
- "TelephonyServerGroup": {
- "properties": {
- "active": {
- "type": "boolean"
- },
- "currentConnections": {
- "format": "int32",
- "type": "integer"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "groupName": {
- "type": "string"
- },
- "groupVendor": {
- "type": "string"
- },
- "isActive": {
- "type": "boolean"
- },
- "maxAgents": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "TimeRange": {
- "properties": {
- "rangeType": {
- "enum": [
- "MINUTE",
- "HOUR",
- "DAY",
- "WEEK",
- "MONTH",
- "YEAR",
- "NOW"
- ],
- "type": "string"
- },
- "rangeValue": {
- "format": "int32",
- "type": "integer"
- },
- "rangeValueValid": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "Timestamp": {
- "properties": {
- "date": {
- "format": "int32",
- "type": "integer"
- },
- "day": {
- "format": "int32",
- "type": "integer"
- },
- "hours": {
- "format": "int32",
- "type": "integer"
- },
- "minutes": {
- "format": "int32",
- "type": "integer"
- },
- "month": {
- "format": "int32",
- "type": "integer"
- },
- "nanos": {
- "format": "int32",
- "type": "integer"
- },
- "seconds": {
- "format": "int32",
- "type": "integer"
- },
- "time": {
- "format": "int64",
- "type": "integer"
- },
- "timezoneOffset": {
- "format": "int32",
- "type": "integer"
- },
- "year": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "Timezone": {
- "properties": {
- "description": {
- "type": "string"
- },
- "name": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "TnManagerSearchCriteria": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "accountIds": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "active": {
- "type": "boolean"
- },
- "assigned": {
- "type": "boolean"
- },
- "assignedSms": {
- "type": "boolean"
- },
- "criteriaType": {
- "enum": [
- "DIALER_RESULT_DOWNLOAD_CRITERIA",
- "GLOBAL_CALL_TYPE_CRITERIA",
- "IVR_DETAIL_CRITERIA",
- "TFN_DID_MANAGER_CRITERIA",
- "ALL_CALLS_CRITERIA",
- "CASPER_CRITERIA"
- ],
- "type": "string"
- },
- "customAppString": {
- "type": "string"
- },
- "databaseTimezone": {
- "type": "string"
- },
- "dnis": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "dnisFilter": {
- "type": "string"
- },
- "endDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "endDateRange": {
- "$ref": "#/components/schemas/TimeRange"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "inboundContext": {
- "type": "string"
- },
- "notes": {
- "type": "string"
- },
- "objectId": {
- "format": "int32",
- "type": "integer"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- },
- "product": {
- "enum": [
- "ACCOUNT",
- "ACD",
- "AGENT",
- "CHAT_QUEUE",
- "OUTBOUND",
- "VISUAL_IVR",
- "CLOUD_PROFILE",
- "CLOUD_DESTINATION",
- "TRAC_NUMBER",
- "HTTP_SERVICES",
- "SCRIPTING",
- "TN_MANAGER",
- "SURVEY",
- "DNIS",
- "TEAMS",
- "KNOWLEDGE_BASE",
- "UTILITIES"
- ],
- "type": "string"
- },
- "scheduleTimezoneName": {
- "type": "string"
- },
- "startDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "startDateRange": {
- "$ref": "#/components/schemas/TimeRange"
- },
- "timezoneName": {
- "type": "string"
- },
- "vendorId": {
- "type": "string"
- },
- "vruNetworkId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "TracGroup": {
- "properties": {
- "groupName": {
- "type": "string"
- },
- "isDefault": {
- "type": "boolean"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "tracGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "tracNumbers": {
- "items": {
- "$ref": "#/components/schemas/TracNumber"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "TracLocation": {
- "properties": {
- "account": {
- "$ref": "#/components/schemas/Account"
- },
- "accountId": {
- "type": "string"
- },
- "address": {
- "type": "string"
- },
- "city": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "destination": {
- "type": "string"
- },
- "isDefault": {
- "type": "boolean"
- },
- "lat": {
- "format": "double",
- "type": "number"
- },
- "locationId": {
- "format": "int32",
- "type": "integer"
- },
- "locator": {
- "$ref": "#/components/schemas/TracLocator"
- },
- "lon": {
- "format": "double",
- "type": "number"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "ringDuration": {
- "format": "int32",
- "type": "integer"
- },
- "state": {
- "type": "string"
- },
- "ttAccept": {
- "type": "boolean"
- },
- "zip": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "TracLocator": {
- "properties": {
- "description": {
- "type": "string"
- },
- "locatorId": {
- "format": "int32",
- "type": "integer"
- },
- "maxDistance": {
- "format": "int32",
- "type": "integer"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "tracLocation": {
- "$ref": "#/components/schemas/CollectionTracLocation"
- }
- },
- "type": "object"
- },
- "TracNumber": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "assignedDnis": {
- "$ref": "#/components/schemas/AssignedDnis"
- },
- "billingCode": {
- "type": "string"
- },
- "billingKey": {
- "type": "string"
- },
- "closeLocatorId": {
- "format": "int32",
- "type": "integer"
- },
- "closeType": {
- "enum": [
- "STANDARD",
- "STANDARD_PARALLEL",
- "LOCATOR"
- ],
- "type": "string"
- },
- "dequeueDelay": {
- "format": "int32",
- "type": "integer"
- },
- "description": {
- "type": "string"
- },
- "endcallMsg": {
- "type": "string"
- },
- "friSched": {
- "type": "string"
- },
- "introMsg": {
- "type": "string"
- },
- "monSched": {
- "type": "string"
- },
- "openLocatorId": {
- "format": "int32",
- "type": "integer"
- },
- "openType": {
- "enum": [
- "STANDARD",
- "STANDARD_PARALLEL",
- "LOCATOR"
- ],
- "type": "string"
- },
- "outboundCallerId": {
- "type": "string"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "postCallSoapService": {
- "$ref": "#/components/schemas/RemoteHttpService"
- },
- "recordCall": {
- "format": "int32",
- "type": "integer"
- },
- "revMatch": {
- "format": "int32",
- "type": "integer"
- },
- "satSched": {
- "type": "string"
- },
- "shortCallTime": {
- "format": "int32",
- "type": "integer"
- },
- "sunSched": {
- "type": "string"
- },
- "surveyId": {
- "format": "int32",
- "type": "integer"
- },
- "thuSched": {
- "type": "string"
- },
- "tracGroup": {
- "$ref": "#/components/schemas/TracGroup"
- },
- "tracId": {
- "format": "int32",
- "type": "integer"
- },
- "tueSched": {
- "type": "string"
- },
- "voicemailEnabled": {
- "format": "int32",
- "type": "integer"
- },
- "wedSched": {
- "type": "string"
- },
- "whisperMsg": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "TracNumberSkinny": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "tracGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "tracId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "TracRoutingRule": {
- "properties": {
- "description": {
- "type": "string"
- },
- "destination": {
- "type": "string"
- },
- "openRule": {
- "type": "boolean"
- },
- "parallelDelay": {
- "format": "int32",
- "type": "integer"
- },
- "rank": {
- "format": "int32",
- "type": "integer"
- },
- "ringDuration": {
- "format": "int32",
- "type": "integer"
- },
- "ruleId": {
- "format": "int32",
- "type": "integer"
- },
- "ruleType": {
- "enum": [
- "STANDARD",
- "STANDARD_SIP",
- "ENCRYPTED_SIP",
- "GATE_XFER",
- "TRAC_XFER",
- "IN_NETWORK",
- "VIVR"
- ],
- "type": "string"
- },
- "tracNumber": {
- "$ref": "#/components/schemas/TracNumber"
- },
- "ttAccept": {
- "type": "boolean"
- },
- "xferGateId": {
- "format": "int32",
- "type": "integer"
- },
- "xferTracId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "TracScheduleOverride": {
- "properties": {
- "overrideClosedEvent": {
- "type": "string"
- },
- "overrideDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "overrideLabel": {
- "type": "string"
- },
- "overrideSched": {
- "type": "string"
- },
- "scheduleOverrideId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "UniqueAgentResponse": {
- "properties": {
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "ani": {
- "type": "string"
- },
- "dnis": {
- "type": "string"
- },
- "dnisE164": {
- "type": "string"
- },
- "firstName": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "uii": {
- "type": "string"
- },
- "username": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "UpdateAgentLoginDialGroupResponse": {
- "properties": {
- "agentId": {
- "format": "int32",
- "type": "integer"
- },
- "agentName": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "success": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "UpdatePhoneNumbersI18nRequest": {
- "properties": {
- "enablePhoneNumbersI18n": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "UploadLeadsRequest": {
- "properties": {
- "description": {
- "type": "string"
- },
- "dialPriority": {
- "description": "Setting this to `IMMEDIATE` allows you to insert a lead to the top of the dialer cache for immediate dialing if you want a normal insert then do not add this parameter.",
- "enum": [
- "IMMEDIATE",
- "NORMAL"
- ],
- "type": "string"
- },
- "duplicateHandling": {
- "enum": [
- "RETAIN_ALL",
- "REMOVE_ALL_EXISTING",
- "REMOVE_FROM_LIST"
- ],
- "type": "string"
- },
- "listState": {
- "enum": [
- "ACTIVE"
- ],
- "type": "string"
- },
- "timeZoneOption": {
- "enum": [
- "NPA_NXX",
- "ZIPCODE",
- "EXPLICIT"
- ],
- "type": "string"
- },
- "uploadLeads": {
- "items": {
- "$ref": "#/components/schemas/CampaignLead"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "UploadLeadsResponse": {
- "properties": {
- "deletedCount": {
- "format": "int32",
- "type": "integer"
- },
- "dncReturnedCount": {
- "format": "int32",
- "type": "integer"
- },
- "dncUploadCount": {
- "format": "int32",
- "type": "integer"
- },
- "hasDeletedLeads": {
- "type": "boolean"
- },
- "internalDncCount": {
- "format": "int32",
- "type": "integer"
- },
- "leadsAccepted": {
- "format": "int32",
- "type": "integer"
- },
- "leadsConverted": {
- "format": "int32",
- "type": "integer"
- },
- "leadsInserted": {
- "format": "int32",
- "type": "integer"
- },
- "leadsSupplied": {
- "format": "int32",
- "type": "integer"
- },
- "listState": {
- "type": "string"
- },
- "message": {
- "description": "Values can be `Your uploaded lead list has successfully completed processing` or `Your uploaded lead list file processing has failed`",
- "type": "string"
- },
- "processingResult": {
- "description": "Values can be `OK` or `Failed`",
- "type": "string"
- },
- "processingStatus": {
- "description": "Values can be `DEFAULT_NOT_A_FAILURE` or `GENERAL_FAILURE`",
- "type": "string"
- },
- "quotaCount": {
- "format": "int32",
- "type": "integer"
- },
- "timeZoneOption": {
- "type": "string"
- },
- "uploadFileName": {
- "type": "string"
- },
- "whitelistCount": {
- "format": "int32",
- "type": "integer"
- }
- },
- "required": [
- "message",
- "leadsSupplied",
- "leadsConverted",
- "leadsAccepted",
- "leadsInserted",
- "internalDncCount",
- "dncUploadCount",
- "dncReturnedCount",
- "whitelistCount",
- "uploadFileName",
- "deletedCount",
- "quotaCount",
- "listState",
- "timeZoneOption",
- "hasDeletedLeads",
- "processingResult",
- "processingStatus"
- ],
- "type": "object"
- },
- "User": {
- "properties": {
- "children": {
- "items": {
- "$ref": "#/components/schemas/User"
- },
- "type": "array"
- },
- "creationDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "enabled": {
- "type": "boolean"
- },
- "firstName": {
- "type": "string"
- },
- "fullName": {
- "type": "string"
- },
- "lastName": {
- "type": "string"
- },
- "parentPath": {
- "type": "string"
- },
- "phoneNumber": {
- "type": "string"
- },
- "phoneNumberE164": {
- "type": "string"
- },
- "phoneNumbersI18nEnabled": {
- "type": "boolean"
- },
- "rcAccountId": {
- "type": "string"
- },
- "rcUserId": {
- "format": "int64",
- "type": "integer"
- },
- "regionalSettings": {
- "$ref": "#/components/schemas/RegionalSettingRequestResponse"
- },
- "roles": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Role"
- }
- },
- "rootUser": {
- "type": "boolean"
- },
- "userId": {
- "format": "int32",
- "type": "integer"
- },
- "userManagedByRC": {
- "type": "boolean"
- },
- "userName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "UserDetailsResult": {
- "properties": {
- "adminId": {
- "format": "int32",
- "type": "integer"
- },
- "agentDetails": {
- "items": {
- "$ref": "#/components/schemas/AgentDetailsResult"
- },
- "type": "array"
- },
- "flr": {
- "type": "boolean"
- },
- "iqUrl": {
- "type": "string"
- },
- "loginHashcode": {
- "type": "string"
- },
- "mainAccountId": {
- "type": "string"
- },
- "managedMainAccountIds": {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "port": {
- "format": "int32",
- "type": "integer"
- },
- "rcAccountId": {
- "format": "int64",
- "type": "integer"
- },
- "rcUserId": {
- "format": "int64",
- "type": "integer"
- },
- "regionalSettings": {
- "$ref": "#/components/schemas/RegionalSettingRequestResponse"
- },
- "xAuthToken": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "UserLoginView": {
- "properties": {
- "accounts": {
- "items": {
- "$ref": "#/components/schemas/AccountView"
- },
- "type": "array"
- },
- "authToken": {
- "type": "string"
- },
- "platformHost": {
- "type": "string"
- },
- "user": {
- "$ref": "#/components/schemas/User"
- }
- },
- "type": "object"
- },
- "ValidationErrorData": {
- "properties": {
- "attributeName": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "value": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "VisualIvr": {
- "properties": {
- "account": {
- "$ref": "#/components/schemas/Account"
- },
- "debug": {
- "type": "boolean"
- },
- "debugEmail": {
- "type": "string"
- },
- "isActive": {
- "type": "boolean"
- },
- "isDeleted": {
- "type": "boolean"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "reportConfig": {
- "type": "string"
- },
- "version": {
- "format": "int32",
- "type": "integer"
- },
- "visualIvrDesc": {
- "type": "string"
- },
- "visualIvrGroup": {
- "$ref": "#/components/schemas/VisualIvrGroup"
- },
- "visualIvrId": {
- "format": "int32",
- "type": "integer"
- },
- "visualIvrName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "VisualIvrConfig": {
- "properties": {
- "account": {
- "$ref": "#/components/schemas/Account"
- },
- "data": {
- "type": "string"
- },
- "visualIvrDesc": {
- "type": "string"
- },
- "visualIvrId": {
- "format": "int32",
- "type": "integer"
- },
- "visualIvrName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "VisualIvrGroup": {
- "properties": {
- "groupName": {
- "type": "string"
- },
- "isDefault": {
- "type": "boolean"
- },
- "ivrGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "permissions": {
- "items": {
- "enum": [
- "CREATE",
- "READ",
- "UPDATE",
- "DELETE",
- "REPORT"
- ],
- "type": "string"
- },
- "type": "array"
- },
- "visualIvrs": {
- "$ref": "#/components/schemas/CollectionVisualIvr"
- }
- },
- "type": "object"
- },
- "VisualIvrSkinny": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "groupId": {
- "format": "int32",
- "type": "integer"
- },
- "isActive": {
- "type": "boolean"
- },
- "isDeleted": {
- "type": "boolean"
- },
- "visualIvrDesc": {
- "type": "string"
- },
- "visualIvrGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "visualIvrId": {
- "format": "int32",
- "type": "integer"
- },
- "visualIvrName": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "WFM": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "wfmType": {
- "enum": [
- "GENERIC",
- "GENERIC_UDP",
- "ASPECT",
- "AC2",
- "PIPKINS",
- "MONET",
- "NONE"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "WhitelistEntry": {
- "properties": {
- "addedBy": {
- "type": "string"
- },
- "addedDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "expireDate": {
- "$ref": "#/components/schemas/DateTime"
- },
- "isIntl": {
- "type": "boolean"
- },
- "notes": {
- "type": "string"
- },
- "phone": {
- "type": "string"
- },
- "whitelistTag": {
- "$ref": "#/components/schemas/WhitelistTag"
- },
- "whitelistTagId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "WhitelistTag": {
- "properties": {
- "accountId": {
- "type": "string"
- },
- "addedBy": {
- "type": "string"
- },
- "addedDts": {
- "$ref": "#/components/schemas/DateTime"
- },
- "tag": {
- "type": "string"
- },
- "whitelistTagId": {
- "format": "int32",
- "type": "integer"
- },
- "wlTagId": {
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "WhitelistTagMembers": {
- "properties": {
- "campaign": {
- "$ref": "#/components/schemas/Campaign"
- },
- "campaignId": {
- "format": "int32",
- "type": "integer"
- },
- "whitelistTag": {
- "$ref": "#/components/schemas/WhitelistTag"
- }
- },
- "type": "object"
- },
- "WsdlDefinition": {
- "properties": {
- "operations": {
- "items": {
- "$ref": "#/components/schemas/Operation"
- },
- "type": "array"
- },
- "serviceName": {
- "type": "string"
- }
+ "description": "gate",
+ "required": true
+ },
+ "GateDisposition": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateDisposition"
+ }
+ }
+ },
+ "description": "gateDisposition",
+ "required": true
+ },
+ "GateGroup": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateGroup"
+ }
+ }
+ },
+ "description": "gateGroup",
+ "required": true
+ },
+ "GateGroupSkill": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateGroupSkill"
+ }
+ }
+ },
+ "description": "skill",
+ "required": true
+ },
+ "GateQueueDtmfEvent": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateQueueDtmfEvent"
+ }
+ }
+ },
+ "description": "postPayload",
+ "required": true
+ },
+ "GateQueueEvent": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateQueueEvent"
+ }
+ }
+ },
+ "description": "queueEvent",
+ "required": true
+ },
+ "GateScheduleOverride": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateScheduleOverride"
+ }
+ }
+ },
+ "description": "scheduleOverride",
+ "required": true
+ },
+ "PhoneBookEntry": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PhoneBookEntry"
+ }
+ }
+ },
+ "description": "entry",
+ "required": true
+ }
+ },
+ "schemas": {
+ "AccessTokenUserDetails": {
+ "properties": {
+ "accessToken": {
+ "type": "string"
+ },
+ "adminId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "adminPasswordReset": {
+ "type": "boolean"
+ },
+ "adminUrl": {
+ "type": "string"
+ },
+ "agentDetails": {
+ "items": {
+ "$ref": "#/components/schemas/AgentV2"
+ },
+ "type": "array"
+ },
+ "agentUrl": {
+ "type": "string"
+ },
+ "analyticsUrl": {
+ "type": "string"
+ },
+ "iqUrl": {
+ "type": "string"
+ },
+ "isAdminPasswordReset": {
+ "type": "boolean"
+ },
+ "loginHashcode": {
+ "type": "string"
+ },
+ "mainAccountId": {
+ "type": "string"
+ },
+ "platformId": {
+ "type": "string"
+ },
+ "port": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "rcUser": {
+ "$ref": "#/components/schemas/Contact"
+ },
+ "redirectUrl": {
+ "type": "string"
+ },
+ "refreshToken": {
+ "type": "string"
+ },
+ "ssoLogin": {
+ "type": "boolean"
+ },
+ "tokenType": {
+ "type": "string"
+ }
+ },
+ "title": "AccessTokenUserDetails",
+ "type": "object"
+ },
+ "Account": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "accountName": {
+ "type": "string"
+ },
+ "amdDefaultProfile": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "archivedAccount": {
+ "type": "boolean"
+ },
+ "audioRetentionDays": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "concurrentLogins": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "crmHost": {
+ "type": "string"
+ },
+ "crmInstance": {
+ "type": "string"
+ },
+ "crmPwd": {
+ "type": "string"
+ },
+ "crmUid": {
+ "type": "string"
+ },
+ "dataRetentionDays": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "databaseShardId": {
+ "type": "string"
+ },
+ "defaultCallerid": {
+ "type": "string"
+ },
+ "defaultHold": {
+ "type": "string"
+ },
+ "defaultIntellidialServerId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "defaultOutdialServerGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dncOrgId": {
+ "type": "string"
+ },
+ "dncOrgIdConfirmed": {
+ "type": "boolean"
+ },
+ "emailFromAddress": {
+ "type": "string"
+ },
+ "enable247Dialing": {
+ "type": "boolean"
+ },
+ "enableAgentRankRouting": {
+ "type": "boolean"
+ },
+ "enableAmdProfiles": {
+ "type": "boolean"
+ },
+ "enableBlankCallerid": {
+ "type": "boolean"
+ },
+ "enableCallEventTracking": {
+ "type": "boolean"
+ },
+ "enableCellScrubbing": {
+ "type": "boolean"
+ },
+ "enableCentralizedData": {
+ "type": "boolean"
+ },
+ "enableChat": {
+ "type": "boolean"
+ },
+ "enableCloudRouting": {
+ "type": "boolean"
+ },
+ "enableCorporateDirectory": {
+ "type": "boolean"
+ },
+ "enableCrmExport": {
+ "type": "boolean"
+ },
+ "enableFifo": {
+ "type": "boolean"
+ },
+ "enableFolderMode": {
+ "type": "boolean"
+ },
+ "enableForceLegacy": {
+ "type": "boolean"
+ },
+ "enableGoodData": {
+ "type": "boolean"
+ },
+ "enableHciDialer": {
+ "type": "boolean"
+ },
+ "enableInbound": {
+ "type": "boolean"
+ },
+ "enableIntlOutbound": {
+ "type": "boolean"
+ },
+ "enableListLoading": {
+ "type": "boolean"
+ },
+ "enableMultiuser": {
+ "type": "boolean"
+ },
+ "enableOutbound": {
+ "type": "boolean"
+ },
+ "enableOutboundPredictive": {
+ "type": "boolean"
+ },
+ "enableScheduledTasks": {
+ "type": "boolean"
+ },
+ "enableSoftphones": {
+ "type": "boolean"
+ },
+ "enableTaskMode": {
+ "type": "boolean"
+ },
+ "enableTcpaSafeMachineDetect": {
+ "type": "boolean"
+ },
+ "enableTracking": {
+ "type": "boolean"
+ },
+ "enableVisualIvr": {
+ "type": "boolean"
+ },
+ "enableVoiceBroadcast": {
+ "type": "boolean"
+ },
+ "endDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "ftpHost": {
+ "type": "string"
+ },
+ "ftpPwd": {
+ "type": "string"
+ },
+ "ftpUid": {
+ "type": "string"
+ },
+ "ivrAppsEnabled": {
+ "type": "boolean"
+ },
+ "mainAccount": {
+ "$ref": "#/components/schemas/MainAccount"
+ },
+ "mainAccountId": {
+ "type": "string"
+ },
+ "mainAccountName": {
+ "type": "string"
+ },
+ "maxBreakTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxLunchTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxOutPortsPerAgent": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "minimumSec": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "notificationEmail": {
+ "type": "string"
+ },
+ "offHookHold": {
+ "type": "string"
+ },
+ "offHookWhisper": {
+ "type": "string"
+ },
+ "offHookWhisperGhost": {
+ "type": "string"
+ },
+ "offhookCallerid": {
+ "type": "string"
+ },
+ "outboundManualDefaultRingtime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "outboundPrepay": {
+ "type": "boolean"
+ },
+ "overrideDispositions": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "pciCompliance": {
+ "type": "boolean"
+ },
+ "pciComplianceRequest": {
+ "type": "boolean"
+ },
+ "phoneRecordingPin": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "primaryTimezone": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "rcAccountAccess": {
+ "enum": [
+ "DISABLED",
+ "ENABLED",
+ "REQUIRED"
+ ],
+ "type": "string"
+ },
+ "recordingAccessMode": {
+ "enum": [
+ "ANONYMOUS",
+ "ACCOUNT",
+ "RIGHTS_DOC",
+ "DISABLED"
+ ],
+ "type": "string"
+ },
+ "recordingFilenameFormat": {
+ "type": "string"
+ },
+ "recordingsDelivery": {
+ "type": "string"
+ },
+ "rounding": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "securityKey": {
+ "type": "string"
+ },
+ "softphoneHost": {
+ "type": "string"
+ },
+ "softphoneWsdl": {
+ "type": "string"
+ },
+ "startDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "tcpaSafeMode": {
+ "type": "boolean"
+ },
+ "usePowerBy": {
+ "type": "boolean"
+ },
+ "weekOffset": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "wfmType": {
+ "enum": [
+ "GENERIC",
+ "GENERIC_UDP",
+ "ASPECT",
+ "AC2",
+ "PIPKINS",
+ "MONET",
+ "NONE"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountAuxState": {
+ "properties": {
+ "agentAuxState": {
+ "type": "string"
+ },
+ "baseAgentState": {
+ "$ref": "#/components/schemas/BaseAgentState"
+ },
+ "description": {
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "isAgentSelectable": {
+ "type": "boolean"
+ },
+ "isRequired": {
+ "type": "boolean"
+ },
+ "rank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "stateId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AccountCallerId": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "callerId": {
+ "type": "string"
+ },
+ "callerIdId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AccountCreationRequest": {
+ "properties": {
+ "accountName": {
+ "type": "string"
+ },
+ "databaseShardId": {
+ "type": "string"
+ },
+ "defaultIntellidialServerId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "defaultOutdialServerGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "mainAccountId": {
+ "type": "string"
+ },
+ "pciCompliance": {
+ "type": "boolean"
+ },
+ "tcpaSafeMode": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "accountName",
+ "databaseShardId",
+ "defaultIntellidialServerId",
+ "defaultOutdialServerGroupId",
+ "mainAccountId",
+ "pciCompliance",
+ "tcpaSafeMode"
+ ],
+ "type": "object"
+ },
+ "AccountIntegrationBase": {
+ "properties": {
+ "_type": {
+ "type": "string"
+ },
+ "accountId": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "integrationType": {
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AccountPrepayProfile": {
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/Account"
+ },
+ "accountId": {
+ "type": "string"
+ },
+ "agent": {
+ "format": "double",
+ "type": "number"
+ },
+ "agentVoip": {
+ "format": "double",
+ "type": "number"
+ },
+ "inbound": {
+ "format": "double",
+ "type": "number"
+ },
+ "inboundTf": {
+ "format": "double",
+ "type": "number"
+ },
+ "machineMsgs": {
+ "format": "double",
+ "type": "number"
+ },
+ "monitoring": {
+ "format": "double",
+ "type": "number"
+ },
+ "offHook": {
+ "format": "double",
+ "type": "number"
+ },
+ "offHookVoip": {
+ "format": "double",
+ "type": "number"
+ },
+ "outbound": {
+ "format": "double",
+ "type": "number"
+ },
+ "transfer": {
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object"
+ },
+ "AccountSkillStats": {
+ "properties": {
+ "accountId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "accountName": {
+ "type": "string"
+ },
+ "availableCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "onlineCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "skillName": {
+ "type": "string"
+ },
+ "staffedCount": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AccountView": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "accountName": {
+ "type": "string"
+ },
+ "databaseShardId": {
+ "type": "string"
+ },
+ "defaultIntellidialServerId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "defaultOutdialServerGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "emailFromAddress": {
+ "type": "string"
+ },
+ "enable247Dialing": {
+ "type": "boolean"
+ },
+ "enableAgentRankRouting": {
+ "type": "boolean"
+ },
+ "enableAmdProfiles": {
+ "type": "boolean"
+ },
+ "enableChat": {
+ "type": "boolean"
+ },
+ "enableCloudRouting": {
+ "type": "boolean"
+ },
+ "enableFifo": {
+ "type": "boolean"
+ },
+ "enableFolderMode": {
+ "type": "boolean"
+ },
+ "enableGoodData": {
+ "type": "boolean"
+ },
+ "enableHciDialer": {
+ "type": "boolean"
+ },
+ "enableInbound": {
+ "type": "boolean"
+ },
+ "enableMultiUser": {
+ "type": "boolean"
+ },
+ "enableOutbound": {
+ "type": "boolean"
+ },
+ "enableSoftphones": {
+ "type": "boolean"
+ },
+ "enableTaskMode": {
+ "type": "boolean"
+ },
+ "enableTcpaSafeMachineDetect": {
+ "type": "boolean"
+ },
+ "enableTracking": {
+ "type": "boolean"
+ },
+ "enableVisualIvr": {
+ "type": "boolean"
+ },
+ "enableVoiceBroadcast": {
+ "type": "boolean"
+ },
+ "engageAccountId": {
+ "type": "string"
+ },
+ "ivrAppsEnabled": {
+ "type": "boolean"
+ },
+ "mainAccountId": {
+ "type": "string"
+ },
+ "mainAccountName": {
+ "type": "string"
+ },
+ "outboundPrepay": {
+ "type": "boolean"
+ },
+ "rcAccountAccess": {
+ "enum": [
+ "DISABLED",
+ "ENABLED",
+ "REQUIRED"
+ ],
+ "type": "string"
+ },
+ "rcAccountId": {
+ "type": "string"
+ },
+ "tcpaSafeMode": {
+ "type": "boolean"
+ },
+ "usePowerBy": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AcdStats": {
+ "properties": {
+ "abandoned": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "accepted": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "accountId": {
+ "type": "string"
+ },
+ "active": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "available": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "deflected": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gateGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gateId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gateName": {
+ "type": "string"
+ },
+ "groupName": {
+ "type": "string"
+ },
+ "inQueue": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "lastUpdate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "longCall": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "longestInQueue": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "presented": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "routing": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "schedule": {
+ "type": "string"
+ },
+ "scheduleOverride": {
+ "type": "string"
+ },
+ "selectable": {
+ "type": "boolean"
+ },
+ "shortAbandon": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "shortCall": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "slaFail": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "slaPass": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "staffed": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "successDispositions": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalAbandonTime": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "totalAnswerTime": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "totalQueueTime": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "totalTalkTime": {
+ "format": "int64",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ActiveCall": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "activeCallSessions": {
+ "items": {
+ "$ref": "#/components/schemas/ActiveCallSession"
+ },
+ "type": "array"
+ },
+ "agentDisposition": {
+ "type": "string"
+ },
+ "ani": {
+ "type": "string"
+ },
+ "archive": {
+ "type": "boolean"
+ },
+ "auxPhone": {
+ "type": "string"
+ },
+ "billingKey": {
+ "type": "string"
+ },
+ "callFinalResult": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "callState": {
+ "type": "string"
+ },
+ "callType": {
+ "type": "string"
+ },
+ "campaign": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "campaignLead": {
+ "$ref": "#/components/schemas/CampaignLead"
+ },
+ "cloudProfileId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "currDequeueEventId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dequeueAgentSession": {
+ "$ref": "#/components/schemas/ActiveCallSession"
+ },
+ "dequeueAttempts": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dequeueTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "dialType": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialerSourceKey": {
+ "type": "string"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "dnisE164": {
+ "type": "string"
+ },
+ "enqueueTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "extraUrlData": {
+ "type": "string"
+ },
+ "gate": {
+ "$ref": "#/components/schemas/Gate"
+ },
+ "iqServerId": {
+ "type": "string"
+ },
+ "isLongCall": {
+ "type": "boolean"
+ },
+ "isShortAbandon": {
+ "type": "boolean"
+ },
+ "isShortCall": {
+ "type": "boolean"
+ },
+ "nextDequeueTime": {
+ "$ref": "#/components/schemas/Timestamp"
+ },
+ "nextSessionId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "optOut": {
+ "type": "boolean"
+ },
+ "originatingDnis": {
+ "type": "string"
+ },
+ "outboundDisposition": {
+ "type": "string"
+ },
+ "outboundExternid": {
+ "type": "string"
+ },
+ "primarySession": {
+ "$ref": "#/components/schemas/ActiveCallSession"
+ },
+ "priorityQueueEvent": {
+ "type": "string"
+ },
+ "recordingDeleted": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "recordingUrl": {
+ "type": "string"
+ },
+ "safeArchiveDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "skillOverride": {
+ "type": "string"
+ },
+ "slaPassed": {
+ "type": "boolean"
+ },
+ "slaQualified": {
+ "type": "boolean"
+ },
+ "sourceAppId": {
+ "type": "string"
+ },
+ "tracId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "uii": {
+ "type": "string"
+ },
+ "visualIvrId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "vruSourceKey": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ActiveCallEventHistory": {
+ "properties": {
+ "ani": {
+ "type": "string"
+ },
+ "callEventDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "callEventId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "callEventType": {
+ "type": "string"
+ },
+ "destDnis": {
+ "type": "string"
+ },
+ "destDnisE164": {
+ "type": "string"
+ },
+ "destId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "destName": {
+ "type": "string"
+ },
+ "destType": {
+ "enum": [
+ "CLOUD-PROFILE",
+ "CLOUD-DESTINATION",
+ "GATE",
+ "TRAC",
+ "CAMPAIGN",
+ "AGENT",
+ "IVR",
+ "VIVR"
+ ],
+ "type": "string"
+ },
+ "destUii": {
+ "type": "string"
+ },
+ "dtmfTrap": {
+ "type": "string"
+ },
+ "eventLog": {
+ "type": "string"
+ },
+ "origDnis": {
+ "type": "string"
+ },
+ "origDnisE164": {
+ "type": "string"
+ },
+ "origId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "origName": {
+ "type": "string"
+ },
+ "origType": {
+ "enum": [
+ "CLOUD-PROFILE",
+ "CLOUD-DESTINATION",
+ "GATE",
+ "TRAC",
+ "CAMPAIGN",
+ "AGENT",
+ "IVR",
+ "VIVR"
+ ],
+ "type": "string"
+ },
+ "origUii": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ActiveCallHistory": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "activeCallEventHistories": {
+ "items": {
+ "$ref": "#/components/schemas/ActiveCallEventHistory"
+ },
+ "type": "array"
+ },
+ "activeCallSessionHistories": {
+ "items": {
+ "$ref": "#/components/schemas/ActiveCallSessionHistory"
+ },
+ "type": "array"
+ },
+ "agentDisposition": {
+ "type": "string"
+ },
+ "agentNameAndType": {
+ "$ref": "#/components/schemas/AgentNameAndType"
+ },
+ "ani": {
+ "type": "string"
+ },
+ "archive": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "auxPhone": {
+ "type": "string"
+ },
+ "billingKey": {
+ "type": "string"
+ },
+ "callFinalResult": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "callState": {
+ "type": "string"
+ },
+ "callType": {
+ "type": "string"
+ },
+ "currDequeueEventId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dequeueAttempts": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dequeueTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "dialType": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialTypeString": {
+ "type": "string"
+ },
+ "dialerSourceKey": {
+ "type": "string"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "dnisE164": {
+ "type": "string"
+ },
+ "enqueueTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "extraUrlData": {
+ "type": "string"
+ },
+ "historySource": {
+ "$ref": "#/components/schemas/HistorySource"
+ },
+ "iqServerId": {
+ "type": "string"
+ },
+ "isLongCall": {
+ "type": "boolean"
+ },
+ "isShortAbandon": {
+ "type": "boolean"
+ },
+ "isShortCall": {
+ "type": "boolean"
+ },
+ "leadId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "nextDequeueTime": {
+ "$ref": "#/components/schemas/Timestamp"
+ },
+ "nextSessionId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "optOut": {
+ "type": "boolean"
+ },
+ "originatingDnis": {
+ "type": "string"
+ },
+ "outboundDisposition": {
+ "type": "string"
+ },
+ "outboundExternid": {
+ "type": "string"
+ },
+ "priorityQueueEvent": {
+ "type": "string"
+ },
+ "recordingDeleted": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "recordingUrl": {
+ "type": "string"
+ },
+ "safeArchiveDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "scriptResult": {
+ "type": "string"
+ },
+ "skillOverride": {
+ "type": "string"
+ },
+ "slaPassed": {
+ "type": "boolean"
+ },
+ "slaQualified": {
+ "type": "boolean"
+ },
+ "sourceAppId": {
+ "type": "string"
+ },
+ "uii": {
+ "type": "string"
+ },
+ "vruSourceKey": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ActiveCallListResponse": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "agentFirstName": {
+ "type": "string"
+ },
+ "agentLastName": {
+ "type": "string"
+ },
+ "ani": {
+ "type": "string"
+ },
+ "archive": {
+ "type": "boolean"
+ },
+ "callState": {
+ "type": "string"
+ },
+ "cnam": {
+ "type": "string"
+ },
+ "dequeueTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "destinationName": {
+ "type": "string"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "dnisE164": {
+ "type": "string"
+ },
+ "enqueueTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "externalId": {
+ "type": "string"
+ },
+ "uii": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ActiveCallSession": {
+ "properties": {
+ "agentDisposition": {
+ "type": "string"
+ },
+ "agentLogin": {
+ "$ref": "#/components/schemas/AgentLogin"
+ },
+ "agentNotes": {
+ "type": "string"
+ },
+ "archive": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "callDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "callerName": {
+ "type": "string"
+ },
+ "carrier": {
+ "type": "string"
+ },
+ "cloudDestinationId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialDisposition": {
+ "type": "string"
+ },
+ "dialDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "dialDuration": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "duration": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "iqServerId": {
+ "type": "string"
+ },
+ "isDequeueAgent": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isMonitoring": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "onHold": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "phone": {
+ "type": "string"
+ },
+ "pk": {
+ "$ref": "#/components/schemas/ActiveCallSessionPK"
+ },
+ "recordingUrl": {
+ "type": "string"
+ },
+ "safeArchiveDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "sessionId": {
+ "type": "string"
+ },
+ "sessionType": {
+ "type": "string"
+ },
+ "skillProfileId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "termParty": {
+ "type": "string"
+ },
+ "termReason": {
+ "type": "string"
+ },
+ "transferFlag": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "wrapTime": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ActiveCallSessionHistory": {
+ "properties": {
+ "agentLoginId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentNotes": {
+ "type": "string"
+ },
+ "archive": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "callDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "callerName": {
+ "type": "string"
+ },
+ "carrier": {
+ "type": "string"
+ },
+ "cloudDestinationId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialDisposition": {
+ "type": "string"
+ },
+ "dialDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "dialDuration": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "duration": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "iqServerId": {
+ "type": "string"
+ },
+ "isDequeueAgent": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isMonitoring": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "onHold": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "phone": {
+ "type": "string"
+ },
+ "pk": {
+ "$ref": "#/components/schemas/ActiveCallSessionPK"
+ },
+ "recordingUrl": {
+ "type": "string"
+ },
+ "safeArchiveDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "sessionId": {
+ "type": "string"
+ },
+ "sessionType": {
+ "type": "string"
+ },
+ "skillProfileId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "termParty": {
+ "type": "string"
+ },
+ "termReason": {
+ "type": "string"
+ },
+ "transferFlag": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "wrapTime": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ActiveCallSessionPK": {
+ "properties": {
+ "sessionId": {
+ "type": "string"
+ },
+ "uii": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ActiveCallUniqueId": {
+ "properties": {
+ "ani": {
+ "type": "string"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "dnisE164": {
+ "type": "string"
+ },
+ "originatingDnis": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ActiveChat": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "activeChatSessions": {
+ "items": {
+ "$ref": "#/components/schemas/ActiveChatSession"
+ },
+ "type": "array"
+ },
+ "agentDisposition": {
+ "type": "string"
+ },
+ "ani": {
+ "type": "string"
+ },
+ "archive": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "billingKey": {
+ "type": "string"
+ },
+ "browserInfo": {
+ "type": "string"
+ },
+ "channelType": {
+ "type": "string"
+ },
+ "chatQueueId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatState": {
+ "enum": [
+ "CHAT_PREQUEUED",
+ "CHAT_QUEUED",
+ "CHAT_DEQUEUE_1",
+ "CHAT_DEQUEUE_2",
+ "CHAT_ACTIVE",
+ "CHAT_COMPLETED",
+ "CHAT_PQUEUED",
+ "CHAT_END",
+ "CHAT_IP_BLOCKED",
+ "CHAT_QUEUE_CLOSED",
+ "CHAT_NO_AGENTS",
+ "CHAT_MAX_QUEUE",
+ "CHAT_THROTTLE",
+ "CHAT_DISCONNECT"
+ ],
+ "type": "string"
+ },
+ "currDequeueEventId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dequeueAgentSession": {
+ "$ref": "#/components/schemas/ActiveChatSession"
+ },
+ "dequeueAttempts": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dequeueTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "dnisE164": {
+ "type": "string"
+ },
+ "enqueueTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "jsonBaggage": {
+ "type": "string"
+ },
+ "nextDequeueTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "safeArchiveDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "skillOverride": {
+ "type": "string"
+ },
+ "sourceIp": {
+ "type": "string"
+ },
+ "uii": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ActiveChatSession": {
+ "properties": {
+ "agentDisposition": {
+ "type": "string"
+ },
+ "agentLogin": {
+ "$ref": "#/components/schemas/AgentLogin"
+ },
+ "agentNotes": {
+ "type": "string"
+ },
+ "archive": {
+ "type": "boolean"
+ },
+ "dequeueAgent": {
+ "type": "boolean"
+ },
+ "iqServerId": {
+ "type": "string"
+ },
+ "isDequeueAgent": {
+ "type": "boolean"
+ },
+ "safeArchiveDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "sessionEnd": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "sessionId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "sessionStart": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "sessionType": {
+ "type": "string"
+ },
+ "skillProfileId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "termParty": {
+ "type": "string"
+ },
+ "termReason": {
+ "type": "string"
+ },
+ "uii": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ActiveState_boolean_": {
+ "properties": {
+ "isActive": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ActiveStateboolean": {
+ "properties": {
+ "isActive": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ActiveStateint": {
+ "properties": {
+ "isActive": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AdminUserRequest": {
+ "properties": {
+ "children": {
+ "items": {
+ "$ref": "#/components/schemas/User"
+ },
+ "type": "array"
+ },
+ "creationDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "fullName": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "parentPath": {
+ "type": "string"
+ },
+ "phoneNumber": {
+ "type": "string"
+ },
+ "phoneNumberE164": {
+ "type": "string"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ },
+ "rcAccountId": {
+ "type": "string"
+ },
+ "rcUserId": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "regionalSettings": {
+ "$ref": "#/components/schemas/RegionalSettingRequestResponse"
+ },
+ "roles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Role"
+ }
+ },
+ "rootUser": {
+ "type": "boolean"
+ },
+ "userId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "userManagedByRC": {
+ "type": "boolean"
+ },
+ "userName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Agent": {
+ "properties": {
+ "accountAccess": {
+ "$ref": "#/components/schemas/CollectionAgentAccountAccess"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "agentAccountAccess": {
+ "items": {
+ "$ref": "#/components/schemas/AgentAccountAccess"
+ },
+ "type": "array"
+ },
+ "agentChatGroupAccess": {
+ "items": {
+ "$ref": "#/components/schemas/AgentChatGroupAccess"
+ },
+ "type": "array"
+ },
+ "agentChatQueueAccesses": {
+ "$ref": "#/components/schemas/CollectionAgentChatQueueAccess"
+ },
+ "agentDialGroupMembers": {
+ "$ref": "#/components/schemas/CollectionAgentDialGroupMember"
+ },
+ "agentGateAccess": {
+ "$ref": "#/components/schemas/CollectionAgentGateAccess"
+ },
+ "agentGateGroupAccess": {
+ "items": {
+ "$ref": "#/components/schemas/AgentGateGroupAccess"
+ },
+ "type": "array"
+ },
+ "agentGroup": {
+ "$ref": "#/components/schemas/AgentGroup"
+ },
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentLoadBalance": {
+ "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember"
+ },
+ "agentLoadBalanceMembers": {
+ "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember"
+ },
+ "agentRank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentSkillProfiles": {
+ "$ref": "#/components/schemas/CollectionAgentSkillProfile"
+ },
+ "agentType": {
+ "enum": [
+ "AGENT",
+ "SUPERVISOR",
+ "MULTI_USER",
+ "MULTI_SUPERVISOR"
+ ],
+ "type": "string"
+ },
+ "allowAgentReports": {
+ "type": "boolean"
+ },
+ "allowAgentStats": {
+ "type": "boolean"
+ },
+ "allowAutoAnswer": {
+ "type": "boolean"
+ },
+ "allowBlended": {
+ "type": "boolean"
+ },
+ "allowCallControl": {
+ "type": "boolean"
+ },
+ "allowCampStats": {
+ "type": "boolean"
+ },
+ "allowChat": {
+ "type": "boolean"
+ },
+ "allowChatStats": {
+ "type": "boolean"
+ },
+ "allowChatVoiceConcurrent": {
+ "type": "boolean"
+ },
+ "allowCrossGateRequeue": {
+ "type": "boolean"
+ },
+ "allowDirectAgentTransfer": {
+ "enum": [
+ "DIRECT_TRANSFER_DISABLED",
+ "ALLOW_DIRECT_TRANSFER_TO_SAME_GROUP",
+ "ALLOW_DIRECT_TRANSFER_TO_ANY_GROUP"
+ ],
+ "type": "string"
+ },
+ "allowEndcallforeveryone": {
+ "type": "boolean"
+ },
+ "allowExternalChat": {
+ "type": "boolean"
+ },
+ "allowFromIpAddresses": {
+ "type": "string"
+ },
+ "allowGateStats": {
+ "type": "boolean"
+ },
+ "allowHangup": {
+ "type": "boolean"
+ },
+ "allowHistoricalDialing": {
+ "type": "boolean"
+ },
+ "allowHold": {
+ "type": "boolean"
+ },
+ "allowInbound": {
+ "type": "boolean"
+ },
+ "allowInboundIntlTransfer": {
+ "type": "boolean"
+ },
+ "allowLeadInserts": {
+ "type": "boolean"
+ },
+ "allowLoginControl": {
+ "type": "boolean"
+ },
+ "allowLoginUpdates": {
+ "type": "boolean"
+ },
+ "allowManualCalls": {
+ "type": "boolean"
+ },
+ "allowManualIntlCalls": {
+ "type": "boolean"
+ },
+ "allowManualIntlTransfer": {
+ "type": "boolean"
+ },
+ "allowManualOutboundGates": {
+ "type": "boolean"
+ },
+ "allowManualPass": {
+ "type": "boolean"
+ },
+ "allowOffHook": {
+ "type": "boolean"
+ },
+ "allowOutbound": {
+ "type": "boolean"
+ },
+ "allowRequeue": {
+ "type": "boolean"
+ },
+ "allowSelfAgentStats": {
+ "type": "boolean"
+ },
+ "allowTransfer": {
+ "type": "boolean"
+ },
+ "altDefaultLoginDest": {
+ "type": "string"
+ },
+ "chatQueueAssignments": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "createdOn": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "defaultAutoAnswerOn": {
+ "type": "boolean"
+ },
+ "defaultLoginDest": {
+ "type": "string"
+ },
+ "dialGroupAssignments": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "directAgentExtension": {
+ "type": "string"
+ },
+ "disableSupervisorMonitoring": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string"
+ },
+ "enableSoftphone": {
+ "type": "boolean"
+ },
+ "externalAgentId": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "gateAssignments": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "gatesControlAgentVisibility": {
+ "type": "boolean"
+ },
+ "ghostRnaAction": {
+ "type": "string"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "initLoginBaseState": {
+ "type": "string"
+ },
+ "initLoginBaseStateId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "lastLoginDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "loadBalanceEnabled": {
+ "type": "boolean"
+ },
+ "location": {
+ "type": "string"
+ },
+ "manualOutboundDefaultCallerId": {
+ "type": "string"
+ },
+ "manualOutboundDefaultCallerIdE164": {
+ "type": "string"
+ },
+ "manualOutboundDefaultGate": {
+ "$ref": "#/components/schemas/Gate"
+ },
+ "maxChats": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "multiAccountAgent": {
+ "type": "boolean"
+ },
+ "parentAgentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "password": {
+ "type": "string"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "phoneLoginDialGroup": {
+ "$ref": "#/components/schemas/DialGroup"
+ },
+ "phoneLoginPin": {
+ "type": "string"
+ },
+ "rcUserId": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "regionalSettings": {
+ "$ref": "#/components/schemas/RegionalSettingRequestResponse"
+ },
+ "showLeadHistory": {
+ "type": "boolean"
+ },
+ "sipPassword": {
+ "type": "string"
+ },
+ "sipSafeUsername": {
+ "type": "string"
+ },
+ "softphoneId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "team": {
+ "type": "string"
+ },
+ "transientAgent": {
+ "type": "boolean"
+ },
+ "transientDelete": {
+ "type": "boolean"
+ },
+ "transientDeleteDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "userManagedByRC": {
+ "type": "boolean"
+ },
+ "username": {
+ "type": "string"
+ },
+ "whereSupervisee": {
+ "items": {
+ "$ref": "#/components/schemas/AgentSupervisor"
+ },
+ "type": "array"
+ },
+ "whereSupervisor": {
+ "$ref": "#/components/schemas/CollectionAgentSupervisor"
+ }
+ },
+ "type": "object"
+ },
+ "ActiveStateBoolean": {
+ "properties": {
+ "isActive": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AgentAccountAccess": {
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/Account"
+ },
+ "accountId": {
+ "type": "string"
+ },
+ "accountName": {
+ "type": "string"
+ },
+ "agent": {
+ "$ref": "#/components/schemas/Agent"
+ },
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AgentBlockMonitor": {
+ "properties": {
+ "blockMonitorId": {
+ "type": "string"
+ },
+ "duration": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "endTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "reason": {
+ "type": "string"
+ },
+ "recordingUrl": {
+ "type": "string"
+ },
+ "requestedBy": {
+ "type": "string"
+ },
+ "result": {
+ "type": "string"
+ },
+ "startTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "uii": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AgentChatGroupAccess": {
+ "properties": {
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatGroupId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AgentChatQueueAccess": {
+ "properties": {
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatQueue": {
+ "$ref": "#/components/schemas/ChatQueue"
+ },
+ "chatQueueId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AgentDetailsResult": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "accountName": {
+ "type": "string"
+ },
+ "agentGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentType": {
+ "enum": [
+ "AGENT",
+ "SUPERVISOR",
+ "MULTI_USER",
+ "MULTI_SUPERVISOR"
+ ],
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "location": {
+ "type": "string"
+ },
+ "rcUserId": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "team": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AgentDialGroupMember": {
+ "properties": {
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "hciClicker": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "AgentGateAccess": {
+ "properties": {
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentRank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "defaultDestOverride": {
+ "type": "string"
+ },
+ "gateId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AgentGateGroupAccess": {
+ "properties": {
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gateGroupId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AgentGateLoginRequest": {
+ "properties": {
+ "action": {
+ "enum": [
+ "ADD",
+ "REMOVE"
+ ],
+ "type": "string"
+ },
+ "agentGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gateIds": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AgentGroup": {
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/Account"
+ },
+ "agentGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agents": {
+ "$ref": "#/components/schemas/CollectionAgent"
+ },
+ "groupName": {
+ "type": "string"
+ },
+ "isDefault": {
+ "type": "boolean"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AgentImportRequest": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "agentType": {
+ "type": "string"
+ },
+ "allowChat": {
+ "type": "boolean"
+ },
+ "allowInbound": {
+ "type": "boolean"
+ },
+ "allowOutbound": {
+ "type": "boolean"
+ },
+ "chatQueueAssignmentIds": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "dialGroupAssignmentIds": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "queueAssignmentIds": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "rcAccountId": {
+ "type": "string"
+ },
+ "rcOfficeUsers": {
+ "items": {
+ "$ref": "#/components/schemas/RcOfficeUser"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AgentLoadBalanceMember": {
+ "properties": {
+ "masterAgentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "slaveAccountId": {
+ "type": "string"
+ },
+ "slaveAgentId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AgentLoadBalanceMemberPK": {
+ "properties": {
+ "masterAgentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "slaveAgentId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AgentLogin": {
+ "properties": {
+ "agent": {
+ "$ref": "#/components/schemas/Agent"
+ },
+ "agentAuxState": {
+ "type": "string"
+ },
+ "agentBlockMonitor": {
+ "$ref": "#/components/schemas/CollectionAgentBlockMonitor"
+ },
+ "agentChatState": {
+ "type": "string"
+ },
+ "agentLoginChatQueues": {
+ "$ref": "#/components/schemas/CollectionAgentLoginChatQueues"
+ },
+ "agentLoginGates": {
+ "$ref": "#/components/schemas/CollectionAgentLoginGate"
+ },
+ "agentLoginId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentLoginType": {
+ "type": "string"
+ },
+ "agentOffhookSessions": {
+ "items": {
+ "$ref": "#/components/schemas/AgentOffhookSession"
+ },
+ "type": "array"
+ },
+ "agentPhone": {
+ "type": "string"
+ },
+ "agentRank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentSkillProfile": {
+ "$ref": "#/components/schemas/AgentSkillProfile"
+ },
+ "agentState": {
+ "type": "string"
+ },
+ "availableTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "awayTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "breakTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "callsHandled": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatAvailableTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatEngagedTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatPresentedTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatRnaTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatsHandled": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "currentChatCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialGroup": {
+ "$ref": "#/components/schemas/DialGroup"
+ },
+ "engagedTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "exportFlag": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "holdTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "id": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "ipMapKey": {
+ "type": "string"
+ },
+ "iqServerId": {
+ "type": "string"
+ },
+ "isGhostLogin": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "lastArchiveStateDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "lastCallDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "loginDialGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "loginDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "loginHashcode": {
+ "type": "string"
+ },
+ "logoutDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "lunchTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "manualDials": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "monitorAgentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "nextCallTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "parentAgentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "pendingDispTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "pendingDisposition": {
+ "type": "boolean"
+ },
+ "previewDials": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "reservedDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "reservedUii": {
+ "type": "string"
+ },
+ "ringTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "rnaCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "rnaTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "stateDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "trainTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "workTime": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AgentLoginAuthVerifyResult": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentLoginId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "authTokens": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "integrations": {
+ "items": {
+ "$ref": "#/components/schemas/AccountIntegrationBase"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AgentLoginChatQueues": {
+ "properties": {
+ "agentLoginChatQueueId": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "chatQueue": {
+ "$ref": "#/components/schemas/ChatQueue"
+ }
+ },
+ "type": "object"
+ },
+ "AgentLoginGate": {
+ "properties": {
+ "agentLoginGateId": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "agentRank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "destOverride": {
+ "type": "string"
+ },
+ "gate": {
+ "$ref": "#/components/schemas/Gate"
+ }
+ },
+ "type": "object"
+ },
+ "AgentLoginProductView": {
+ "properties": {
+ "agentGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentLoginId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentLoginType": {
+ "type": "string"
+ },
+ "agentPhone": {
+ "type": "string"
+ },
+ "agentRank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentState": {
+ "type": "string"
+ },
+ "agentType": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "isGhostLogin": {
+ "type": "boolean"
+ },
+ "isOffhook": {
+ "type": "boolean"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "loginDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "pendingDisposition": {
+ "type": "boolean"
+ },
+ "stateDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AgentLoginRequest": {
+ "properties": {
+ "defaultDialDest": {
+ "type": "string"
+ },
+ "gateIds": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AgentNameAndType": {
+ "properties": {
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentName": {
+ "type": "string"
+ },
+ "agentType": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AgentOffhookSession": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "ani": {
+ "type": "string"
+ },
+ "archive": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "carrier": {
+ "type": "string"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "dnisE164": {
+ "type": "string"
+ },
+ "endDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "iqServerId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "monitoring": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "offhookUii": {
+ "type": "string"
+ },
+ "safeArchiveDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "startDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "vruSourceKey": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AgentRequest": {
+ "properties": {
+ "accountAccess": {
+ "items": {
+ "$ref": "#/components/schemas/AgentAccountAccess"
+ },
+ "type": "array"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "agentAccountAccess": {
+ "items": {
+ "$ref": "#/components/schemas/AgentAccountAccess"
+ },
+ "type": "array"
+ },
+ "agentChatGroupAccess": {
+ "items": {
+ "$ref": "#/components/schemas/AgentChatGroupAccess"
+ },
+ "type": "array"
+ },
+ "agentChatQueueAccesses": {
+ "$ref": "#/components/schemas/CollectionAgentChatQueueAccess"
+ },
+ "agentDialGroupMembers": {
+ "$ref": "#/components/schemas/CollectionAgentDialGroupMember"
+ },
+ "agentGateAccess": {
+ "items": {
+ "$ref": "#/components/schemas/AgentGateAccess"
+ },
+ "type": "array"
+ },
+ "agentGateGroupAccess": {
+ "items": {
+ "$ref": "#/components/schemas/AgentGateGroupAccess"
+ },
+ "type": "array"
+ },
+ "agentGroup": {
+ "$ref": "#/components/schemas/AgentGroup"
+ },
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentLoadBalance": {
+ "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember"
+ },
+ "agentLoadBalanceMembers": {
+ "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember"
+ },
+ "agentRank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentSkillProfiles": {
+ "items": {
+ "$ref": "#/components/schemas/AgentSkillProfile"
+ },
+ "type": "array"
+ },
+ "agentType": {
+ "enum": [
+ "AGENT",
+ "SUPERVISOR",
+ "MULTI_USER",
+ "MULTI_SUPERVISOR"
+ ],
+ "type": "string"
+ },
+ "allowAgentReports": {
+ "type": "boolean"
+ },
+ "allowAgentStats": {
+ "type": "boolean"
+ },
+ "allowAutoAnswer": {
+ "type": "boolean"
+ },
+ "allowBlended": {
+ "type": "boolean"
+ },
+ "allowCallControl": {
+ "type": "boolean"
+ },
+ "allowCampStats": {
+ "type": "boolean"
+ },
+ "allowChat": {
+ "type": "boolean"
+ },
+ "allowChatStats": {
+ "type": "boolean"
+ },
+ "allowChatVoiceConcurrent": {
+ "type": "boolean"
+ },
+ "allowCrossGateRequeue": {
+ "type": "boolean"
+ },
+ "allowDirectAgentTransfer": {
+ "enum": [
+ "DIRECT_TRANSFER_DISABLED",
+ "ALLOW_DIRECT_TRANSFER_TO_SAME_GROUP",
+ "ALLOW_DIRECT_TRANSFER_TO_ANY_GROUP"
+ ],
+ "type": "string"
+ },
+ "allowEndcallforeveryone": {
+ "type": "boolean"
+ },
+ "allowExternalChat": {
+ "type": "boolean"
+ },
+ "allowFromIpAddresses": {
+ "type": "string"
+ },
+ "allowGateStats": {
+ "type": "boolean"
+ },
+ "allowHangup": {
+ "type": "boolean"
+ },
+ "allowHistoricalDialing": {
+ "type": "boolean"
+ },
+ "allowHold": {
+ "type": "boolean"
+ },
+ "allowInbound": {
+ "type": "boolean"
+ },
+ "allowInboundIntlTransfer": {
+ "type": "boolean"
+ },
+ "allowLeadInserts": {
+ "type": "boolean"
+ },
+ "allowLoginControl": {
+ "type": "boolean"
+ },
+ "allowLoginUpdates": {
+ "type": "boolean"
+ },
+ "allowManualCalls": {
+ "type": "boolean"
+ },
+ "allowManualIntlCalls": {
+ "type": "boolean"
+ },
+ "allowManualIntlTransfer": {
+ "type": "boolean"
+ },
+ "allowManualOutboundGates": {
+ "type": "boolean"
+ },
+ "allowManualPass": {
+ "type": "boolean"
+ },
+ "allowOffHook": {
+ "type": "boolean"
+ },
+ "allowOutbound": {
+ "type": "boolean"
+ },
+ "allowRequeue": {
+ "type": "boolean"
+ },
+ "allowSelfAgentStats": {
+ "type": "boolean"
+ },
+ "allowTransfer": {
+ "type": "boolean"
+ },
+ "altDefaultLoginDest": {
+ "type": "string"
+ },
+ "chatQueueAssignments": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "createdOn": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "defaultAutoAnswerOn": {
+ "type": "boolean"
+ },
+ "defaultLoginDest": {
+ "type": "string"
+ },
+ "dialGroupAssignments": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "directAgentExtension": {
+ "type": "string"
+ },
+ "disableSupervisorMonitoring": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string"
+ },
+ "enableSoftphone": {
+ "type": "boolean"
+ },
+ "externalAgentId": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "gateAssignments": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "gatesControlAgentVisibility": {
+ "type": "boolean"
+ },
+ "ghostRnaAction": {
+ "type": "string"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "initLoginBaseState": {
+ "type": "string"
+ },
+ "initLoginBaseStateId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "lastLoginDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "loadBalanceEnabled": {
+ "type": "boolean"
+ },
+ "location": {
+ "type": "string"
+ },
+ "manualOutboundDefaultCallerId": {
+ "type": "string"
+ },
+ "manualOutboundDefaultCallerIdE164": {
+ "type": "string"
+ },
+ "manualOutboundDefaultGate": {
+ "$ref": "#/components/schemas/Gate"
+ },
+ "maxChats": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "multiAccountAgent": {
+ "type": "boolean"
+ },
+ "parentAgentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "password": {
+ "type": "string"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "phoneLoginDialGroup": {
+ "$ref": "#/components/schemas/DialGroup"
+ },
+ "phoneLoginPin": {
+ "type": "string"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ },
+ "rcUserId": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "regionalSettings": {
+ "$ref": "#/components/schemas/RegionalSettingRequestResponse"
+ },
+ "showLeadHistory": {
+ "type": "boolean"
+ },
+ "sipPassword": {
+ "type": "string"
+ },
+ "sipSafeUsername": {
+ "type": "string"
+ },
+ "softphoneId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "team": {
+ "type": "string"
+ },
+ "transientAgent": {
+ "type": "boolean"
+ },
+ "transientDelete": {
+ "type": "boolean"
+ },
+ "transientDeleteDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "userManagedByRC": {
+ "type": "boolean"
+ },
+ "username": {
+ "type": "string"
+ },
+ "whereSupervisee": {
+ "items": {
+ "$ref": "#/components/schemas/AgentSupervisor"
+ },
+ "type": "array"
+ },
+ "whereSupervisor": {
+ "$ref": "#/components/schemas/CollectionAgentSupervisor"
+ }
+ },
+ "type": "object"
+ },
+ "AgentSkillProfile": {
+ "properties": {
+ "chatGroupSkills": {
+ "items": {
+ "$ref": "#/components/schemas/ChatGroupSkill"
+ },
+ "type": "array"
+ },
+ "createdOn": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "default": {
+ "type": "boolean"
+ },
+ "gateGroupSkills": {
+ "items": {
+ "$ref": "#/components/schemas/GateGroupSkill"
+ },
+ "type": "array"
+ },
+ "groupSkills": {
+ "items": {
+ "$ref": "#/components/schemas/GateGroupSkill"
+ },
+ "type": "array"
+ },
+ "isDefault": {
+ "type": "boolean"
+ },
+ "profileDesc": {
+ "type": "string"
+ },
+ "profileId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "profileName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AgentStats": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "accountName": {
+ "type": "string"
+ },
+ "agentChatState": {
+ "type": "string"
+ },
+ "agentGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentGroupName": {
+ "type": "string"
+ },
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentLoginId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentLoginType": {
+ "type": "string"
+ },
+ "agentPhone": {
+ "type": "string"
+ },
+ "agentState": {
+ "type": "string"
+ },
+ "agentType": {
+ "type": "string"
+ },
+ "callAni": {
+ "type": "string"
+ },
+ "callDnis": {
+ "type": "string"
+ },
+ "callSource": {
+ "type": "string"
+ },
+ "callSourceDesc": {
+ "type": "string"
+ },
+ "callUii": {
+ "type": "string"
+ },
+ "callsHandled": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "campaignId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatsHandled": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "currentChatCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "email": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "gateId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isDequeueAgent": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isGhostLogin": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isOffhook": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "lastUpdate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "loginDialGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "loginTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "onHoldDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "pendingDisposition": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "pendingDispositionTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "profileName": {
+ "type": "string"
+ },
+ "rna": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "selectable": {
+ "type": "boolean"
+ },
+ "stateTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "successDispositions": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalChatTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalTalkTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AgentSupervisor": {
+ "properties": {
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "supervisorId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AgentSupervisorPK": {
+ "properties": {
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "supervisorId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AgentV2": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "accountName": {
+ "type": "string"
+ },
+ "agentGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentRank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentType": {
+ "type": "string"
+ },
+ "allowLoginControl": {
+ "type": "boolean"
+ },
+ "allowLoginUpdates": {
+ "type": "boolean"
+ },
+ "altDefaultLoginDest": {
+ "type": "string"
+ },
+ "directAgentExtension": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "enableSoftphone": {
+ "type": "boolean"
+ },
+ "externalAgentId": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "ghostRnaAction": {
+ "type": "string"
+ },
+ "initLoginBaseState": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "location": {
+ "type": "string"
+ },
+ "manualOutboundDefaultCallerId": {
+ "type": "string"
+ },
+ "maxChats": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "password": {
+ "type": "string"
+ },
+ "phoneLoginPin": {
+ "type": "string"
+ },
+ "rcUserId": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "team": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "title": "AgentV2",
+ "type": "object"
+ },
+ "AgentsLoggedInGatesView": {
+ "properties": {
+ "gateGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gateId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gateName": {
+ "type": "string"
+ },
+ "groupName": {
+ "type": "string"
+ },
+ "id": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Alert": {
+ "properties": {
+ "alertId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "alertMessageBody": {
+ "type": "string"
+ },
+ "alertMessageSubject": {
+ "type": "string"
+ },
+ "alertName": {
+ "type": "string"
+ },
+ "alertScript": {
+ "type": "string"
+ },
+ "intervalMin": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "itemIds": {
+ "type": "string"
+ },
+ "jsonBlob": {
+ "type": "string"
+ },
+ "nextRunTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "productType": {
+ "enum": [
+ "ACCOUNT",
+ "ACD",
+ "AGENT",
+ "CHAT_QUEUE",
+ "OUTBOUND",
+ "VISUAL_IVR",
+ "CLOUD_PROFILE",
+ "CLOUD_DESTINATION",
+ "TRAC_NUMBER",
+ "HTTP_SERVICES",
+ "SCRIPTING",
+ "TN_MANAGER",
+ "SURVEY",
+ "DNIS",
+ "TEAMS",
+ "KNOWLEDGE_BASE",
+ "UTILITIES"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AmdProfile": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "amdAfterGreetingSilence": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "amdBetweenWordSilence": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "amdGreeting": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "amdInitSilence": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "amdMaxWords": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "amdMinWordLength": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "amdProfileId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "amdProfileName": {
+ "type": "string"
+ },
+ "amdSilenceThreshold": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "amdTotalTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "countOfCampaigns": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "systemDefault": {
+ "type": "boolean"
+ },
+ "systemProfile": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ApplicationContext": {
+ "properties": {
+ "applicationName": {
+ "type": "string"
+ },
+ "autowireCapableBeanFactory": {
+ "$ref": "#/components/schemas/AutowireCapableBeanFactory"
+ },
+ "beanDefinitionCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "beanDefinitionNames": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "classLoader": {
+ "$ref": "#/components/schemas/ClassLoader"
+ },
+ "displayName": {
+ "type": "string"
+ },
+ "environment": {
+ "$ref": "#/components/schemas/Environment"
+ },
+ "id": {
+ "type": "string"
+ },
+ "parent": {
+ "$ref": "#/components/schemas/ApplicationContext"
+ },
+ "parentBeanFactory": {
+ "$ref": "#/components/schemas/BeanFactory"
+ },
+ "startupDate": {
+ "format": "int64",
+ "type": "integer"
+ }
+ },
+ "title": "ApplicationContext",
+ "type": "object"
+ },
+ "AssignedDnis": {
+ "properties": {
+ "cloudRouteProfile": {
+ "$ref": "#/components/schemas/CloudRouteProfileSkinny"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "dnisDescription": {
+ "type": "string"
+ },
+ "dnisE164": {
+ "type": "string"
+ },
+ "endDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "endPointId": {
+ "type": "string"
+ },
+ "endPointType": {
+ "type": "string"
+ },
+ "gate": {
+ "$ref": "#/components/schemas/GateSkinnyAssignable"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "originatingDnis": {
+ "type": "string"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ },
+ "startDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "tracNumber": {
+ "$ref": "#/components/schemas/TracNumberSkinny"
+ },
+ "visualIvr": {
+ "$ref": "#/components/schemas/VisualIvrSkinny"
+ }
+ },
+ "type": "object"
+ },
+ "AssignedSmsDnis": {
+ "properties": {
+ "chatQueue": {
+ "$ref": "#/components/schemas/ChatQueueSkinny"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "dnisDescription": {
+ "type": "string"
+ },
+ "dnisE164": {
+ "type": "string"
+ },
+ "dnisPool": {
+ "$ref": "#/components/schemas/DnisPoolV2"
+ },
+ "endDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "originatingDnis": {
+ "type": "string"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ },
+ "startDate": {
+ "$ref": "#/components/schemas/DateTime"
+ }
+ },
+ "type": "object"
+ },
+ "AudioFileView": {
+ "properties": {
+ "fileName": {
+ "type": "string"
+ },
+ "fileSize": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "lastModified": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuditLog": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "actionType": {
+ "enum": [
+ "DELETE",
+ "CREATE",
+ "UPDATE"
+ ],
+ "type": "string"
+ },
+ "affectedEntityJson": {
+ "type": "string"
+ },
+ "auditLogResultList": {
+ "items": {
+ "$ref": "#/components/schemas/AuditLogResult"
+ },
+ "type": "array"
+ },
+ "auditedEntityDescription": {
+ "type": "object"
+ },
+ "auditedEntityId": {
+ "type": "object"
+ },
+ "authUser": {
+ "$ref": "#/components/schemas/AuditLogAuthenticatedUser"
+ },
+ "createTime": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "createTimeAsDateTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "description": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuditLogAuthenticatedUser": {
+ "properties": {
+ "firstName": {
+ "type": "string"
+ },
+ "fullJson": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "sourceId": {
+ "type": "string"
+ },
+ "userId": {
+ "type": "string"
+ },
+ "userName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuditLogResult": {
+ "properties": {
+ "attributeName": {
+ "type": "string"
+ },
+ "classType": {
+ "type": "string"
+ },
+ "newValue": {
+ "type": "object"
+ },
+ "originalValue": {
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "AuditLogSearchCriteria": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "ascOrDesc": {
+ "enum": [
+ "ASCENDING",
+ "DESCENDING"
+ ],
+ "type": "string"
+ },
+ "auditActions": {
+ "items": {
+ "enum": [
+ "DELETE",
+ "CREATE",
+ "UPDATE"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "auditedEntityId": {
+ "type": "string"
+ },
+ "createUserId": {
+ "type": "string"
+ },
+ "endDateTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "endDateTimeAsUnix": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "orderBy": {
+ "type": "string"
+ },
+ "searchEntities": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "startDateTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "startDateTimeAsUnix": {
+ "format": "int64",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Auditable": {
+ "properties": {
+ "fullPath": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuthConfig": {
+ "properties": {
+ "authType": {
+ "enum": [
+ "APIKEY",
+ "JWT",
+ "BASIC",
+ "OAUTH",
+ "CUSTOM_AUTH"
+ ],
+ "type": "string"
+ },
+ "apiKey": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuthenticatedUser": {
+ "properties": {
+ "authToken": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "isApiToken": {
+ "type": "boolean"
+ },
+ "masterRightsDocs": {
+ "additionalProperties": {
+ "$ref": "#/components/schemas/RightsDocument"
+ },
+ "type": "object"
+ },
+ "masterRightsDocsValues": {
+ "$ref": "#/components/schemas/CollectionRightsDocument"
+ },
+ "name": {
+ "type": "string"
+ },
+ "rightsDocs": {
+ "additionalProperties": {
+ "$ref": "#/components/schemas/RightsDocument"
+ },
+ "type": "object"
+ },
+ "sourceIp": {
+ "type": "string"
+ },
+ "stayLoggedIn": {
+ "type": "boolean"
+ },
+ "superUser": {
+ "type": "boolean"
+ },
+ "user": {
+ "$ref": "#/components/schemas/User"
+ }
+ },
+ "type": "object"
+ },
+ "AutowireCapableBeanFactory": {
+ "title": "AutowireCapableBeanFactory",
+ "type": "object"
+ },
+ "BaseAgentState": {
+ "properties": {
+ "colKey": {
+ "type": "string"
+ },
+ "colLabel": {
+ "type": "string"
+ },
+ "id": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isCore": {
+ "type": "boolean"
+ },
+ "isRequired": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "BaseCsvDto": {
+ "type": "object"
+ },
+ "BatchOperationResult": {
+ "properties": {
+ "result": {
+ "items": {
+ "$ref": "#/components/schemas/ProductOperationResult"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "BeanFactory": {
+ "title": "BeanFactory",
+ "type": "object"
+ },
+ "Blob": {
+ "properties": {
+ "binaryStream": {
+ "$ref": "#/components/schemas/InputStream"
+ }
+ },
+ "type": "object"
+ },
+ "BlockedANI": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "ani": {
+ "type": "string"
+ },
+ "aniE164": {
+ "type": "string"
+ },
+ "dateCreated": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "notes": {
+ "type": "string"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "BlockedANIDeleteRequest": {
+ "properties": {
+ "ani": {
+ "type": "string"
+ },
+ "aniE164": {
+ "type": "string"
+ },
+ "effectiveAni": {
+ "type": "string"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "BlockedIP": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "dateCreated": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "ipAddress": {
+ "type": "string"
+ },
+ "mask": {
+ "type": "string"
+ },
+ "notes": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CallerIdBucket": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "bucketId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "bucketName": {
+ "type": "string"
+ },
+ "bwOrderId": {
+ "type": "string"
+ },
+ "callerIdBucketNumbers": {
+ "items": {
+ "$ref": "#/components/schemas/CallerIdBucketNumber"
+ },
+ "type": "array"
+ },
+ "callerIdName": {
+ "type": "string"
+ },
+ "createDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "excludedStates": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "forwardingDid": {
+ "type": "string"
+ },
+ "forwardingDidE164": {
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "orderStatus": {
+ "enum": [
+ "PENDING",
+ "COMPLETE",
+ "FAILED",
+ "DISCONNECT"
+ ],
+ "type": "string"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "CallerIdBucketNumber": {
+ "properties": {
+ "city": {
+ "type": "string"
+ },
+ "lat": {
+ "format": "double",
+ "type": "number"
+ },
+ "lon": {
+ "format": "double",
+ "type": "number"
+ },
+ "numberId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "state": {
+ "type": "string"
+ },
+ "tnNumber": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Campaign": {
+ "properties": {
+ "abandonMsg": {
+ "type": "string"
+ },
+ "afterCallBaseState": {
+ "type": "string"
+ },
+ "afterCallState": {
+ "$ref": "#/components/schemas/AccountAuxState"
+ },
+ "agentConnectSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "agentPopMessage": {
+ "type": "string"
+ },
+ "agentTermSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "allowLeadInserts": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "allowLeadUpdates": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "amdProfileId": {
+ "$ref": "#/components/schemas/AmdProfile"
+ },
+ "appUrl": {
+ "type": "string"
+ },
+ "aux1Label": {
+ "type": "string"
+ },
+ "aux2Label": {
+ "type": "string"
+ },
+ "aux3Label": {
+ "type": "string"
+ },
+ "aux4Label": {
+ "type": "string"
+ },
+ "aux5Label": {
+ "type": "string"
+ },
+ "billingCode": {
+ "type": "string"
+ },
+ "callerId": {
+ "type": "string"
+ },
+ "callerIdBucket": {
+ "$ref": "#/components/schemas/CallerIdBucket"
+ },
+ "campaignDesc": {
+ "type": "string"
+ },
+ "campaignDispositions": {
+ "$ref": "#/components/schemas/CollectionCampaignDisposition"
+ },
+ "campaignFilterStates": {
+ "$ref": "#/components/schemas/CollectionCampaignFilterStates"
+ },
+ "campaignFilterTimezones": {
+ "$ref": "#/components/schemas/CollectionCampaignFilterTimezones"
+ },
+ "campaignId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "campaignName": {
+ "type": "string"
+ },
+ "campaignPriority": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "campaignRequeueShortcuts": {
+ "$ref": "#/components/schemas/CollectionRequeueShortcut"
+ },
+ "campaignResultDest": {
+ "$ref": "#/components/schemas/ResultFileDestination"
+ },
+ "campaignUnlimitedFieldGroup": {
+ "$ref": "#/components/schemas/CampaignUnlimitedFieldGroup"
+ },
+ "campaignWhitelistTagMembers": {
+ "$ref": "#/components/schemas/CollectionWhitelistTagMembers"
+ },
+ "countryId": {
+ "type": "string"
+ },
+ "customDialZoneGroup": {
+ "$ref": "#/components/schemas/CustomDialZoneGroups"
+ },
+ "dialGroup": {
+ "$ref": "#/components/schemas/DialGroup"
+ },
+ "dialLoadedOrder": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dispositionTimeout": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dncScrubOption": {
+ "enum": [
+ "DO_NOT_SCRUB",
+ "INTERNAL_AND_NATIONAL",
+ "INTERNAL_ONLY",
+ "CELLULAR_AND_INTERNAL",
+ "CELLULAR_ONLY"
+ ],
+ "type": "string"
+ },
+ "enableGlobalPhoneBook": {
+ "type": "boolean"
+ },
+ "endCallMsg": {
+ "type": "string"
+ },
+ "endDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "exportFlag": {
+ "type": "boolean"
+ },
+ "filterEnabled": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "filterType": {
+ "type": "string"
+ },
+ "friSched": {
+ "type": "string"
+ },
+ "genericKeyValuePairs": {
+ "type": "string"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "hangupOnDisposition": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isActive": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "lastPassDts": {
+ "$ref": "#/components/schemas/Timestamp"
+ },
+ "liveAnswerMsg": {
+ "type": "string"
+ },
+ "machAnswerMsg": {
+ "type": "string"
+ },
+ "machineDetect": {
+ "type": "boolean"
+ },
+ "maxDailyPasses": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxDailyPassesInclude": {
+ "type": "string"
+ },
+ "maxDialLimit": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxPasses": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxPassesExclude": {
+ "type": "string"
+ },
+ "maxRingTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxRingTimeTransfer": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "minPredictiveCallsHistory": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "monSched": {
+ "type": "string"
+ },
+ "onHoldMsg": {
+ "type": "string"
+ },
+ "passDelayMin": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "pauseRecordingSec": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "perspectiveRecordingMode": {
+ "enum": [
+ "DISABLED",
+ "ALL_AGENT_LEGS"
+ ],
+ "type": "string"
+ },
+ "postCallSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "postDispSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "quotaGroup": {
+ "$ref": "#/components/schemas/QuotaGroup"
+ },
+ "realtimeDncUrl": {
+ "type": "string"
+ },
+ "recordCall": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "recordingInConference": {
+ "type": "boolean"
+ },
+ "recordingSettings": {
+ "enum": [
+ "RECORD_FULL_CALL",
+ "AGENT_FULL_CONTROL_DEFAULT_ON",
+ "AGENT_FULL_CONTROL_DEFAULT_OFF",
+ "AGENT_PAUSE"
+ ],
+ "type": "string"
+ },
+ "requeueType": {
+ "enum": [
+ "ADVANCED",
+ "RESTRICTED"
+ ],
+ "type": "string"
+ },
+ "rescrubInterval": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "satSched": {
+ "type": "string"
+ },
+ "script": {
+ "$ref": "#/components/schemas/Script"
+ },
+ "scrubDisconnectNoanswer": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "seedAbandonRate": {
+ "format": "double",
+ "type": "number"
+ },
+ "seedSuccessRate": {
+ "format": "double",
+ "type": "number"
+ },
+ "showLeadInfo": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "showLeadPasses": {
+ "type": "boolean"
+ },
+ "showListName": {
+ "type": "boolean"
+ },
+ "singleChannelEnabled": {
+ "type": "boolean"
+ },
+ "startDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "stopRecordingOnTransfer": {
+ "type": "boolean"
+ },
+ "sunSched": {
+ "type": "string"
+ },
+ "survey": {
+ "$ref": "#/components/schemas/Survey"
+ },
+ "surveyPopType": {
+ "type": "string"
+ },
+ "targetAbandonRate": {
+ "format": "double",
+ "type": "number"
+ },
+ "thuSched": {
+ "type": "string"
+ },
+ "trackSpeedToLead": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "transferCallerId": {
+ "type": "string"
+ },
+ "transferTermSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "tueSched": {
+ "type": "string"
+ },
+ "useGlobalWhitelist": {
+ "type": "boolean"
+ },
+ "wedSched": {
+ "type": "string"
+ },
+ "whisperMsg": {
+ "type": "string"
+ },
+ "callingConfiguration": {
+ "description": "Calling preference mode for the campaign. Use SIMPLE for standard lead-phone dialing or STRATEGIC for persona-based phone selection. This setting is selected when the campaign is created and cannot be changed later.",
+ "enum": [
+ "SIMPLE",
+ "STRATEGIC"
+ ],
+ "type": "string"
+ },
+ "personaCallSchedules": {
+ "description": "Persona-based calling windows and phone-priority rules for STRATEGIC campaigns.",
+ "items": {
+ "$ref": "#/components/schemas/PersonaCallSchedule"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignCriteriaGroupAccess": {
+ "properties": {
+ "campaignId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignDisposition": {
+ "properties": {
+ "campaign": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "contactForwarding": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "createCopy": {
+ "type": "boolean"
+ },
+ "destCampaign": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "dispSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "disposition": {
+ "type": "string"
+ },
+ "dispositionId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dncTagLabel": {
+ "type": "string"
+ },
+ "doNotCall": {
+ "type": "boolean"
+ },
+ "dtmfMapping": {
+ "type": "string"
+ },
+ "emailDestinations": {
+ "type": "string"
+ },
+ "emailTemplate": {
+ "$ref": "#/components/schemas/EmailTemplate"
+ },
+ "excludeAbandon": {
+ "type": "boolean"
+ },
+ "isComplete": {
+ "type": "boolean"
+ },
+ "isContact": {
+ "type": "boolean"
+ },
+ "isDefault": {
+ "type": "boolean"
+ },
+ "isDisabled": {
+ "type": "boolean"
+ },
+ "isRequeued": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isSuccess": {
+ "type": "boolean"
+ },
+ "mergeOriginal": {
+ "type": "boolean"
+ },
+ "rank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "requeueDelay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "requireNote": {
+ "type": "boolean"
+ },
+ "saveSurvey": {
+ "type": "boolean"
+ },
+ "setAgentFlag": {
+ "type": "boolean"
+ },
+ "termMessage": {
+ "type": "string"
+ },
+ "timeout": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "xfer": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "xferDest": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignFilterStates": {
+ "properties": {
+ "campaign": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "campaignId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignFilterTimezones": {
+ "properties": {
+ "campaign": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "campaignId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "timezone": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignLead": {
+ "properties": {
+ "address1": {
+ "type": "string"
+ },
+ "address2": {
+ "type": "string"
+ },
+ "auxData1": {
+ "type": "string"
+ },
+ "auxData2": {
+ "type": "string"
+ },
+ "auxData3": {
+ "type": "string"
+ },
+ "auxData4": {
+ "type": "string"
+ },
+ "auxData5": {
+ "type": "string"
+ },
+ "auxExternalUrl": {
+ "type": "string"
+ },
+ "auxGreeting": {
+ "type": "string"
+ },
+ "auxPhone": {
+ "type": "string"
+ },
+ "callerId": {
+ "type": "string"
+ },
+ "campaign": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "campaignRedials": {
+ "items": {
+ "$ref": "#/components/schemas/CampaignRedial"
+ },
+ "type": "array"
+ },
+ "city": {
+ "type": "string"
+ },
+ "dupeKeyOverride": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "email": {
+ "type": "string"
+ },
+ "extendedLeadData": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "externId": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "gateKeeper": {
+ "type": "string"
+ },
+ "id": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "lastPassDisposition": {
+ "enum": [
+ "ANSWER",
+ "NOANSWER",
+ "BUSY",
+ "MACHINE",
+ "INTERCEPT",
+ "DISCONNECT",
+ "ABANDON",
+ "CONGESTION",
+ "MANUAL_PASS",
+ "INBOUND_CALLBACK",
+ "APP_DNC",
+ "APP_REQUEUE",
+ "APP_REQUEUE_COMPLETE",
+ "APP_REQUEUE_ABANDON",
+ "INBOUND_ABANDON",
+ "API_BLOCKED",
+ "API_ERROR"
+ ],
+ "type": "string"
+ },
+ "lastPassDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "leadId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadPasses": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadPhone": {
+ "description": "Primary lead phone number. For accounts enabled for E.164 or international phone-number handling, provide the primary phone in leadPhoneE164.",
+ "type": "string"
+ },
+ "leadPhoneE164": {
+ "description": "Primary lead phone number in E.164 format. Required for direct lead loading when the account uses E.164 or international phone-number handling.",
+ "type": "string"
+ },
+ "leadPriority": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadState": {
+ "enum": [
+ "ACTIVE",
+ "AGENT-CALLBACK",
+ "CALLBACK-CANCELLED",
+ "CALLBACK",
+ "CANCELLED",
+ "COMPLETE",
+ "DISCONNECTED",
+ "DO-NOT-CALL",
+ "INTERCEPT",
+ "MAX-DIAL-LIMIT",
+ "PAUSED",
+ "PENDING-CALLBACK",
+ "PENDING-ERR",
+ "PENDING-HCI",
+ "PENDING",
+ "READY",
+ "TRANSITIONED",
+ "WHITELIST"
+ ],
+ "type": "string"
+ },
+ "leadTimezone": {
+ "type": "string"
+ },
+ "liveAnswerMessage": {
+ "type": "string"
+ },
+ "loadedDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "machAnswerMessage": {
+ "type": "string"
+ },
+ "maxPasses": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "midName": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "nextDialTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "quotaTargetIds": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "quotaTargets": {
+ "$ref": "#/components/schemas/CollectionQuotaTarget"
+ },
+ "reserveAgent": {
+ "description": "Agent ID to reserve this lead for during direct lead loading. If the value is blank, null, omitted, invalid, or refers to an agent without access to the account, the lead is still accepted. Invalid or inaccessible assignments are counted in failedAgentAssignment.",
+ "example": "980",
+ "nullable": true,
+ "type": "string",
+ "writeOnly": true
+ },
+ "sortCol": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "stateDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "suffix": {
+ "type": "string"
+ },
+ "suppressed": {
+ "type": "boolean"
+ },
+ "title": {
+ "type": "string"
+ },
+ "zip": {
+ "type": "string"
+ },
+ "personaMapping": {
+ "description": "Stored mapping of lead phone values to persona phone IDs.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "personaPhoneConfig": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Additional phone numbers for direct lead loading. Keys must exactly match configured persona phone labels, and values are phone numbers for that lead.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignLeadList": {
+ "properties": {
+ "deleteLeads": {
+ "type": "boolean"
+ },
+ "deletedDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "dncTagList": {
+ "type": "string"
+ },
+ "exportFlag": {
+ "type": "boolean"
+ },
+ "lastDncScrubDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "leadsAccepted": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadsConverted": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadsDoNotCall": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadsSupplied": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadsWhitelist": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "listDesc": {
+ "type": "string"
+ },
+ "listId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "listPriority": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "listState": {
+ "enum": [
+ "ACTIVE",
+ "PAUSED",
+ "PENDING_DNC",
+ "LOADING",
+ "DELETED",
+ "READY",
+ "CALLBACKS",
+ "CALLBACKS_AGENT",
+ "DUPLICATES_NOT_MERGED",
+ "DUPLICATES_NOT_MOVED"
+ ],
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "originalFormat": {
+ "type": "string"
+ },
+ "result": {
+ "type": "string"
+ },
+ "unloadFilename": {
+ "type": "string"
+ },
+ "uploadDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "uploadedBy": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignLeadSearchCriteria": {
+ "properties": {
+ "address1": {
+ "type": "string"
+ },
+ "address2": {
+ "type": "string"
+ },
+ "agentDispositions": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "auxData1": {
+ "type": "string"
+ },
+ "auxData2": {
+ "type": "string"
+ },
+ "auxData3": {
+ "type": "string"
+ },
+ "auxData4": {
+ "type": "string"
+ },
+ "auxData5": {
+ "type": "string"
+ },
+ "callerId": {
+ "type": "string"
+ },
+ "campaignIds": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "city": {
+ "type": "string"
+ },
+ "emailAddress": {
+ "type": "string"
+ },
+ "externIds": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "lastPassTimeCriteria": {
+ "$ref": "#/components/schemas/DateTimeComparableSearchField"
+ },
+ "leadIds": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "leadPassesCriteria": {
+ "$ref": "#/components/schemas/ComparableSearchField"
+ },
+ "leadPhoneNum": {
+ "type": "string"
+ },
+ "leadPhoneNumbers": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "leadStates": {
+ "items": {
+ "enum": [
+ "ACTIVE",
+ "AGENT-CALLBACK",
+ "CALLBACK-CANCELLED",
+ "CALLBACK",
+ "CANCELLED",
+ "COMPLETE",
+ "DISCONNECTED",
+ "DO-NOT-CALL",
+ "INTERCEPT",
+ "MAX-DIAL-LIMIT",
+ "PAUSED",
+ "PENDING-CALLBACK",
+ "PENDING-ERR",
+ "PENDING-HCI",
+ "PENDING",
+ "READY",
+ "TRANSITIONED",
+ "WHITELIST"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "leadTimezones": {
+ "items": {
+ "$ref": "#/components/schemas/Timezone"
+ },
+ "type": "array"
+ },
+ "listIds": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "loadedDtsEnd": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "loadedDtsStart": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "nextDialTimeCriteria": {
+ "$ref": "#/components/schemas/DateTimeComparableSearchField"
+ },
+ "orphanedLeadsOnly": {
+ "type": "boolean"
+ },
+ "pendingAgentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "physicalStates": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "suppressed": {
+ "enum": [
+ "ONLY_SUPPRESSED",
+ "ONLY_UNSUPPRESSED",
+ "ALL"
+ ],
+ "type": "string"
+ },
+ "systemDispositions": {
+ "items": {
+ "enum": [
+ "ANSWER",
+ "NOANSWER",
+ "BUSY",
+ "MACHINE",
+ "INTERCEPT",
+ "DISCONNECT",
+ "ABANDON",
+ "CONGESTION",
+ "MANUAL_PASS",
+ "INBOUND_CALLBACK",
+ "APP_DNC",
+ "APP_REQUEUE",
+ "APP_REQUEUE_COMPLETE",
+ "APP_REQUEUE_ABANDON",
+ "INBOUND_ABANDON",
+ "API_BLOCKED",
+ "API_ERROR"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "zip": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignLeadSearchResultsView": {
+ "properties": {
+ "address1": {
+ "type": "string"
+ },
+ "address2": {
+ "type": "string"
+ },
+ "agentDispostion": {
+ "type": "string"
+ },
+ "auxData1": {
+ "type": "string"
+ },
+ "auxData2": {
+ "type": "string"
+ },
+ "auxData3": {
+ "type": "string"
+ },
+ "auxData4": {
+ "type": "string"
+ },
+ "auxData5": {
+ "type": "string"
+ },
+ "auxExternalUrl": {
+ "type": "string"
+ },
+ "auxGreeting": {
+ "type": "string"
+ },
+ "auxPhone": {
+ "type": "string"
+ },
+ "callerId": {
+ "type": "string"
+ },
+ "campaignId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "campaignLead": {
+ "$ref": "#/components/schemas/CampaignLead"
+ },
+ "campaignName": {
+ "type": "string"
+ },
+ "city": {
+ "type": "string"
+ },
+ "dialGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dupeKeyOverride": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "email": {
+ "type": "string"
+ },
+ "externId": {
+ "type": "string"
+ },
+ "extraData": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "gateKeeper": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "lastPassAgentName": {
+ "type": "string"
+ },
+ "lastPassDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "lastPassDispo": {
+ "type": "string"
+ },
+ "lastPassDisposition": {
+ "type": "string"
+ },
+ "lastPassDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "leadId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadPasses": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadPhone": {
+ "type": "string"
+ },
+ "leadState": {
+ "type": "string"
+ },
+ "leadTimezone": {
+ "type": "string"
+ },
+ "listDesc": {
+ "type": "string"
+ },
+ "listId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "liveAnswerMessage": {
+ "type": "string"
+ },
+ "loadedDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "machAnswerMessage": {
+ "type": "string"
+ },
+ "maxPasses": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "midName": {
+ "type": "string"
+ },
+ "nextDialTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "pendingAgentName": {
+ "type": "string"
+ },
+ "sortCol": {
+ "type": "string"
+ },
+ "speedToLeadAgentConn": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "speedToLeadFirstPass": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "state": {
+ "type": "string"
+ },
+ "stateDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "suffix": {
+ "type": "string"
+ },
+ "suppressed": {
+ "type": "boolean"
+ },
+ "title": {
+ "type": "string"
+ },
+ "uploadDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "uploadedBy": {
+ "type": "string"
+ },
+ "zip": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignPass": {
+ "properties": {
+ "agent": {
+ "$ref": "#/components/schemas/Agent"
+ },
+ "agentDisposition": {
+ "type": "string"
+ },
+ "agentNotes": {
+ "type": "string"
+ },
+ "callStart": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "campaignRedials": {
+ "items": {
+ "$ref": "#/components/schemas/CampaignRedial"
+ },
+ "type": "array"
+ },
+ "dialDuration": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialType": {
+ "type": "boolean"
+ },
+ "duration": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "export": {
+ "type": "boolean"
+ },
+ "exportFlag": {
+ "type": "boolean"
+ },
+ "leadPhone": {
+ "type": "string"
+ },
+ "passDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "passDisposition": {
+ "enum": [
+ "ANSWER",
+ "NOANSWER",
+ "BUSY",
+ "MACHINE",
+ "INTERCEPT",
+ "DISCONNECT",
+ "ABANDON",
+ "CONGESTION",
+ "MANUAL_PASS",
+ "INBOUND_CALLBACK",
+ "APP_DNC",
+ "APP_REQUEUE",
+ "APP_REQUEUE_COMPLETE",
+ "APP_REQUEUE_ABANDON",
+ "INBOUND_ABANDON",
+ "API_BLOCKED",
+ "API_ERROR"
+ ],
+ "type": "string"
+ },
+ "passNumber": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "passUii": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignPassDisposition": {
+ "properties": {
+ "createCopy": {
+ "type": "boolean"
+ },
+ "destCampaign": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "isComplete": {
+ "type": "boolean"
+ },
+ "machineDetect": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "mergeOriginal": {
+ "type": "boolean"
+ },
+ "pass": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "passDispositionId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "passEnd": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "requeueDelay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "requeueType": {
+ "enum": [
+ "DEFAULT",
+ "NONE",
+ "STANDARD",
+ "PRIORITY"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignRedial": {
+ "properties": {
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "callBackDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "callBackPhone": {
+ "type": "string"
+ },
+ "campaignLead": {
+ "$ref": "#/components/schemas/CampaignLead"
+ },
+ "campaignPass": {
+ "$ref": "#/components/schemas/CampaignPass"
+ },
+ "id": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "redialId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignStats": {
+ "properties": {
+ "campaignId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "campaignName": {
+ "type": "string"
+ },
+ "complete": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "doNotCall": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "endDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "maxPasses": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "other": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "paused": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "readyFuture": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "readyNow": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "startDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "suppressed": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignTimeZoneDialCount": {
+ "properties": {
+ "dialFuture": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialNow": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "suppressed": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "timezone": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignTimeZoneDialCountWrapper": {
+ "properties": {
+ "campaignId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "campaignName": {
+ "type": "string"
+ },
+ "dialGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialGroupName": {
+ "type": "string"
+ },
+ "dialMode": {
+ "enum": [
+ "PREVIEW",
+ "CLICK_TO_TALK",
+ "PREDICTIVE",
+ "POWER",
+ "TCPA_SAFE_MODE"
+ ],
+ "type": "string"
+ },
+ "endDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "leadData": {
+ "items": {
+ "$ref": "#/components/schemas/CampaignTimeZoneDialCount"
+ },
+ "type": "array"
+ },
+ "maxPasses": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "passDelayMin": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "startDate": {
+ "$ref": "#/components/schemas/DateTime"
+ }
+ },
+ "type": "object"
+ },
+ "CampaignUnlimitedFieldGroup": {
+ "properties": {
+ "campaigns": {
+ "items": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "type": "array"
+ },
+ "extraDataMappings": {
+ "type": "string"
+ },
+ "groupName": {
+ "type": "string"
+ },
+ "unlimitedFieldGroupId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ChatGroup": {
+ "properties": {
+ "billingKey": {
+ "type": "string"
+ },
+ "chatGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatGroupSkills": {
+ "items": {
+ "$ref": "#/components/schemas/ChatGroupSkill"
+ },
+ "type": "array"
+ },
+ "chatGroups": {
+ "items": {
+ "$ref": "#/components/schemas/ChatQueue"
+ },
+ "type": "array"
+ },
+ "chatQueues": {
+ "items": {
+ "$ref": "#/components/schemas/ChatQueue"
+ },
+ "type": "array"
+ },
+ "createdOn": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "groupName": {
+ "type": "string"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ChatGroupSkill": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "agentSkillProfiles": {
+ "$ref": "#/components/schemas/CollectionAgentSkillProfile"
+ },
+ "chatRequeueShortcuts": {
+ "items": {
+ "$ref": "#/components/schemas/ChatRequeueShortcut"
+ },
+ "type": "array"
+ },
+ "createdOn": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "skillDesc": {
+ "type": "string"
+ },
+ "skillId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "skillName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChatPriorityGroup": {
+ "properties": {
+ "chatPriorityGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatQueues": {
+ "items": {
+ "$ref": "#/components/schemas/ChatQueue"
+ },
+ "type": "array"
+ },
+ "priorityGroupName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChatQueue": {
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/Account"
+ },
+ "accountId": {
+ "type": "string"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "agentConnectHttpService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "agentConnectMsg": {
+ "type": "string"
+ },
+ "agentFrom": {
+ "type": "string"
+ },
+ "agentMaxAcceptTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentTermHttpService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "agentWrapTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "appUrl": {
+ "type": "string"
+ },
+ "callbackCampaign": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "chatGroup": {
+ "$ref": "#/components/schemas/ChatGroup"
+ },
+ "chatPriorityGroup": {
+ "$ref": "#/components/schemas/ChatPriorityGroup"
+ },
+ "chatQueueDescription": {
+ "type": "string"
+ },
+ "chatQueueId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatQueueName": {
+ "type": "string"
+ },
+ "chatQueueOpen": {
+ "type": "boolean"
+ },
+ "clientFrom": {
+ "type": "string"
+ },
+ "companyLogo": {
+ "$ref": "#/components/schemas/Blob"
+ },
+ "createdOn": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "dequeueHttpService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "dispTimeout": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "friSched": {
+ "type": "string"
+ },
+ "gateQueueAnips": {
+ "items": {
+ "$ref": "#/components/schemas/ChatQueueAnip"
+ },
+ "type": "array"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "idleTimeout": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "longChatTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxQueueEvent": {
+ "type": "string"
+ },
+ "maxQueueLimit": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "monSched": {
+ "type": "string"
+ },
+ "newChatHttpService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "noAgentEvent": {
+ "type": "string"
+ },
+ "observeDst": {
+ "type": "boolean"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "postChatHttpService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "postDispHttpService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "queueClosedEvent": {
+ "type": "string"
+ },
+ "queuePriority": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "requeueShortcutAccess": {
+ "items": {
+ "$ref": "#/components/schemas/ChatRequeueShortcutGroupChatQueueAccess"
+ },
+ "type": "array"
+ },
+ "requeueType": {
+ "type": "string"
+ },
+ "requireCaptcha": {
+ "type": "boolean"
+ },
+ "satSched": {
+ "type": "string"
+ },
+ "script": {
+ "$ref": "#/components/schemas/Script"
+ },
+ "shortChatTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "slaTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "specialIpEvent": {
+ "type": "string"
+ },
+ "sunSched": {
+ "type": "string"
+ },
+ "surveyId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "surveyPopType": {
+ "type": "string"
+ },
+ "throttleCalls": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "throttleDays": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "throttleIpEvent": {
+ "type": "string"
+ },
+ "thuSched": {
+ "type": "string"
+ },
+ "tueSched": {
+ "type": "string"
+ },
+ "wedSched": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChatQueueAnip": {
+ "properties": {
+ "anip": {
+ "type": "string"
+ },
+ "chatQueueId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dateAdded": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "recordType": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChatQueueChatWidgetAccess": {
+ "properties": {
+ "chatQueue": {
+ "$ref": "#/components/schemas/ChatQueue"
+ },
+ "chatQueueId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatWidget": {
+ "$ref": "#/components/schemas/ChatWidget"
+ },
+ "guid": {
+ "type": "string"
+ },
+ "jsonMetadata": {
+ "type": "string"
+ },
+ "widgetId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ChatQueueClosedMessage": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "chatQueueClosedMessageId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatQueueId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "jsonBaggage": {
+ "type": "string"
+ },
+ "sourceIp": {
+ "type": "string"
+ },
+ "timeStamp": {
+ "$ref": "#/components/schemas/DateTime"
+ }
+ },
+ "type": "object"
+ },
+ "ChatQueueDisposition": {
+ "properties": {
+ "chatGroupSkill": {
+ "$ref": "#/components/schemas/ChatGroupSkill"
+ },
+ "chatQueue": {
+ "$ref": "#/components/schemas/ChatQueue"
+ },
+ "destChatQueue": {
+ "$ref": "#/components/schemas/ChatQueue"
+ },
+ "dispServiceId": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "disposition": {
+ "type": "string"
+ },
+ "dispositionId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "emailDestinations": {
+ "type": "string"
+ },
+ "emailTemplate": {
+ "$ref": "#/components/schemas/EmailTemplate"
+ },
+ "isComplete": {
+ "type": "boolean"
+ },
+ "isDefault": {
+ "type": "boolean"
+ },
+ "isDisabled": {
+ "type": "boolean"
+ },
+ "isSuccess": {
+ "type": "boolean"
+ },
+ "rank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "timeout": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ChatQueueEvent": {
+ "properties": {
+ "chatQueue": {
+ "$ref": "#/components/schemas/ChatQueue"
+ },
+ "eventDuration": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "eventId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "eventRank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "queueEvent": {
+ "type": "string"
+ },
+ "sendMessage": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChatQueueScheduleOverride": {
+ "properties": {
+ "chatQueue": {
+ "$ref": "#/components/schemas/ChatQueue"
+ },
+ "overrideClosedEvent": {
+ "type": "string"
+ },
+ "overrideDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "overrideLabel": {
+ "type": "string"
+ },
+ "overrideSched": {
+ "type": "string"
+ },
+ "scheduleOverrideId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ChatQueueSkinny": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "chatGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatQueueId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatQueueName": {
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ChatQueueSpecialAnip": {
+ "properties": {
+ "anip": {
+ "type": "string"
+ },
+ "dateAdded": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "id": {
+ "type": "object"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChatRequeueShortcut": {
+ "properties": {
+ "chatGroupSkill": {
+ "$ref": "#/components/schemas/ChatGroupSkill"
+ },
+ "chatRequeueShortcutId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "rank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "requeueGroup": {
+ "$ref": "#/components/schemas/ChatGroup"
+ },
+ "requeueQueue": {
+ "$ref": "#/components/schemas/ChatQueue"
+ }
+ },
+ "type": "object"
+ },
+ "ChatRequeueShortcutGroup": {
+ "properties": {
+ "chatRequeueShortcutGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChatRequeueShortcutGroupChatQueueAccess": {
+ "properties": {
+ "chatQueue": {
+ "$ref": "#/components/schemas/ChatQueue"
+ },
+ "chatQueueId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatRequeueShortcutGroup": {
+ "$ref": "#/components/schemas/ChatRequeueShortcutGroup"
+ },
+ "chatRequeueShortcutGroupId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ChatRoom": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "permissionType": {
+ "enum": [
+ "ALL",
+ "EXPLICIT"
+ ],
+ "type": "string"
+ },
+ "roomDesc": {
+ "type": "string"
+ },
+ "roomId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "roomName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ChatStats": {
+ "properties": {
+ "abandoned": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "accepted": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "accountId": {
+ "type": "string"
+ },
+ "active": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "available": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatQueueGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatQueueGroupName": {
+ "type": "string"
+ },
+ "chatQueueId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatQueueName": {
+ "type": "string"
+ },
+ "deflected": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "inQueue": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "lastUpdate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "longestInQueue": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "presented": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "routing": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "schedule": {
+ "type": "string"
+ },
+ "scheduleOverride": {
+ "type": "string"
+ },
+ "selectable": {
+ "type": "boolean"
+ },
+ "staffed": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalAbandonTime": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "totalAnswerTime": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "totalChatTime": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "totalQueueTime": {
+ "format": "int64",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ChatWidget": {
+ "properties": {
+ "chatWidgetId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "createdDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "json": {
+ "type": "string"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "updatedDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "widgetDesc": {
+ "type": "string"
+ },
+ "widgetId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "widgetName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Chronology": {
+ "properties": {
+ "zone": {
+ "$ref": "#/components/schemas/DateTimeZone"
+ }
+ },
+ "type": "object"
+ },
+ "ClassLoader": {
+ "properties": {
+ "parent": {
+ "$ref": "#/components/schemas/ClassLoader"
+ }
+ },
+ "title": "ClassLoader",
+ "type": "object"
+ },
+ "CloudRouteAssignedDestination": {
+ "properties": {
+ "allocationPercent": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "allocationPercentHours": {
+ "type": "string"
+ },
+ "assignedDestinationId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "cloudDestination": {
+ "$ref": "#/components/schemas/CloudRouteDestination"
+ },
+ "cloudProfile": {
+ "$ref": "#/components/schemas/CloudRouteProfile"
+ },
+ "countryCode": {
+ "$ref": "#/components/schemas/CountryCode"
+ },
+ "destinationType": {
+ "enum": [
+ "STANDARD",
+ "DID",
+ "SIP",
+ "IN_NETWORK_DID",
+ "ACD",
+ "IVR",
+ "IVR_STUDIO"
+ ],
+ "type": "string"
+ },
+ "dtmfEventsEnabled": {
+ "type": "boolean"
+ },
+ "enablePrerouteHttp": {
+ "type": "boolean"
+ },
+ "forceAcdQueue": {
+ "type": "boolean"
+ },
+ "outboundCallerId": {
+ "type": "string"
+ },
+ "overrideFlag": {
+ "type": "boolean"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "rank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "repeatIndexStart": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "ringDuration": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "routeDestination": {
+ "type": "string"
+ },
+ "takeBackDtmf": {
+ "type": "string"
+ },
+ "ttAccept": {
+ "type": "boolean"
+ },
+ "ttAcceptTime": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CloudRouteAssignedOverride": {
+ "properties": {
+ "assignedDestination": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ },
+ "assignedOverrideId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "countryId": {
+ "type": "string"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "routeDestination": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CloudRouteDestination": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "address": {
+ "type": "string"
+ },
+ "authKey": {
+ "type": "string"
+ },
+ "city": {
+ "type": "string"
+ },
+ "cloudDestinationId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "cloudRouteGroup": {
+ "$ref": "#/components/schemas/CloudRouteGroup"
+ },
+ "countryCode": {
+ "$ref": "#/components/schemas/CountryCode"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "destinationDesc": {
+ "type": "string"
+ },
+ "destinationName": {
+ "type": "string"
+ },
+ "destinationType": {
+ "enum": [
+ "STANDARD",
+ "DID",
+ "SIP",
+ "IN_NETWORK_DID",
+ "ACD",
+ "IVR",
+ "IVR_STUDIO"
+ ],
+ "type": "string"
+ },
+ "endDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "forceAcdQueue": {
+ "type": "boolean"
+ },
+ "friSched": {
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "isDeleted": {
+ "type": "boolean"
+ },
+ "lat": {
+ "format": "double",
+ "type": "number"
+ },
+ "lon": {
+ "format": "double",
+ "type": "number"
+ },
+ "maxConcurrent": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxConcurrentHours": {
+ "type": "string"
+ },
+ "maxConcurrentType": {
+ "type": "string"
+ },
+ "monSched": {
+ "type": "string"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "prerouteHttpUrl": {
+ "type": "string"
+ },
+ "ringDuration": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "routeDestination": {
+ "type": "string"
+ },
+ "satSched": {
+ "type": "string"
+ },
+ "startDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "state": {
+ "type": "string"
+ },
+ "sunSched": {
+ "type": "string"
+ },
+ "thuSched": {
+ "type": "string"
+ },
+ "ttAccept": {
+ "type": "boolean"
+ },
+ "ttAcceptTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "tueSched": {
+ "type": "string"
+ },
+ "wedSched": {
+ "type": "string"
+ },
+ "zip": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CloudRouteDestinationOverride": {
+ "properties": {
+ "cloudDestination": {
+ "$ref": "#/components/schemas/CloudRouteDestination"
+ },
+ "countryId": {
+ "type": "string"
+ },
+ "destOverrideId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "routeDestination": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CloudRouteDtmfEvent": {
+ "properties": {
+ "cloudRouteDtmfId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dtmfCode": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dtmfEventData": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CloudRouteGroup": {
+ "properties": {
+ "cloudGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "cloudRouteDestinations": {
+ "$ref": "#/components/schemas/CollectionCloudRouteDestination"
+ },
+ "cloudRouteProfiles": {
+ "$ref": "#/components/schemas/CollectionCloudRouteProfile"
+ },
+ "groupName": {
+ "type": "string"
+ },
+ "isDefault": {
+ "type": "boolean"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CloudRouteProfile": {
+ "properties": {
+ "billingCode": {
+ "type": "string"
+ },
+ "billingKey": {
+ "type": "string"
+ },
+ "callConnSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "callEndSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "callStartSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "cloudProfileId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "cloudRouteGroup": {
+ "$ref": "#/components/schemas/CloudRouteGroup"
+ },
+ "dequeueDelay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "endcallMsg": {
+ "type": "string"
+ },
+ "geoMaxDistance": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "introMsg": {
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "isDeleted": {
+ "type": "boolean"
+ },
+ "longCall": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "outboundCallerId": {
+ "type": "string"
+ },
+ "percentAllocType": {
+ "type": "string"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "profileDesc": {
+ "type": "string"
+ },
+ "profileName": {
+ "type": "string"
+ },
+ "recordCall": {
+ "type": "boolean"
+ },
+ "repeatCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "repeatDelay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "revMatch": {
+ "type": "boolean"
+ },
+ "routeExhaustedAction": {
+ "type": "string"
+ },
+ "routingType": {
+ "type": "string"
+ },
+ "shortCall": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "stickyDestinationType": {
+ "type": "string"
+ },
+ "takeBackMsg": {
+ "type": "string"
+ },
+ "voicemailEmail": {
+ "type": "string"
+ },
+ "whisperMsg": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CloudRouteProfileSkinny": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "cloudGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "cloudProfileId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "isDeleted": {
+ "type": "boolean"
+ },
+ "profileName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CollectionAgent": {
+ "type": "object"
+ },
+ "CollectionAgentAccountAccess": {
+ "type": "object"
+ },
+ "CollectionAgentBlockMonitor": {
+ "type": "object"
+ },
+ "CollectionAgentChatQueueAccess": {
+ "type": "object"
+ },
+ "CollectionAgentDialGroupMember": {
+ "type": "object"
+ },
+ "CollectionAgentGateAccess": {
+ "type": "object"
+ },
+ "CollectionAgentLoadBalanceMember": {
+ "type": "object"
+ },
+ "CollectionAgentLoginChatQueues": {
+ "type": "object"
+ },
+ "CollectionAgentLoginGate": {
+ "type": "object"
+ },
+ "CollectionAgentSkillProfile": {
+ "type": "object"
+ },
+ "CollectionAgentSupervisor": {
+ "type": "object"
+ },
+ "CollectionCampaign": {
+ "type": "object"
+ },
+ "CollectionCampaignDisposition": {
+ "type": "object"
+ },
+ "CollectionCampaignFilterStates": {
+ "type": "object"
+ },
+ "CollectionCampaignFilterTimezones": {
+ "type": "object"
+ },
+ "CollectionCloudRouteDestination": {
+ "type": "object"
+ },
+ "CollectionCloudRouteProfile": {
+ "type": "object"
+ },
+ "CollectionCustomCriteriaPlan": {
+ "type": "object"
+ },
+ "CollectionCustomDialZone": {
+ "type": "object"
+ },
+ "CollectionCustomDialZoneGroups": {
+ "type": "object"
+ },
+ "CollectionDncTag": {
+ "type": "object"
+ },
+ "CollectionJobInfo": {
+ "type": "object"
+ },
+ "CollectionMultipartFile": {
+ "type": "object"
+ },
+ "CollectionQuotaTarget": {
+ "type": "object"
+ },
+ "CollectionRemoteHttpService": {
+ "type": "object"
+ },
+ "CollectionRemoteHttpServiceInput": {
+ "type": "object"
+ },
+ "CollectionReportMetaData": {
+ "type": "object"
+ },
+ "CollectionRequeueShortcut": {
+ "type": "object"
+ },
+ "CollectionRightsDocument": {
+ "type": "object"
+ },
+ "CollectionState": {
+ "type": "object"
+ },
+ "CollectionSurvey": {
+ "type": "object"
+ },
+ "CollectionTracLocation": {
+ "type": "object"
+ },
+ "CollectionVisualIvr": {
+ "type": "object"
+ },
+ "CollectionWhitelistTagMembers": {
+ "type": "object"
+ },
+ "Collection_AgentAccountAccess_": {
+ "type": "object"
+ },
+ "Collection_AgentChatQueueAccess_": {
+ "type": "object"
+ },
+ "Collection_AgentDialGroupMember_": {
+ "type": "object"
+ },
+ "Collection_AgentGateAccess_": {
+ "type": "object"
+ },
+ "Collection_AgentLoadBalanceMember_": {
+ "type": "object"
+ },
+ "Collection_AgentSkillProfile_": {
+ "type": "object"
+ },
+ "Collection_AgentSupervisor_": {
+ "type": "object"
+ },
+ "Collection_Agent_": {
+ "type": "object"
+ },
+ "Collection_CampaignDisposition_": {
+ "type": "object"
+ },
+ "Collection_CampaignFilterStates_": {
+ "type": "object"
+ },
+ "Collection_CampaignFilterTimezones_": {
+ "type": "object"
+ },
+ "Collection_Campaign_": {
+ "type": "object"
+ },
+ "Collection_CustomDialZone_": {
+ "type": "object"
+ },
+ "Collection_GateSkinny_": {
+ "type": "object"
+ },
+ "Collection_QuotaTarget_": {
+ "type": "object"
+ },
+ "Collection_RequeueShortcut_": {
+ "type": "object"
+ },
+ "Collection_WhitelistTagMembers_": {
+ "type": "object"
+ },
+ "ComparableSearchField": {
+ "properties": {
+ "operator": {
+ "enum": [
+ "GREATER_THAN",
+ "LESS_THAN",
+ "EQUALS"
+ ],
+ "type": "string"
+ },
+ "value": {
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "Contact": {
+ "properties": {
+ "businessPhone": {
+ "type": "string"
+ },
+ "company": {
+ "type": "string"
+ },
+ "department": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "emailAsLoginName": {
+ "type": "boolean"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "jobTitle": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "mobilePhone": {
+ "type": "string"
+ }
+ },
+ "title": "Contact",
+ "type": "object"
+ },
+ "Country": {
+ "properties": {
+ "countryCode": {
+ "type": "string"
+ },
+ "countryId": {
+ "description": "Country code i ISO 3166-1 alpha-3 format",
+ "type": "string"
+ },
+ "countryName": {
+ "type": "string"
+ },
+ "maxAniLength": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxUtcOffset": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "minAniLength": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "minUtcOffset": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "countryCode"
+ ],
+ "type": "object"
+ },
+ "CountryCode": {
+ "properties": {
+ "countryCode": {
+ "type": "string"
+ },
+ "countryId": {
+ "type": "string"
+ },
+ "countryName": {
+ "type": "string"
+ },
+ "maxAniLength": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxUtcOffset": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "minAniLength": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "minUtcOffset": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "CustomCriteriaGroup": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "customCriteriaPlan": {
+ "$ref": "#/components/schemas/CollectionCustomCriteriaPlan"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "groupName": {
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "CustomCriteriaPlan": {
+ "properties": {
+ "criteriaJson": {
+ "type": "string"
+ },
+ "endDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "planId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "planName": {
+ "type": "string"
+ },
+ "startDate": {
+ "$ref": "#/components/schemas/DateTime"
+ }
+ },
+ "type": "object"
+ },
+ "CustomDialZone": {
+ "properties": {
+ "fridaySchedule": {
+ "type": "string"
+ },
+ "mondaySchedule": {
+ "type": "string"
+ },
+ "saturdaySchedule": {
+ "type": "string"
+ },
+ "sundaySchedule": {
+ "type": "string"
+ },
+ "thursdaySchedule": {
+ "type": "string"
+ },
+ "tuesdaySchedule": {
+ "type": "string"
+ },
+ "wednesdaySchedule": {
+ "type": "string"
+ },
+ "zoneDesc": {
+ "type": "string"
+ },
+ "zoneGroup": {
+ "$ref": "#/components/schemas/CustomDialZoneGroups"
+ },
+ "zoneGroups": {
+ "$ref": "#/components/schemas/CustomDialZoneGroups"
+ },
+ "zoneId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "zoneKey": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CustomDialZoneGroups": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "baseTimezone": {
+ "type": "string"
+ },
+ "customDialZones": {
+ "$ref": "#/components/schemas/CollectionCustomDialZone"
+ },
+ "zoneGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "zoneGroupName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Dashboard": {
+ "properties": {
+ "creationDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "data": {
+ "$ref": "#/components/schemas/JsonNode"
+ },
+ "id": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "shared": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Role": {
+ "type": "object",
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "roleType": {
+ "type": "string",
+ "enum": [
+ "SUPER_USER",
+ "USER",
+ "MANAGE_USERS",
+ "MANAGE_RIGHTS",
+ "ACCESS_SIBLINGS",
+ "ACCESS_AUDIT_LOG",
+ "ACCESS_GOODDATA_ADMIN",
+ "ACCESS_GOODDATA_EDITOR",
+ "ACCESS_GOODDATA_EXPLORER",
+ "ACCESS_GOODDATA_VIEWER",
+ "ACCESS_GOODDATA_EMBEDDED_EXPLORER",
+ "ACCESS_GOODDATA_EMBEDDED_DASHBOARD",
+ "ASSUME_USERS",
+ "REPORT_ADMINISTRATIVE_USER",
+ "NO_ACCESS"
+ ]
+ }
+ }
+ },
+ "DateTime": {
+ "properties": {
+ "afterNow": {
+ "type": "boolean"
+ },
+ "beforeNow": {
+ "type": "boolean"
+ },
+ "centuryOfEra": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chronology": {
+ "$ref": "#/components/schemas/Chronology"
+ },
+ "dayOfMonth": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dayOfWeek": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dayOfYear": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "equalNow": {
+ "type": "boolean"
+ },
+ "era": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "hourOfDay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "millis": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "millisOfDay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "millisOfSecond": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "minuteOfDay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "minuteOfHour": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "monthOfYear": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "secondOfDay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "secondOfMinute": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "weekOfWeekyear": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "weekyear": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "year": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "yearOfCentury": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "yearOfEra": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "zone": {
+ "$ref": "#/components/schemas/DateTimeZone"
+ }
+ },
+ "type": "object"
+ },
+ "DateTimeComparableSearchField": {
+ "properties": {
+ "operator": {
+ "enum": [
+ "GREATER_THAN",
+ "LESS_THAN",
+ "EQUALS"
+ ],
+ "type": "string"
+ },
+ "value": {
+ "$ref": "#/components/schemas/DateTime"
+ }
+ },
+ "type": "object"
+ },
+ "DateTimeField": {
+ "properties": {
+ "durationField": {
+ "$ref": "#/components/schemas/DurationField"
+ },
+ "leapDurationField": {
+ "$ref": "#/components/schemas/DurationField"
+ },
+ "lenient": {
+ "type": "boolean"
+ },
+ "maximumValue": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "minimumValue": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "rangeDurationField": {
+ "$ref": "#/components/schemas/DurationField"
+ },
+ "supported": {
+ "type": "boolean"
+ },
+ "type": {
+ "$ref": "#/components/schemas/DateTimeFieldType"
+ }
+ },
+ "type": "object"
+ },
+ "DateTimeFieldType": {
+ "properties": {
+ "durationType": {
+ "$ref": "#/components/schemas/DurationFieldType"
+ },
+ "name": {
+ "type": "string"
+ },
+ "rangeDurationType": {
+ "$ref": "#/components/schemas/DurationFieldType"
+ }
+ },
+ "type": "object"
+ },
+ "DateTimeZone": {
+ "properties": {
+ "fixed": {
+ "type": "boolean"
+ },
+ "id": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DeferredResultMessage": {
+ "properties": {
+ "result": {
+ "type": "object"
+ },
+ "setOrExpired": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DeleteDnisRequest": {
+ "properties": {
+ "dnis": {
+ "type": "string"
+ },
+ "dnisE164": {
+ "type": "string"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DestinationCampaignRequest": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "campaignId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialGroupId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "DestinationParams": {
+ "properties": {
+ "destinationType": {
+ "enum": [
+ "EMAIL",
+ "FILE_TRANSFER",
+ "SECURE_FILE_TRANSFER"
+ ],
+ "type": "string"
+ },
+ "isCompress": {
+ "type": "boolean"
+ },
+ "titleDateTimeFormat": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Device": {
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "linePooling": {
+ "type": "string"
+ },
+ "phoneLines": {
+ "items": {
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "status": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "uri": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DialGroup": {
+ "properties": {
+ "agentDialGroupMembers": {
+ "$ref": "#/components/schemas/CollectionAgentDialGroupMember"
+ },
+ "agentsReady": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "allowLeadSearch": {
+ "type": "string"
+ },
+ "allowPreviewLeadFilters": {
+ "type": "boolean"
+ },
+ "billingKey": {
+ "type": "string"
+ },
+ "campaigns": {
+ "$ref": "#/components/schemas/CollectionCampaign"
+ },
+ "dialGroupDesc": {
+ "type": "string"
+ },
+ "dialGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialGroupName": {
+ "type": "string"
+ },
+ "dialMode": {
+ "enum": [
+ "PREVIEW",
+ "CLICK_TO_TALK",
+ "PREDICTIVE",
+ "POWER",
+ "TCPA_SAFE_MODE"
+ ],
+ "type": "string"
+ },
+ "enableAbsolutePriority": {
+ "type": "boolean"
+ },
+ "enableAgentFilter": {
+ "type": "boolean"
+ },
+ "enableCallbacksAfterMaxDailyPass": {
+ "type": "boolean"
+ },
+ "enableCallbacksAfterMaxpass": {
+ "type": "boolean"
+ },
+ "enableListPriority": {
+ "type": "boolean"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "hciEnabled": {
+ "enum": [
+ "DISABLED",
+ "HCI_FETCH",
+ "HCI_PACING"
+ ],
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "maxLeadsReturned": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxPorts": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "minPredictiveAgents": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "outdialServerGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "progressiveCallDelay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "progressiveEnabled": {
+ "type": "boolean"
+ },
+ "realTimeAgentData": {
+ "type": "boolean"
+ },
+ "requireFetchedLeadsCalled": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DialGroupTimeZoneDialCountWrapper": {
+ "properties": {
+ "dialGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialGroupName": {
+ "type": "string"
+ },
+ "dialMode": {
+ "enum": [
+ "PREVIEW",
+ "CLICK_TO_TALK",
+ "PREDICTIVE",
+ "POWER",
+ "TCPA_SAFE_MODE"
+ ],
+ "type": "string"
+ },
+ "leadData": {
+ "items": {
+ "$ref": "#/components/schemas/CampaignTimeZoneDialCount"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DncListEntry": {
+ "properties": {
+ "addedBy": {
+ "type": "string"
+ },
+ "addedDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "countryCode": {
+ "$ref": "#/components/schemas/CountryCode"
+ },
+ "dncTagId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "phone": {
+ "type": "string"
+ },
+ "reason": {
+ "type": "string"
+ },
+ "tag": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DncTag": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "dncTagId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dncTagLabel": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DnisBulkUpdateRespose": {
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "status": {
+ "type": "string"
+ },
+ "updatedRows": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DnisListPreviewResponse": {
+ "properties": {
+ "records": {
+ "items": {
+ "$ref": "#/components/schemas/BaseCsvDto"
+ },
+ "type": "array"
+ },
+ "uploadStatus": {
+ "$ref": "#/components/schemas/DnisResponseValidation"
+ }
+ },
+ "type": "object"
+ },
+ "DnisListRequest": {
+ "properties": {
+ "accountIds": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dnisState": {
+ "type": "string"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ },
+ "searchText": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DnisMigrationResult": {
+ "properties": {
+ "tbl_acd_dnis_pool": {
+ "$ref": "#/components/schemas/DnisMigrationResultEntry"
+ },
+ "tbl_acd_gate_dnis": {
+ "$ref": "#/components/schemas/DnisMigrationResultEntry"
+ },
+ "tbl_acd_sms_dnis": {
+ "$ref": "#/components/schemas/DnisMigrationResultEntry"
+ }
+ },
+ "type": "object"
+ },
+ "DnisMigrationResultEntry": {
+ "properties": {
+ "converted": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "convertedAsIs": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "total": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "DnisNotification": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "missCall": {
+ "type": "boolean"
+ },
+ "notificationId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "notifyDest": {
+ "type": "string"
+ },
+ "shortCall": {
+ "type": "boolean"
+ },
+ "voicemail": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DnisPool": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "assignedDnis": {
+ "$ref": "#/components/schemas/AssignedDnis"
+ },
+ "assignedSmsDnis": {
+ "$ref": "#/components/schemas/AssignedSmsDnis"
+ },
+ "carrier": {
+ "type": "string"
+ },
+ "customAppString": {
+ "type": "string"
+ },
+ "dateCreated": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "dnisCategory": {
+ "type": "string"
+ },
+ "dnisDescription": {
+ "type": "string"
+ },
+ "dnisE164": {
+ "type": "string"
+ },
+ "dnisManagedByRC": {
+ "type": "boolean"
+ },
+ "inboundContext": {
+ "type": "string"
+ },
+ "lastModified": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "lastModifiedBy": {
+ "type": "string"
+ },
+ "mediaCode": {
+ "type": "string"
+ },
+ "mediaFormat": {
+ "type": "string"
+ },
+ "mediaIsci": {
+ "type": "string"
+ },
+ "mediaLength": {
+ "type": "string"
+ },
+ "mediaMarket": {
+ "type": "string"
+ },
+ "mediaNetwork": {
+ "type": "string"
+ },
+ "mediaUrl": {
+ "type": "string"
+ },
+ "mediaVersion": {
+ "type": "string"
+ },
+ "mediaWebSourcecode": {
+ "type": "string"
+ },
+ "notes": {
+ "type": "string"
+ },
+ "originatingDnis": {
+ "type": "string"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ },
+ "platformId": {
+ "type": "string"
+ },
+ "reservedAccount": {
+ "$ref": "#/components/schemas/Account"
+ },
+ "reservedAccountId": {
+ "type": "string"
+ },
+ "resporg": {
+ "type": "string"
+ },
+ "smsEnabled": {
+ "type": "boolean"
+ },
+ "twilioApiKey": {
+ "type": "string"
+ },
+ "vendorId": {
+ "type": "string"
+ },
+ "vruNetworkId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "DnisPoolUpdateRequest": {
+ "properties": {
+ "chatQueueId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dnisPool": {
+ "$ref": "#/components/schemas/DnisPoolV2"
+ },
+ "endDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "product": {
+ "enum": [
+ "ACCOUNT",
+ "ACD",
+ "AGENT",
+ "CHAT_QUEUE",
+ "OUTBOUND",
+ "VISUAL_IVR",
+ "CLOUD_PROFILE",
+ "CLOUD_DESTINATION",
+ "TRAC_NUMBER",
+ "HTTP_SERVICES",
+ "SCRIPTING",
+ "TN_MANAGER",
+ "SURVEY",
+ "DNIS",
+ "TEAMS",
+ "KNOWLEDGE_BASE",
+ "UTILITIES"
+ ],
+ "type": "string"
+ },
+ "productId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "smsEndDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "smsStartDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "startDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "unassignProduct": {
+ "type": "boolean"
+ },
+ "unassignSmsProduct": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DnisPoolV2": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "assignedDnis": {
+ "$ref": "#/components/schemas/AssignedDnis"
+ },
+ "assignedSmsDnis": {
+ "$ref": "#/components/schemas/AssignedSmsDnis"
+ },
+ "carrier": {
+ "type": "string"
+ },
+ "customAppString": {
+ "type": "string"
+ },
+ "dateCreated": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "dnisCategory": {
+ "type": "string"
+ },
+ "dnisDescription": {
+ "type": "string"
+ },
+ "dnisE164": {
+ "type": "string"
+ },
+ "inboundContext": {
+ "type": "string"
+ },
+ "lastModified": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "lastModifiedBy": {
+ "type": "string"
+ },
+ "mediaCode": {
+ "type": "string"
+ },
+ "mediaFormat": {
+ "type": "string"
+ },
+ "mediaIsci": {
+ "type": "string"
+ },
+ "mediaLength": {
+ "type": "string"
+ },
+ "mediaMarket": {
+ "type": "string"
+ },
+ "mediaNetwork": {
+ "type": "string"
+ },
+ "mediaUrl": {
+ "type": "string"
+ },
+ "mediaVersion": {
+ "type": "string"
+ },
+ "mediaWebSourcecode": {
+ "type": "string"
+ },
+ "notes": {
+ "type": "string"
+ },
+ "originatingDnis": {
+ "type": "string"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ },
+ "platformId": {
+ "type": "string"
+ },
+ "reservedAccount": {
+ "$ref": "#/components/schemas/Account"
+ },
+ "reservedAccountId": {
+ "type": "string"
+ },
+ "resporg": {
+ "type": "string"
+ },
+ "smsEnabled": {
+ "type": "boolean"
+ },
+ "twilioApiKey": {
+ "type": "string"
+ },
+ "vendorId": {
+ "type": "string"
+ },
+ "vruNetworkId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "DnisResponseValidation": {
+ "properties": {
+ "errorCode": {
+ "type": "string"
+ },
+ "errorMessage": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "totalRecords": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "validRecords": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "validated": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DurationField": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "precise": {
+ "type": "boolean"
+ },
+ "supported": {
+ "type": "boolean"
+ },
+ "type": {
+ "$ref": "#/components/schemas/DurationFieldType"
+ },
+ "unitMillis": {
+ "format": "int64",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "DurationFieldType": {
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EVUser": {
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "ev_user_type": {
+ "enum": [
+ "admin",
+ "agent"
+ ],
+ "type": "string"
+ },
+ "ev_user_uid": {
+ "type": "string"
+ },
+ "first_name": {
+ "type": "string"
+ },
+ "is_active": {
+ "type": "boolean"
+ },
+ "last_name": {
+ "type": "string"
+ },
+ "rc_sync": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Element": {
+ "properties": {
+ "elements": {
+ "items": {
+ "$ref": "#/components/schemas/Element"
+ },
+ "type": "array"
+ },
+ "isComplex": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EmailTemplate": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "allowBccChange": {
+ "type": "boolean"
+ },
+ "allowBodyChange": {
+ "type": "boolean"
+ },
+ "allowCcChange": {
+ "type": "boolean"
+ },
+ "allowFromChange": {
+ "type": "boolean"
+ },
+ "allowSubjectChange": {
+ "type": "boolean"
+ },
+ "allowToChange": {
+ "type": "boolean"
+ },
+ "emailBcc": {
+ "type": "string"
+ },
+ "emailCc": {
+ "type": "string"
+ },
+ "emailFrom": {
+ "type": "string"
+ },
+ "emailRte": {
+ "type": "string"
+ },
+ "emailSubject": {
+ "type": "string"
+ },
+ "emailTemplateId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "emailTo": {
+ "type": "string"
+ },
+ "sendFormat": {
+ "type": "string"
+ },
+ "templateName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "EmailTemplateAttachment": {
+ "properties": {
+ "attachmentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "attachmentName": {
+ "type": "string"
+ },
+ "attachmentSize": {
+ "format": "int64",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "EmbeddedChatWidget": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "isOpen": {
+ "type": "boolean"
+ },
+ "open": {
+ "type": "boolean"
+ },
+ "showPoweredBy": {
+ "type": "boolean"
+ },
+ "widgetConfiguration": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Environment": {
+ "properties": {
+ "activeProfiles": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "defaultProfiles": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "title": "Environment",
+ "type": "object"
+ },
+ "Error": {
+ "properties": {
+ "details": {
+ "type": "string"
+ },
+ "generalMessage": {
+ "type": "string"
+ },
+ "requestUri": {
+ "type": "string"
+ },
+ "timestamp": {
+ "format": "int64",
+ "type": "integer"
+ }
+ }
+ },
+ "Errors": {
+ "properties": {
+ "cause": {
+ "type": "string"
+ },
+ "details": {
+ "type": "string"
+ },
+ "developerMessage": {
+ "type": "string"
+ },
+ "generalMessage": {
+ "type": "string"
+ },
+ "requestUri": {
+ "type": "string"
+ },
+ "timestamp": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "validationErrors": {
+ "items": {
+ "$ref": "#/components/schemas/ValidationErrorData"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ExtendedLeadData": {
+ "properties": {
+ "important": {
+ "type": "string"
+ },
+ "interested": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "FilteredIdView": {
+ "properties": {
+ "permission": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "products": {
+ "items": {
+ "enum": [
+ "ACCOUNT",
+ "ACD",
+ "AGENT",
+ "CHAT_QUEUE",
+ "OUTBOUND",
+ "VISUAL_IVR",
+ "CLOUD_PROFILE",
+ "CLOUD_DESTINATION",
+ "TRAC_NUMBER",
+ "HTTP_SERVICES",
+ "SCRIPTING",
+ "TN_MANAGER",
+ "SURVEY",
+ "DNIS",
+ "TEAMS",
+ "KNOWLEDGE_BASE",
+ "UTILITIES"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "permission",
+ "products"
+ ],
+ "type": "object"
+ },
+ "Gate": {
+ "properties": {
+ "abandonCampaign": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "acceptTime": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "afterCallBaseState": {
+ "type": "string"
+ },
+ "afterCallState": {
+ "$ref": "#/components/schemas/AccountAuxState"
+ },
+ "agentConnSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "agentGateAccess": {
+ "items": {
+ "$ref": "#/components/schemas/AgentGateAccess"
+ },
+ "type": "array"
+ },
+ "agentPopMessage": {
+ "type": "string"
+ },
+ "agentTermSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "appUrl": {
+ "type": "string"
+ },
+ "backupAppUrl": {
+ "type": "string"
+ },
+ "billingCode": {
+ "type": "string"
+ },
+ "blockedAniMessage": {
+ "type": "string"
+ },
+ "callbackCampaign": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "createdOn": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "dequeueDelay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dequeueSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "dispositionTimeout": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "enableGlobalPhoneBook": {
+ "type": "boolean"
+ },
+ "enableIvrTokens": {
+ "type": "boolean"
+ },
+ "endCallMessage": {
+ "type": "string"
+ },
+ "fifoDisabled": {
+ "type": "boolean"
+ },
+ "friSched": {
+ "type": "string"
+ },
+ "gateClosedEvent": {
+ "type": "string"
+ },
+ "gateDesc": {
+ "type": "string"
+ },
+ "gateGroup": {
+ "$ref": "#/components/schemas/GateGroup"
+ },
+ "gateId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gateName": {
+ "type": "string"
+ },
+ "gateOpen": {
+ "type": "boolean"
+ },
+ "gatePriority": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gatePriorityGroup": {
+ "$ref": "#/components/schemas/GatePriorityGroup"
+ },
+ "gateQueueEvents": {
+ "items": {
+ "$ref": "#/components/schemas/GateQueueEvent"
+ },
+ "type": "array"
+ },
+ "hangupOnDisposition": {
+ "type": "boolean"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "longCallTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "manualCallerId": {
+ "type": "string"
+ },
+ "manualCallerIdE164": {
+ "type": "string"
+ },
+ "maxQueueEvent": {
+ "type": "string"
+ },
+ "maxQueueLimit": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "monSched": {
+ "type": "string"
+ },
+ "noAgentEvent": {
+ "type": "string"
+ },
+ "observeDst": {
+ "type": "boolean"
+ },
+ "onHoldMessage": {
+ "type": "string"
+ },
+ "outboundCallerId": {
+ "type": "string"
+ },
+ "pauseRecordingSec": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "perspectiveRecordingMode": {
+ "enum": [
+ "DISABLED",
+ "ALL_AGENT_LEGS"
+ ],
+ "type": "string"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ },
+ "postCallSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "postDispSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "recordCall": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "recordingInConference": {
+ "type": "boolean"
+ },
+ "recordingSettings": {
+ "enum": [
+ "RECORD_FULL_CALL",
+ "AGENT_FULL_CONTROL_DEFAULT_ON",
+ "AGENT_FULL_CONTROL_DEFAULT_OFF",
+ "AGENT_PAUSE"
+ ],
+ "type": "string"
+ },
+ "requeueType": {
+ "enum": [
+ "ADVANCED",
+ "RESTRICTED"
+ ],
+ "type": "string"
+ },
+ "resultFileDestination": {
+ "$ref": "#/components/schemas/ResultFileDestination"
+ },
+ "revMatch": {
+ "type": "boolean"
+ },
+ "satSched": {
+ "type": "string"
+ },
+ "script": {
+ "$ref": "#/components/schemas/Script"
+ },
+ "shortAbandonTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "shortCallTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "singleChannelEnabled": {
+ "type": "boolean"
+ },
+ "slaTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "specialAniEvent": {
+ "type": "string"
+ },
+ "stopRecordingOnTransfer": {
+ "type": "boolean"
+ },
+ "sunSched": {
+ "type": "string"
+ },
+ "survey": {
+ "$ref": "#/components/schemas/Survey"
+ },
+ "surveyPopType": {
+ "type": "string"
+ },
+ "syncQueueWait": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "throttleCalls": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "throttleDays": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "throttlingAniEvent": {
+ "type": "string"
+ },
+ "thuSched": {
+ "type": "string"
+ },
+ "transferCallerId": {
+ "type": "string"
+ },
+ "transferCallerIdE164": {
+ "type": "string"
+ },
+ "transferTermSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "ttAccept": {
+ "type": "boolean"
+ },
+ "tueSched": {
+ "type": "string"
+ },
+ "wedSched": {
+ "type": "string"
+ },
+ "whisperMessage": {
+ "type": "string"
+ },
+ "wrapTime": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "GateDisposition": {
+ "properties": {
+ "destCampaign": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "dispSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "disposition": {
+ "type": "string"
+ },
+ "dncTagLabel": {
+ "type": "string"
+ },
+ "doNotCall": {
+ "type": "boolean"
+ },
+ "dtmfMapping": {
+ "type": "string"
+ },
+ "emailDestinations": {
+ "type": "string"
+ },
+ "emailTemplate": {
+ "$ref": "#/components/schemas/EmailTemplate"
+ },
+ "gateDispositionId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isComplete": {
+ "type": "boolean"
+ },
+ "isContact": {
+ "type": "boolean"
+ },
+ "isDefault": {
+ "type": "boolean"
+ },
+ "isDisabled": {
+ "type": "boolean"
+ },
+ "isRequeued": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isSuccess": {
+ "type": "boolean"
+ },
+ "rank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "requeueDelay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "requireNote": {
+ "type": "boolean"
+ },
+ "saveSurvey": {
+ "type": "boolean"
+ },
+ "setAgentFlag": {
+ "type": "boolean"
+ },
+ "timeout": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "xfer": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "xferDest": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GateGroup": {
+ "properties": {
+ "billingKey": {
+ "type": "string"
+ },
+ "createdOn": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "endDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "gateGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gates": {
+ "items": {
+ "$ref": "#/components/schemas/Gate"
+ },
+ "type": "array"
+ },
+ "groupName": {
+ "type": "string"
+ },
+ "groupSkills": {
+ "items": {
+ "$ref": "#/components/schemas/GateGroupSkill"
+ },
+ "type": "array"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "startDate": {
+ "$ref": "#/components/schemas/DateTime"
+ }
+ },
+ "type": "object"
+ },
+ "GateGroupSkill": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "agentSkillProfiles": {
+ "$ref": "#/components/schemas/CollectionAgentSkillProfile"
+ },
+ "createdOn": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "requeueShortcut": {
+ "items": {
+ "$ref": "#/components/schemas/RequeueShortcut"
+ },
+ "type": "array"
+ },
+ "skillDesc": {
+ "type": "string"
+ },
+ "skillId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "skillName": {
+ "type": "string"
+ },
+ "whisperAudio": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GateGroupSkinny": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "gateGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gates": {
+ "$ref": "#/components/schemas/Collection_GateSkinny_"
+ },
+ "groupName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GateGroupV2": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "billingKey": {
+ "type": "string"
+ },
+ "gateGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "groupName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GatePriorityGroup": {
+ "properties": {
+ "gatePriorityGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gatePriorityGroupName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GateQueueDtmfEvent": {
+ "properties": {
+ "dtmf": {
+ "type": "string"
+ },
+ "dtmfEvent": {
+ "type": "string"
+ },
+ "dtmfEventId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "GateQueueEvent": {
+ "properties": {
+ "enableDtmf": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "eventDuration": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "eventId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "eventRank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gate": {
+ "$ref": "#/components/schemas/Gate"
+ },
+ "queueEvent": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GateScheduleOverride": {
+ "properties": {
+ "overrideClosedEvent": {
+ "type": "string"
+ },
+ "overrideDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "overrideLabel": {
+ "type": "string"
+ },
+ "overrideSched": {
+ "type": "string"
+ },
+ "scheduleOverrideId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "GateSkinny": {
+ "properties": {
+ "gateGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gateId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gateName": {
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "GateSkinnyAssignable": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "gateGroup": {
+ "$ref": "#/components/schemas/GateGroupV2"
+ },
+ "gateGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gateId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "gateName": {
+ "type": "string"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isActive": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "GateSpecialAni": {
+ "properties": {
+ "ani": {
+ "type": "string"
+ },
+ "aniE164": {
+ "type": "string"
+ },
+ "dateAdded": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GateSpecialAniDeleteRequest": {
+ "properties": {
+ "ani": {
+ "type": "string"
+ },
+ "aniE164": {
+ "type": "string"
+ },
+ "effectiveAni": {
+ "type": "string"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ },
+ "type": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GatesLoggedInAgentsView": {
+ "properties": {
+ "agentGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "groupName": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GatesSelection": {
+ "properties": {
+ "gateIds": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Generic": {
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "id": {
+ "format": "int64",
+ "type": "integer"
+ }
+ }
+ },
+ "GenericEmail": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "attachments": {
+ "$ref": "#/components/schemas/CollectionMultipartFile"
+ },
+ "emailBcc": {
+ "type": "string"
+ },
+ "emailCc": {
+ "type": "string"
+ },
+ "emailFrom": {
+ "type": "string"
+ },
+ "emailPlainText": {
+ "type": "string"
+ },
+ "emailRte": {
+ "type": "string"
+ },
+ "emailSubject": {
+ "type": "string"
+ },
+ "emailTo": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GetRcLinkedAdminsRequest": {
+ "properties": {
+ "rcAccountId": {
+ "type": "string"
+ },
+ "rcExtensionIds": {
+ "items": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "HistorySource": {
+ "properties": {
+ "sourceDescription": {
+ "type": "string"
+ },
+ "sourceGroupDescription": {
+ "type": "string"
+ },
+ "sourceGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "sourceGroupName": {
+ "type": "string"
+ },
+ "sourceId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "sourceName": {
+ "type": "string"
+ },
+ "sourceType": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "HttpServiceMapping": {
+ "properties": {
+ "originalValue": {
+ "type": "string"
+ },
+ "replacementValue": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "IVRApplication": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "appDesc": {
+ "type": "string"
+ },
+ "appId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "appName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ImportNumber": {
+ "properties": {
+ "customAppString": {
+ "type": "string"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "dnisDescription": {
+ "type": "string"
+ },
+ "dnisE164": {
+ "type": "string"
+ },
+ "inboundContext": {
+ "type": "string"
+ },
+ "notes": {
+ "type": "string"
+ },
+ "originatingDnis": {
+ "type": "string"
+ },
+ "resporg": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ImportNumbersRequest": {
+ "properties": {
+ "numbersForImport": {
+ "items": {
+ "$ref": "#/components/schemas/ImportNumber"
+ },
+ "type": "array"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ },
+ "rcAccountId": {
+ "type": "string"
+ },
+ "subAccountId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "InputStream": {
+ "type": "object"
+ },
+ "IvrStats": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "active": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "connected": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "ivrGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "ivrGroupName": {
+ "type": "string"
+ },
+ "lastUpdate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "presented": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "selectable": {
+ "type": "boolean"
+ },
+ "transferCloud": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "transferGate": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "transferTrac": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "visualIvrId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "visualIvrName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "JobInfo": {
+ "properties": {
+ "finalFireTimeMillis": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "jobId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "jobParam": {
+ "$ref": "#/components/schemas/JobParamobject"
+ },
+ "jobState": {
+ "enum": [
+ "NONE",
+ "NORMAL",
+ "PAUSED",
+ "COMPLETE",
+ "ERROR",
+ "BLOCKED"
+ ],
+ "type": "string"
+ },
+ "jobType": {
+ "enum": [
+ "DNC_DOWNLOAD",
+ "ALERTING_JOB",
+ "LIST_DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "lastRunDateTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "name": {
+ "type": "string"
+ },
+ "nextFireTimeMillis": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "nextRunDateTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "ownerId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "schedule": {
+ "$ref": "#/components/schemas/Schedule"
+ }
+ },
+ "type": "object"
+ },
+ "JobParamobject": {
+ "properties": {
+ "data": {
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "JsonNode": {
+ "properties": {
+ "array": {
+ "type": "boolean"
+ },
+ "bigDecimal": {
+ "type": "boolean"
+ },
+ "bigInteger": {
+ "type": "boolean"
+ },
+ "binary": {
+ "type": "boolean"
+ },
+ "boolean": {
+ "type": "boolean"
+ },
+ "containerNode": {
+ "type": "boolean"
+ },
+ "double": {
+ "type": "boolean"
+ },
+ "empty": {
+ "type": "boolean"
+ },
+ "float": {
+ "type": "boolean"
+ },
+ "floatingPointNumber": {
+ "type": "boolean"
+ },
+ "int": {
+ "type": "boolean"
+ },
+ "integralNumber": {
+ "type": "boolean"
+ },
+ "long": {
+ "type": "boolean"
+ },
+ "missingNode": {
+ "type": "boolean"
+ },
+ "nodeType": {
+ "enum": [
+ "ARRAY",
+ "BINARY",
+ "BOOLEAN",
+ "MISSING",
+ null,
+ "NUMBER",
+ "OBJECT",
+ "POJO",
+ "STRING"
+ ],
+ "type": "string"
+ },
+ "null": {
+ "type": "boolean"
+ },
+ "number": {
+ "type": "boolean"
+ },
+ "object": {
+ "type": "boolean"
+ },
+ "pojo": {
+ "type": "boolean"
+ },
+ "short": {
+ "type": "boolean"
+ },
+ "textual": {
+ "type": "boolean"
+ },
+ "valueNode": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "KnowledgeBaseArticle": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "content": {
+ "type": "string"
+ },
+ "contentPlain": {
+ "type": "string"
+ },
+ "createdOn": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "knowledgeBaseArticleId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "knowledgeBaseCategory": {
+ "$ref": "#/components/schemas/KnowledgeBaseCategory"
+ },
+ "labels": {
+ "type": "string"
+ },
+ "order": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "showSend": {
+ "type": "boolean"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updatedOn": {
+ "$ref": "#/components/schemas/DateTime"
+ }
+ },
+ "type": "object"
+ },
+ "KnowledgeBaseCategory": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "createdOn": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "description": {
+ "type": "string"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "knowledgeBaseArticles": {
+ "items": {
+ "$ref": "#/components/schemas/KnowledgeBaseArticle"
+ },
+ "type": "array"
+ },
+ "knowledgeBaseCategoryId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "knowledgeBaseGroup": {
+ "$ref": "#/components/schemas/KnowledgeBaseGroup"
+ },
+ "order": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "title": {
+ "type": "string"
+ },
+ "updatedOn": {
+ "$ref": "#/components/schemas/DateTime"
+ }
+ },
+ "type": "object"
+ },
+ "KnowledgeBaseGroup": {
+ "properties": {
+ "knowledgeBaseCategories": {
+ "items": {
+ "$ref": "#/components/schemas/KnowledgeBaseCategory"
+ },
+ "type": "array"
+ },
+ "knowledgeBaseGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Lead": {
+ "properties": {
+ "address1": {
+ "type": "string"
+ },
+ "address2": {
+ "type": "string"
+ },
+ "auxData1": {
+ "type": "string"
+ },
+ "auxData2": {
+ "type": "string"
+ },
+ "auxData3": {
+ "type": "string"
+ },
+ "auxData4": {
+ "type": "string"
+ },
+ "auxData5": {
+ "type": "string"
+ },
+ "auxPhone": {
+ "type": "string"
+ },
+ "city": {
+ "type": "string"
+ },
+ "email": {
+ "type": "string"
+ },
+ "extendedLeadData": {
+ "$ref": "#/components/schemas/ExtendedLeadData"
+ },
+ "externId": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "gateKeeper": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "leadPhone": {
+ "description": "multiple values can be submitted with a pipe delimiter between phone numbers",
+ "type": "string"
+ },
+ "midName": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "suffix": {
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "zip": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "externId"
+ ],
+ "type": "object"
+ },
+ "LeadActionParams": {
+ "properties": {
+ "paramMap": {
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "LeadActionResult": {
+ "properties": {
+ "dialerRefreshed": {
+ "type": "boolean"
+ },
+ "errorMessage": {
+ "type": "string"
+ },
+ "leadActionType": {
+ "type": "string"
+ },
+ "leadDeleteCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadUpdateCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "redialDeleteCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "success": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "LeadListPagePreview": {
+ "properties": {
+ "pageName": {
+ "type": "string"
+ },
+ "pageNumber": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "rowData": {
+ "items": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LeadListPreviewResponse": {
+ "properties": {
+ "mappingColumns": {
+ "items": {
+ "enum": [
+ "LEAD_PHONE",
+ "EXTERN_ID",
+ "STATE",
+ "LEAD_TIMEZONE",
+ "PENDING_AGENT_ID",
+ "TITLE",
+ "FIRST_NAME",
+ "MID_NAME",
+ "LAST_NAME",
+ "SUFFIX",
+ "EMAIL",
+ "ADDRESS1",
+ "ADDRESS2",
+ "CITY",
+ "ZIP",
+ "GATE_KEEPER",
+ "AUX_DATA1",
+ "AUX_DATA2",
+ "AUX_DATA3",
+ "AUX_DATA4",
+ "AUX_DATA5",
+ "AUX_PHONE",
+ "AUX_EXTERNAL_URL",
+ "AUX_GREETING",
+ "LIVE_ANSWER_MESSAGE",
+ "MACH_ANSWER_MESSAGE",
+ "CALLER_ID",
+ "LEAD_PRIORITY",
+ "COUNTRY"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "pagePreviews": {
+ "items": {
+ "$ref": "#/components/schemas/LeadListPagePreview"
+ },
+ "type": "array"
+ },
+ "transactionId": {
+ "type": "string"
+ },
+ "personaPhoneConfig": {
+ "description": "Configured additional persona phone fields available for mapping when the campaign uses strategic calling configuration.",
+ "items": {
+ "$ref": "#/components/schemas/PersonaPhoneConfigFields"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LeadListProcessingRequest": {
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "dialPriority": {
+ "enum": [
+ "IMMEDIATE",
+ "NORMAL"
+ ],
+ "type": "string"
+ },
+ "dncTags": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "duplicateHandling": {
+ "enum": [
+ "RETAIN_ALL",
+ "REMOVE_ALL_EXISTING",
+ "REMOVE_FROM_LIST"
+ ],
+ "type": "string"
+ },
+ "extendedLeadDataMappings": {
+ "additionalProperties": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "object"
+ },
+ "fileContainsHeaders": {
+ "type": "boolean"
+ },
+ "fileType": {
+ "enum": [
+ "EXCEL",
+ "PIPE",
+ "COMMA",
+ "TAB"
+ ],
+ "type": "string"
+ },
+ "listState": {
+ "enum": [
+ "ACTIVE",
+ "PAUSED",
+ "PENDING_DNC",
+ "LOADING",
+ "DELETED",
+ "READY",
+ "CALLBACKS",
+ "CALLBACKS_AGENT",
+ "DUPLICATES_NOT_MERGED",
+ "DUPLICATES_NOT_MOVED",
+ "ARCHIVED"
+ ],
+ "type": "string"
+ },
+ "pageColumnMappings": {
+ "additionalProperties": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "object"
+ },
+ "pageNumber": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "quoteChar": {
+ "type": "string"
+ },
+ "timeZoneOption": {
+ "enum": [
+ "NPA_NXX",
+ "ZIPCODE",
+ "EXPLICIT",
+ "COUNTRY",
+ "NOT_APPLICABLE"
+ ],
+ "type": "string"
+ },
+ "transactionId": {
+ "type": "string"
+ },
+ "uploadLeads": {
+ "items": {
+ "$ref": "#/components/schemas/CampaignLead"
+ },
+ "type": "array"
+ },
+ "additionalPhoneMappings": {
+ "additionalProperties": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "description": "Maps persona phone IDs to the source column indexes used by leadLoader/process. JSON object keys are persona phone IDs, and values are column indexes from the uploaded file preview.",
+ "type": "object"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ },
+ "internationalNumberFormat": {
+ "type": "boolean"
+ },
+ "numberOriginCountry": {
+ "type": "string"
+ },
+ "scheduleArchiveDts": {
+ "format": "date-time",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "LeadListProcessingResult": {
+ "properties": {
+ "deletedCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dncReturnedCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dncUploadCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "failedAgentAssignment": {
+ "description": "Number of accepted leads whose reserveAgent value could not be assigned because the agent ID was invalid or the agent does not have access to the account.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "hasDeletedLeads": {
+ "type": "boolean"
+ },
+ "internalDncCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadsAccepted": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadsConverted": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadsInserted": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadsSupplied": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "listState": {
+ "enum": [
+ "ACTIVE",
+ "PAUSED",
+ "PENDING_DNC",
+ "LOADING",
+ "DELETED",
+ "READY",
+ "CALLBACKS",
+ "CALLBACKS_AGENT",
+ "DUPLICATES_NOT_MERGED",
+ "DUPLICATES_NOT_MOVED"
+ ],
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "processingResult": {
+ "type": "string"
+ },
+ "processingStatus": {
+ "enum": [
+ "NO_LEADS_PASSED_VALIDATION",
+ "DNC_ACCOUNT_SETTINGS",
+ "DNC_UPLOAD_FAILED",
+ "DEFAULT_NOT_A_FAILURE",
+ "DNC_GREATER_ONE_DAY",
+ "GENERAL_FAILURE"
+ ],
+ "type": "string"
+ },
+ "quotaCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "rejectedRows": {
+ "items": {
+ "$ref": "#/components/schemas/RejectedRow"
+ },
+ "type": "array"
+ },
+ "timeZoneOption": {
+ "enum": [
+ "NPA_NXX",
+ "ZIPCODE",
+ "EXPLICIT",
+ "NOT_APPLICABLE"
+ ],
+ "type": "string"
+ },
+ "uploadFileName": {
+ "type": "string"
+ },
+ "whitelistCount": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "LeadManagerRequest": {
+ "properties": {
+ "campaignLeadSearchCriteria": {
+ "$ref": "#/components/schemas/CampaignLeadSearchCriteria"
+ },
+ "leadActionParams": {
+ "$ref": "#/components/schemas/LeadActionParams"
+ }
+ },
+ "type": "object"
+ },
+ "LocalTime": {
+ "properties": {
+ "chronology": {
+ "$ref": "#/components/schemas/Chronology"
+ },
+ "fieldTypes": {
+ "items": {
+ "$ref": "#/components/schemas/DateTimeFieldType"
+ },
+ "type": "array"
+ },
+ "fields": {
+ "items": {
+ "$ref": "#/components/schemas/DateTimeField"
+ },
+ "type": "array"
+ },
+ "hourOfDay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "millisOfDay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "millisOfSecond": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "minuteOfHour": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "secondOfMinute": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "values": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "LoggedInAgentsByQueue": {
+ "properties": {
+ "loggedInAgentCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "queueId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "MainAccount": {
+ "properties": {
+ "dataRetentionDays": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "enableAmdProfiles": {
+ "type": "boolean"
+ },
+ "enableConsultCall": {
+ "type": "boolean"
+ },
+ "enablePhoneNumbersI18n": {
+ "type": "boolean"
+ },
+ "engageAccountId": {
+ "type": "string"
+ },
+ "isActive": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "mainAccountId": {
+ "type": "string"
+ },
+ "mainAccountName": {
+ "type": "string"
+ },
+ "rcAccountId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MainAccountCreationDto": {
+ "properties": {
+ "dataRetentionDays": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "engageAccountId": {
+ "type": "string"
+ },
+ "enterpriseAccountId": {
+ "type": "string"
+ },
+ "mainAccountId": {
+ "type": "string"
+ },
+ "mainAccountName": {
+ "type": "string"
+ },
+ "rcAccountId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MainAccountDto": {
+ "properties": {
+ "dataRetentionDays": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "engageAccountId": {
+ "type": "string"
+ },
+ "isActive": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "mainAccountId": {
+ "type": "string"
+ },
+ "mainAccountName": {
+ "type": "string"
+ },
+ "rcAccountId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MainAccountUpdateDto": {
+ "properties": {
+ "engageAccountId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MappingTemplate": {
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/Account"
+ },
+ "createdBy": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dateCreated": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "lastUpdated": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "mappingData": {
+ "type": "string"
+ },
+ "mappingId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "mappingName": {
+ "type": "string"
+ },
+ "updatedBy": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "MediaCodeValuesOnDnisPool": {
+ "properties": {
+ "category": {
+ "type": "string"
+ },
+ "code": {
+ "type": "string"
+ },
+ "duration": {
+ "type": "string"
+ },
+ "format": {
+ "type": "string"
+ },
+ "isci": {
+ "type": "string"
+ },
+ "market": {
+ "type": "string"
+ },
+ "network": {
+ "type": "string"
+ },
+ "sourceCode": {
+ "type": "string"
+ },
+ "url": {
+ "type": "string"
+ },
+ "version": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Message": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "actionType": {
+ "enum": [
+ "INITIALIZE",
+ "CONNECT",
+ "DISCONNECT",
+ "TYPING",
+ "MESSAGE",
+ "DELIVERED",
+ "SENT",
+ "ACTIVE",
+ "MONITOR_START",
+ "MONITOR_STOP",
+ "CHAT_HISTORY"
+ ],
+ "type": "string"
+ },
+ "activeChatUii": {
+ "type": "string"
+ },
+ "apiKey": {
+ "type": "string"
+ },
+ "browserInfo": {
+ "type": "string"
+ },
+ "chatQueueId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "chatWebsocketConnectUri": {
+ "type": "string"
+ },
+ "chatWidgetAccessGuid": {
+ "type": "string"
+ },
+ "destinationJmsQueue": {
+ "type": "string"
+ },
+ "mediaLinks": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "originatingHost": {
+ "type": "string"
+ },
+ "payload": {
+ "type": "string"
+ },
+ "recipient": {
+ "type": "string"
+ },
+ "referer": {
+ "type": "string"
+ },
+ "sender": {
+ "type": "string"
+ },
+ "senderType": {
+ "type": "string"
+ },
+ "sessionGuid": {
+ "type": "string"
+ },
+ "status": {
+ "enum": [
+ "SUCCESS",
+ "FAILED"
+ ],
+ "type": "string"
+ },
+ "statusMessage": {
+ "type": "string"
+ },
+ "textMessageDirection": {
+ "type": "string"
+ },
+ "textMessageType": {
+ "enum": [
+ "SMS",
+ "MMS"
+ ],
+ "type": "string"
+ },
+ "time": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "type": {
+ "enum": [
+ "SMS",
+ "WEB_CHAT",
+ "CHAT_ADMIN",
+ "SMS_TWILIO"
+ ],
+ "type": "string"
+ },
+ "whisper": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "NextivaAccountIntegration": {
+ "properties": {
+ "_type": {
+ "type": "string"
+ },
+ "accountId": {
+ "type": "string"
+ },
+ "corpAcctNumber": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "encryptedAuthToken": {
+ "type": "string"
+ },
+ "hasAccess": {
+ "type": "boolean"
+ },
+ "integrationType": {
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "NotificationGroup": {
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "groupName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "NotificationTarget": {
+ "properties": {
+ "notificationGroup": {
+ "$ref": "#/components/schemas/NotificationGroup"
+ },
+ "smsOrEmail": {
+ "type": "string"
+ },
+ "targetId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": {
+ "enum": [
+ "SMS",
+ "EMAIL",
+ "USER"
+ ],
+ "type": "string"
+ },
+ "user": {
+ "$ref": "#/components/schemas/User"
+ }
+ },
+ "type": "object"
+ },
+ "Operation": {
+ "properties": {
+ "bindingName": {
+ "type": "string"
+ },
+ "operation": {
+ "type": "string"
+ },
+ "parts": {
+ "items": {
+ "$ref": "#/components/schemas/Element"
+ },
+ "type": "array"
+ },
+ "portName": {
+ "type": "string"
+ },
+ "soapAction": {
+ "type": "string"
+ },
+ "style": {
+ "type": "string"
+ },
+ "tagetNamespace": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "OutboundAndInboundDailyCallData": {
+ "properties": {
+ "inboundCallTotal": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "outboundCallTotal": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "OutboundStats": {
+ "properties": {
+ "abandon": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "accountId": {
+ "type": "string"
+ },
+ "active": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "answer": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "available": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "busy": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "campaignId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "campaignName": {
+ "type": "string"
+ },
+ "complete": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "connects": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialGroupName": {
+ "type": "string"
+ },
+ "dnc": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "fax": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "intercept": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "lastUpdate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "machine": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "noanswer": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "notHumanAnswers": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "other": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "pending": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "ready": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "selectable": {
+ "type": "boolean"
+ },
+ "staffed": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "successDispositions": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "totalTalkTime": {
+ "format": "int64",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "PassDispositionRequest": {
+ "properties": {
+ "destinationCampaignRequest": {
+ "$ref": "#/components/schemas/DestinationCampaignRequest"
+ },
+ "passDisposition": {
+ "$ref": "#/components/schemas/CampaignPassDisposition"
+ }
+ },
+ "type": "object"
+ },
+ "PbxDirectoryFilter": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "contactCenterExtension": {
+ "enum": [
+ "INCLUDE_ALL",
+ "EXCLUDE_AGENTS_ONLY",
+ "EXCLUDE_AGENTS_AND_SUPERVISORS"
+ ],
+ "type": "string"
+ },
+ "corporateExtension": {
+ "enum": [
+ "INCLUDE_ALL",
+ "INCLUDE_SPECIFIC_RANGES",
+ "EXCLUDE_SPECIFIC_RANGES"
+ ],
+ "type": "string"
+ },
+ "corporateExtensionRange": {
+ "type": "string"
+ },
+ "id": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "includeInactiveExtensions": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "PbxDirectoryFilterMailbox": {
+ "properties": {
+ "mailboxDetails": {
+ "items": {
+ "$ref": "#/components/schemas/PbxDirectoryMailboxDetail"
+ },
+ "type": "array"
+ },
+ "pbxDirectoryEnable": {
+ "type": "boolean"
+ },
+ "pbxDirectoryFilter": {
+ "$ref": "#/components/schemas/PbxDirectoryFilter"
+ }
+ },
+ "type": "object"
+ },
+ "PbxDirectoryMailboxDetail": {
+ "properties": {
+ "agentType": {
+ "enum": [
+ "AGENT",
+ "SUPERVISOR",
+ "MULTI_USER",
+ "MULTI_SUPERVISOR"
+ ],
+ "type": "string"
+ },
+ "mailboxId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PhoneBookEntry": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "countryId": {
+ "type": "string"
+ },
+ "dateCreated": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "destName": {
+ "type": "string"
+ },
+ "destination": {
+ "type": "string"
+ },
+ "entryId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "notes": {
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "GATE",
+ "GLOBAL",
+ "CAMPAIGN"
+ ],
+ "type": "string"
+ },
+ "typeId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "PhoneNumbersI18nMigrationStatusInfoResponse": {
+ "properties": {
+ "errorMessage": {
+ "type": "string"
+ },
+ "finalStatus": {
+ "type": "string"
+ },
+ "startTime": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "subStatuses": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ "taskId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PhoneNumbersI18nMigrationTaskResponse": {
+ "properties": {
+ "finalStatus": {
+ "type": "string"
+ },
+ "mainAccount": {
+ "$ref": "#/components/schemas/MainAccount"
+ },
+ "taskId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Platform": {
+ "properties": {
+ "id": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "iqPort": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "iqSslPort": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "iqUrl": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "platformDesc": {
+ "type": "string"
+ },
+ "platformId": {
+ "type": "string"
+ },
+ "telePlatformId": {
+ "type": "string"
+ },
+ "webSocketPort": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "PlatformDialer": {
+ "properties": {
+ "dialerDesc": {
+ "type": "string"
+ },
+ "dialerId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dialerType": {
+ "type": "string"
+ },
+ "id": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "tcpaSafeMode": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "PoolUsage": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "mode": {
+ "enum": [
+ "PREVIEW",
+ "CLICK_TO_TALK",
+ "PREDICTIVE",
+ "POWER",
+ "TCPA_SAFE_MODE"
+ ],
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "usageType": {
+ "enum": [
+ "OUTBOUND",
+ "INBOUND"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PrepayMinutePool": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "notificationEmail": {
+ "type": "string"
+ },
+ "poolDesc": {
+ "type": "string"
+ },
+ "poolName": {
+ "type": "string"
+ },
+ "poolTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "tenPercentWarn": {
+ "type": "boolean"
+ },
+ "twentyPercentWarn": {
+ "type": "boolean"
+ },
+ "usedTime": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "PrepayTransaction": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "address1": {
+ "type": "string"
+ },
+ "city": {
+ "type": "string"
+ },
+ "comments": {
+ "type": "string"
+ },
+ "country": {
+ "type": "string"
+ },
+ "dollarAmount": {
+ "format": "double",
+ "type": "number"
+ },
+ "email": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "minutes": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "phone": {
+ "type": "string"
+ },
+ "poolName": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ },
+ "transDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "transType": {
+ "type": "string"
+ },
+ "transactionId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "transactionName": {
+ "type": "string"
+ },
+ "zip": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PrerouteCheckStatus": {
+ "properties": {
+ "reason": {
+ "type": "string"
+ },
+ "status": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ProductOperationResult": {
+ "properties": {
+ "id": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "success": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "ProductPermission": {
+ "properties": {
+ "cascade": {
+ "type": "boolean"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "product": {
+ "enum": [
+ "ACCOUNT",
+ "ACD",
+ "AGENT",
+ "CHAT_QUEUE",
+ "OUTBOUND",
+ "VISUAL_IVR",
+ "CLOUD_PROFILE",
+ "CLOUD_DESTINATION",
+ "TRAC_NUMBER",
+ "HTTP_SERVICES",
+ "SCRIPTING",
+ "TN_MANAGER",
+ "SURVEY",
+ "DNIS",
+ "TEAMS",
+ "KNOWLEDGE_BASE",
+ "UTILITIES"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ProductsSelection": {
+ "properties": {
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "ids": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "QuotaGroup": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "campaigns": {
+ "$ref": "#/components/schemas/CollectionCampaign"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "quotaGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "quotaGroupName": {
+ "type": "string"
+ },
+ "quotaTargets": {
+ "$ref": "#/components/schemas/CollectionQuotaTarget"
+ }
+ },
+ "type": "object"
+ },
+ "QuotaManagementGroup": {
+ "properties": {
+ "quotaGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "quotaGroupName": {
+ "type": "string"
+ },
+ "quotaTargetStats": {
+ "items": {
+ "$ref": "#/components/schemas/QuotaTargetStats"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "QuotaTarget": {
+ "properties": {
+ "clientMetadata": {
+ "type": "string"
+ },
+ "criteriaJs": {
+ "type": "string"
+ },
+ "currentCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "quotaGroup": {
+ "$ref": "#/components/schemas/QuotaGroup"
+ },
+ "quotaMetOn": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "quotaTargetId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "targetName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "QuotaTargetStats": {
+ "properties": {
+ "campaigns": {
+ "items": {
+ "$ref": "#/components/schemas/CampaignStats"
+ },
+ "type": "array"
+ },
+ "currentCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "quotaGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "quotaMetOn": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "quotaTargetId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "quotaTargetName": {
+ "type": "string"
+ },
+ "targetCount": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "RTASubscriptionRequest": {
+ "required": [
+ "subscriptionName",
+ "notificationUrl"
+ ],
+ "properties": {
+ "subscriptionName": {
+ "description": "Subscription name.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Human-readable description.",
+ "type": "string"
+ },
+ "retryCount": {
+ "description": "Maximum delivery retry count. Maximum allowed value is 10. Default is 3.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "notificationUrl": {
+ "description": "HTTP or HTTPS endpoint that receives agent-state notifications.",
+ "type": "string"
+ },
+ "authConfigId": {
+ "description": "Auth configuration ID used when RingCX sends notification requests to the receiver.",
+ "format": "uuid",
+ "type": "string"
+ },
+ "active": {
+ "description": "Whether the subscription is active.",
+ "type": "boolean"
+ },
+ "customHeaders": {
+ "additionalProperties": {
+ "type": "object"
+ },
+ "description": "Additional headers to send with notification requests.",
+ "type": "object"
+ },
+ "expiresAt": {
+ "description": "Expiration time as epoch seconds. Use 0 for no configured expiration.",
+ "format": "int64",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "RTASubscriptionResponse": {
+ "properties": {
+ "subscriptionId": {
+ "format": "uuid",
+ "type": "string"
+ },
+ "mainAccountId": {
+ "type": "string"
+ },
+ "subAccountId": {
+ "type": "string"
+ },
+ "subscriptionName": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "notificationUrl": {
+ "type": "string"
+ },
+ "authConfigId": {
+ "format": "uuid",
+ "type": "string"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "maxRetryCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "customHeaders": {
+ "additionalProperties": {
+ "type": "object"
+ },
+ "type": "object"
+ },
+ "expiresAt": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "createdBy": {
+ "type": "string"
+ },
+ "createdAt": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "updatedBy": {
+ "type": "string"
+ },
+ "updatedAt": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "authConfig": {
+ "$ref": "#/components/schemas/AuthConfig"
+ }
+ },
+ "type": "object"
+ },
+ "RcAccountAccessResponse": {
+ "properties": {
+ "errorMessage": {
+ "type": "string"
+ },
+ "hasAccess": {
+ "type": "boolean"
+ },
+ "rcAccountId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RcExtensionRegionalSettings": {
+ "properties": {
+ "greetingsLanguageId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "greetingsLanguageLocaleCode": {
+ "type": "string"
+ },
+ "greetingsLanguageName": {
+ "type": "string"
+ },
+ "homeCountryCode": {
+ "type": "string"
+ },
+ "homeCountryId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "homeCountryName": {
+ "type": "string"
+ },
+ "regionalFormatId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "regionalFormatLocaleCode": {
+ "type": "string"
+ },
+ "regionalFormatName": {
+ "type": "string"
+ },
+ "timeFormat": {
+ "type": "string"
+ },
+ "timeZoneBias": {
+ "type": "string"
+ },
+ "timeZoneDescription": {
+ "type": "string"
+ },
+ "timeZoneId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "userLanguageId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "userLanguageLocaleCode": {
+ "type": "string"
+ },
+ "userLanguageName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RcOfficeUser": {
+ "properties": {
+ "email": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "rcUserId": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "regionalSettings": {
+ "$ref": "#/components/schemas/RcExtensionRegionalSettings"
+ }
+ },
+ "type": "object"
+ },
+ "RcUserMappingResponse": {
+ "properties": {
+ "ev_users": {
+ "items": {
+ "$ref": "#/components/schemas/EVUser"
+ },
+ "type": "array"
+ },
+ "rc_user_uid": {
+ "format": "int64",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "RcUserSyncUpdateRequest": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "email": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "rcSync": {
+ "type": "boolean"
+ },
+ "regionalSettings": {
+ "$ref": "#/components/schemas/RcExtensionRegionalSettings"
+ }
+ },
+ "type": "object"
+ },
+ "RecordingDestinationV2": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "destDir": {
+ "type": "string"
+ },
+ "destType": {
+ "enum": [
+ "SFTP",
+ "S3",
+ "FTP",
+ "UNKNOWN"
+ ],
+ "type": "string"
+ },
+ "destinationId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "destinationJson": {
+ "type": "string"
+ },
+ "destinationName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RecordingTaskV2": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "deleted": {
+ "type": "boolean"
+ },
+ "filterConfig": {
+ "type": "string"
+ },
+ "lastDaySync": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "lastPushTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "lastQueryTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "nextPushTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "nextQueryTime": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "pushStatusDesc": {
+ "type": "string"
+ },
+ "queryStatusDesc": {
+ "type": "string"
+ },
+ "recordingDestinationV2": {
+ "$ref": "#/components/schemas/RecordingDestinationV2"
+ },
+ "recordingFilename": {
+ "type": "string"
+ },
+ "taskDesc": {
+ "type": "string"
+ },
+ "taskId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "taskName": {
+ "type": "string"
+ },
+ "taskStart": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "taskState": {
+ "enum": [
+ "READY",
+ "TEST",
+ "RUNNING",
+ "FAILED",
+ "DISABLED",
+ "UNKNOWN"
+ ],
+ "type": "string"
+ },
+ "taskType": {
+ "enum": [
+ "INTELLITASK_RECORDING_PUSH"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RedirectView": {
+ "properties": {
+ "applicationContext": {
+ "$ref": "#/components/schemas/ApplicationContext"
+ },
+ "attributesMap": {
+ "type": "object"
+ },
+ "beanName": {
+ "type": "string"
+ },
+ "contentType": {
+ "type": "string"
+ },
+ "exposePathVariables": {
+ "type": "boolean"
+ },
+ "hosts": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "propagateQueryProperties": {
+ "type": "boolean"
+ },
+ "redirectView": {
+ "type": "boolean"
+ },
+ "requestContextAttribute": {
+ "type": "string"
+ },
+ "staticAttributes": {
+ "type": "object"
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "title": "RedirectView",
+ "type": "object"
+ },
+ "RegionalSettingRequestResponse": {
+ "properties": {
+ "formattingLocale": {
+ "type": "string"
+ },
+ "greetingLanguage": {
+ "type": "string"
+ },
+ "homeCountry": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "homeCountryCode": {
+ "type": "string"
+ },
+ "language": {
+ "type": "string"
+ },
+ "timeFormat": {
+ "type": "string"
+ },
+ "timezone": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "RejectedRow": {
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "rowData": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RemoteHttpService": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "enableMappings": {
+ "type": "boolean"
+ },
+ "httpPassword": {
+ "type": "string"
+ },
+ "httpServiceConfig": {
+ "type": "string"
+ },
+ "httpServiceGroup": {
+ "$ref": "#/components/schemas/RemoteHttpServiceGroup"
+ },
+ "httpServiceInputs": {
+ "$ref": "#/components/schemas/CollectionRemoteHttpServiceInput"
+ },
+ "httpUsername": {
+ "type": "string"
+ },
+ "isDebug": {
+ "type": "boolean"
+ },
+ "isEnabled": {
+ "type": "boolean"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "returntype": {
+ "type": "string"
+ },
+ "sendAllSurveyData": {
+ "type": "boolean"
+ },
+ "serviceDescription": {
+ "type": "string"
+ },
+ "serviceId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "serviceType": {
+ "enum": [
+ "SOAP",
+ "HTTP_POST",
+ "HTTP_GET",
+ "HTTP"
+ ],
+ "type": "string"
+ },
+ "soapAction": {
+ "type": "string"
+ },
+ "soapEndpoint": {
+ "type": "string"
+ },
+ "soapOperationname": {
+ "type": "string"
+ },
+ "soapPortname": {
+ "type": "string"
+ },
+ "soapServicename": {
+ "type": "string"
+ },
+ "targetNamespace": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RemoteHttpServiceGroup": {
+ "properties": {
+ "groupName": {
+ "type": "string"
+ },
+ "isDefault": {
+ "type": "boolean"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "serviceGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "services": {
+ "$ref": "#/components/schemas/CollectionRemoteHttpService"
+ }
+ },
+ "type": "object"
+ },
+ "RemoteHttpServiceInput": {
+ "properties": {
+ "inputId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "rank": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "simpleDataType": {
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportCriteria": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "criteriaType": {
+ "enum": [
+ "DIALER_RESULT_DOWNLOAD_CRITERIA",
+ "GLOBAL_CALL_TYPE_CRITERIA",
+ "IVR_DETAIL_CRITERIA",
+ "TFN_DID_MANAGER_CRITERIA",
+ "ALL_CALLS_CRITERIA",
+ "CASPER_CRITERIA"
+ ],
+ "type": "string"
+ },
+ "databaseTimezone": {
+ "type": "string"
+ },
+ "endDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "endDateRange": {
+ "$ref": "#/components/schemas/TimeRange"
+ },
+ "scheduleTimezoneName": {
+ "type": "string"
+ },
+ "startDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "startDateRange": {
+ "$ref": "#/components/schemas/TimeRange"
+ },
+ "timezoneName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportMetaData": {
+ "properties": {
+ "cciReport": {
+ "type": "boolean"
+ },
+ "parameterList": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reportGroup": {
+ "type": "string"
+ },
+ "reportName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportParams": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "compressReport": {
+ "type": "boolean"
+ },
+ "delimiter": {
+ "enum": [
+ "PIPE",
+ "COMMA",
+ "TAB",
+ "EXCEL",
+ "HTML"
+ ],
+ "type": "string"
+ },
+ "destination": {
+ "$ref": "#/components/schemas/DestinationParams"
+ },
+ "maxRows": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "reportCriteria": {
+ "$ref": "#/components/schemas/ReportCriteria"
+ },
+ "reportName": {
+ "type": "string"
+ },
+ "reportType": {
+ "enum": [
+ "DIALER_RESULT_DOWNLOAD",
+ "GLOBAL_CALL_TYPE_EXCEL",
+ "GLOBAL_CALL_TYPE_DELIMITED",
+ "ALL_CALLS",
+ "IVR_DETAIL",
+ "TFN_DID_MANAGER_SUPERUSER_EXCEL",
+ "TFN_DID_MANAGER_EXCEL",
+ "TFN_DID_MANAGER_DELIMITED",
+ "CASPER_REPORT"
+ ],
+ "type": "string"
+ },
+ "requestUser": {
+ "$ref": "#/components/schemas/User"
+ },
+ "schedule": {
+ "$ref": "#/components/schemas/Schedule"
+ },
+ "scheduledReport": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "RequeueShortcut": {
+ "properties": {
+ "campaign": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "gate": {
+ "$ref": "#/components/schemas/Gate"
+ },
+ "groupSkill": {
+ "$ref": "#/components/schemas/GateGroupSkill"
+ },
+ "name": {
+ "type": "string"
+ },
+ "rank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "requeueGate": {
+ "$ref": "#/components/schemas/Gate"
+ },
+ "requeueGateGroup": {
+ "$ref": "#/components/schemas/GateGroup"
+ },
+ "requeueShortcutId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ResourcePermission": {
+ "properties": {
+ "cascade": {
+ "type": "boolean"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "resourceId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "resourceType": {
+ "enum": [
+ "ACCOUNT",
+ "GATE_GROUP",
+ "GATE",
+ "AGENT",
+ "AGENT_GROUP",
+ "OUTBOUND_DIAL_GROUP",
+ "OUTBOUND_CAMPAIGN",
+ "VISUAL_IVR",
+ "VISUAL_IVR_GROUP",
+ "TRAC_NUMBER",
+ "TRAC_GROUP",
+ "CLOUD_PROFILE",
+ "CLOUD_DESTINATION",
+ "CLOUD_PROFILE_GROUP",
+ "CLOUD_GROUP",
+ "CLOUD_DESTINATION_GROUP",
+ "HTTP_SERVICE",
+ "HTTP_SERVICE_GROUP",
+ "SCRIPT",
+ "SCRIPT_GROUP",
+ "TN_MANAGER",
+ "UTILITIES",
+ "CHAT_QUEUE",
+ "CHAT_GROUP",
+ "KNOWLEDGEBASE_GROUP",
+ "KNOWLEDGEBASE_CATEGORY"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ResponseEntity": {
+ "properties": {
+ "body": {
+ "type": "object"
+ },
+ "statusCode": {
+ "enum": [
+ "100",
+ "101",
+ "102",
+ "103",
+ "200",
+ "201",
+ "202",
+ "203",
+ "204",
+ "205",
+ "206",
+ "207",
+ "208",
+ "226",
+ "300",
+ "301",
+ "302",
+ "303",
+ "304",
+ "305",
+ "307",
+ "308",
+ "400",
+ "401",
+ "402",
+ "403",
+ "404",
+ "405",
+ "406",
+ "407",
+ "408",
+ "409",
+ "410",
+ "411",
+ "412",
+ "413",
+ "414",
+ "415",
+ "416",
+ "417",
+ "418",
+ "419",
+ "420",
+ "421",
+ "422",
+ "423",
+ "424",
+ "426",
+ "428",
+ "429",
+ "431",
+ "451",
+ "500",
+ "501",
+ "502",
+ "503",
+ "504",
+ "505",
+ "506",
+ "507",
+ "508",
+ "509",
+ "510",
+ "511"
+ ],
+ "type": "string"
+ },
+ "statusCodeValue": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "ResultFileDestination": {
+ "properties": {
+ "aggregateOutput": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "destType": {
+ "type": "string"
+ },
+ "destinationId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "destinationName": {
+ "type": "string"
+ },
+ "emailDest": {
+ "type": "string"
+ },
+ "ftpDir": {
+ "type": "string"
+ },
+ "ftpPwd": {
+ "type": "string"
+ },
+ "ftpServer": {
+ "type": "string"
+ },
+ "ftpUid": {
+ "type": "string"
+ },
+ "passive": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "sendEmptyFiles": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "sftp": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RightsDocTable": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "creationDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "isMaster": {
+ "type": "boolean"
+ },
+ "owner": {
+ "$ref": "#/components/schemas/User"
+ },
+ "rightsDocJson": {
+ "type": "string"
+ },
+ "rightsDocName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RightsDocument": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "accountPermissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "assigned": {
+ "type": "boolean"
+ },
+ "cascade": {
+ "type": "boolean"
+ },
+ "isMaster": {
+ "type": "boolean"
+ },
+ "ownerId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "productPermissions": {
+ "items": {
+ "$ref": "#/components/schemas/ProductPermission"
+ },
+ "type": "array"
+ },
+ "resourcePermissions": {
+ "items": {
+ "$ref": "#/components/schemas/ResourcePermission"
+ },
+ "type": "array"
+ },
+ "rightsDocId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "rightsDocName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SIPRegistrationResult": {
+ "properties": {
+ "device": {
+ "$ref": "#/components/schemas/Device"
+ },
+ "sipErrorCodes": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sipFlags": {
+ "$ref": "#/components/schemas/SipFlags"
+ },
+ "sipInfo": {
+ "items": {
+ "$ref": "#/components/schemas/SipInfo"
+ },
+ "type": "array"
+ },
+ "sipInfoPstn": {
+ "items": {
+ "type": "object"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Schedule": {
+ "properties": {
+ "dayOfTheMonth": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "daysOfWeek": {
+ "items": {
+ "enum": [
+ "SUNDAY",
+ "MONDAY",
+ "TUESDAY",
+ "WEDNESDAY",
+ "THURSDAY",
+ "FRIDAY",
+ "SATURDAY"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "endDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "endTime": {
+ "$ref": "#/components/schemas/LocalTime"
+ },
+ "interval": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "month": {
+ "enum": [
+ "JANUARY",
+ "FEBRUARY",
+ "MARCH",
+ "APRIL",
+ "MAY",
+ "JUNE",
+ "JULY",
+ "AUGUST",
+ "SEPTEMBER",
+ "OCTOBER",
+ "NOVEMBER",
+ "DECEMBER"
+ ],
+ "type": "string"
+ },
+ "repeatOption": {
+ "enum": [
+ "SINGLE",
+ "MINUTE",
+ "HOURLY",
+ "DAILY",
+ "WEEKLY",
+ "MONTHLY",
+ "CALENDAR",
+ "YEARLY"
+ ],
+ "type": "string"
+ },
+ "scheduleTimezoneName": {
+ "type": "string"
+ },
+ "startDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "startTime": {
+ "$ref": "#/components/schemas/LocalTime"
+ },
+ "versionNum": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "SchedulerStateResponse": {
+ "properties": {
+ "currentState": {
+ "enum": [
+ "RUN",
+ "PAUSE"
+ ],
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Script": {
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/Account"
+ },
+ "created": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "description": {
+ "type": "string"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "name": {
+ "type": "string"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "scriptGroup": {
+ "$ref": "#/components/schemas/ScriptGroup"
+ },
+ "scriptId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "updated": {
+ "$ref": "#/components/schemas/DateTime"
+ }
+ },
+ "type": "object"
+ },
+ "ScriptConfig": {
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/Account"
+ },
+ "description": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "scriptId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "scriptJson": {
+ "type": "string"
+ },
+ "updated": {
+ "$ref": "#/components/schemas/DateTime"
+ }
+ },
+ "type": "object"
+ },
+ "ScriptGroup": {
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/Account"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "type": "string"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "scripts": {
+ "items": {
+ "$ref": "#/components/schemas/Script"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "SecurityStrategyModel": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "fullPermission": {
+ "type": "boolean"
+ },
+ "productIds": {
+ "items": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "type": "array"
+ },
+ "redshiftProduct": {
+ "enum": [
+ "ACCOUNT",
+ "AGENT",
+ "AGENT_DISPOSITION",
+ "AGENT_EXTERNAL_ID",
+ "AGENT_GROUP_ID",
+ "AGENT_TEAM",
+ "ANI",
+ "CALL_ID",
+ "CAMPAIGN",
+ "CHAT_QUEUE",
+ "CHAT_QUEUE_GROUP",
+ "CLOUD_DESTINATION",
+ "CLOUD_DESTINATION_GROUP_ID",
+ "CLOUD_PROFILE",
+ "CLOUD_PROFILE_GROUP_ID",
+ "DIAL_GROUP",
+ "DIAL_TYPE",
+ "DNC_TAG",
+ "DNIS",
+ "GATE",
+ "GATE_GROUP",
+ "INCLUDE_DIAL_GROUP",
+ "INCLUDE_MEDIA",
+ "INTERNAL_CHAT",
+ "LIST_STATE",
+ "LEAD_LIST",
+ "OPT_OUT",
+ "OUTBOUND_DISPOSITION",
+ "ROLLUP_AGENT",
+ "SCRIPTING",
+ "SCRIPT_GROUP_ID",
+ "STARTS_WITH_NPA_EXCLUDE",
+ "STARTS_WITH_NPA_INCLUDE",
+ "SURVEY",
+ "TRACK_GROUP_ID",
+ "TRACK_NUMBER",
+ "USERNAME",
+ "VISUAL_IVR",
+ "VISUAL_IVR_GROUP_ID",
+ "WHITELIST_TAG"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SecurityStrategyView": {
+ "properties": {
+ "accountIds": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "fullPermission": {
+ "type": "boolean"
+ },
+ "redshiftProducts": {
+ "items": {
+ "enum": [
+ "ACCOUNT",
+ "AGENT",
+ "AGENT_DISPOSITION",
+ "AGENT_EXTERNAL_ID",
+ "AGENT_GROUP_ID",
+ "AGENT_TEAM",
+ "ANI",
+ "CALL_ID",
+ "CAMPAIGN",
+ "CHAT_QUEUE",
+ "CHAT_QUEUE_GROUP",
+ "CLOUD_DESTINATION",
+ "CLOUD_DESTINATION_GROUP_ID",
+ "CLOUD_PROFILE",
+ "CLOUD_PROFILE_GROUP_ID",
+ "DIAL_GROUP",
+ "DIAL_TYPE",
+ "DNC_TAG",
+ "DNIS",
+ "GATE",
+ "GATE_GROUP",
+ "INCLUDE_DIAL_GROUP",
+ "INCLUDE_MEDIA",
+ "INTERNAL_CHAT",
+ "LIST_STATE",
+ "LEAD_LIST",
+ "OPT_OUT",
+ "OUTBOUND_DISPOSITION",
+ "ROLLUP_AGENT",
+ "SCRIPTING",
+ "SCRIPT_GROUP_ID",
+ "STARTS_WITH_NPA_EXCLUDE",
+ "STARTS_WITH_NPA_INCLUDE",
+ "SURVEY",
+ "TRACK_GROUP_ID",
+ "TRACK_NUMBER",
+ "USERNAME",
+ "VISUAL_IVR",
+ "VISUAL_IVR_GROUP_ID",
+ "WHITELIST_TAG"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "accountIds",
+ "fullPermission",
+ "redshiftProducts"
+ ],
+ "type": "object"
+ },
+ "SimplePostgresChild": {
+ "properties": {
+ "accountId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "groupName": {
+ "type": "string"
+ },
+ "objId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "objectName": {
+ "type": "string"
+ },
+ "objectTimestamp": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SimplePostgresParent": {
+ "properties": {
+ "accountId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "children": {
+ "items": {
+ "$ref": "#/components/schemas/SimplePostgresChild"
+ },
+ "type": "array"
+ },
+ "filters": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "groupName": {
+ "type": "string"
+ },
+ "objectTimestamp": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "product": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SipFlags": {
+ "properties": {
+ "dcspVoice": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dscpEnabled": {
+ "type": "boolean"
+ },
+ "dscpSignaling": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dscpVideo": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "outboundCallsEnabled": {
+ "type": "boolean"
+ },
+ "voipCountryBlocked": {
+ "type": "boolean"
+ },
+ "voipFeatureEnabled": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "SipInfo": {
+ "properties": {
+ "authorizationId": {
+ "type": "string"
+ },
+ "domain": {
+ "type": "string"
+ },
+ "outboundProxy": {
+ "type": "string"
+ },
+ "password": {
+ "type": "string"
+ },
+ "transport": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "State": {
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "state": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "StateProvince": {
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "searchString": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SuppressedType": {
+ "properties": {
+ "name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Survey": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "active": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "enableTokens": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "exportFlag": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "headingCss": {
+ "type": "string"
+ },
+ "lastModified": {
+ "$ref": "#/components/schemas/Timestamp"
+ },
+ "name": {
+ "type": "string"
+ },
+ "submitText": {
+ "type": "string"
+ },
+ "surveyDesc": {
+ "type": "string"
+ },
+ "surveyId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "surveyName": {
+ "type": "string"
+ },
+ "tableCss": {
+ "type": "string"
+ },
+ "textCss": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SurveyGroup": {
+ "properties": {
+ "groupName": {
+ "type": "string"
+ },
+ "isDefault": {
+ "format": "byte",
+ "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ },
+ "surveyGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "surveys": {
+ "$ref": "#/components/schemas/CollectionSurvey"
+ }
+ },
+ "type": "object"
+ },
+ "TelephonyServerGroup": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "currentConnections": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "groupName": {
+ "type": "string"
+ },
+ "groupVendor": {
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "maxAgents": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "TimeRange": {
+ "properties": {
+ "rangeType": {
+ "enum": [
+ "MINUTE",
+ "HOUR",
+ "DAY",
+ "WEEK",
+ "MONTH",
+ "YEAR",
+ "NOW"
+ ],
+ "type": "string"
+ },
+ "rangeValue": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "rangeValueValid": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "Timestamp": {
+ "properties": {
+ "date": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "day": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "hours": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "minutes": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "month": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "nanos": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "seconds": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "time": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "timezoneOffset": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "year": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Timezone": {
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "name": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TnManagerSearchCriteria": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "accountIds": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "active": {
+ "type": "boolean"
+ },
+ "assigned": {
+ "type": "boolean"
+ },
+ "assignedSms": {
+ "type": "boolean"
+ },
+ "criteriaType": {
+ "enum": [
+ "DIALER_RESULT_DOWNLOAD_CRITERIA",
+ "GLOBAL_CALL_TYPE_CRITERIA",
+ "IVR_DETAIL_CRITERIA",
+ "TFN_DID_MANAGER_CRITERIA",
+ "ALL_CALLS_CRITERIA",
+ "CASPER_CRITERIA"
+ ],
+ "type": "string"
+ },
+ "customAppString": {
+ "type": "string"
+ },
+ "databaseTimezone": {
+ "type": "string"
+ },
+ "dnis": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "dnisFilter": {
+ "type": "string"
+ },
+ "endDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "endDateRange": {
+ "$ref": "#/components/schemas/TimeRange"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "inboundContext": {
+ "type": "string"
+ },
+ "notes": {
+ "type": "string"
+ },
+ "objectId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ },
+ "product": {
+ "enum": [
+ "ACCOUNT",
+ "ACD",
+ "AGENT",
+ "CHAT_QUEUE",
+ "OUTBOUND",
+ "VISUAL_IVR",
+ "CLOUD_PROFILE",
+ "CLOUD_DESTINATION",
+ "TRAC_NUMBER",
+ "HTTP_SERVICES",
+ "SCRIPTING",
+ "TN_MANAGER",
+ "SURVEY",
+ "DNIS",
+ "TEAMS",
+ "KNOWLEDGE_BASE",
+ "UTILITIES"
+ ],
+ "type": "string"
+ },
+ "scheduleTimezoneName": {
+ "type": "string"
+ },
+ "startDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "startDateRange": {
+ "$ref": "#/components/schemas/TimeRange"
+ },
+ "timezoneName": {
+ "type": "string"
+ },
+ "vendorId": {
+ "type": "string"
+ },
+ "vruNetworkId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "TracGroup": {
+ "properties": {
+ "groupName": {
+ "type": "string"
+ },
+ "isDefault": {
+ "type": "boolean"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "tracGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "tracNumbers": {
+ "items": {
+ "$ref": "#/components/schemas/TracNumber"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TracLocation": {
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/Account"
+ },
+ "accountId": {
+ "type": "string"
+ },
+ "address": {
+ "type": "string"
+ },
+ "city": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "destination": {
+ "type": "string"
+ },
+ "isDefault": {
+ "type": "boolean"
+ },
+ "lat": {
+ "format": "double",
+ "type": "number"
+ },
+ "locationId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "locator": {
+ "$ref": "#/components/schemas/TracLocator"
+ },
+ "lon": {
+ "format": "double",
+ "type": "number"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "ringDuration": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "state": {
+ "type": "string"
+ },
+ "ttAccept": {
+ "type": "boolean"
+ },
+ "zip": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TracLocator": {
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "locatorId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "maxDistance": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "tracLocation": {
+ "$ref": "#/components/schemas/CollectionTracLocation"
+ }
+ },
+ "type": "object"
+ },
+ "TracNumber": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "assignedDnis": {
+ "$ref": "#/components/schemas/AssignedDnis"
+ },
+ "billingCode": {
+ "type": "string"
+ },
+ "billingKey": {
+ "type": "string"
+ },
+ "closeLocatorId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "closeType": {
+ "enum": [
+ "STANDARD",
+ "STANDARD_PARALLEL",
+ "LOCATOR"
+ ],
+ "type": "string"
+ },
+ "dequeueDelay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "description": {
+ "type": "string"
+ },
+ "endcallMsg": {
+ "type": "string"
+ },
+ "friSched": {
+ "type": "string"
+ },
+ "introMsg": {
+ "type": "string"
+ },
+ "monSched": {
+ "type": "string"
+ },
+ "openLocatorId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "openType": {
+ "enum": [
+ "STANDARD",
+ "STANDARD_PARALLEL",
+ "LOCATOR"
+ ],
+ "type": "string"
+ },
+ "outboundCallerId": {
+ "type": "string"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "postCallSoapService": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ },
+ "recordCall": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "revMatch": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "satSched": {
+ "type": "string"
+ },
+ "shortCallTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "sunSched": {
+ "type": "string"
+ },
+ "surveyId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "thuSched": {
+ "type": "string"
+ },
+ "tracGroup": {
+ "$ref": "#/components/schemas/TracGroup"
+ },
+ "tracId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "tueSched": {
+ "type": "string"
+ },
+ "voicemailEnabled": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "wedSched": {
+ "type": "string"
+ },
+ "whisperMsg": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "TracNumberSkinny": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "tracGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "tracId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "TracRoutingRule": {
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "destination": {
+ "type": "string"
+ },
+ "openRule": {
+ "type": "boolean"
+ },
+ "parallelDelay": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "rank": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "ringDuration": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "ruleId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "ruleType": {
+ "enum": [
+ "STANDARD",
+ "STANDARD_SIP",
+ "ENCRYPTED_SIP",
+ "GATE_XFER",
+ "TRAC_XFER",
+ "IN_NETWORK",
+ "VIVR"
+ ],
+ "type": "string"
+ },
+ "tracNumber": {
+ "$ref": "#/components/schemas/TracNumber"
+ },
+ "ttAccept": {
+ "type": "boolean"
+ },
+ "xferGateId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "xferTracId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "TracScheduleOverride": {
+ "properties": {
+ "overrideClosedEvent": {
+ "type": "string"
+ },
+ "overrideDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "overrideLabel": {
+ "type": "string"
+ },
+ "overrideSched": {
+ "type": "string"
+ },
+ "scheduleOverrideId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "UniqueAgentResponse": {
+ "properties": {
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "ani": {
+ "type": "string"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "dnisE164": {
+ "type": "string"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "uii": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UpdateAgentLoginDialGroupResponse": {
+ "properties": {
+ "agentId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentName": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "success": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "UpdatePhoneNumbersI18nRequest": {
+ "properties": {
+ "enablePhoneNumbersI18n": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "UploadLeadsRequest": {
+ "properties": {
+ "description": {
+ "type": "string"
+ },
+ "dialPriority": {
+ "description": "Setting this to `IMMEDIATE` allows you to insert a lead to the top of the dialer cache for immediate dialing if you want a normal insert then do not add this parameter.",
+ "enum": [
+ "IMMEDIATE",
+ "NORMAL"
+ ],
+ "type": "string"
+ },
+ "duplicateHandling": {
+ "enum": [
+ "RETAIN_ALL",
+ "REMOVE_ALL_EXISTING",
+ "REMOVE_FROM_LIST"
+ ],
+ "type": "string"
+ },
+ "listState": {
+ "enum": [
+ "ACTIVE"
+ ],
+ "type": "string"
+ },
+ "timeZoneOption": {
+ "enum": [
+ "NPA_NXX",
+ "ZIPCODE",
+ "EXPLICIT"
+ ],
+ "type": "string"
+ },
+ "uploadLeads": {
+ "items": {
+ "$ref": "#/components/schemas/CampaignLead"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "UploadLeadsResponse": {
+ "properties": {
+ "deletedCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dncReturnedCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "dncUploadCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "hasDeletedLeads": {
+ "type": "boolean"
+ },
+ "internalDncCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadsAccepted": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadsConverted": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadsInserted": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "leadsSupplied": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "listState": {
+ "type": "string"
+ },
+ "message": {
+ "description": "Values can be `Your uploaded lead list has successfully completed processing` or `Your uploaded lead list file processing has failed`",
+ "type": "string"
+ },
+ "processingResult": {
+ "description": "Values can be `OK` or `Failed`",
+ "type": "string"
+ },
+ "processingStatus": {
+ "description": "Values can be `DEFAULT_NOT_A_FAILURE` or `GENERAL_FAILURE`",
+ "type": "string"
+ },
+ "quotaCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "timeZoneOption": {
+ "type": "string"
+ },
+ "uploadFileName": {
+ "type": "string"
+ },
+ "whitelistCount": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "message",
+ "leadsSupplied",
+ "leadsConverted",
+ "leadsAccepted",
+ "leadsInserted",
+ "internalDncCount",
+ "dncUploadCount",
+ "dncReturnedCount",
+ "whitelistCount",
+ "uploadFileName",
+ "deletedCount",
+ "quotaCount",
+ "listState",
+ "timeZoneOption",
+ "hasDeletedLeads",
+ "processingResult",
+ "processingStatus"
+ ],
+ "type": "object"
+ },
+ "User": {
+ "properties": {
+ "children": {
+ "items": {
+ "$ref": "#/components/schemas/User"
+ },
+ "type": "array"
+ },
+ "creationDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "enabled": {
+ "type": "boolean"
+ },
+ "firstName": {
+ "type": "string"
+ },
+ "fullName": {
+ "type": "string"
+ },
+ "lastName": {
+ "type": "string"
+ },
+ "parentPath": {
+ "type": "string"
+ },
+ "phoneNumber": {
+ "type": "string"
+ },
+ "phoneNumberE164": {
+ "type": "string"
+ },
+ "phoneNumbersI18nEnabled": {
+ "type": "boolean"
+ },
+ "rcAccountId": {
+ "type": "string"
+ },
+ "rcUserId": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "regionalSettings": {
+ "$ref": "#/components/schemas/RegionalSettingRequestResponse"
+ },
+ "roles": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Role"
+ }
+ },
+ "rootUser": {
+ "type": "boolean"
+ },
+ "userId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "userManagedByRC": {
+ "type": "boolean"
+ },
+ "userName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserDetailsResult": {
+ "properties": {
+ "adminId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "agentDetails": {
+ "items": {
+ "$ref": "#/components/schemas/AgentDetailsResult"
+ },
+ "type": "array"
+ },
+ "flr": {
+ "type": "boolean"
+ },
+ "iqUrl": {
+ "type": "string"
+ },
+ "loginHashcode": {
+ "type": "string"
+ },
+ "mainAccountId": {
+ "type": "string"
+ },
+ "managedMainAccountIds": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "port": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "rcAccountId": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "rcUserId": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "regionalSettings": {
+ "$ref": "#/components/schemas/RegionalSettingRequestResponse"
+ },
+ "xAuthToken": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "UserLoginView": {
+ "properties": {
+ "accounts": {
+ "items": {
+ "$ref": "#/components/schemas/AccountView"
+ },
+ "type": "array"
+ },
+ "authToken": {
+ "type": "string"
+ },
+ "platformHost": {
+ "type": "string"
+ },
+ "user": {
+ "$ref": "#/components/schemas/User"
+ }
+ },
+ "type": "object"
+ },
+ "ValidationErrorData": {
+ "properties": {
+ "attributeName": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "VisualIvr": {
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/Account"
+ },
+ "debug": {
+ "type": "boolean"
+ },
+ "debugEmail": {
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "isDeleted": {
+ "type": "boolean"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reportConfig": {
+ "type": "string"
+ },
+ "version": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "visualIvrDesc": {
+ "type": "string"
+ },
+ "visualIvrGroup": {
+ "$ref": "#/components/schemas/VisualIvrGroup"
+ },
+ "visualIvrId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "visualIvrName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "VisualIvrConfig": {
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/Account"
+ },
+ "data": {
+ "type": "string"
+ },
+ "visualIvrDesc": {
+ "type": "string"
+ },
+ "visualIvrId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "visualIvrName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "VisualIvrGroup": {
+ "properties": {
+ "groupName": {
+ "type": "string"
+ },
+ "isDefault": {
+ "type": "boolean"
+ },
+ "ivrGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "visualIvrs": {
+ "$ref": "#/components/schemas/CollectionVisualIvr"
+ }
+ },
+ "type": "object"
+ },
+ "VisualIvrSkinny": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "groupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "isActive": {
+ "type": "boolean"
+ },
+ "isDeleted": {
+ "type": "boolean"
+ },
+ "visualIvrDesc": {
+ "type": "string"
+ },
+ "visualIvrGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "visualIvrId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "visualIvrName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "WFM": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "wfmType": {
+ "enum": [
+ "GENERIC",
+ "GENERIC_UDP",
+ "ASPECT",
+ "AC2",
+ "PIPKINS",
+ "MONET",
+ "NONE"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "WhitelistEntry": {
+ "properties": {
+ "addedBy": {
+ "type": "string"
+ },
+ "addedDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "expireDate": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "isIntl": {
+ "type": "boolean"
+ },
+ "notes": {
+ "type": "string"
+ },
+ "phone": {
+ "type": "string"
+ },
+ "whitelistTag": {
+ "$ref": "#/components/schemas/WhitelistTag"
+ },
+ "whitelistTagId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "WhitelistTag": {
+ "properties": {
+ "accountId": {
+ "type": "string"
+ },
+ "addedBy": {
+ "type": "string"
+ },
+ "addedDts": {
+ "$ref": "#/components/schemas/DateTime"
+ },
+ "tag": {
+ "type": "string"
+ },
+ "whitelistTagId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "wlTagId": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "WhitelistTagMembers": {
+ "properties": {
+ "campaign": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "campaignId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "whitelistTag": {
+ "$ref": "#/components/schemas/WhitelistTag"
+ }
+ },
+ "type": "object"
+ },
+ "WsdlDefinition": {
+ "properties": {
+ "operations": {
+ "items": {
+ "$ref": "#/components/schemas/Operation"
+ },
+ "type": "array"
+ },
+ "serviceName": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SubAccount": {
+ "type": "object",
+ "required": [
+ "subAccountId",
+ "subAccountName",
+ "isActive"
+ ],
+ "properties": {
+ "subAccountId": {
+ "type": "string",
+ "description": "Engage Voice sub-account id",
+ "example": "15910001"
+ },
+ "subAccountName": {
+ "type": "string",
+ "description": "Engage Sub-account name",
+ "example": "Cappuccino Engage Development"
+ },
+ "isActive": {
+ "type": "boolean",
+ "description": "true if sub-account is active",
+ "example": true
+ }
+ }
+ },
+ "QueueWithAgents": {
+ "type": "object",
+ "required": [
+ "queueId",
+ "queueName",
+ "gateGroupId",
+ "isActive",
+ "createdOn"
+ ],
+ "properties": {
+ "queueId": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Unique ID for inbound queue",
+ "example": 555
+ },
+ "queueName": {
+ "type": "string",
+ "description": "Name of inbound queue",
+ "example": "Test queue"
+ },
+ "gateGroupId": {
+ "type": "integer",
+ "format": "int32",
+ "description": "inbound queue group ID",
+ "example": 1009
+ },
+ "isActive": {
+ "type": "boolean",
+ "description": "true if the inbound queue is active",
+ "example": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Timestamp when inbound group was created",
+ "example": "2020-07-21T17:32:28Z"
+ },
+ "agentIds": {
+ "type": "array",
+ "description": "List of agents who connected to this queue",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "example": [
+ 10,
+ 20
+ ]
+ }
+ }
+ },
+ "HistoricalReportParams": {
+ "description": "Parameters for historical reports",
+ "required": [
+ "startDate",
+ "timeInterval",
+ "timeZone",
+ "outputFormat"
+ ],
+ "type": "object",
+ "properties": {
+ "startDate": {
+ "type": "string",
+ "description": "Start date and time for the logging interval. Note: The report will be generated to the nearest minute (Seconds will not be taken into account).",
+ "example": "2021-02-28 08:27:00"
+ },
+ "timeInterval": {
+ "type": "integer",
+ "format": "int32",
+ "enum": [
+ 15,
+ 30,
+ 45,
+ 60
+ ],
+ "description": "Interval length in minutes.",
+ "example": 60
+ },
+ "timeZone": {
+ "type": "string",
+ "description": "Timezone name which should be used for report generation",
+ "example": "US/Eastern"
+ },
+ "reportType": {
+ "type": "string",
+ "enum": [
+ "WEM"
+ ],
+ "description": "Report type which defines required input parameters",
+ "default": "WEM",
+ "example": "WEM"
+ },
+ "outputFormat": {
+ "type": "string",
+ "enum": [
+ "CSV",
+ "XML"
+ ],
+ "description": "Report file format",
+ "example": "CSV"
+ }
+ }
+ },
+ "RealtimeReportParams": {
+ "description": "Parameters for realtime reports",
+ "required": [
+ "startDate",
+ "timeInterval",
+ "timeZone",
+ "outputFormat"
+ ],
+ "type": "object",
+ "properties": {
+ "segmentEndTime": {
+ "type": "string",
+ "description": "Start date and time for the logging interval",
+ "example": "2021-02-28 08:27:15"
+ },
+ "timeInterval": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Interval length in seconds. Maximum allowed length is 3600 (1 hour). Note: if your time interval start or end in the future consecutive requests may return different list of segment. Idempotent results only guaranteed for the completed intervals. Segment recording URL may be added after delay. Allow 1-2min for processing.",
+ "example": 1800
+ },
+ "timeZone": {
+ "type": "string",
+ "description": "Timezone name which should be used for report generation",
+ "example": "US/Eastern"
+ },
+ "reportType": {
+ "type": "string",
+ "enum": [
+ "WEM"
+ ],
+ "description": "Client who requests the report",
+ "default": "WEM",
+ "example": "WEM"
+ },
+ "outputFormat": {
+ "type": "string",
+ "enum": [
+ "CSV",
+ "XML"
+ ],
+ "description": "Report file format",
+ "example": "CSV"
+ }
+ }
+ },
+ "BaseWemStateInfo": {
+ "type": "object",
+ "required": [
+ "createdAt",
+ "updatedAt",
+ "version"
+ ],
+ "properties": {
+ "createdAt": {
+ "type": "string",
+ "format": "datetime",
+ "description": "Creation date and time"
+ },
+ "updatedAt": {
+ "type": "string",
+ "format": "datetime",
+ "description": "Date and time of last update action"
+ },
+ "version": {
+ "type": "integer",
+ "description": "Version number"
+ }
+ }
+ },
+ "MainAccountWemState": {
+ "description": "Main Account WEM state",
+ "type": "object",
+ "required": [
+ "mainAccountId",
+ "mainAccountName",
+ "status"
+ ],
+ "properties": {
+ "mainAccountId": {
+ "type": "string",
+ "description": "Main Account Id",
+ "example": "99990033"
+ },
+ "mainAccountName": {
+ "type": "string",
+ "description": "Main Account Name",
+ "example": "Internal Account"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "ACTIVE",
+ "SUSPENDED"
+ ],
+ "description": "WEM feature status:\n * `ACTIVE` - WEM feature is active for that Customer\n * `SUSPENDED` - WEM feature is suspended for that Customer\n",
+ "example": "ACTIVE"
+ }
+ }
+ },
+ "SubAccountWemState": {
+ "description": "Engage Voice sub-account WEM state",
+ "type": "object",
+ "required": [
+ "subAccountId",
+ "status"
+ ],
+ "properties": {
+ "subAccountId": {
+ "type": "string",
+ "description": "Engage Voice sub-account id",
+ "example": "99990033"
+ },
+ "accountName": {
+ "type": "string",
+ "description": "Engage Voice sub-account name",
+ "example": "Internal Account"
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "ACTIVE",
+ "INACTIVE"
+ ],
+ "description": "WEM feature status:\n * `ACTIVE` - WEM feature is active for that subaccount\n * `INACTIVE` - WEM feature is inactive for that subaccount\n"
+ }
+ }
+ },
+ "AssignedDnisBulkUpdateDTO": {
+ "type": "object",
+ "properties": {
+ "dnisType": {
+ "type": "string",
+ "enum": [
+ "ACCOUNT",
+ "ACD",
+ "AGENT",
+ "CHAT_QUEUE",
+ "OUTBOUND",
+ "VISUAL_IVR",
+ "CLOUD_PROFILE",
+ "CLOUD_DESTINATION",
+ "TRAC_NUMBER",
+ "HTTP_SERVICES",
+ "SCRIPTING",
+ "TN_MANAGER",
+ "SURVEY",
+ "DNIS",
+ "TEAMS",
+ "KNOWLEDGE_BASE",
+ "UTILITIES"
+ ]
+ },
+ "endDate": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "startDate": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "AssignedSmsDnisBulkUpdateDTO": {
+ "type": "object",
+ "properties": {
+ "endDate": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "id": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "startDate": {
+ "type": "string",
+ "format": "date-time"
+ }
+ }
+ },
+ "DnisBulkUpdateRequest": {
+ "type": "object",
+ "properties": {
+ "assignedDnis": {
+ "$ref": "#/components/schemas/AssignedDnisBulkUpdateDTO"
+ },
+ "assignedSmsDnis": {
+ "$ref": "#/components/schemas/AssignedSmsDnisBulkUpdateDTO"
+ },
+ "dnisPool": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DnisPoolDTO"
+ }
+ },
+ "general": {
+ "$ref": "#/components/schemas/GeneralDTO"
+ },
+ "mediaCodes": {
+ "$ref": "#/components/schemas/MediaCodeDTO"
+ }
+ }
+ },
+ "DnisPoolDTO": {
+ "type": "object",
+ "properties": {
+ "dnis": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "reservedAccountId": {
+ "type": "string"
+ }
+ }
+ },
+ "GeneralDTO": {
+ "type": "object",
+ "properties": {
+ "dnisDescription": {
+ "type": "string"
+ },
+ "inboundContext": {
+ "type": "string"
+ },
+ "originatingDnis": {
+ "type": "string"
+ },
+ "reservedAccountId": {
+ "type": "string"
+ }
+ }
+ },
+ "MediaCodeDTO": {
+ "type": "object",
+ "properties": {
+ "dnisCategory": {
+ "type": "string"
+ },
+ "mediaCode": {
+ "type": "string"
+ },
+ "mediaFormat": {
+ "type": "string"
+ },
+ "mediaIsci": {
+ "type": "string"
+ },
+ "mediaLength": {
+ "type": "string"
+ },
+ "mediaMarket": {
+ "type": "string"
+ },
+ "mediaNetwork": {
+ "type": "string"
+ },
+ "mediaUrl": {
+ "type": "string"
+ },
+ "mediaVersion": {
+ "type": "string"
+ },
+ "mediaWebSourcecode": {
+ "type": "string"
+ }
+ }
+ },
+ "InteractionMetadataRequest": {
+ "description": "Parameters for realtime reports",
+ "required": [
+ "segmentEndTime",
+ "timeInterval",
+ "timeZone"
+ ],
+ "type": "object",
+ "properties": {
+ "segmentEndTime": {
+ "type": "string",
+ "description": "Start date and time for the logging interval",
+ "example": "2021-02-28 08:27:15"
+ },
+ "timeInterval": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Interval length in seconds. Maximum allowed length is 3600 (1 hour). Note: if your time interval start or end in the future consecutive requests may return different list of segment. Idempotent results only guaranteed for the completed intervals. Segment recording URL may be added after delay. Allow 1-2min for processing.",
+ "example": 1800
+ },
+ "timeZone": {
+ "type": "string",
+ "description": "Timezone name which should be used for report generation",
+ "example": "US/Eastern"
+ }
+ }
+ },
+ "InteractionSegmentMetaData2Array": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/InteractionSegmentMetaData2"
+ }
+ },
+ "InteractionSegmentMetaData2": {
+ "type": "object",
+ "required": [
+ "interactionId",
+ "interactionStartTime",
+ "interactionDuration",
+ "segmentId",
+ "segmentAgentId",
+ "segmentContactStartTime",
+ "segmentDuration",
+ "segmentCallingAddress",
+ "segmentCalledAddress",
+ "segmentDirection",
+ "segmentRecordingURL",
+ "segmentAgentGroupId"
+ ],
+ "properties": {
+ "interactionId": {
+ "type": "string",
+ "description": "Unique interaction ID used to connect different call segments together in transfer/conference scenarios.",
+ "example": "20200721123305013105000001977"
+ },
+ "interactionStartTimeMs": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Start time of the interaction. Could be different from segment start time if customer was engaged with the IVR, waited in queue, etc before agent joined the conversation. Milliseconds precision.",
+ "example": "2020-07-21T17:32:28.001Z"
+ },
+ "interactionDurationMs": {
+ "type": "integer",
+ "format": "int32",
+ "description": "The total duration of the interaction. Milliseconds precision.",
+ "example": 832
+ },
+ "segmentID": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Unique segment sequnce ID within the interaction.",
+ "example": 2
+ },
+ "segmentAgentId": {
+ "type": "integer",
+ "format": "int32",
+ "description": "RingCentral user id.",
+ "example": 1009
+ },
+ "segmentContactStartTimeMs": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time agent joined the conversation. Milliseconds precision.",
+ "example": "2020-07-21T17:32:40.002Z"
+ },
+ "segmentContactEndTimeMs": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Time agent left the conversation. Milliseconds precision.",
+ "example": "2020-07-21T17:32:42.045Z"
+ },
+ "segmentDuration": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Segment duration (available even when segmentContactEndTime is not provided). Seconds.",
+ "example": 832
+ },
+ "interactionCallingAddress": {
+ "type": "string",
+ "description": "The ANI of the interaction",
+ "example": 4155058987
+ },
+ "interactionCalledAddress": {
+ "type": "string",
+ "description": "The DNIS of the interaction",
+ "example": 8776239199
+ },
+ "interactionDirection": {
+ "type": "string",
+ "enum": [
+ "INBOUND",
+ "OUTBOUND"
+ ],
+ "description": "Direction of the interaction.",
+ "example": "INBOUND"
+ },
+ "segmentRecordingURL": {
+ "type": "string",
+ "description": "URL for segment recording",
+ "example": "https://c02-recordings.virtualacd.biz/api/v1/calls/recordings/?v=1&accountId=99990001&bucket=c02-recordings®ion=us-east-1&compliance=false&file=99990001/202205/09/20220509120710013214000058679-2.WAV"
+ },
+ "segmentAgentGroupId": {
+ "type": "string",
+ "description": "Agent group Id",
+ "example": 8
+ },
+ "segmentEvents": {
+ "type": "array",
+ "description": "Ordered list of events. Can be empty if segmentRecordingURL is empty. In other cases array start with the event `REC_START`. Events don't overlap each other.",
+ "items": {
+ "$ref": "#/components/schemas/InteractionSegmentEvent"
+ }
+ }
+ }
+ },
+ "InteractionSegmentEvent": {
+ "type": "object",
+ "required": [
+ "eventTimeMs",
+ "clientEventTimeMs",
+ "eventType"
+ ],
+ "properties": {
+ "eventTimeMs": {
+ "type": "string",
+ "format": "date-time",
+ "description": "event time with milliseconds precision. Server side.",
+ "example": "2020-07-21T17:32:28.000Z"
+ },
+ "clientEventTimeMs": {
+ "type": "string",
+ "format": "date-time",
+ "description": "event time with milliseconds precision. Client side.",
+ "example": "2020-07-21T17:32:28.000Z"
+ },
+ "eventType": {
+ "type": "string",
+ "enum": [
+ "REC_START",
+ "REC_STOP"
+ ],
+ "example": "REC_START"
+ }
+ }
+ },
+ "WEMInteractionSegmentMetaData2Array": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/WEMDialogSegmentMetaData"
+ },
+ "example": [
+ {
+ "subAccountId": "99999999",
+ "dialogId": "s-v-93bd0e6f0f0a479ea8025fe8f8ec3e1d-1721690897808",
+ "interactionId": "202407221928172035020000000572",
+ "channelId": "2013770791",
+ "channelType": "VOICE",
+ "channelClass": "VOICE",
+ "channelEndpointAddress": "7312066731",
+ "contactEndpointAddress": "2013770791",
+ "dialogOrigination": "INBOUND",
+ "dialogStartTimeMs": "2024-07-22T11:24:40.000Z",
+ "dialogEndTimeMs": "2024-07-22T11:24:47.000Z",
+ "dialogDurationMs": 7000,
+ "segmentId": "p-v-93bd0e6f0f0a479ea8025fe8f8ec3e1d-1721690897808-190dcc63d90ab",
+ "segmentType": "AGENT",
+ "segmentParticipantId": "449438",
+ "segmentParticipantRcExtensionId": "985901004",
+ "segmentStartTimeMs": "2024-07-22T11:24:40.000Z",
+ "segmentEndTimeMs": "2024-07-22T11:24:47.000Z",
+ "segmentDurationMs": 7000,
+ "segmentAgentGroupId": "76873",
+ "systemDisposition": "ANSWER",
+ "agentDisposition": "Success",
+ "agentNotes": "requeue to others",
+ "hasRecording": true,
+ "hasTranscript": true,
+ "segmentEvents": [
+ {
+ "eventTimeMs": "2024-07-22T11:24:40.000Z",
+ "clientEventTimeMs": "2024-07-22T11:24:40.000Z",
+ "eventType": "REC_START"
+ },
+ {
+ "eventTimeMs": "2024-07-22T11:24:47.000Z",
+ "clientEventTimeMs": "2024-07-22T11:24:47.000Z",
+ "eventType": "REC_STOP"
+ }
+ ]
+ },
+ {
+ "subAccountId": "99999999",
+ "dialogId": "d-65fc2f3a382dd00007d8a5d7-1711025979007",
+ "interactionId": "202407230228251400000000001026",
+ "channelId": "672daeb8cd026600070ca39f",
+ "channelType": "ENGAGE_MESSAGING",
+ "channelClass": "DIGITAL",
+ "channelEndpointAddress": "+16506675176",
+ "contactEndpointAddress": "+1324",
+ "dialogOrigination": "INBOUND",
+ "dialogStartTimeMs": "2024-07-23T02:28:25.014Z",
+ "dialogEndTimeMs": "2024-07-23T02:28:42.000Z",
+ "dialogDurationMs": 17000,
+ "segmentId": "d-669e351bef0ea5000753266b-669f4d88a7ba580007b48caf",
+ "segmentType": "AGENT",
+ "segmentParticipantId": "789438",
+ "segmentParticipantRcExtensionId": "1552533005",
+ "segmentStartTimeMs": "2024-07-23T02:28:25.000Z",
+ "segmentEndTimeMs": "2024-07-23T02:28:42.000Z",
+ "segmentDurationMs": 17000,
+ "segmentAgentGroupId": "79698",
+ "systemDisposition": null,
+ "agentDisposition": "Success",
+ "agentNotes": "Engage Messaging Notes",
+ "hasRecording": false,
+ "hasTranscript": true,
+ "segmentEvents": null
+ },
+ {
+ "subAccountId": "99999999",
+ "dialogId": "d-672dbaf7c211050006e056e1-1731050231731",
+ "interactionId": "202411080217120144700000000001",
+ "channelId": "672daeb8cd026600070ca39f",
+ "channelType": "EMAIL",
+ "channelClass": "DIGITAL",
+ "channelEndpointAddress": "+16506675176",
+ "contactEndpointAddress": "+1324",
+ "dialogOrigination": "INBOUND",
+ "dialogStartTimeMs": "2024-07-23T02:28:25.014Z",
+ "dialogEndTimeMs": "2024-07-23T02:28:42.000Z",
+ "dialogDurationMs": 17000,
+ "segmentId": "d-672dbaf7c211050006e056e1-1731050231731-1930aa2600f99",
+ "segmentType": "AGENT",
+ "segmentParticipantId": "789438",
+ "segmentParticipantRcExtensionId": "1552533005",
+ "segmentStartTimeMs": "2024-07-23T02:28:25.000Z",
+ "segmentEndTimeMs": "2024-07-23T02:28:42.000Z",
+ "segmentDurationMs": 17000,
+ "segmentAgentGroupId": "79698",
+ "systemDisposition": null,
+ "agentDisposition": "Success",
+ "agentNotes": "email notes",
+ "hasRecording": false,
+ "hasTranscript": true,
+ "segmentEvents": null
+ },
+ {
+ "subAccountId": "99999999",
+ "dialogId": "d-672dba74c211050006e056d4-1731050100923",
+ "interactionId": "202411080215020144700000000000",
+ "channelId": "672daeb8cd026600070ca39f",
+ "channelType": "MESSENGER",
+ "channelClass": "DIGITAL",
+ "channelEndpointAddress": "+16506675176",
+ "contactEndpointAddress": "+1324",
+ "dialogOrigination": "INBOUND",
+ "dialogStartTimeMs": "2024-07-23T02:28:25.014Z",
+ "dialogEndTimeMs": "2024-07-23T02:28:42.000Z",
+ "dialogDurationMs": 17000,
+ "segmentId": "d-672dba74c211050006e056d4-1731050100923-1930aa0638ea8",
+ "segmentType": "AGENT",
+ "segmentParticipantId": "789438",
+ "segmentParticipantRcExtensionId": "1552533005",
+ "segmentStartTimeMs": "2024-07-23T02:28:25.000Z",
+ "segmentEndTimeMs": "2024-07-23T02:28:42.000Z",
+ "segmentDurationMs": 17000,
+ "segmentAgentGroupId": "79698",
+ "systemDisposition": null,
+ "agentDisposition": "Success",
+ "agentNotes": "Messenger notes",
+ "hasRecording": false,
+ "hasTranscript": true,
+ "segmentEvents": null
+ }
+ ]
+ },
+ "WEMDialogSegmentMetaData": {
+ "type": "object",
+ "properties": {
+ "subAccountId": {
+ "type": "string"
+ },
+ "dialogId": {
+ "type": "string"
+ },
+ "interactionId": {
+ "type": "string"
+ },
+ "channelId": {
+ "type": "string"
+ },
+ "channelType": {
+ "type": "string"
+ },
+ "channelClass": {
+ "type": "string"
+ },
+ "channelEndpointAddress": {
+ "type": "string"
+ },
+ "contactEndpointAddress": {
+ "type": "string"
+ },
+ "dialogOrigination": {
+ "type": "string"
+ },
+ "dialogStartTimeMs": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "dialogEndTimeMs": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "dialogDurationMs": {
+ "type": "integer"
+ },
+ "segmentId": {
+ "type": "string"
+ },
+ "segmentType": {
+ "type": "string"
+ },
+ "segmentParticipantId": {
+ "type": "string"
+ },
+ "segmentParticipantRcExtensionId": {
+ "type": "string"
+ },
+ "segmentStartTimeMs": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "segmentEndTimeMs": {
+ "type": "string",
+ "format": "date-time"
+ },
+ "segmentDurationMs": {
+ "type": "integer"
+ },
+ "segmentAgentGroupId": {
+ "type": "string"
+ },
+ "systemDisposition": {
+ "type": "string",
+ "nullable": true
+ },
+ "agentDisposition": {
+ "type": "string"
+ },
+ "agentNotes": {
+ "type": "string"
+ },
+ "hasRecording": {
+ "type": "boolean"
+ },
+ "hasTranscript": {
+ "type": "boolean"
+ },
+ "segmentEvents": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/InteractionSegmentEvent"
+ },
+ "nullable": true
+ }
+ }
+ },
+ "AggregatedIntegrationParams": {
+ "type": "object",
+ "required": [
+ "startDate",
+ "endDate",
+ "timeInterval",
+ "timeZone"
+ ],
+ "properties": {
+ "startDate": {
+ "type": "string",
+ "description": "Start date and time for the logging interval in 'YYYY-MM-DD HH:mm:ss' format.",
+ "example": "2026-03-02 09:00:00"
+ },
+ "endDate": {
+ "type": "string",
+ "description": "End date and time for the logging interval in 'YYYY-MM-DD HH:mm:ss' format. Must be within 3 hours of the startDate.",
+ "example": "2026-03-02 12:00:00"
+ },
+ "timeInterval": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Interval length in seconds (e.g., 1800 for 30 minutes).",
+ "example": 1800
+ },
+ "timeZone": {
+ "type": "string",
+ "description": "Timezone name used for report generation (e.g., 'US/Eastern').",
+ "example": "US/Eastern"
+ },
+ "outputFormat": {
+ "type": "string",
+ "enum": [
+ "CSV",
+ "XML"
+ ],
+ "description": "The file format of the generated report.",
+ "example": "CSV"
+ }
+ }
+ },
+ "AggregatedAgentStats": {
+ "type": "object",
+ "properties": {
+ "interval": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "dateTimeFrom": {
+ "type": "string"
+ },
+ "agentId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "agentName": {
+ "type": "string"
+ },
+ "availDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "totWorkDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "pauseDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "waitDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "adminDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "directOutIxnCnt": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "directOutIxnDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "directInIxnCnt": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "directInIxnDur": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "AggregatedQueueStats": {
+ "type": "object",
+ "properties": {
+ "dateTimeFrom": {
+ "type": "string"
+ },
+ "interval": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "queue": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "queueName": {
+ "type": "string"
+ },
+ "offdDirectIxnCnt": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "answIxnCnt": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "abandIxnCnt": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "abandShortIxnCnt": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "abandWithinSlCnt": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "ansServicelevelCnt": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "completedContacts": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "queuedAndAnswIxnDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "queuedAndAbandIxnDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "queuedAnswLongestQueDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "queuedAbandLongestQueDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "talkingIxnDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "wrapUpDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "waitDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "segmentHoldTime": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "overflowInIxnCnt": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "overflowOutIxnCnt": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "ExtendedAggregatedQueueStats": {
+ "type": "object",
+ "properties": {
+ "interval": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "dateTimeFrom": {
+ "type": "string"
+ },
+ "agentId": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "agentName": {
+ "type": "string"
+ },
+ "queue": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "queueName": {
+ "type": "string"
+ },
+ "talkingIxnDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "wrapUpDur": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "answIxnCnt": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "transferOutIxnCnt": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "CXQueueWithAgents": {
+ "type": "object",
+ "required": [
+ "queueId",
+ "queueName",
+ "queueGroupId",
+ "isActive",
+ "createdOn"
+ ],
+ "properties": {
+ "queueId": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Unique ID for inbound queue",
+ "example": 555
+ },
+ "queueType": {
+ "type": "string",
+ "enum": [
+ "VOICE",
+ "DIGITAL"
+ ],
+ "example": "VOICE"
+ },
+ "queueName": {
+ "type": "string",
+ "description": "Name of inbound queue",
+ "example": "Test queue"
+ },
+ "queueGroupId": {
+ "type": "integer",
+ "format": "int32",
+ "description": "inbound queue group ID",
+ "example": 1009
+ },
+ "isActive": {
+ "type": "boolean",
+ "description": "true if the inbound queue is active",
+ "example": true
+ },
+ "createdOn": {
+ "type": "string",
+ "format": "date-time",
+ "description": "Timestamp when inbound group was created",
+ "example": "2020-07-21T17:32:28Z"
+ },
+ "agentIds": {
+ "type": "array",
+ "description": "List of agents who connected to this queue",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "example": [
+ 10,
+ 20
+ ]
+ }
+ }
+ },
+ "RCInteractionTranscriptData": {
+ "type": "object",
+ "properties": {
+ "channelClass": {
+ "type": "string",
+ "example": "DIGITAL"
+ },
+ "errorCode": {
+ "type": "string",
+ "nullable": true
+ },
+ "errorMessage": {
+ "type": "string",
+ "nullable": true
+ },
+ "transcript": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TranscriptPhrase"
+ }
+ }
+ }
+ },
+ "TranscriptPhrase": {
+ "type": "object",
+ "properties": {
+ "participantId": {
+ "type": "string"
+ },
+ "rcUserId": {
+ "type": "string",
+ "nullable": true
+ },
+ "participantName": {
+ "type": "string",
+ "nullable": true
+ },
+ "participantType": {
+ "type": "string",
+ "example": "agent"
+ },
+ "timestamp": {
+ "type": "string",
+ "example": "1721651880000"
+ },
+ "message": {
+ "type": "string"
+ }
+ }
+ },
+ "QueueGroup": {
+ "type": "object",
+ "properties": {
+ "queueGroupId": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Unique ID for queue group",
+ "example": 1009
+ },
+ "groupName": {
+ "type": "string",
+ "description": "Queue group name",
+ "example": "Queue group 1"
+ },
+ "queueGroupType": {
+ "type": "string",
+ "enum": [
+ "VOICE",
+ "DIGITAL"
+ ],
+ "description": "The type of queues contained in this group",
+ "example": "VOICE"
+ }
+ }
+ },
+ "CloudRouteDestinationSkinny": {
+ "properties": {
+ "cloudDestinationId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "destinationName": {
+ "type": "string"
+ },
+ "cloudGroupId": {
+ "type": "string"
+ },
+ "isActive": {
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "CloudRouteGroupSkinny": {
+ "properties": {
+ "cloudGroupId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "groupName": {
+ "type": "string"
+ },
+ "accountId": {
+ "type": "string"
+ },
+ "cloudRouteDestinations": {
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteDestinationSkinny"
+ },
+ "type": "array"
+ },
+ "cloudRouteProfiles": {
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteProfileSkinny"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "PersonaPhoneConfig": {
+ "properties": {
+ "accountId": {
+ "description": "RingCX account ID for the persona phone configuration.",
+ "type": "string"
+ },
+ "phoneId": {
+ "description": "Persona phone identifier. Use 1 for the primary lead phone and 2 through 7 for additional configured phone personas.",
+ "format": "int32",
+ "maximum": 7,
+ "type": "integer"
+ },
+ "phoneLabel": {
+ "description": "Display label for this phone persona.",
+ "maxLength": 30,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PersonaPhoneConfigFields": {
+ "properties": {
+ "phoneId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "phoneLabel": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PersonaCallPreference": {
+ "properties": {
+ "phoneId": {
+ "description": "Persona phone ID to dial during this schedule window.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "priority": {
+ "description": "Dialing order for this phone persona within the schedule window. Lower numbers are attempted first.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "phoneLabel": {
+ "description": "Configured label for the persona phone ID.",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "PersonaCallSchedule": {
+ "properties": {
+ "scheduleId": {
+ "format": "int32",
+ "readOnly": true,
+ "type": "integer"
+ },
+ "day": {
+ "enum": [
+ "SUNDAY",
+ "MONDAY",
+ "TUESDAY",
+ "WEDNESDAY",
+ "THURSDAY",
+ "FRIDAY",
+ "SATURDAY"
+ ],
+ "type": "string"
+ },
+ "campaignId": {
+ "format": "int32",
+ "readOnly": true,
+ "type": "integer"
+ },
+ "start": {
+ "description": "Start time for the persona calling window, in HH:mm format.",
+ "type": "string"
+ },
+ "end": {
+ "description": "End time for the persona calling window, in HH:mm format.",
+ "type": "string"
+ },
+ "callPreferences": {
+ "items": {
+ "$ref": "#/components/schemas/PersonaCallPreference"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AccountDTO": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "records": {
+ "items": {
+ "$ref": "#/components/schemas/DnisRecordDTO"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DnisRecordDTO": {
+ "properties": {
+ "active": {
+ "type": "boolean"
+ },
+ "assignedDnis": {
+ "$ref": "#/components/schemas/AssignedDnis"
+ },
+ "carrier": {
+ "type": "string"
+ },
+ "customAppString": {
+ "type": "string"
+ },
+ "dateCreated": {
+ "type": "string"
+ },
+ "dnis": {
+ "type": "string"
+ },
+ "dnisCategory": {
+ "type": "string"
+ },
+ "dnisDescription": {
+ "type": "string"
+ },
+ "dnisE164": {
+ "type": "string"
+ },
+ "dnisManagedByRC": {
+ "type": "boolean"
+ },
+ "dnisState": {
+ "type": "string"
+ },
+ "inboundContext": {
+ "type": "string"
+ },
+ "lastModified": {
+ "type": "string"
+ },
+ "lastModifiedBy": {
+ "type": "string"
+ },
+ "mediaCode": {
+ "type": "string"
+ },
+ "mediaFormat": {
+ "type": "string"
+ },
+ "mediaIsci": {
+ "type": "string"
+ },
+ "mediaLength": {
+ "type": "string"
+ },
+ "mediaMarket": {
+ "type": "string"
+ },
+ "mediaNetwork": {
+ "type": "string"
+ },
+ "mediaUrl": {
+ "type": "string"
+ },
+ "mediaVersion": {
+ "type": "string"
+ },
+ "mediaWebSourcecode": {
+ "type": "string"
+ },
+ "notes": {
+ "type": "string"
+ },
+ "originatingDnis": {
+ "type": "string"
+ },
+ "platformId": {
+ "type": "string"
+ },
+ "resporg": {
+ "type": "string"
+ },
+ "smsEnabled": {
+ "type": "boolean"
+ },
+ "twilioApiKey": {
+ "type": "string"
+ },
+ "vendorId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DnisSearchResultDTO": {
+ "properties": {
+ "entries": {
+ "additionalProperties": {
+ "$ref": "#/components/schemas/AccountDTO"
+ },
+ "type": "object"
+ },
+ "totalCount": {
+ "format": "int64",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "AuthConfigApiKey": {
+ "required": [
+ "apiKey",
+ "providerName"
+ ],
+ "properties": {
+ "apiKey": {
+ "type": "string"
+ },
+ "authConfigId": {
+ "format": "uuid",
+ "type": "string"
+ },
+ "authType": {
+ "enum": [
+ "APIKEY",
+ "JWT",
+ "BASIC",
+ "OAUTH",
+ "CUSTOM_AUTH"
+ ],
+ "type": "string"
+ },
+ "createdTime": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "providerName": {
+ "type": "string"
+ },
+ "updatedTime": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuthConfigBasic": {
+ "required": [
+ "password",
+ "providerName",
+ "username"
+ ],
+ "properties": {
+ "authConfigId": {
+ "format": "uuid",
+ "type": "string"
+ },
+ "authType": {
+ "enum": [
+ "APIKEY",
+ "JWT",
+ "BASIC",
+ "OAUTH",
+ "CUSTOM_AUTH"
+ ],
+ "type": "string"
+ },
+ "createdTime": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "password": {
+ "type": "string"
+ },
+ "providerName": {
+ "type": "string"
+ },
+ "updatedTime": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuthConfigCustomAuth": {
+ "properties": {
+ "allowedBaseUrl": {
+ "type": "string"
+ },
+ "authConfigId": {
+ "format": "uuid",
+ "type": "string"
+ },
+ "authType": {
+ "enum": [
+ "APIKEY",
+ "JWT",
+ "BASIC",
+ "OAUTH",
+ "CUSTOM_AUTH"
+ ],
+ "type": "string"
+ },
+ "createdTime": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "inputParams": {
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "providerName": {
+ "type": "string"
+ },
+ "updatedTime": {
+ "type": "string"
+ },
+ "wcgFunctionId": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuthConfigJwt": {
+ "required": [
+ "addTokenTo",
+ "algorithm",
+ "payload",
+ "providerName"
+ ],
+ "properties": {
+ "addTokenTo": {
+ "enum": [
+ "REQUEST_HEADER",
+ "QUERY_PARAM"
+ ],
+ "type": "string"
+ },
+ "algorithm": {
+ "type": "string"
+ },
+ "authConfigId": {
+ "format": "uuid",
+ "type": "string"
+ },
+ "authType": {
+ "enum": [
+ "APIKEY",
+ "JWT",
+ "BASIC",
+ "OAUTH",
+ "CUSTOM_AUTH"
+ ],
+ "type": "string"
+ },
+ "createdTime": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "expirationTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "headerPrefix": {
+ "type": "string"
+ },
+ "isIncludeIssueAt": {
+ "type": "boolean"
+ },
+ "isSecretEncoded": {
+ "type": "boolean"
+ },
+ "jwtHeaders": {
+ "type": "string"
+ },
+ "payload": {
+ "type": "string"
+ },
+ "privateKey": {
+ "type": "string"
+ },
+ "providerName": {
+ "type": "string"
+ },
+ "queryParamName": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ },
+ "updatedTime": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuthConfigList": {
+ "properties": {
+ "records": {
+ "items": {
+ "$ref": "#/components/schemas/GetExternalAuthConfigById200Response"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "AuthConfigOAuth": {
+ "required": [
+ "clientId",
+ "grantType",
+ "providerName",
+ "secret",
+ "tokenUrl"
+ ],
+ "properties": {
+ "assertion": {
+ "type": "string"
+ },
+ "authConfigId": {
+ "format": "uuid",
+ "type": "string"
+ },
+ "authType": {
+ "enum": [
+ "APIKEY",
+ "JWT",
+ "BASIC",
+ "OAUTH",
+ "CUSTOM_AUTH"
+ ],
+ "type": "string"
+ },
+ "clientCredentialsSupplyIn": {
+ "enum": [
+ "BODY",
+ "QUERY_PARAM",
+ "HEADER"
+ ],
+ "type": "string"
+ },
+ "clientId": {
+ "type": "string"
+ },
+ "createdTime": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "grantType": {
+ "enum": [
+ "CLIENT_CREDENTIALS",
+ "PASSWORD",
+ "REFRESH_TOKEN",
+ "JWT_BEARER"
+ ],
+ "type": "string"
+ },
+ "oauthProvider": {
+ "enum": [
+ "ADMIN_POPULATED",
+ "SFDC_WEBFLOW"
+ ],
+ "type": "string"
+ },
+ "otherParameters": {
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "password": {
+ "type": "string"
+ },
+ "providerName": {
+ "type": "string"
+ },
+ "scope": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ },
+ "tokenResponse": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "tokenUrl": {
+ "type": "string"
+ },
+ "updatedTime": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "AuthConfigOAuthUrl": {
+ "properties": {
+ "location": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ExternalHttpService": {
+ "description": "External HTTP Service",
+ "properties": {
+ "accountId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "action": {
+ "type": "string"
+ },
+ "authConfigId": {
+ "type": "string"
+ },
+ "enableMappings": {
+ "type": "boolean"
+ },
+ "endpoint": {
+ "type": "string"
+ },
+ "httpServiceConfig": {
+ "properties": {
+ "content_type": {
+ "type": "string"
+ },
+ "form_data": {
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
},
- "type": "object"
- },
- "SubAccount": {
- "type": "object",
- "required": [
- "subAccountId",
- "subAccountName",
- "isActive"
- ],
- "properties": {
- "subAccountId": {
- "type": "string",
- "description": "Engage Voice sub-account id",
- "example": "15910001"
- },
- "subAccountName": {
- "type": "string",
- "description": "Engage Sub-account name",
- "example": "Cappuccino Engage Development"
- },
- "isActive": {
- "type": "boolean",
- "description": "true if sub-account is active",
- "example": true
- }
+ "type": "array"
+ },
+ "headers": {
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "json_data": {
+ "type": "string"
+ },
+ "method": {
+ "enum": [
+ "GET",
+ "POST",
+ "PUT",
+ "DELETE",
+ "PATCH"
+ ],
+ "type": "string"
+ },
+ "query_params": {
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "soap_inputs": {
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "text_data": {
+ "type": "string"
+ },
+ "type": {
+ "enum": [
+ "HTTP",
+ "SOAP"
+ ],
+ "type": "string"
+ },
+ "xml_data": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "isDebug": {
+ "type": "boolean"
+ },
+ "isEnabled": {
+ "type": "boolean"
+ },
+ "operationName": {
+ "type": "string"
+ },
+ "permissions": {
+ "items": {
+ "enum": [
+ "CREATE",
+ "READ",
+ "UPDATE",
+ "DELETE",
+ "REPORT"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "portname": {
+ "type": "string"
+ },
+ "returnType": {
+ "type": "string"
+ },
+ "sendAllSurveyData": {
+ "type": "boolean"
+ },
+ "serviceDescription": {
+ "type": "string"
+ },
+ "serviceId": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "serviceType": {
+ "enum": [
+ "SOAP",
+ "HTTP_POST",
+ "HTTP_GET",
+ "HTTP"
+ ],
+ "type": "string"
+ },
+ "servicename": {
+ "type": "string"
+ },
+ "targetNamespace": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GetExternalAuthConfigById200Response": {
+ "properties": {
+ "addTokenTo": {
+ "enum": [
+ "REQUEST_HEADER",
+ "QUERY_PARAM"
+ ],
+ "type": "string"
+ },
+ "algorithm": {
+ "type": "string"
+ },
+ "apiKey": {
+ "type": "string"
+ },
+ "assertion": {
+ "type": "string"
+ },
+ "authConfigId": {
+ "format": "uuid",
+ "type": "string"
+ },
+ "authType": {
+ "enum": [
+ "APIKEY",
+ "JWT",
+ "BASIC",
+ "OAUTH",
+ "CUSTOM_AUTH"
+ ],
+ "type": "string"
+ },
+ "clientCredentialsSupplyIn": {
+ "enum": [
+ "BODY",
+ "QUERY_PARAM",
+ "HEADER"
+ ],
+ "type": "string"
+ },
+ "clientId": {
+ "type": "string"
+ },
+ "createdTime": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "expirationTime": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "grantType": {
+ "enum": [
+ "CLIENT_CREDENTIALS",
+ "PASSWORD",
+ "REFRESH_TOKEN",
+ "JWT_BEARER"
+ ],
+ "type": "string"
+ },
+ "headerPrefix": {
+ "type": "string"
+ },
+ "isIncludeIssueAt": {
+ "type": "boolean"
+ },
+ "isSecretEncoded": {
+ "type": "boolean"
+ },
+ "jwtHeaders": {
+ "type": "string"
+ },
+ "oauthProvider": {
+ "enum": [
+ "ADMIN_POPULATED",
+ "SFDC_WEBFLOW"
+ ],
+ "type": "string"
+ },
+ "otherParameters": {
+ "items": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "password": {
+ "type": "string"
+ },
+ "payload": {
+ "type": "string"
+ },
+ "privateKey": {
+ "type": "string"
+ },
+ "providerName": {
+ "type": "string"
+ },
+ "queryParamName": {
+ "type": "string"
+ },
+ "scope": {
+ "type": "string"
+ },
+ "secret": {
+ "type": "string"
+ },
+ "tokenUrl": {
+ "type": "string"
+ },
+ "updatedTime": {
+ "type": "string"
+ },
+ "username": {
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "securitySchemes": {
+ "BearerAuth": {
+ "scheme": "bearer",
+ "type": "http"
+ },
+ "apiKey": {
+ "in": "header",
+ "name": "apiKey",
+ "type": "apiKey"
+ }
+ }
+ },
+ "info": {
+ "title": "RingCentral RingCX API",
+ "version": "1.0.0",
+ "termsOfService": "https://developers.ringcentral.com",
+ "license": {
+ "name": "none"
+ },
+ "contact": {}
+ },
+ "openapi": "3.0.0",
+ "paths": {
+ "/api/auth/login/rc/accesstoken": {
+ "post": {
+ "operationId": "loginWithRcAccessToken",
+ "parameters": [
+ {
+ "description": "Includes the refresh token along with the Engage Access Token.",
+ "in": "query",
+ "name": "includeRefresh",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "To acquire an Engage Access Token, you will need to first [retrieve a Ring Central Access Token](https://developers.ringcentral.com/engage/voice/guide/authentication/auth-ringcentral#retrieve-ringcentral-access-token).",
+ "in": "query",
+ "name": "rcAccessToken",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "The Ring Central Token Type is a 'Bearer' type using the [OAuth 2.0](https://developers.ringcentral.com/api-reference/authentication) bearer token.",
+ "example": "Bearer",
+ "in": "query",
+ "name": "rcTokenType",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AccessTokenUserDetails"
}
- },
- "QueueWithAgents": {
- "type": "object",
- "required": [
- "queueId",
- "queueName",
- "gateGroupId",
- "isActive",
- "createdOn"
- ],
- "properties": {
- "queueId": {
- "type": "integer",
- "format": "int32",
- "description": "Unique ID for inbound queue",
- "example": 555
- },
- "queueName": {
- "type": "string",
- "description": "Name of inbound queue",
- "example": "Test queue"
- },
- "gateGroupId": {
- "type": "integer",
- "format": "int32",
- "description": "inbound queue group ID",
- "example": 1009
- },
- "isActive": {
- "type": "boolean",
- "description": "true if the inbound queue is active",
- "example": true
- },
- "createdOn": {
- "type": "string",
- "format": "date-time",
- "description": "Timestamp when inbound group was created",
- "example": "2020-07-21T17:32:28Z"
- },
- "agentIds": {
- "type": "array",
- "description": "List of agents who connected to this queue",
- "items": {
- "type": "integer",
- "format": "int32"
- },
- "example": [
- 10,
- 20
- ]
- }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Logs in an RC user via their access token issued by the RC API server. Returns Engage access token and user details",
+ "tags": [
+ "RingCentral Auth"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts": {
+ "get": {
+ "description": "Returns the RingCX accounts available to the authenticated user.",
+ "operationId": "getAllAccounts",
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/Account"
+ },
+ "type": "array"
}
- },
- "HistoricalReportParams": {
- "description": "Parameters for historical reports",
- "required": [
- "startDate",
- "timeInterval",
- "timeZone",
- "outputFormat"
- ],
- "type": "object",
- "properties": {
- "startDate": {
- "type": "string",
- "description": "Start date and time for the logging interval. Note: The report will be generated to the nearest minute (Seconds will not be taken into account).",
- "example": "2021-02-28 08:27:00"
- },
- "timeInterval": {
- "type": "integer",
- "format": "int32",
- "enum": [
- 15,
- 30,
- 45,
- 60
- ],
- "description": "Interval length in minutes.",
- "example": 60
- },
- "timeZone": {
- "type": "string",
- "description": "Timezone name which should be used for report generation",
- "example": "US/Eastern"
- },
- "reportType": {
- "type": "string",
- "enum": [
- "WEM"
- ],
- "description": "Report type which defines required input parameters",
- "default": "WEM",
- "example": "WEM"
- },
- "outputFormat": {
- "type": "string",
- "enum": [
- "CSV",
- "XML"
- ],
- "description": "Report file format",
- "example": "CSV"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns RingCX accounts available to the authenticated user",
+ "tags": [
+ "RingCentral Auth"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/activeCalls/createManualAgentCall": {
+ "post": {
+ "description": "Permissions: READ on Account (Permission Override)",
+ "operationId": "createManualAgentCall",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "username",
+ "in": "query",
+ "name": "username",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "destination",
+ "in": "query",
+ "name": "destination",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "ringDuration",
+ "in": "query",
+ "name": "ringDuration",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "callerId",
+ "in": "query",
+ "name": "callerId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "boolean"
}
- },
- "RealtimeReportParams": {
- "description": "Parameters for realtime reports",
- "required": [
- "startDate",
- "timeInterval",
- "timeZone",
- "outputFormat"
- ],
- "type": "object",
- "properties": {
- "segmentEndTime": {
- "type": "string",
- "description": "Start date and time for the logging interval",
- "example": "2021-02-28 08:27:15"
- },
- "timeInterval": {
- "type": "integer",
- "format": "int32",
- "description": "Interval length in seconds. Maximum allowed length is 3600 (1 hour). Note: if your time interval start or end in the future consecutive requests may return different list of segment. Idempotent results only guaranteed for the completed intervals. Segment recording URL may be added after delay. Allow 1-2min for processing.",
- "example": 1800
- },
- "timeZone": {
- "type": "string",
- "description": "Timezone name which should be used for report generation",
- "example": "US/Eastern"
- },
- "reportType": {
- "type": "string",
- "enum": [
- "WEM"
- ],
- "description": "Client who requests the report",
- "default": "WEM",
- "example": "WEM"
- },
- "outputFormat": {
- "type": "string",
- "enum": [
- "CSV",
- "XML"
- ],
- "description": "Report file format",
- "example": "CSV"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates a manual agent call",
+ "tags": [
+ "Active Calls"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/activeCalls/list": {
+ "get": {
+ "description": "Permissions: READ on Account",
+ "operationId": "getProductActiveCallsListRequest",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "product",
+ "in": "query",
+ "name": "product",
+ "schema": {
+ "enum": [
+ "ACCOUNT",
+ "ACD",
+ "AGENT",
+ "CHAT_QUEUE",
+ "OUTBOUND",
+ "VISUAL_IVR",
+ "CLOUD_PROFILE",
+ "CLOUD_DESTINATION",
+ "TRAC_NUMBER",
+ "HTTP_SERVICES",
+ "SCRIPTING",
+ "TN_MANAGER",
+ "SURVEY",
+ "DNIS",
+ "TEAMS",
+ "KNOWLEDGE_BASE",
+ "UTILITIES"
+ ],
+ "type": "string"
+ }
+ },
+ {
+ "description": "productId",
+ "in": "query",
+ "name": "productId",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "externalId",
+ "in": "query",
+ "name": "externalId",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "page",
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "maxRows",
+ "in": "query",
+ "name": "maxRows",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/ActiveCallListResponse"
+ },
+ "type": "array"
}
- },
- "BaseWemStateInfo": {
- "type": "object",
- "required": [
- "createdAt",
- "updatedAt",
- "version"
- ],
- "properties": {
- "createdAt": {
- "type": "string",
- "format": "datetime",
- "description": "Creation date and time"
- },
- "updatedAt": {
- "type": "string",
- "format": "datetime",
- "description": "Date and time of last update action"
- },
- "version": {
- "type": "integer",
- "description": "Version number"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of current active calls for a given product OR externalId, on an account",
+ "tags": [
+ "Active Calls"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/activeCalls/prerouteChecks/checkQueueStatus": {
+ "get": {
+ "description": "Check queue status API returns true or false (with more info) if the queue is available to take calls based on the max queue time.",
+ "operationId": "checkQueueStatus",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "DNIS to be used for queue lookup. Must be assigned to the queue.",
+ "in": "query",
+ "name": "destination_number",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Max queue time. If max queue time is greater than 0, then if the longest in queue time is less than the passed in max queue time, return TRUE, else return FALSE with message containing the number of calls in queue and the longest queue time. If the max queue time is <=0, then return TRUE if there are any agents available in the queue to take the call, else return FALSE. auth_token - permanent API x-auth-token. More info https://developers.ringcentral.com/engage/voice/guide/authentication/auth-legacy",
+ "in": "query",
+ "name": "maxq",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "phoneNumbersI18nEnabled",
+ "in": "query",
+ "name": "phoneNumbersI18nEnabled",
+ "schema": {
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PrerouteCheckStatus"
}
- },
- "MainAccountWemState": {
- "description": "Main Account WEM state",
- "type": "object",
- "required": [
- "mainAccountId",
- "mainAccountName",
- "status"
- ],
- "properties": {
- "mainAccountId": {
- "type": "string",
- "description": "Main Account Id",
- "example": "99990033"
- },
- "mainAccountName": {
- "type": "string",
- "description": "Main Account Name",
- "example": "Internal Account"
- },
- "status": {
- "type": "string",
- "enum": [
- "ACTIVE",
- "SUSPENDED"
- ],
- "description": "WEM feature status:\n * `ACTIVE` - WEM feature is active for that Customer\n * `SUSPENDED` - WEM feature is suspended for that Customer\n",
- "example": "ACTIVE"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Check queue status",
+ "tags": [
+ "Active Calls"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/activeCalls/prerouteChecks/checkQueueThreshold": {
+ "get": {
+ "description": "Check queue threshold API Returns true or false based on the current number of calls in queue and the passed in threshold value.",
+ "operationId": "checkQueueThreshold",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "DNIS to be used for queue lookup. Must be assigned to the queue.",
+ "in": "query",
+ "name": "destination_number",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "If the number of calls currently in queue is less than the passed maxCallsQueued value (default 0) it returns TRUE, else FALSE. auth_token - permanent API x-auth-token. More info https://developers.ringcentral.com/engage/voice/guide/authentication/auth-legacy",
+ "in": "query",
+ "name": "maxCallsQueued",
+ "schema": {
+ "default": 10,
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "phoneNumbersI18nEnabled",
+ "in": "query",
+ "name": "phoneNumbersI18nEnabled",
+ "schema": {
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PrerouteCheckStatus"
}
- },
- "SubAccountWemState": {
- "description": "Engage Voice sub-account WEM state",
- "type": "object",
- "required": [
- "subAccountId",
- "status"
- ],
- "properties": {
- "subAccountId": {
- "type": "string",
- "description": "Engage Voice sub-account id",
- "example": "99990033"
- },
- "accountName": {
- "type": "string",
- "description": "Engage Voice sub-account name",
- "example": "Internal Account"
- },
- "status": {
- "type": "string",
- "enum": [
- "ACTIVE",
- "INACTIVE"
- ],
- "description": "WEM feature status:\n * `ACTIVE` - WEM feature is active for that subaccount\n * `INACTIVE` - WEM feature is inactive for that subaccount\n"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Check queue threshold",
+ "tags": [
+ "Active Calls"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/activeCalls/{uii}/addSessionToCall": {
+ "post": {
+ "description": "Permissions: READ on Account (Permission Override)",
+ "operationId": "addSessionToCall",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "uii",
+ "in": "path",
+ "name": "uii",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "destination",
+ "in": "query",
+ "name": "destination",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "sessionType",
+ "in": "query",
+ "name": "sessionType",
+ "required": true,
+ "schema": {
+ "enum": [
+ "MONITOR",
+ "BARGEIN",
+ "COACHING"
+ ],
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "boolean"
}
- },
- "AssignedDnisBulkUpdateDTO": {
- "type": "object",
- "properties": {
- "dnisType": {
- "type": "string",
- "enum": [
- "ACCOUNT",
- "ACD",
- "AGENT",
- "CHAT_QUEUE",
- "OUTBOUND",
- "VISUAL_IVR",
- "CLOUD_PROFILE",
- "CLOUD_DESTINATION",
- "TRAC_NUMBER",
- "HTTP_SERVICES",
- "SCRIPTING",
- "TN_MANAGER",
- "SURVEY",
- "DNIS",
- "TEAMS",
- "KNOWLEDGE_BASE",
- "UTILITIES"
- ]
- },
- "endDate": {
- "type": "string",
- "format": "date-time"
- },
- "id": {
- "type": "integer",
- "format": "int32"
- },
- "startDate": {
- "type": "string",
- "format": "date-time"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Provides support for adding sessions to an active call",
+ "tags": [
+ "Active Calls"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/activeCalls/{uii}/dispositionCall": {
+ "post": {
+ "description": "Permissions: READ on Account (Permission Override)",
+ "operationId": "dispositionCall",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "uii",
+ "in": "path",
+ "name": "uii",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "disposition",
+ "in": "query",
+ "name": "disposition",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "callback",
+ "in": "query",
+ "name": "callback",
+ "required": true,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "description": "callBackDTS",
+ "in": "query",
+ "name": "callBackDTS",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "notes",
+ "in": "query",
+ "name": "notes",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "boolean"
}
- },
- "AssignedSmsDnisBulkUpdateDTO": {
- "type": "object",
- "properties": {
- "endDate": {
- "type": "string",
- "format": "date-time"
- },
- "id": {
- "type": "integer",
- "format": "int32"
- },
- "startDate": {
- "type": "string",
- "format": "date-time"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Sets the call disposition for either INBOUND or OUTBOUND calls and releases the agent from PD state",
+ "tags": [
+ "Active Calls"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/activeCalls/{uii}/hangupCall": {
+ "post": {
+ "description": "Permissions: READ on Account (Permission Override)",
+ "operationId": "hangupCall",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "uii",
+ "in": "path",
+ "name": "uii",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "boolean"
}
- },
- "DnisBulkUpdateRequest": {
- "type": "object",
- "properties": {
- "assignedDnis": {
- "$ref": "#/components/schemas/AssignedDnisBulkUpdateDTO"
- },
- "assignedSmsDnis": {
- "$ref": "#/components/schemas/AssignedSmsDnisBulkUpdateDTO"
- },
- "dnisPool": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/DnisPoolDTO"
- }
- },
- "general": {
- "$ref": "#/components/schemas/GeneralDTO"
- },
- "mediaCodes": {
- "$ref": "#/components/schemas/MediaCodeDTO"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Terminates an active call",
+ "tags": [
+ "Active Calls"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/activeCalls/{uii}/hangupSession": {
+ "post": {
+ "description": "Permissions: READ on Account (Permission Override)",
+ "operationId": "hangupSession",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "uii",
+ "in": "path",
+ "name": "uii",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "phone",
+ "in": "query",
+ "name": "phone",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "boolean"
}
- },
- "DnisPoolDTO": {
- "type": "object",
- "properties": {
- "dnis": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "reservedAccountId": {
- "type": "string"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Terminates an active session",
+ "tags": [
+ "Active Calls"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/activeCalls/{uii}/toggleCallRecording": {
+ "post": {
+ "description": "Permissions: READ on Account (Permission Override)",
+ "operationId": "toggleCallRecording",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "uii",
+ "in": "path",
+ "name": "uii",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "record",
+ "in": "query",
+ "name": "record",
+ "required": true,
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "boolean"
}
- },
- "GeneralDTO": {
- "type": "object",
- "properties": {
- "dnisDescription": {
- "type": "string"
- },
- "inboundContext": {
- "type": "string"
- },
- "originatingDnis": {
- "type": "string"
- },
- "reservedAccountId": {
- "type": "string"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Provides support for toggling call recording on/off for an active call",
+ "tags": [
+ "Active Calls"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/auditLogs/auditable": {
+ "get": {
+ "tags": [
+ "Audit Logs"
+ ],
+ "summary": "Identify system entities eligible for auditing",
+ "operationId": "getAuditableEntities",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Auditable"
+ }
}
- },
- "MediaCodeDTO": {
- "type": "object",
- "properties": {
- "dnisCategory": {
- "type": "string"
- },
- "mediaCode": {
- "type": "string"
- },
- "mediaFormat": {
- "type": "string"
- },
- "mediaIsci": {
- "type": "string"
- },
- "mediaLength": {
- "type": "string"
- },
- "mediaMarket": {
- "type": "string"
- },
- "mediaNetwork": {
- "type": "string"
- },
- "mediaUrl": {
- "type": "string"
- },
- "mediaVersion": {
- "type": "string"
- },
- "mediaWebSourcecode": {
- "type": "string"
- }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/voice/api/v1/admin/auditLogs/search": {
+ "put": {
+ "tags": [
+ "Audit Logs"
+ ],
+ "summary": "Search administrative audit records",
+ "description": "The Search API serves as the primary extraction point for audit records. It allows organizations to reconstruct the history of administrative tasks by filtering for specific timeframes, action types, or individual actors.",
+ "operationId": "searchAuditLogs",
+ "requestBody": {
+ "required": true,
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuditLogSearchCriteria"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AuditLog"
+ }
}
- },
- "InteractionMetadataRequest": {
- "description": "Parameters for realtime reports",
- "required": [
- "segmentEndTime",
- "timeInterval",
- "timeZone"
- ],
- "type": "object",
- "properties": {
- "segmentEndTime": {
- "type": "string",
- "description": "Start date and time for the logging interval",
- "example": "2021-02-28 08:27:15"
- },
- "timeInterval": {
- "type": "integer",
- "format": "int32",
- "description": "Interval length in seconds. Maximum allowed length is 3600 (1 hour). Note: if your time interval start or end in the future consecutive requests may return different list of segment. Idempotent results only guaranteed for the completed intervals. Segment recording URL may be added after delay. Allow 1-2min for processing.",
- "example": 1800
- },
- "timeZone": {
- "type": "string",
- "description": "Timezone name which should be used for report generation",
- "example": "US/Eastern"
- }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/agentGroups": {
+ "get": {
+ "description": "Permissions: READ on Account, Post Filtered Results",
+ "operationId": "getAgentGroupList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "page",
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "maxRows",
+ "in": "query",
+ "name": "maxRows",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "includePermissions",
+ "in": "query",
+ "name": "includePermissions",
+ "schema": {
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/AgentGroup"
+ },
+ "type": "array"
}
- },
- "InteractionSegmentMetaData2Array": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/InteractionSegmentMetaData2"
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of agent groups for an account",
+ "tags": [
+ "Agent Groups"
+ ]
+ },
+ "post": {
+ "description": "Permissions: CREATE on Account",
+ "operationId": "createAgentGroup",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AgentGroup"
+ }
+ }
+ },
+ "description": "agentGroup",
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AgentGroup"
}
- },
- "InteractionSegmentMetaData2": {
- "type": "object",
- "required": [
- "interactionId",
- "interactionStartTime",
- "interactionDuration",
- "segmentId",
- "segmentAgentId",
- "segmentContactStartTime",
- "segmentDuration",
- "segmentCallingAddress",
- "segmentCalledAddress",
- "segmentDirection",
- "segmentRecordingURL",
- "segmentAgentGroupId"
- ],
- "properties": {
- "interactionId": {
- "type": "string",
- "description": "Unique interaction ID used to connect different call segments together in transfer/conference scenarios.",
- "example": "20200721123305013105000001977"
- },
- "interactionStartTimeMs": {
- "type": "string",
- "format": "date-time",
- "description": "Start time of the interaction. Could be different from segment start time if customer was engaged with the IVR, waited in queue, etc before agent joined the conversation. Milliseconds precision.",
- "example": "2020-07-21T17:32:28.001Z"
- },
- "interactionDurationMs": {
- "type": "integer",
- "format": "int32",
- "description": "The total duration of the interaction. Milliseconds precision.",
- "example": 832
- },
- "segmentID": {
- "type": "integer",
- "format": "int32",
- "description": "Unique segment sequnce ID within the interaction.",
- "example": 2
- },
- "segmentAgentId": {
- "type": "integer",
- "format": "int32",
- "description": "RingCentral user id.",
- "example": 1009
- },
- "segmentContactStartTimeMs": {
- "type": "string",
- "format": "date-time",
- "description": "Time agent joined the conversation. Milliseconds precision.",
- "example": "2020-07-21T17:32:40.002Z"
- },
- "segmentContactEndTimeMs": {
- "type": "string",
- "format": "date-time",
- "description": "Time agent left the conversation. Milliseconds precision.",
- "example": "2020-07-21T17:32:42.045Z"
- },
- "segmentDuration": {
- "type": "integer",
- "format": "int32",
- "description": "Segment duration (available even when segmentContactEndTime is not provided). Seconds.",
- "example": 832
- },
- "interactionCallingAddress": {
- "type": "string",
- "description": "The ANI of the interaction",
- "example": 4155058987
- },
- "interactionCalledAddress": {
- "type": "string",
- "description": "The DNIS of the interaction",
- "example": 8776239199
- },
- "interactionDirection": {
- "type": "string",
- "enum": [
- "INBOUND",
- "OUTBOUND"
- ],
- "description": "Direction of the interaction.",
- "example": "INBOUND"
- },
- "segmentRecordingURL": {
- "type": "string",
- "description": "URL for segment recording",
- "example": "https://c02-recordings.virtualacd.biz/api/v1/calls/recordings/?v=1&accountId=99990001&bucket=c02-recordings®ion=us-east-1&compliance=false&file=99990001/202205/09/20220509120710013214000058679-2.WAV"
- },
- "segmentAgentGroupId": {
- "type": "string",
- "description": "Agent group Id",
- "example": 8
- },
- "segmentEvents": {
- "type": "array",
- "description": "Ordered list of events. Can be empty if segmentRecordingURL is empty. In other cases array start with the event `REC_START`. Events don't overlap each other.",
- "items": {
- "$ref": "#/components/schemas/InteractionSegmentEvent"
- }
- }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates a single new agent group for an account",
+ "tags": [
+ "Agent Groups"
+ ],
+ "x-codegen-request-body-name": "agentGroup"
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/agentGroups/{agentGroupId}": {
+ "delete": {
+ "deprecated": true,
+ "description": "Permissions: DELETE on Agent Group",
+ "operationId": "deleteAgentGroup",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "agentGroupId",
+ "in": "path",
+ "name": "agentGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "type": "boolean"
}
- },
- "InteractionSegmentEvent": {
- "type": "object",
- "required": [
- "eventTimeMs",
- "clientEventTimeMs",
- "eventType"
- ],
- "properties": {
- "eventTimeMs": {
- "type": "string",
- "format": "date-time",
- "description": "event time with milliseconds precision. Server side.",
- "example": "2020-07-21T17:32:28.000Z"
- },
- "clientEventTimeMs": {
- "type": "string",
- "format": "date-time",
- "description": "event time with milliseconds precision. Client side.",
- "example": "2020-07-21T17:32:28.000Z"
- },
- "eventType": {
- "type": "string",
- "enum": [
- "REC_START",
- "REC_STOP"
- ],
- "example": "REC_START"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Deletes an agent group for an account",
+ "tags": [
+ "Agent Groups"
+ ]
+ },
+ "get": {
+ "description": "Permissions: READ on Gate Group",
+ "operationId": "getAgentGroup",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "agentGroupId",
+ "in": "path",
+ "name": "agentGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "includePermissions",
+ "in": "query",
+ "name": "includePermissions",
+ "schema": {
+ "default": false,
+ "type": "boolean"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AgentGroup"
}
- },
- "WEMInteractionSegmentMetaData2Array": {
- "type": "array",
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of agent groups for an account",
+ "tags": [
+ "Agent Groups"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Agent Group",
+ "operationId": "updateAgentGroup",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "agentGroupId",
+ "in": "path",
+ "name": "agentGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AgentGroup"
+ }
+ }
+ },
+ "description": "agentGroup",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AgentGroup"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates an agent group for an account",
+ "tags": [
+ "Agent Groups"
+ ],
+ "x-codegen-request-body-name": "agentGroup"
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/agentGroups/{agentGroupId}/agents": {
+ "get": {
+ "description": "Permissions: READ on Agent Group, Post Filtered Results",
+ "operationId": "getAgentList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "agentGroupId",
+ "in": "path",
+ "name": "agentGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/Agent"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of agents for an agent group",
+ "tags": [
+ "Agents"
+ ]
+ },
+ "post": {
+ "description": "Permissions: CREATE on Agent Group",
+ "operationId": "createAgent",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "agentGroupId",
+ "in": "path",
+ "name": "agentGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AgentRequest"
+ }
+ }
+ },
+ "description": "agentRequest",
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Agent"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates a single agent for an agent group",
+ "tags": [
+ "Agents"
+ ],
+ "x-codegen-request-body-name": "agentRequest"
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Agent Group",
+ "operationId": "updateAgents",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "agentGroupId",
+ "in": "path",
+ "name": "agentGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
"items": {
- "$ref": "#/components/schemas/WEMDialogSegmentMetaData"
+ "$ref": "#/components/schemas/Agent"
},
- "example": [
- {
- "subAccountId": "99999999",
- "dialogId": "s-v-93bd0e6f0f0a479ea8025fe8f8ec3e1d-1721690897808",
- "interactionId": "202407221928172035020000000572",
- "channelId": "2013770791",
- "channelType": "VOICE",
- "channelClass": "VOICE",
- "channelEndpointAddress": "7312066731",
- "contactEndpointAddress": "2013770791",
- "dialogOrigination": "INBOUND",
- "dialogStartTimeMs": "2024-07-22T11:24:40.000Z",
- "dialogEndTimeMs": "2024-07-22T11:24:47.000Z",
- "dialogDurationMs": 7000,
- "segmentId": "p-v-93bd0e6f0f0a479ea8025fe8f8ec3e1d-1721690897808-190dcc63d90ab",
- "segmentType": "AGENT",
- "segmentParticipantId": "449438",
- "segmentParticipantRcExtensionId": "985901004",
- "segmentStartTimeMs": "2024-07-22T11:24:40.000Z",
- "segmentEndTimeMs": "2024-07-22T11:24:47.000Z",
- "segmentDurationMs": 7000,
- "segmentAgentGroupId": "76873",
- "systemDisposition": "ANSWER",
- "agentDisposition": "Success",
- "agentNotes": "requeue to others",
- "hasRecording": true,
- "hasTranscript": true,
- "segmentEvents": [
- {
- "eventTimeMs": "2024-07-22T11:24:40.000Z",
- "clientEventTimeMs": "2024-07-22T11:24:40.000Z",
- "eventType": "REC_START"
- },
- {
- "eventTimeMs": "2024-07-22T11:24:47.000Z",
- "clientEventTimeMs": "2024-07-22T11:24:47.000Z",
- "eventType": "REC_STOP"
- }
- ]
- },
- {
- "subAccountId": "99999999",
- "dialogId": "d-65fc2f3a382dd00007d8a5d7-1711025979007",
- "interactionId": "202407230228251400000000001026",
- "channelId": "672daeb8cd026600070ca39f",
- "channelType": "ENGAGE_MESSAGING",
- "channelClass": "DIGITAL",
- "channelEndpointAddress": "+16506675176",
- "contactEndpointAddress": "+1324",
- "dialogOrigination": "INBOUND",
- "dialogStartTimeMs": "2024-07-23T02:28:25.014Z",
- "dialogEndTimeMs": "2024-07-23T02:28:42.000Z",
- "dialogDurationMs": 17000,
- "segmentId": "d-669e351bef0ea5000753266b-669f4d88a7ba580007b48caf",
- "segmentType": "AGENT",
- "segmentParticipantId": "789438",
- "segmentParticipantRcExtensionId": "1552533005",
- "segmentStartTimeMs": "2024-07-23T02:28:25.000Z",
- "segmentEndTimeMs": "2024-07-23T02:28:42.000Z",
- "segmentDurationMs": 17000,
- "segmentAgentGroupId": "79698",
- "systemDisposition": null,
- "agentDisposition": "Success",
- "agentNotes": "Engage Messaging Notes",
- "hasRecording": false,
- "hasTranscript": true,
- "segmentEvents": null
- },
- {
- "subAccountId": "99999999",
- "dialogId": "d-672dbaf7c211050006e056e1-1731050231731",
- "interactionId": "202411080217120144700000000001",
- "channelId": "672daeb8cd026600070ca39f",
- "channelType": "EMAIL",
- "channelClass": "DIGITAL",
- "channelEndpointAddress": "+16506675176",
- "contactEndpointAddress": "+1324",
- "dialogOrigination": "INBOUND",
- "dialogStartTimeMs": "2024-07-23T02:28:25.014Z",
- "dialogEndTimeMs": "2024-07-23T02:28:42.000Z",
- "dialogDurationMs": 17000,
- "segmentId": "d-672dbaf7c211050006e056e1-1731050231731-1930aa2600f99",
- "segmentType": "AGENT",
- "segmentParticipantId": "789438",
- "segmentParticipantRcExtensionId": "1552533005",
- "segmentStartTimeMs": "2024-07-23T02:28:25.000Z",
- "segmentEndTimeMs": "2024-07-23T02:28:42.000Z",
- "segmentDurationMs": 17000,
- "segmentAgentGroupId": "79698",
- "systemDisposition": null,
- "agentDisposition": "Success",
- "agentNotes": "email notes",
- "hasRecording": false,
- "hasTranscript": true,
- "segmentEvents": null
- },
- {
- "subAccountId": "99999999",
- "dialogId": "d-672dba74c211050006e056d4-1731050100923",
- "interactionId": "202411080215020144700000000000",
- "channelId": "672daeb8cd026600070ca39f",
- "channelType": "MESSENGER",
- "channelClass": "DIGITAL",
- "channelEndpointAddress": "+16506675176",
- "contactEndpointAddress": "+1324",
- "dialogOrigination": "INBOUND",
- "dialogStartTimeMs": "2024-07-23T02:28:25.014Z",
- "dialogEndTimeMs": "2024-07-23T02:28:42.000Z",
- "dialogDurationMs": 17000,
- "segmentId": "d-672dba74c211050006e056d4-1731050100923-1930aa0638ea8",
- "segmentType": "AGENT",
- "segmentParticipantId": "789438",
- "segmentParticipantRcExtensionId": "1552533005",
- "segmentStartTimeMs": "2024-07-23T02:28:25.000Z",
- "segmentEndTimeMs": "2024-07-23T02:28:42.000Z",
- "segmentDurationMs": 17000,
- "segmentAgentGroupId": "79698",
- "systemDisposition": null,
- "agentDisposition": "Success",
- "agentNotes": "Messenger notes",
- "hasRecording": false,
- "hasTranscript": true,
- "segmentEvents": null
- }
- ]
- },
- "WEMDialogSegmentMetaData": {
- "type": "object",
- "properties": {
- "subAccountId": {
- "type": "string"
- },
- "dialogId": {
- "type": "string"
- },
- "interactionId": {
- "type": "string"
- },
- "channelId": {
- "type": "string"
- },
- "channelType": {
- "type": "string"
- },
- "channelClass": {
- "type": "string"
- },
- "channelEndpointAddress": {
- "type": "string"
- },
- "contactEndpointAddress": {
- "type": "string"
- },
- "dialogOrigination": {
- "type": "string"
- },
- "dialogStartTimeMs": {
- "type": "string",
- "format": "date-time"
- },
- "dialogEndTimeMs": {
- "type": "string",
- "format": "date-time"
- },
- "dialogDurationMs": {
- "type": "integer"
- },
- "segmentId": {
- "type": "string"
- },
- "segmentType": {
- "type": "string"
- },
- "segmentParticipantId": {
- "type": "string"
- },
- "segmentParticipantRcExtensionId": {
- "type": "string"
- },
- "segmentStartTimeMs": {
- "type": "string",
- "format": "date-time"
- },
- "segmentEndTimeMs": {
- "type": "string",
- "format": "date-time"
- },
- "segmentDurationMs": {
- "type": "integer"
- },
- "segmentAgentGroupId": {
- "type": "string"
- },
- "systemDisposition": {
- "type": "string",
- "nullable": true
- },
- "agentDisposition": {
- "type": "string"
- },
- "agentNotes": {
- "type": "string"
- },
- "hasRecording": {
- "type": "boolean"
- },
- "hasTranscript": {
- "type": "boolean"
- },
- "segmentEvents": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/InteractionSegmentEvent"
- },
- "nullable": true
- }
+ "type": "array"
+ }
+ }
+ },
+ "description": "agents",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/Agent"
+ },
+ "type": "array"
}
- },
- "AggregatedIntegrationParams": {
- "type": "object",
- "required": [
- "startDate",
- "endDate",
- "timeInterval",
- "timeZone"
- ],
- "properties": {
- "startDate": {
- "type": "string",
- "description": "Start date and time for the logging interval in 'YYYY-MM-DD HH:mm:ss' format.",
- "example": "2026-03-02 09:00:00"
- },
- "endDate": {
- "type": "string",
- "description": "End date and time for the logging interval in 'YYYY-MM-DD HH:mm:ss' format. Must be within 3 hours of the startDate.",
- "example": "2026-03-02 12:00:00"
- },
- "timeInterval": {
- "type": "integer",
- "format": "int32",
- "description": "Interval length in seconds (e.g., 1800 for 30 minutes).",
- "example": 1800
- },
- "timeZone": {
- "type": "string",
- "description": "Timezone name used for report generation (e.g., 'US/Eastern').",
- "example": "US/Eastern"
- },
- "outputFormat": {
- "type": "string",
- "enum": [
- "CSV",
- "XML"
- ],
- "description": "The file format of the generated report.",
- "example": "CSV"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a listing of agents for an agent group",
+ "tags": [
+ "Agents"
+ ],
+ "x-codegen-request-body-name": "agents"
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/agentGroups/{agentGroupId}/agents/{agentId}": {
+ "delete": {
+ "description": "Permissions: DELETE on Agent",
+ "operationId": "deleteAgent",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "agentGroupId",
+ "in": "path",
+ "name": "agentGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "agentId",
+ "in": "path",
+ "name": "agentId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "type": "boolean"
}
- },
- "AggregatedAgentStats": {
- "type": "object",
- "properties": {
- "interval": {
- "type": "integer",
- "format": "int32"
- },
- "dateTimeFrom": {
- "type": "string"
- },
- "agentId": {
- "type": "integer",
- "format": "int32"
- },
- "agentName": {
- "type": "string"
- },
- "availDur": {
- "type": "integer",
- "format": "int32"
- },
- "totWorkDur": {
- "type": "integer",
- "format": "int32"
- },
- "pauseDur": {
- "type": "integer",
- "format": "int32"
- },
- "waitDur": {
- "type": "integer",
- "format": "int32"
- },
- "adminDur": {
- "type": "integer",
- "format": "int32"
- },
- "directOutIxnCnt": {
- "type": "integer",
- "format": "int32"
- },
- "directOutIxnDur": {
- "type": "integer",
- "format": "int32"
- },
- "directInIxnCnt": {
- "type": "integer",
- "format": "int32"
- },
- "directInIxnDur": {
- "type": "integer",
- "format": "int32"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Deletes an agent for an agent group",
+ "tags": [
+ "Agents"
+ ]
+ },
+ "get": {
+ "description": "Permissions: READ on Agent",
+ "operationId": "getAgent",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "agentGroupId",
+ "in": "path",
+ "name": "agentGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "agentId",
+ "in": "path",
+ "name": "agentId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Agent"
}
- },
- "AggregatedQueueStats": {
- "type": "object",
- "properties": {
- "dateTimeFrom": {
- "type": "string"
- },
- "interval": {
- "type": "integer",
- "format": "int32"
- },
- "queue": {
- "type": "integer",
- "format": "int32"
- },
- "queueName": {
- "type": "string"
- },
- "offdDirectIxnCnt": {
- "type": "integer",
- "format": "int32"
- },
- "answIxnCnt": {
- "type": "integer",
- "format": "int32"
- },
- "abandIxnCnt": {
- "type": "integer",
- "format": "int32"
- },
- "abandShortIxnCnt": {
- "type": "integer",
- "format": "int32"
- },
- "abandWithinSlCnt": {
- "type": "integer",
- "format": "int32"
- },
- "ansServicelevelCnt": {
- "type": "integer",
- "format": "int32"
- },
- "completedContacts": {
- "type": "integer",
- "format": "int32"
- },
- "queuedAndAnswIxnDur": {
- "type": "integer",
- "format": "int32"
- },
- "queuedAndAbandIxnDur": {
- "type": "integer",
- "format": "int32"
- },
- "queuedAnswLongestQueDur": {
- "type": "integer",
- "format": "int32"
- },
- "queuedAbandLongestQueDur": {
- "type": "integer",
- "format": "int32"
- },
- "talkingIxnDur": {
- "type": "integer",
- "format": "int32"
- },
- "wrapUpDur": {
- "type": "integer",
- "format": "int32"
- },
- "waitDur": {
- "type": "integer",
- "format": "int32"
- },
- "segmentHoldTime": {
- "type": "integer",
- "format": "int32"
- },
- "overflowInIxnCnt": {
- "type": "integer",
- "format": "int32"
- },
- "overflowOutIxnCnt": {
- "type": "integer",
- "format": "int32"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a single agent for an agent group",
+ "tags": [
+ "Agents"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Agent",
+ "operationId": "updateAgent",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "agentGroupId",
+ "in": "path",
+ "name": "agentGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "agentId",
+ "in": "path",
+ "name": "agentId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AgentRequest"
+ }
+ }
+ },
+ "description": "updateRequest",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Agent"
}
- },
- "ExtendedAggregatedQueueStats": {
- "type": "object",
- "properties": {
- "interval": {
- "type": "integer",
- "format": "int32"
- },
- "dateTimeFrom": {
- "type": "string"
- },
- "agentId": {
- "type": "integer",
- "format": "int32"
- },
- "agentName": {
- "type": "string"
- },
- "queue": {
- "type": "integer",
- "format": "int32"
- },
- "queueName": {
- "type": "string"
- },
- "talkingIxnDur": {
- "type": "integer",
- "format": "int32"
- },
- "wrapUpDur": {
- "type": "integer",
- "format": "int32"
- },
- "answIxnCnt": {
- "type": "integer",
- "format": "int32"
- },
- "transferOutIxnCnt": {
- "type": "integer",
- "format": "int32"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a single agent for an agent group",
+ "tags": [
+ "Agents"
+ ],
+ "x-codegen-request-body-name": "updateRequest"
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/agentGroups/{agentGroupId}/gateGroups/{gateGroupId}/gates/{gateId}": {
+ "get": {
+ "description": "Permissions: READ on Account, READ on requested Gate",
+ "operationId": "getLoggedInAgentsByAgentGroupPerQueue",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "agentGroupId",
+ "in": "path",
+ "name": "agentGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
- },
- "CXQueueWithAgents": {
- "type": "object",
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns the count of agents in an agentGroup logged into a Queue ",
+ "tags": [
+ "Agent Access"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/campaignLeads/actions": {
+ "put": {
+ "description": "Permissions: READ on Account (Permission Override), UPDATE on Campaign",
+ "operationId": "performLeadAction",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "leadAction",
+ "in": "query",
+ "name": "leadAction",
+ "required": true,
+ "schema": {
+ "enum": [
+ "RESET_LEADS",
+ "CANCEL_LEADS",
+ "DELETE_LEADS",
+ "PAUSE_LEADS",
+ "DIALER_REFRESH",
+ "READY_LEADS",
+ "MANUAL_LEADS",
+ "EMAIL_LEADS",
+ "CALLBACK_LEADS",
+ "MOVE_TO_CAMPAIGN",
+ "AGENT_RESERVATION",
+ "SUPPRESS_LEADS",
+ "UNSUPPRESS_LEADS"
+ ],
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LeadManagerRequest"
+ }
+ }
+ },
+ "description": "leadManagerActionRequest",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LeadActionResult"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Performs a lead action against the matching campaign leads found for the given the search criteria",
+ "tags": [
+ "Campaigns"
+ ],
+ "x-codegen-request-body-name": "leadManagerActionRequest"
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/campaignLeads/leadSearch": {
+ "post": {
+ "description": "Permissions: READ on Account (Permission Override)",
+ "operationId": "searchForCampaignLeads",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "count",
+ "in": "query",
+ "name": "count",
+ "schema": {
+ "default": false,
+ "type": "boolean"
+ }
+ },
+ {
+ "description": "page",
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "maxRows",
+ "in": "query",
+ "name": "maxRows",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CampaignLeadSearchCriteria"
+ }
+ }
+ },
+ "description": "searchRequest",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Allows searching of campaign leads for a single campaign",
+ "tags": [
+ "Leads"
+ ],
+ "x-codegen-request-body-name": "searchRequest"
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/campaignLeads/leadSearchByPhoneList": {
+ "post": {
+ "description": "Permissions: READ on Account (Permission Override)",
+ "operationId": "uploadSearchCriteriaForCampaignLeads",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "page",
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "maxRows",
+ "in": "query",
+ "name": "maxRows",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "properties": {
+ "file": {
+ "description": "file",
+ "format": "binary",
+ "type": "string"
+ }
+ },
"required": [
- "queueId",
- "queueName",
- "queueGroupId",
- "isActive",
- "createdOn"
+ "file"
],
- "properties": {
- "queueId": {
- "type": "integer",
- "format": "int32",
- "description": "Unique ID for inbound queue",
- "example": 555
- },
- "queueType": {
- "type": "string",
- "enum": [
- "VOICE",
- "DIGITAL"
- ],
- "example": "VOICE"
- },
- "queueName": {
- "type": "string",
- "description": "Name of inbound queue",
- "example": "Test queue"
- },
- "queueGroupId": {
- "type": "integer",
- "format": "int32",
- "description": "inbound queue group ID",
- "example": 1009
- },
- "isActive": {
- "type": "boolean",
- "description": "true if the inbound queue is active",
- "example": true
- },
- "createdOn": {
- "type": "string",
- "format": "date-time",
- "description": "Timestamp when inbound group was created",
- "example": "2020-07-21T17:32:28Z"
- },
- "agentIds": {
- "type": "array",
- "description": "List of agents who connected to this queue",
- "items": {
- "type": "integer",
- "format": "int32"
- },
- "example": [
- 10,
- 20
- ]
- }
- }
- },
- "RCInteractionTranscriptData": {
- "type": "object",
- "properties": {
- "channelClass": {
- "type": "string",
- "example": "DIGITAL"
- },
- "errorCode": {
- "type": "string",
- "nullable": true
- },
- "errorMessage": {
- "type": "string",
- "nullable": true
- },
- "transcript": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/TranscriptPhrase"
- }
- }
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/CampaignLeadSearchResultsView"
+ },
+ "type": "array"
}
- },
- "TranscriptPhrase": {
- "type": "object",
- "properties": {
- "participantId": {
- "type": "string"
- },
- "rcUserId": {
- "type": "string",
- "nullable": true
- },
- "participantName": {
- "type": "string",
- "nullable": true
- },
- "participantType": {
- "type": "string",
- "example": "agent"
- },
- "timestamp": {
- "type": "string",
- "example": "1721651880000"
- },
- "message": {
- "type": "string"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Allows searching of campaign leads for a single campaign",
+ "tags": [
+ "Campaigns"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/campaignLeads/leadStates": {
+ "get": {
+ "description": "Permissions: READ on Account",
+ "operationId": "getLeadStates",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "enum": [
+ "ACTIVE",
+ "AGENT-CALLBACK",
+ "CALLBACK-CANCELLED",
+ "CALLBACK",
+ "CANCELLED",
+ "COMPLETE",
+ "DISCONNECTED",
+ "DO-NOT-CALL",
+ "INTERCEPT",
+ "MAX-DIAL-LIMIT",
+ "PAUSED",
+ "PENDING-CALLBACK",
+ "PENDING-ERR",
+ "PENDING-HCI",
+ "PENDING",
+ "READY",
+ "TRANSITIONED",
+ "WHITELIST"
+ ],
+ "type": "string"
+ },
+ "type": "array"
}
- },
- "QueueGroup": {
- "type": "object",
- "properties": {
- "queueGroupId": {
- "type": "integer",
- "format": "int32",
- "description": "Unique ID for queue group",
- "example": 1009
- },
- "groupName": {
- "type": "string",
- "description": "Queue group name",
- "example": "Queue group 1"
- },
- "queueGroupType": {
- "type": "string",
- "enum": [
- "VOICE",
- "DIGITAL"
- ],
- "description": "The type of queues contained in this group",
- "example": "VOICE"
- }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of all lead states for an account",
+ "tags": [
+ "Leads"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/campaignLeads/systemDispositions": {
+ "get": {
+ "description": "Permissions: READ on Account",
+ "operationId": "getSystemDispositions",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "enum": [
+ "ANSWER",
+ "NOANSWER",
+ "BUSY",
+ "MACHINE",
+ "INTERCEPT",
+ "DISCONNECT",
+ "ABANDON",
+ "CONGESTION",
+ "MANUAL_PASS",
+ "INBOUND_CALLBACK",
+ "APP_DNC",
+ "APP_REQUEUE",
+ "APP_REQUEUE_COMPLETE",
+ "APP_REQUEUE_ABANDON",
+ "INBOUND_ABANDON",
+ "API_BLOCKED",
+ "API_ERROR"
+ ],
+ "type": "string"
+ },
+ "type": "array"
}
- },
- "ActiveStateBoolean": {
- "properties": {
- "isActive": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "CloudRouteDestinationSkinny": {
- "properties": {
- "cloudDestinationId": {
- "format": "int32",
- "type": "integer"
- },
- "destinationName": {
- "type": "string"
- },
- "cloudGroupId": {
- "type": "string"
- },
- "isActive": {
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "CloudRouteGroupSkinny": {
- "properties": {
- "cloudGroupId": {
- "format": "int32",
- "type": "integer"
- },
- "groupName": {
- "type": "string"
- },
- "accountId": {
- "type": "string"
- },
- "cloudRouteDestinations": {
- "items": {
- "$ref": "#/components/schemas/CloudRouteDestinationSkinny"
- },
- "type": "array"
- },
- "cloudRouteProfiles": {
- "items": {
- "$ref": "#/components/schemas/CloudRouteProfileSkinny"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "PersonaPhoneConfig": {
- "properties": {
- "accountId": {
- "description": "RingCX account ID for the persona phone configuration.",
- "type": "string"
- },
- "phoneId": {
- "description": "Persona phone identifier. Use 1 for the primary lead phone and 2 through 7 for additional configured phone personas.",
- "format": "int32",
- "maximum": 7,
- "type": "integer"
- },
- "phoneLabel": {
- "description": "Display label for this phone persona.",
- "maxLength": 30,
- "type": "string"
- }
- },
- "type": "object"
- },
- "PersonaPhoneConfigFields": {
- "properties": {
- "phoneId": {
- "format": "int32",
- "type": "integer"
- },
- "phoneLabel": {
- "type": "string"
- }
- },
- "type": "object"
- },
- "PersonaCallPreference": {
- "properties": {
- "phoneId": {
- "description": "Persona phone ID to dial during this schedule window.",
- "format": "int32",
- "type": "integer"
- },
- "priority": {
- "description": "Dialing order for this phone persona within the schedule window. Lower numbers are attempted first.",
- "format": "int32",
- "type": "integer"
- },
- "phoneLabel": {
- "description": "Configured label for the persona phone ID.",
- "readOnly": true,
- "type": "string"
- }
- },
- "type": "object"
- },
- "PersonaCallSchedule": {
- "properties": {
- "scheduleId": {
- "format": "int32",
- "readOnly": true,
- "type": "integer"
- },
- "day": {
- "enum": [
- "SUNDAY",
- "MONDAY",
- "TUESDAY",
- "WEDNESDAY",
- "THURSDAY",
- "FRIDAY",
- "SATURDAY"
- ],
- "type": "string"
- },
- "campaignId": {
- "format": "int32",
- "readOnly": true,
- "type": "integer"
- },
- "start": {
- "description": "Start time for the persona calling window, in HH:mm format.",
- "type": "string"
- },
- "end": {
- "description": "End time for the persona calling window, in HH:mm format.",
- "type": "string"
- },
- "callPreferences": {
- "items": {
- "$ref": "#/components/schemas/PersonaCallPreference"
- },
- "type": "array"
- }
- },
- "type": "object"
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of all system dispositions for an account",
+ "tags": [
+ "Leads"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/campaignLeads/{leadId}": {
+ "patch": {
+ "description": "Permissions: READ on Account (Permission Override), UPDATE on Campaign",
+ "operationId": "patchCampaignLead",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "leadId",
+ "in": "path",
+ "name": "leadId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "campaignId",
+ "in": "query",
+ "name": "campaignId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "listId",
+ "in": "query",
+ "name": "listId",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "timezoneOption",
+ "in": "query",
+ "name": "timezoneOption",
+ "schema": {
+ "enum": [
+ "NPA_NXX",
+ "ZIPCODE",
+ "EXPLICIT",
+ "NOT_APPLICABLE"
+ ],
+ "type": "string"
+ }
+ },
+ {
+ "description": "duplicateHandling",
+ "in": "query",
+ "name": "duplicateHandling",
+ "schema": {
+ "default": "RETAIN_ALL",
+ "enum": [
+ "RETAIN_ALL",
+ "REMOVE_ALL_EXISTING",
+ "REMOVE_FROM_LIST"
+ ],
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CampaignLead"
+ }
}
+ },
+ "description": "campaignLead",
+ "required": true
},
- "securitySchemes": {
- "BearerAuth": {
- "scheme": "bearer",
- "type": "http"
- },
- "apiKey": {
- "in": "header",
- "name": "apiKey",
- "type": "apiKey"
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CampaignLead"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Allows updating of a campaign lead, only updating those fields passed in",
+ "tags": [
+ "Leads"
+ ],
+ "x-codegen-request-body-name": "campaignLead"
+ },
+ "put": {
+ "description": "Permissions: READ on Account (Permission Override), UPDATE on Campaign",
+ "operationId": "updateCampaignLead",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
}
- }
+ },
+ {
+ "description": "leadId",
+ "in": "path",
+ "name": "leadId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "campaignId",
+ "in": "query",
+ "name": "campaignId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "listId",
+ "in": "query",
+ "name": "listId",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "timezoneOption",
+ "in": "query",
+ "name": "timezoneOption",
+ "schema": {
+ "enum": [
+ "NPA_NXX",
+ "ZIPCODE",
+ "EXPLICIT",
+ "NOT_APPLICABLE"
+ ],
+ "type": "string"
+ }
+ },
+ {
+ "description": "duplicateHandling",
+ "in": "query",
+ "name": "duplicateHandling",
+ "schema": {
+ "default": "RETAIN_ALL",
+ "enum": [
+ "RETAIN_ALL",
+ "REMOVE_ALL_EXISTING",
+ "REMOVE_FROM_LIST"
+ ],
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CampaignLead"
+ }
+ }
+ },
+ "description": "campaignLead",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CampaignLead"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Allows updating of a campaign lead, updating entire lead including fields not passed in",
+ "tags": [
+ "Leads"
+ ],
+ "x-codegen-request-body-name": "campaignLead"
+ }
},
- "info": {
- "title": "RingCentral RingCX API",
- "version": "1.0.0",
- "termsOfService": "https://developers.ringcentral.com",
- "license": {
- "name": "none"
- },
- "contact": {}
- },
- "openapi": "3.0.0",
- "paths": {
- "/api/auth/login/rc/accesstoken": {
- "post": {
- "operationId": "loginWithRcAccessToken",
- "parameters": [
- {
- "description": "Includes the refresh token along with the Engage Access Token.",
- "in": "query",
- "name": "includeRefresh",
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "To acquire an Engage Access Token, you will need to first [retrieve a Ring Central Access Token](https://developers.ringcentral.com/engage/voice/guide/authentication/auth-ringcentral#retrieve-ringcentral-access-token).",
- "in": "query",
- "name": "rcAccessToken",
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "The Ring Central Token Type is a 'Bearer' type using the [OAuth 2.0](https://developers.ringcentral.com/api-reference/authentication) bearer token.",
- "example": "Bearer",
- "in": "query",
- "name": "rcTokenType",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AccessTokenUserDetails"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Logs in an RC user via their access token issued by the RC API server. Returns Engage access token and user details",
- "tags": [
- "RingCentral Auth"
- ]
+ "/voice/api/v1/admin/accounts/{accountId}/campaigns/{campaignId}/leadLoader/direct": {
+ "post": {
+ "description": "Permissions: Update on Campaign (Permission Override)",
+ "operationId": "loadDirectLeads",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "campaignId",
+ "in": "path",
+ "name": "campaignId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LeadListProcessingRequest"
+ }
}
+ },
+ "description": "request",
+ "required": true
},
- "/voice/api/v1/admin/accounts": {
- "get": {
- "description": "Returns the RingCX accounts available to the authenticated user.",
- "operationId": "getAllAccounts",
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/Account"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LeadListProcessingResult"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Uploads a single lead or list of leads to a new or existing list",
+ "tags": [
+ "Leads"
+ ],
+ "x-codegen-request-body-name": "request"
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/campaigns/{campaignId}/leadLoader/preview": {
+ "post": {
+ "description": "Permissions: UPDATE on Campaign (Permission Override)",
+ "operationId": "previewLeadList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "campaignId",
+ "in": "path",
+ "name": "campaignId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "fileType",
+ "in": "query",
+ "name": "fileType",
+ "required": true,
+ "schema": {
+ "enum": [
+ "EXCEL",
+ "PIPE",
+ "COMMA",
+ "TAB"
+ ],
+ "type": "string"
+ }
+ },
+ {
+ "description": "quoteCharacter",
+ "in": "query",
+ "name": "quoteCharacter",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "properties": {
+ "file": {
+ "description": "file",
+ "format": "binary",
+ "type": "string"
+ }
},
- "security": [
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns RingCX accounts available to the authenticated user",
- "tags": [
- "RingCentral Auth"
+ "required": [
+ "file"
]
+ }
}
+ },
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/activeCalls/createManualAgentCall": {
- "post": {
- "description": "Permissions: READ on Account (Permission Override)",
- "operationId": "createManualAgentCall",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "username",
- "in": "query",
- "name": "username",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "destination",
- "in": "query",
- "name": "destination",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "ringDuration",
- "in": "query",
- "name": "ringDuration",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "callerId",
- "in": "query",
- "name": "callerId",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "text/plain": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates a manual agent call",
- "tags": [
- "Active Calls"
- ]
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LeadListPreviewResponse"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Upload new leads to a new or existing list",
+ "tags": [
+ "Outbound"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/campaigns/{campaignId}/leadLoader/process": {
+ "post": {
+ "description": "Permissions: UPDATE on Campaign (Permission Override)",
+ "operationId": "loadList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "campaignId",
+ "in": "path",
+ "name": "campaignId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/LeadListProcessingRequest"
+ }
}
+ },
+ "description": "request",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/activeCalls/list": {
- "get": {
- "description": "Permissions: READ on Account",
- "operationId": "getProductActiveCallsListRequest",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "product",
- "in": "query",
- "name": "product",
- "schema": {
- "enum": [
- "ACCOUNT",
- "ACD",
- "AGENT",
- "CHAT_QUEUE",
- "OUTBOUND",
- "VISUAL_IVR",
- "CLOUD_PROFILE",
- "CLOUD_DESTINATION",
- "TRAC_NUMBER",
- "HTTP_SERVICES",
- "SCRIPTING",
- "TN_MANAGER",
- "SURVEY",
- "DNIS",
- "TEAMS",
- "KNOWLEDGE_BASE",
- "UTILITIES"
- ],
- "type": "string"
- }
- },
- {
- "description": "productId",
- "in": "query",
- "name": "productId",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "externalId",
- "in": "query",
- "name": "externalId",
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "page",
- "in": "query",
- "name": "page",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "maxRows",
- "in": "query",
- "name": "maxRows",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/ActiveCallListResponse"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of current active calls for a given product OR externalId, on an account",
- "tags": [
- "Active Calls"
- ]
+ "responses": {
+ "201": {
+ "description": "Created"
+ },
+ "202": {
+ "description": "Accepted"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Upload new leads to a new or existing list",
+ "tags": [
+ "Outbound"
+ ],
+ "x-codegen-request-body-name": "request"
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/countries/available": {
+ "get": {
+ "description": "Permissions: READ on Account",
+ "operationId": "getCountryList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/CountryCode"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/activeCalls/prerouteChecks/checkQueueStatus": {
- "get": {
- "description": "Check queue status API returns true or false (with more info) if the queue is available to take calls based on the max queue time.",
- "operationId": "checkQueueStatus",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "DNIS to be used for queue lookup. Must be assigned to the queue.",
- "in": "query",
- "name": "destination_number",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "Max queue time. If max queue time is greater than 0, then if the longest in queue time is less than the passed in max queue time, return TRUE, else return FALSE with message containing the number of calls in queue and the longest queue time. If the max queue time is <=0, then return TRUE if there are any agents available in the queue to take the call, else return FALSE. auth_token - permanent API x-auth-token. More info https://developers.ringcentral.com/engage/voice/guide/authentication/auth-legacy",
- "in": "query",
- "name": "maxq",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "phoneNumbersI18nEnabled",
- "in": "query",
- "name": "phoneNumbersI18nEnabled",
- "schema": {
- "default": false,
- "type": "boolean"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PrerouteCheckStatus"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Check queue status",
- "tags": [
- "Active Calls"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of all country codes available on the system",
+ "tags": [
+ "Countries"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/dialGroups": {
+ "get": {
+ "description": "Permissions: READ on Account, Post Filtered Results",
+ "operationId": "getDialGroupListByAccount",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
}
+ },
+ {
+ "description": "page",
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "maxRows",
+ "in": "query",
+ "name": "maxRows",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/DialGroup"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/activeCalls/prerouteChecks/checkQueueThreshold": {
- "get": {
- "description": "Check queue threshold API Returns true or false based on the current number of calls in queue and the passed in threshold value.",
- "operationId": "checkQueueThreshold",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "DNIS to be used for queue lookup. Must be assigned to the queue.",
- "in": "query",
- "name": "destination_number",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "If the number of calls currently in queue is less than the passed maxCallsQueued value (default 0) it returns TRUE, else FALSE. auth_token - permanent API x-auth-token. More info https://developers.ringcentral.com/engage/voice/guide/authentication/auth-legacy",
- "in": "query",
- "name": "maxCallsQueued",
- "schema": {
- "default": 10,
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "phoneNumbersI18nEnabled",
- "in": "query",
- "name": "phoneNumbersI18nEnabled",
- "schema": {
- "default": false,
- "type": "boolean"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PrerouteCheckStatus"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Check queue threshold",
- "tags": [
- "Active Calls"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of dial groups for an account",
+ "tags": [
+ "Dial Groups"
+ ]
+ },
+ "post": {
+ "description": "Permissions: CREATE on Account",
+ "operationId": "createDialGroup",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
}
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DialGroup"
+ }
+ }
+ },
+ "description": "dialGroup",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/activeCalls/{uii}/addSessionToCall": {
- "post": {
- "description": "Permissions: READ on Account (Permission Override)",
- "operationId": "addSessionToCall",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "uii",
- "in": "path",
- "name": "uii",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "destination",
- "in": "query",
- "name": "destination",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "sessionType",
- "in": "query",
- "name": "sessionType",
- "required": true,
- "schema": {
- "enum": [
- "MONITOR",
- "BARGEIN",
- "COACHING"
- ],
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "text/plain": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Provides support for adding sessions to an active call",
- "tags": [
- "Active Calls"
- ]
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DialGroup"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates a dial group for an account",
+ "tags": [
+ "Dial Groups"
+ ],
+ "x-codegen-request-body-name": "dialGroup"
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/dialGroups/withChildren": {
+ "get": {
+ "description": "Permissions: READ on Account, Post Filtered Results for Dial Groups and Campaigns",
+ "operationId": "getDialGroupListWithChildren",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "includePermissions",
+ "in": "query",
+ "name": "includePermissions",
+ "schema": {
+ "default": false,
+ "type": "string"
+ }
+ },
+ {
+ "description": "page",
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ },
+ {
+ "description": "maxRows",
+ "in": "query",
+ "name": "maxRows",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/DialGroup"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/activeCalls/{uii}/dispositionCall": {
- "post": {
- "description": "Permissions: READ on Account (Permission Override)",
- "operationId": "dispositionCall",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "uii",
- "in": "path",
- "name": "uii",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "disposition",
- "in": "query",
- "name": "disposition",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "callback",
- "in": "query",
- "name": "callback",
- "required": true,
- "schema": {
- "type": "boolean"
- }
- },
- {
- "description": "callBackDTS",
- "in": "query",
- "name": "callBackDTS",
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "notes",
- "in": "query",
- "name": "notes",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "text/plain": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Sets the call disposition for either INBOUND or OUTBOUND calls and releases the agent from PD state",
- "tags": [
- "Active Calls"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of dial groups with associated campaigns for an account",
+ "tags": [
+ "Dial Groups"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/dialGroups/{dialGroupId}": {
+ "delete": {
+ "description": "Permissions: DELETE on Account",
+ "operationId": "deleteDialGroup",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "dialGroupId",
+ "in": "path",
+ "name": "dialGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/activeCalls/{uii}/hangupCall": {
- "post": {
- "description": "Permissions: READ on Account (Permission Override)",
- "operationId": "hangupCall",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "uii",
- "in": "path",
- "name": "uii",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "text/plain": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Terminates an active call",
- "tags": [
- "Active Calls"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Deletes a dial group for an account",
+ "tags": [
+ "Dial Groups"
+ ]
+ },
+ "get": {
+ "description": "Permissions: READ on Dial Group",
+ "operationId": "getDialGroup",
+ "parameters": [
+ {
+ "description": "dialGroupId",
+ "in": "path",
+ "name": "dialGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DialGroup"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/activeCalls/{uii}/hangupSession": {
- "post": {
- "description": "Permissions: READ on Account (Permission Override)",
- "operationId": "hangupSession",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "uii",
- "in": "path",
- "name": "uii",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "phone",
- "in": "query",
- "name": "phone",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "text/plain": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Terminates an active session",
- "tags": [
- "Active Calls"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a dial group for an account",
+ "tags": [
+ "Dial Groups"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Dial Group",
+ "operationId": "updateDialGroup",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
}
+ },
+ {
+ "description": "dialGroupId",
+ "in": "path",
+ "name": "dialGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DialGroup"
+ }
+ }
+ },
+ "description": "dialGroup",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/activeCalls/{uii}/toggleCallRecording": {
- "post": {
- "description": "Permissions: READ on Account (Permission Override)",
- "operationId": "toggleCallRecording",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "uii",
- "in": "path",
- "name": "uii",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "record",
- "in": "query",
- "name": "record",
- "required": true,
- "schema": {
- "type": "boolean"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "text/plain": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DialGroup"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a dial group for an account",
+ "tags": [
+ "Dial Groups"
+ ],
+ "x-codegen-request-body-name": "dialGroup"
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/dialGroups/{dialGroupId}/assignAgents": {
+ "put": {
+ "description": "Permissions: UPDATE on Dial Group and READ on Agent",
+ "operationId": "assignAgentsToDialGroups",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "dialGroupId",
+ "in": "path",
+ "name": "dialGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/AgentDialGroupMember"
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Provides support for toggling call recording on/off for an active call",
- "tags": [
- "Active Calls"
- ]
+ "type": "array"
+ }
}
+ },
+ "description": "agentDialGroupMembers",
+ "required": true
},
- "/voice/api/v1/admin/auditLogs/auditable": {
- "get": {
- "tags": [
- "Audit Logs"
- ],
- "summary": "Identify system entities eligible for auditing",
- "operationId": "getAuditableEntities",
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Auditable"
- }
- }
- }
- }
- }
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CollectionAgent"
}
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Assigns a listing of agents to a dial group",
+ "tags": [
+ "Dial Groups"
+ ],
+ "x-codegen-request-body-name": "agentDialGroupMembers"
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/dialGroups/{dialGroupId}/assignedAgents": {
+ "get": {
+ "description": "Permissions: READ on Dial Group",
+ "operationId": "getAgentsFromDialGroup",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "dialGroupId",
+ "in": "path",
+ "name": "dialGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "page",
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "maxRows",
+ "in": "query",
+ "name": "maxRows",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/Agent"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/auditLogs/search": {
- "put": {
- "tags": [
- "Audit Logs"
- ],
- "summary": "Search administrative audit records",
- "description": "The Search API serves as the primary extraction point for audit records. It allows organizations to reconstruct the history of administrative tasks by filtering for specific timeframes, action types, or individual actors.",
- "operationId": "searchAuditLogs",
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AuditLogSearchCriteria"
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AuditLog"
- }
- }
- }
- }
- }
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of all agents assigned to a dial group",
+ "tags": [
+ "Dial Groups"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns": {
+ "get": {
+ "description": "Permissions: READ on Dial Group, Post Filtered Results",
+ "operationId": "getCampaignList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "dialGroupId",
+ "in": "path",
+ "name": "dialGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "page",
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "maxRows",
+ "in": "query",
+ "name": "maxRows",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/Campaign"
+ },
+ "type": "array"
}
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of campaigns for a dial group",
+ "tags": [
+ "Campaigns"
+ ]
+ },
+ "post": {
+ "description": "Permissions: UPDATE on Dial Group (Permission Override)",
+ "operationId": "createCampaign",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "dialGroupId",
+ "in": "path",
+ "name": "dialGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Campaign"
+ }
+ }
+ },
+ "description": "campaign",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/agentGroups": {
- "get": {
- "description": "Permissions: READ on Account, Post Filtered Results",
- "operationId": "getAgentGroupList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "page",
- "in": "query",
- "name": "page",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "maxRows",
- "in": "query",
- "name": "maxRows",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "includePermissions",
- "in": "query",
- "name": "includePermissions",
- "schema": {
- "default": false,
- "type": "boolean"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/AgentGroup"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of agent groups for an account",
- "tags": [
- "Agent Groups"
- ]
- },
- "post": {
- "description": "Permissions: CREATE on Account",
- "operationId": "createAgentGroup",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AgentGroup"
- }
- }
- },
- "description": "agentGroup",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AgentGroup"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates a single new agent group for an account",
- "tags": [
- "Agent Groups"
- ],
- "x-codegen-request-body-name": "agentGroup"
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Campaign"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a campaign for a dial group",
+ "tags": [
+ "Campaigns"
+ ],
+ "x-codegen-request-body-name": "campaign"
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns/{campaignId}": {
+ "delete": {
+ "deprecated": true,
+ "description": "Permissions: DELETE on Campaign",
+ "operationId": "deleteCampaign",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "dialGroupId",
+ "in": "path",
+ "name": "dialGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ },
+ {
+ "description": "campaignId",
+ "in": "path",
+ "name": "campaignId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/agentGroups/{agentGroupId}": {
- "delete": {
- "deprecated": true,
- "description": "Permissions: DELETE on Agent Group",
- "operationId": "deleteAgentGroup",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "agentGroupId",
- "in": "path",
- "name": "agentGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "*/*": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Deletes an agent group for an account",
- "tags": [
- "Agent Groups"
- ]
- },
- "get": {
- "description": "Permissions: READ on Gate Group",
- "operationId": "getAgentGroup",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "agentGroupId",
- "in": "path",
- "name": "agentGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "includePermissions",
- "in": "query",
- "name": "includePermissions",
- "schema": {
- "default": false,
- "type": "boolean"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AgentGroup"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of agent groups for an account",
- "tags": [
- "Agent Groups"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Agent Group",
- "operationId": "updateAgentGroup",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "agentGroupId",
- "in": "path",
- "name": "agentGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AgentGroup"
- }
- }
- },
- "description": "agentGroup",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AgentGroup"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates an agent group for an account",
- "tags": [
- "Agent Groups"
- ],
- "x-codegen-request-body-name": "agentGroup"
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Deletes a campaign for a dial group",
+ "tags": [
+ "Campaigns"
+ ]
+ },
+ "get": {
+ "description": "Permissions: READ on Campaign",
+ "operationId": "getCampaign",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "dialGroupId",
+ "in": "path",
+ "name": "dialGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "campaignId",
+ "in": "path",
+ "name": "campaignId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Campaign"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a campaign for a dial group",
+ "tags": [
+ "Campaigns"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Campaign",
+ "operationId": "updateCampaign",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "dialGroupId",
+ "in": "path",
+ "name": "dialGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "campaignId",
+ "in": "path",
+ "name": "campaignId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Campaign"
+ }
+ }
+ },
+ "description": "campaign",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Campaign"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a campaign for a dial group",
+ "tags": [
+ "Campaigns"
+ ],
+ "x-codegen-request-body-name": "campaign"
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns/{campaignId}/clearCache": {
+ "post": {
+ "description": "Permissions: READ on Campaign (Permission Override)",
+ "operationId": "forceDialerRefresh",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "dialGroupId",
+ "in": "path",
+ "name": "dialGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "campaignId",
+ "in": "path",
+ "name": "campaignId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Clears the cache for a campaign",
+ "tags": [
+ "Campaigns"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/withChildren": {
+ "get": {
+ "description": "Permissions: READ on Account, Post Filtered Results",
+ "operationId": "getGateGroupListWithChildren",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "includePermissions",
+ "in": "query",
+ "name": "includePermissions",
+ "schema": {
+ "default": false,
+ "type": "boolean"
+ }
+ },
+ {
+ "description": "page",
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "maxRows",
+ "in": "query",
+ "name": "maxRows",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateGroup"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/agentGroups/{agentGroupId}/agents": {
- "get": {
- "description": "Permissions: READ on Agent Group, Post Filtered Results",
- "operationId": "getAgentList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "agentGroupId",
- "in": "path",
- "name": "agentGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/Agent"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of agents for an agent group",
- "tags": [
- "Agents"
- ]
- },
- "post": {
- "description": "Permissions: CREATE on Agent Group",
- "operationId": "createAgent",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "agentGroupId",
- "in": "path",
- "name": "agentGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AgentRequest"
- }
- }
- },
- "description": "agentRequest",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Agent"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates a single agent for an agent group",
- "tags": [
- "Agents"
- ],
- "x-codegen-request-body-name": "agentRequest"
- },
- "put": {
- "description": "Permissions: UPDATE on Agent Group",
- "operationId": "updateAgents",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "agentGroupId",
- "in": "path",
- "name": "agentGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/Agent"
- },
- "type": "array"
- }
- }
- },
- "description": "agents",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/Agent"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a listing of agents for an agent group",
- "tags": [
- "Agents"
- ],
- "x-codegen-request-body-name": "agents"
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of queue groups (AKA gate groups) with related data for an account",
+ "tags": [
+ "Queue Groups"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/withChildren/additionalData": {
+ "get": {
+ "description": "Permissions: READ on Account, Post Filtered Results",
+ "operationId": "getGateGroupListWithChildrenAdditionalData",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "page",
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "maxRows",
+ "in": "query",
+ "name": "maxRows",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateGroup"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/agentGroups/{agentGroupId}/agents/{agentId}": {
- "delete": {
- "description": "Permissions: DELETE on Agent",
- "operationId": "deleteAgent",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "agentGroupId",
- "in": "path",
- "name": "agentGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "agentId",
- "in": "path",
- "name": "agentId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "*/*": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Deletes an agent for an agent group",
- "tags": [
- "Agents"
- ]
- },
- "get": {
- "description": "Permissions: READ on Agent",
- "operationId": "getAgent",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "agentGroupId",
- "in": "path",
- "name": "agentGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "agentId",
- "in": "path",
- "name": "agentId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Agent"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a single agent for an agent group",
- "tags": [
- "Agents"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Agent",
- "operationId": "updateAgent",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "agentGroupId",
- "in": "path",
- "name": "agentGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "agentId",
- "in": "path",
- "name": "agentId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AgentRequest"
- }
- }
- },
- "description": "updateRequest",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Agent"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a single agent for an agent group",
- "tags": [
- "Agents"
- ],
- "x-codegen-request-body-name": "updateRequest"
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of queue groups (AKA gate groups) with related and additional data for an account",
+ "tags": [
+ "Queue Groups"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}": {
+ "delete": {
+ "deprecated": true,
+ "description": "Permissions: DELETE on Gate Group",
+ "operationId": "deleteGateGroup",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
}
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/agentGroups/{agentGroupId}/gateGroups/{gateGroupId}/gates/{gateId}": {
- "get": {
- "description": "Permissions: READ on Account, READ on requested Gate",
- "operationId": "getLoggedInAgentsByAgentGroupPerQueue",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "agentGroupId",
- "in": "path",
- "name": "agentGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "text/plain": {
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Deletes a single queue group (AKA gate group)",
+ "tags": [
+ "Queue Groups"
+ ]
+ },
+ "get": {
+ "description": "Permissions: READ on Gate Group",
+ "operationId": "getGateGroup",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateGroup"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a single queue group (AKA gate group) for an account",
+ "tags": [
+ "Queue Groups"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate Group",
+ "operationId": "updateGateGroup",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateGroup"
+ }
+ }
+ },
+ "description": "gateGroup",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateGroup"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a single queue group (AKA gate group) for an account",
+ "tags": [
+ "Queue Groups"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates": {
+ "get": {
+ "description": "Permissions: READ on Gate Group, Post Filtered Results",
+ "operationId": "getGateList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "page",
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "maxRows",
+ "in": "query",
+ "name": "maxRows",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/Gate"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of all queues (AKA gates) for a queue group",
+ "tags": [
+ "Queues"
+ ]
+ },
+ "post": {
+ "description": "Permissions: CREATE on Gate Group",
+ "operationId": "createGate",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Gate"
+ }
+ }
+ },
+ "description": "gate",
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Gate"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates a new queue (AKA gate) for a queue group",
+ "tags": [
+ "Queues"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}": {
+ "delete": {
+ "deprecated": true,
+ "description": "Permissions: DELETE on Gate",
+ "operationId": "deleteGate",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Deletes a queue (AKA gate) for a queue group",
+ "tags": [
+ "Queues"
+ ]
+ },
+ "get": {
+ "description": "Permissions: READ on Gate",
+ "operationId": "getGate",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Gate"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a single queue (AKA gate) for a queue group",
+ "tags": [
+ "Queues"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "updateGate",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Gate"
+ }
+ }
+ },
+ "description": "gate",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Gate"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a queue (AKA gate) for a queue group",
+ "tags": [
+ "Queues"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/assignAgents": {
+ "put": {
+ "description": "Permissions: UPDATE on Gate and READ on Agents",
+ "operationId": "assignAgentsToGate",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/AgentGateAccess"
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns the count of agents in an agentGroup logged into a Queue ",
- "tags": [
- "Agent Access"
- ]
+ "type": "array"
+ }
+ }
+ },
+ "description": "agentAccessRequests",
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/Agent"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Assigns a listing of agents to a queue (AKA gate)",
+ "tags": [
+ "Agents"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/assignGateToPriorityGroup": {
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "assignGateToPriorityGroup",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "priorityGroupId",
+ "in": "query",
+ "name": "priorityGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "priorityGroupRank",
+ "in": "query",
+ "name": "priorityGroupRank",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "$ref": "#/components/schemas/Gate"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Assigns a queue (AKA gate) to a queue priority group for an account",
+ "tags": [
+ "Queues"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/assignedAgents": {
+ "get": {
+ "description": "Permissions: READ on Gate",
+ "operationId": "getAssignedAgentsForGate",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "page",
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "maxRows",
+ "in": "query",
+ "name": "maxRows",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/Agent"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of assigned agents for a queue (AKA gate) ",
+ "tags": [
+ "Agents"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/clone": {
+ "post": {
+ "description": "Permissions: READ on cloned Gate and CREATE on new Gate Group (Permission Override",
+ "operationId": "cloneGate",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "newGateGroupId",
+ "in": "query",
+ "name": "newGateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "newGateName",
+ "in": "query",
+ "name": "newGateName",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Gate"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates a clone of a queue (AKA gate) for a queue group",
+ "tags": [
+ "Queues"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/dispositions": {
+ "get": {
+ "description": "Permissions: READ on Gate, Post Filtered Results",
+ "operationId": "getGateDispositionList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateDisposition"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/campaignLeads/actions": {
- "put": {
- "description": "Permissions: READ on Account (Permission Override), UPDATE on Campaign",
- "operationId": "performLeadAction",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "leadAction",
- "in": "query",
- "name": "leadAction",
- "required": true,
- "schema": {
- "enum": [
- "RESET_LEADS",
- "CANCEL_LEADS",
- "DELETE_LEADS",
- "PAUSE_LEADS",
- "DIALER_REFRESH",
- "READY_LEADS",
- "MANUAL_LEADS",
- "EMAIL_LEADS",
- "CALLBACK_LEADS",
- "MOVE_TO_CAMPAIGN",
- "AGENT_RESERVATION",
- "SUPPRESS_LEADS",
- "UNSUPPRESS_LEADS"
- ],
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/LeadManagerRequest"
- }
- }
- },
- "description": "leadManagerActionRequest",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/LeadActionResult"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Performs a lead action against the matching campaign leads found for the given the search criteria",
- "tags": [
- "Campaigns"
- ],
- "x-codegen-request-body-name": "leadManagerActionRequest"
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of dispositions for a queue (AKA gate)",
+ "tags": [
+ "Queue Dispositions"
+ ]
+ },
+ "post": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "createGateDisposition",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateDisposition"
+ }
+ }
+ },
+ "description": "gateDisposition",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/campaignLeads/leadSearch": {
- "post": {
- "description": "Permissions: READ on Account (Permission Override)",
- "operationId": "searchForCampaignLeads",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "count",
- "in": "query",
- "name": "count",
- "schema": {
- "default": false,
- "type": "boolean"
- }
- },
- {
- "description": "page",
- "in": "query",
- "name": "page",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "maxRows",
- "in": "query",
- "name": "maxRows",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CampaignLeadSearchCriteria"
- }
- }
- },
- "description": "searchRequest",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateDisposition"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates a disposition for a queue (AKA gate)",
+ "tags": [
+ "Queue Dispositions"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "saveGateDispositionList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateDisposition"
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Allows searching of campaign leads for a single campaign",
- "tags": [
- "Leads"
- ],
- "x-codegen-request-body-name": "searchRequest"
+ "type": "array"
+ }
}
+ },
+ "description": "gateDispositions",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/campaignLeads/leadSearchByPhoneList": {
- "post": {
- "description": "Permissions: READ on Account (Permission Override)",
- "operationId": "uploadSearchCriteriaForCampaignLeads",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "page",
- "in": "query",
- "name": "page",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "maxRows",
- "in": "query",
- "name": "maxRows",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "multipart/form-data": {
- "schema": {
- "properties": {
- "file": {
- "description": "file",
- "format": "binary",
- "type": "string"
- }
- },
- "required": [
- "file"
- ],
- "type": "object"
- }
- }
- }
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/CampaignLeadSearchResultsView"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Allows searching of campaign leads for a single campaign",
- "tags": [
- "Campaigns"
- ]
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateDisposition"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Saves a list of dispositions for a queue (AKA gate)",
+ "tags": [
+ "Queue Dispositions"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/dispositions/{gateDispositionId}": {
+ "delete": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "deleteGateDisposition",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateDispositionId",
+ "in": "path",
+ "name": "gateDispositionId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/campaignLeads/leadStates": {
- "get": {
- "description": "Permissions: READ on Account",
- "operationId": "getLeadStates",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "enum": [
- "ACTIVE",
- "AGENT-CALLBACK",
- "CALLBACK-CANCELLED",
- "CALLBACK",
- "CANCELLED",
- "COMPLETE",
- "DISCONNECTED",
- "DO-NOT-CALL",
- "INTERCEPT",
- "MAX-DIAL-LIMIT",
- "PAUSED",
- "PENDING-CALLBACK",
- "PENDING-ERR",
- "PENDING-HCI",
- "PENDING",
- "READY",
- "TRANSITIONED",
- "WHITELIST"
- ],
- "type": "string"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of all lead states for an account",
- "tags": [
- "Leads"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Deletes a disposition for a queue (AKA gate)",
+ "tags": [
+ "Queue Dispositions"
+ ]
+ },
+ "get": {
+ "description": "Permissions: READ on Gate",
+ "operationId": "getGateDisposition",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateDispositionId",
+ "in": "path",
+ "name": "gateDispositionId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateDisposition"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/campaignLeads/systemDispositions": {
- "get": {
- "description": "Permissions: READ on Account",
- "operationId": "getSystemDispositions",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "enum": [
- "ANSWER",
- "NOANSWER",
- "BUSY",
- "MACHINE",
- "INTERCEPT",
- "DISCONNECT",
- "ABANDON",
- "CONGESTION",
- "MANUAL_PASS",
- "INBOUND_CALLBACK",
- "APP_DNC",
- "APP_REQUEUE",
- "APP_REQUEUE_COMPLETE",
- "APP_REQUEUE_ABANDON",
- "INBOUND_ABANDON",
- "API_BLOCKED",
- "API_ERROR"
- ],
- "type": "string"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of all system dispositions for an account",
- "tags": [
- "Leads"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a single disposition for a queue (AKA gate)",
+ "tags": [
+ "Queue Dispositions"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "updateGateDisposition",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateDispositionId",
+ "in": "path",
+ "name": "gateDispositionId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateDisposition"
+ }
+ }
+ },
+ "description": "gateDisposition",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/campaignLeads/{leadId}": {
- "patch": {
- "description": "Permissions: READ on Account (Permission Override), UPDATE on Campaign",
- "operationId": "patchCampaignLead",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "leadId",
- "in": "path",
- "name": "leadId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "campaignId",
- "in": "query",
- "name": "campaignId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "listId",
- "in": "query",
- "name": "listId",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "timezoneOption",
- "in": "query",
- "name": "timezoneOption",
- "schema": {
- "enum": [
- "NPA_NXX",
- "ZIPCODE",
- "EXPLICIT",
- "NOT_APPLICABLE"
- ],
- "type": "string"
- }
- },
- {
- "description": "duplicateHandling",
- "in": "query",
- "name": "duplicateHandling",
- "schema": {
- "default": "RETAIN_ALL",
- "enum": [
- "RETAIN_ALL",
- "REMOVE_ALL_EXISTING",
- "REMOVE_FROM_LIST"
- ],
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CampaignLead"
- }
- }
- },
- "description": "campaignLead",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CampaignLead"
- }
- }
- },
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Allows updating of a campaign lead, only updating those fields passed in",
- "tags": [
- "Leads"
- ],
- "x-codegen-request-body-name": "campaignLead"
- },
- "put": {
- "description": "Permissions: READ on Account (Permission Override), UPDATE on Campaign",
- "operationId": "updateCampaignLead",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "leadId",
- "in": "path",
- "name": "leadId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "campaignId",
- "in": "query",
- "name": "campaignId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "listId",
- "in": "query",
- "name": "listId",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "timezoneOption",
- "in": "query",
- "name": "timezoneOption",
- "schema": {
- "enum": [
- "NPA_NXX",
- "ZIPCODE",
- "EXPLICIT",
- "NOT_APPLICABLE"
- ],
- "type": "string"
- }
- },
- {
- "description": "duplicateHandling",
- "in": "query",
- "name": "duplicateHandling",
- "schema": {
- "default": "RETAIN_ALL",
- "enum": [
- "RETAIN_ALL",
- "REMOVE_ALL_EXISTING",
- "REMOVE_FROM_LIST"
- ],
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CampaignLead"
- }
- }
- },
- "description": "campaignLead",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CampaignLead"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Allows updating of a campaign lead, updating entire lead including fields not passed in",
- "tags": [
- "Leads"
- ],
- "x-codegen-request-body-name": "campaignLead"
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateDisposition"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a single disposition for a queue (AKA gate)",
+ "tags": [
+ "Queue Dispositions"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/gateAgentAccessLogin": {
+ "get": {
+ "description": "Permissions: READ on Account and Read on Agent, Post Filtered Results",
+ "operationId": "getGatesAgentsLoggedInto",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GatesLoggedInAgentsView"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/campaigns/{campaignId}/leadLoader/direct": {
- "post": {
- "description": "Permissions: Update on Campaign (Permission Override)",
- "operationId": "loadDirectLeads",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "campaignId",
- "in": "path",
- "name": "campaignId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/LeadListProcessingRequest"
- }
- }
- },
- "description": "request",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/LeadListProcessingResult"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Uploads a single lead or list of leads to a new or existing list",
- "tags": [
- "Leads"
- ],
- "x-codegen-request-body-name": "request"
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of all agents that have access to the queue (AKA gate) - this includes data to indicate if an agent is currently logged into the queue",
+ "tags": [
+ "Agent Access"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/gateQueueEvents": {
+ "get": {
+ "description": "Permissions: READ on Gate",
+ "operationId": "getGateQueueEventList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateQueueEvent"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/campaigns/{campaignId}/leadLoader/preview": {
- "post": {
- "description": "Permissions: UPDATE on Campaign (Permission Override)",
- "operationId": "previewLeadList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "campaignId",
- "in": "path",
- "name": "campaignId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "fileType",
- "in": "query",
- "name": "fileType",
- "required": true,
- "schema": {
- "enum": [
- "EXCEL",
- "PIPE",
- "COMMA",
- "TAB"
- ],
- "type": "string"
- }
- },
- {
- "description": "quoteCharacter",
- "in": "query",
- "name": "quoteCharacter",
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "content": {
- "multipart/form-data": {
- "schema": {
- "properties": {
- "file": {
- "description": "file",
- "format": "binary",
- "type": "string"
- }
- },
- "required": [
- "file"
- ]
- }
- }
- },
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/LeadListPreviewResponse"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Upload new leads to a new or existing list",
- "tags": [
- "Outbound"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of gate queue events for a queue",
+ "tags": [
+ "Queue Events"
+ ]
+ },
+ "post": {
+ "deprecated": true,
+ "operationId": "createGateQueueEvent",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
}
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateQueueEvent"
+ }
+ }
+ },
+ "description": "queueEvent",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/campaigns/{campaignId}/leadLoader/process": {
- "post": {
- "description": "Permissions: UPDATE on Campaign (Permission Override)",
- "operationId": "loadList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "campaignId",
- "in": "path",
- "name": "campaignId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/LeadListProcessingRequest"
- }
- }
- },
- "description": "request",
- "required": true
- },
- "responses": {
- "201": {
- "description": "Created"
- },
- "202": {
- "description": "Accepted"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateQueueEvent"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "createGateQueueEvent",
+ "tags": [
+ "Queue Events"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "saveGateQueueEventList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateQueueEvent"
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Upload new leads to a new or existing list",
- "tags": [
- "Outbound"
- ],
- "x-codegen-request-body-name": "request"
+ "type": "array"
+ }
}
+ },
+ "description": "queueEvents",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/countries/available": {
- "get": {
- "description": "Permissions: READ on Account",
- "operationId": "getCountryList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/CountryCode"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of all country codes available on the system",
- "tags": [
- "Countries"
- ]
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateQueueEvent"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Saves a list of gate queue events for a queue",
+ "tags": [
+ "Queue Events"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/gateQueueEvents/{eventId}": {
+ "delete": {
+ "description": "Permissions: UPDATE on Gate (Override Permission Request)",
+ "operationId": "deleteGateQueueEvent",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "eventId",
+ "in": "path",
+ "name": "eventId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/dialGroups": {
- "get": {
- "description": "Permissions: READ on Account, Post Filtered Results",
- "operationId": "getDialGroupListByAccount",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "page",
- "in": "query",
- "name": "page",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "maxRows",
- "in": "query",
- "name": "maxRows",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/DialGroup"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of dial groups for an account",
- "tags": [
- "Dial Groups"
- ]
- },
- "post": {
- "description": "Permissions: CREATE on Account",
- "operationId": "createDialGroup",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DialGroup"
- }
- }
- },
- "description": "dialGroup",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DialGroup"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates a dial group for an account",
- "tags": [
- "Dial Groups"
- ],
- "x-codegen-request-body-name": "dialGroup"
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Deletes a gate queue event for a queue",
+ "tags": [
+ "Queue Events"
+ ]
+ },
+ "get": {
+ "description": "Permissions: READ on Gate",
+ "operationId": "getGateQueueEvent",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ },
+ {
+ "description": "eventId",
+ "in": "path",
+ "name": "eventId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateQueueEvent"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/dialGroups/withChildren": {
- "get": {
- "description": "Permissions: READ on Account, Post Filtered Results for Dial Groups and Campaigns",
- "operationId": "getDialGroupListWithChildren",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "includePermissions",
- "in": "query",
- "name": "includePermissions",
- "schema": {
- "default": false,
- "type": "string"
- }
- },
- {
- "description": "page",
- "in": "query",
- "name": "page",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "maxRows",
- "in": "query",
- "name": "maxRows",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/DialGroup"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of dial groups with associated campaigns for an account",
- "tags": [
- "Dial Groups"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a single gate queue event for a queue",
+ "tags": [
+ "Queue Events"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "updateGateQueueEvent",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "eventId",
+ "in": "path",
+ "name": "eventId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateQueueEvent"
+ }
+ }
+ },
+ "description": "queueEvent",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/dialGroups/{dialGroupId}": {
- "delete": {
- "description": "Permissions: DELETE on Account",
- "operationId": "deleteDialGroup",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "dialGroupId",
- "in": "path",
- "name": "dialGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "*/*": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Deletes a dial group for an account",
- "tags": [
- "Dial Groups"
- ]
- },
- "get": {
- "description": "Permissions: READ on Dial Group",
- "operationId": "getDialGroup",
- "parameters": [
- {
- "description": "dialGroupId",
- "in": "path",
- "name": "dialGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DialGroup"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a dial group for an account",
- "tags": [
- "Dial Groups"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Dial Group",
- "operationId": "updateDialGroup",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "dialGroupId",
- "in": "path",
- "name": "dialGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DialGroup"
- }
- }
- },
- "description": "dialGroup",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DialGroup"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a dial group for an account",
- "tags": [
- "Dial Groups"
- ],
- "x-codegen-request-body-name": "dialGroup"
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateQueueEvent"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a single gate queue event for a queue",
+ "tags": [
+ "Queue Events"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/gateQueueEvents/{eventId}/gateQueueDtmfEvents": {
+ "get": {
+ "description": "Permissions: READ on Gate",
+ "operationId": "getGateQueueDtmfEventList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "eventId",
+ "in": "path",
+ "name": "eventId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateQueueDtmfEvent"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of Gate Queue Dtmp Events for a Queue",
+ "tags": [
+ "Queue Events"
+ ]
+ },
+ "post": {
+ "description": "Permissions: UPDATE on Gate (Permission Override)",
+ "operationId": "createGateQueueDtmfEvent",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "eventId",
+ "in": "path",
+ "name": "eventId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateQueueDtmfEvent"
+ }
+ }
+ },
+ "description": "postPayload",
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateQueueDtmfEvent"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates a new Gate Queue Dtmp Event",
+ "tags": [
+ "Queue Events"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "saveGateQueueDtmfEventList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
- },
- "/voice/api/v1/admin/accounts/{accountId}/dialGroups/{dialGroupId}/assignAgents": {
- "put": {
- "description": "Permissions: UPDATE on Dial Group and READ on Agent",
- "operationId": "assignAgentsToDialGroups",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "dialGroupId",
- "in": "path",
- "name": "dialGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/AgentDialGroupMember"
- },
- "type": "array"
- }
- }
- },
- "description": "agentDialGroupMembers",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CollectionAgent"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "eventId",
+ "in": "path",
+ "name": "eventId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateQueueDtmfEvent"
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Assigns a listing of agents to a dial group",
- "tags": [
- "Dial Groups"
- ],
- "x-codegen-request-body-name": "agentDialGroupMembers"
+ "type": "array"
+ }
}
+ },
+ "description": "postPayload",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/dialGroups/{dialGroupId}/assignedAgents": {
- "get": {
- "description": "Permissions: READ on Dial Group",
- "operationId": "getAgentsFromDialGroup",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "dialGroupId",
- "in": "path",
- "name": "dialGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "page",
- "in": "query",
- "name": "page",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "maxRows",
- "in": "query",
- "name": "maxRows",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/Agent"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of all agents assigned to a dial group",
- "tags": [
- "Dial Groups"
- ]
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateQueueDtmfEvent"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a listing of Gate Queue Dtmp Events",
+ "tags": [
+ "Queue Events"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/gateQueueEvents/{eventId}/gateQueueDtmfEvents/{dtmfEventId}": {
+ "delete": {
+ "description": "Permissions: UPDATE on Gate (Permission Override)",
+ "operationId": "deleteGateQueueDtmfEvent",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ },
+ {
+ "description": "eventId",
+ "in": "path",
+ "name": "eventId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "dtmfEventId",
+ "in": "path",
+ "name": "dtmfEventId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns": {
- "get": {
- "description": "Permissions: READ on Dial Group, Post Filtered Results",
- "operationId": "getCampaignList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "dialGroupId",
- "in": "path",
- "name": "dialGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "page",
- "in": "query",
- "name": "page",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "maxRows",
- "in": "query",
- "name": "maxRows",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/Campaign"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of campaigns for a dial group",
- "tags": [
- "Campaigns"
- ]
- },
- "post": {
- "description": "Permissions: UPDATE on Dial Group (Permission Override)",
- "operationId": "createCampaign",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "dialGroupId",
- "in": "path",
- "name": "dialGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Campaign"
- }
- }
- },
- "description": "campaign",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Campaign"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a campaign for a dial group",
- "tags": [
- "Campaigns"
- ],
- "x-codegen-request-body-name": "campaign"
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Deletes a Gate Queue Dtmp Event",
+ "tags": [
+ "Queue Events"
+ ]
+ },
+ "get": {
+ "description": "Permissions: READ on Gate",
+ "operationId": "getGateQueueDtmfEvent",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ },
+ {
+ "description": "eventId",
+ "in": "path",
+ "name": "eventId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "dtmfEventId",
+ "in": "path",
+ "name": "dtmfEventId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateQueueDtmfEvent"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns/{campaignId}": {
- "delete": {
- "deprecated": true,
- "description": "Permissions: DELETE on Campaign",
- "operationId": "deleteCampaign",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "dialGroupId",
- "in": "path",
- "name": "dialGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "campaignId",
- "in": "path",
- "name": "campaignId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "*/*": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Deletes a campaign for a dial group",
- "tags": [
- "Campaigns"
- ]
- },
- "get": {
- "description": "Permissions: READ on Campaign",
- "operationId": "getCampaign",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "dialGroupId",
- "in": "path",
- "name": "dialGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "campaignId",
- "in": "path",
- "name": "campaignId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Campaign"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a campaign for a dial group",
- "tags": [
- "Campaigns"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Campaign",
- "operationId": "updateCampaign",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "dialGroupId",
- "in": "path",
- "name": "dialGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "campaignId",
- "in": "path",
- "name": "campaignId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Campaign"
- }
- }
- },
- "description": "campaign",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Campaign"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a single Gate Queue Dtmp Event",
+ "tags": [
+ "Queue Events"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "updateGateQueueDtmfEvent",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "eventId",
+ "in": "path",
+ "name": "eventId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "dtmfEventId",
+ "in": "path",
+ "name": "dtmfEventId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateQueueDtmfEvent"
+ }
+ }
+ },
+ "description": "postPayload",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateQueueDtmfEvent"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a single Gate Queue Dtmp Event",
+ "tags": [
+ "Queue Events"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/moveToGroup": {
+ "post": {
+ "deprecated": true,
+ "description": "Permissions: UPDATE on Gate and CREATE on new Gate Group (Permission Override)",
+ "operationId": "moveGateToGroup",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "newGateGroupId",
+ "in": "query",
+ "name": "newGateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Move an existing queue (AKA gate) to a new existing queue group",
+ "tags": [
+ "Queues"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/phoneBookEntries": {
+ "get": {
+ "description": "Permissions: READ on Gate",
+ "operationId": "getGatePhoneBookEntries",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "page",
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "maxRows",
+ "in": "query",
+ "name": "maxRows",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/PhoneBookEntry"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns all phone book entries for a queue (AKA gate)",
+ "tags": [
+ "Queue Phone Book"
+ ]
+ },
+ "post": {
+ "description": "Permissions: UPDATE on Gate (Permission Override)",
+ "operationId": "create",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PhoneBookEntry"
+ }
+ }
+ },
+ "description": "entry",
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PhoneBookEntry"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates a phone book entry for a queue (AKA gate)",
+ "tags": [
+ "Queue Phone Book"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "updateGatePhoneBookEntries",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/PhoneBookEntry"
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a campaign for a dial group",
- "tags": [
- "Campaigns"
- ],
- "x-codegen-request-body-name": "campaign"
+ "type": "array"
+ }
+ }
+ },
+ "description": "entries",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/PhoneBookEntry"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a listing of phone book entries for a queue (AKA gate)",
+ "tags": [
+ "Queue Phone Book"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/phoneBookEntries/{entryId}": {
+ "delete": {
+ "description": "Permissions: UPDATE on Gate (Permission Override)",
+ "operationId": "delete",
+ "parameters": [
+ {
+ "description": "entryId",
+ "in": "path",
+ "name": "entryId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Deletes a single phone book entry for a queue (AKA gate)",
+ "tags": [
+ "Queue Phone Book"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "updatePhoneBookEntry",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "entryId",
+ "in": "path",
+ "name": "entryId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PhoneBookEntry"
+ }
+ }
+ },
+ "description": "entry",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PhoneBookEntry"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a phone book entry for a queue (AKA gate)",
+ "tags": [
+ "Queue Phone Book"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/requeueShortcuts": {
+ "get": {
+ "description": "Permissions: READ on Gate",
+ "operationId": "getGateRequeueShortcutList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/RequeueShortcut"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of requeue shortcuts for a queue (AKA gate)",
+ "tags": [
+ "Requeue Shortcuts"
+ ]
+ },
+ "post": {
+ "description": "Permissions: UPDATE on Gate (Override Permission Request)",
+ "operationId": "createGateRequeueShortcut",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequeueShortcut"
+ }
+ }
+ },
+ "description": "shortcut",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns/{campaignId}/clearCache": {
- "post": {
- "description": "Permissions: READ on Campaign (Permission Override)",
- "operationId": "forceDialerRefresh",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "dialGroupId",
- "in": "path",
- "name": "dialGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "campaignId",
- "in": "path",
- "name": "campaignId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "201": {
- "content": {
- "text/plain": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequeueShortcut"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a requeue shortcut for a queue (AKA gate)",
+ "tags": [
+ "Requeue Shortcuts"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "createGateRequeueShortcuts",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/RequeueShortcut"
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Clears the cache for a campaign",
- "tags": [
- "Campaigns"
- ]
+ "type": "array"
+ }
}
+ },
+ "description": "shortcuts",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/withChildren": {
- "get": {
- "description": "Permissions: READ on Account, Post Filtered Results",
- "operationId": "getGateGroupListWithChildren",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "includePermissions",
- "in": "query",
- "name": "includePermissions",
- "schema": {
- "default": false,
- "type": "boolean"
- }
- },
- {
- "description": "page",
- "in": "query",
- "name": "page",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "maxRows",
- "in": "query",
- "name": "maxRows",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateGroup"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of queue groups (AKA gate groups) with related data for an account",
- "tags": [
- "Queue Groups"
- ]
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/RequeueShortcut"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates a list of requeue shortcuts for a queue (AKA gate)",
+ "tags": [
+ "Requeue Shortcuts"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/requeueShortcuts/{requeueShortcutId}": {
+ "delete": {
+ "description": "Permissions: UPDATE on Gate (Permission Override)",
+ "operationId": "deleteGateRequeueShortcut",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "requeueShortcutId",
+ "in": "path",
+ "name": "requeueShortcutId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/withChildren/additionalData": {
- "get": {
- "description": "Permissions: READ on Account, Post Filtered Results",
- "operationId": "getGateGroupListWithChildrenAdditionalData",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "page",
- "in": "query",
- "name": "page",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "maxRows",
- "in": "query",
- "name": "maxRows",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateGroup"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of queue groups (AKA gate groups) with related and additional data for an account",
- "tags": [
- "Queue Groups"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of requeue shortcuts for a queue (AKA gate)",
+ "tags": [
+ "Requeue Shortcuts"
+ ]
+ },
+ "get": {
+ "description": "Permissions: READ on Gate",
+ "operationId": "getGateRequeueShortcut",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "requeueShortcutId",
+ "in": "path",
+ "name": "requeueShortcutId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequeueShortcut"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}": {
- "delete": {
- "deprecated": true,
- "description": "Permissions: DELETE on Gate Group",
- "operationId": "deleteGateGroup",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "*/*": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Deletes a single queue group (AKA gate group)",
- "tags": [
- "Queue Groups"
- ]
- },
- "get": {
- "description": "Permissions: READ on Gate Group",
- "operationId": "getGateGroup",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateGroup"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a single queue group (AKA gate group) for an account",
- "tags": [
- "Queue Groups"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate Group",
- "operationId": "updateGateGroup",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateGroup"
- }
- }
- },
- "description": "gateGroup",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateGroup"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a single queue group (AKA gate group) for an account",
- "tags": [
- "Queue Groups"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a requeue shortcut for a queue (AKA gate)",
+ "tags": [
+ "Requeue Shortcuts"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "updateGateRequeueShortcut",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ },
+ {
+ "description": "requeueShortcutId",
+ "in": "path",
+ "name": "requeueShortcutId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequeueShortcut"
+ }
+ }
+ },
+ "description": "requeueShortcut",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates": {
- "get": {
- "description": "Permissions: READ on Gate Group, Post Filtered Results",
- "operationId": "getGateList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "page",
- "in": "query",
- "name": "page",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "maxRows",
- "in": "query",
- "name": "maxRows",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/Gate"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of all queues (AKA gates) for a queue group",
- "tags": [
- "Queues"
- ]
- },
- "post": {
- "description": "Permissions: CREATE on Gate Group",
- "operationId": "createGate",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Gate"
- }
- }
- },
- "description": "gate",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Gate"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RequeueShortcut"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a requeue shortcut for a queue (AKA gate)",
+ "tags": [
+ "Requeue Shortcuts"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/scheduleOverrides": {
+ "get": {
+ "description": "Permissions: READ on Gate",
+ "operationId": "getOverridesForGate",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateScheduleOverride"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of schedule overrides for a queue (AKA gate)",
+ "tags": [
+ "Queue Schedule"
+ ]
+ },
+ "post": {
+ "description": "Permissions: UPDATE on Gate (Permission Override)",
+ "operationId": "createGateScheduledOverride",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateScheduleOverride"
+ }
+ }
+ },
+ "description": "scheduleOverride",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateScheduleOverride"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates a schedule override for a queue (AKA gate)",
+ "tags": [
+ "Queue Schedule"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "saveList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateScheduleOverride"
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates a new queue (AKA gate) for a queue group",
- "tags": [
- "Queues"
- ]
+ "type": "array"
+ }
+ }
+ },
+ "description": "scheduleOverrides",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateScheduleOverride"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Saves a listing of schedule overrides for a queue (AKA gate)",
+ "tags": [
+ "Queue Schedule"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/scheduleOverrides/{scheduleOverrideId}": {
+ "delete": {
+ "description": "Permissions: UPDATE on Gate (Permission Override)",
+ "operationId": "deleteGateScheduledOverride",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "scheduleOverrideId",
+ "in": "path",
+ "name": "scheduleOverrideId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Deletes a schedule override for a queue (AKA gate)",
+ "tags": [
+ "Queue Schedule"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "updateGateScheduledOverride",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "scheduleOverrideId",
+ "in": "path",
+ "name": "scheduleOverrideId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateScheduleOverride"
+ }
+ }
+ },
+ "description": "scheduleOverride",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateScheduleOverride"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a schedule override for a queue (AKA gate)",
+ "tags": [
+ "Queue Schedule"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/setIsActive": {
+ "put": {
+ "description": "Permissions: UPDATE on Gate",
+ "operationId": "setGateIsActive",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
}
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ActiveState_boolean_"
+ }
+ }
+ },
+ "description": "state",
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}": {
- "delete": {
- "deprecated": true,
- "description": "Permissions: DELETE on Gate",
- "operationId": "deleteGate",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "*/*": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
+ "responses": {
+ "200": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Set queue (AKA gate) active state",
+ "tags": [
+ "Queues"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/specialAnis": {
+ "delete": {
+ "description": "Permissions: UPDATE on Gate (Permission Override)",
+ "operationId": "deleteSpecialAni",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "type",
+ "in": "query",
+ "name": "type",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "ani",
+ "in": "query",
+ "name": "ani",
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Deletes a special ani for a queue (AKA gate)",
+ "tags": [
+ "Queue Special ANI"
+ ]
+ },
+ "get": {
+ "description": "Permissions: READ on Gate",
+ "operationId": "getGateSpecialAniList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "type",
+ "in": "query",
+ "name": "type",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "filter",
+ "in": "query",
+ "name": "filter",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "page",
+ "in": "query",
+ "name": "page",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "maxRows",
+ "in": "query",
+ "name": "maxRows",
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateSpecialAni"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of special anis for a queue (AKA gate)",
+ "tags": [
+ "Queue Special ANI"
+ ]
+ },
+ "post": {
+ "description": "Permissions: UPDATE on Gate (Permission Override)",
+ "operationId": "createGateSpecialAni",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateSpecialAni"
+ }
+ }
+ },
+ "description": "gateSpecialAni",
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateSpecialAni"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates a special ani for a queue (AKA gate)",
+ "tags": [
+ "Queue Special ANI"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/specialAnis/upload": {
+ "post": {
+ "description": "Permissions: UPDATE on Gate (Permission Override)",
+ "operationId": "uploadSpecialAniList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "operation",
+ "in": "query",
+ "name": "operation",
+ "schema": {
+ "default": "APPEND",
+ "type": "string"
+ }
+ },
+ {
+ "description": "type",
+ "in": "query",
+ "name": "type",
+ "required": true,
+ "schema": {
+ "enum": [
+ "S-ANI",
+ "THROTTLE"
+ ],
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "properties": {
+ "file": {
+ "description": "file",
+ "format": "binary",
+ "type": "string"
+ }
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Deletes a queue (AKA gate) for a queue group",
- "tags": [
- "Queues"
- ]
- },
- "get": {
- "description": "Permissions: READ on Gate",
- "operationId": "getGate",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
+ "required": [
+ "file"
],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Gate"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
+ "type": "object"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Uploads a special ani for a queue (AKA gate)",
+ "tags": [
+ "Queue Special ANI"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/unassignAgent/{agentId}": {
+ "delete": {
+ "description": "Permissions: UPDATE on Gate (Permission Override), READ on agent",
+ "operationId": "unassignAgentFromGate",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "gateId",
+ "in": "path",
+ "name": "gateId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "agentId",
+ "in": "path",
+ "name": "agentId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Unassigns a single agent from a queue (AKA gate)",
+ "tags": [
+ "Agents"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/skills": {
+ "get": {
+ "description": "Permissions: READ on Gate Group",
+ "operationId": "getList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateGroupSkill"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a listing of skills for a queue group (AKA gate group)",
+ "tags": [
+ "Queue Skills"
+ ]
+ },
+ "post": {
+ "description": "Permissions: UPDATE on Gate Group (Permission Override)",
+ "operationId": "createGateGroupSkill",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateGroupSkill"
+ }
+ }
+ },
+ "description": "skill",
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateGroupSkill"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates a skill for a queue group (AKA gate group)",
+ "tags": [
+ "Queue Skills"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate Group",
+ "operationId": "saveGateGroupSkillList",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateGroupSkill"
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a single queue (AKA gate) for a queue group",
- "tags": [
- "Queues"
- ]
+ "type": "array"
+ }
+ }
+ },
+ "description": "skills",
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "$ref": "#/components/schemas/GateGroupSkill"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates an existing list of skills for a queue group (AKA gate group)",
+ "tags": [
+ "Queue Skills"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/skills/{skillId}": {
+ "delete": {
+ "description": "Permissions: UPDATE on Gate Group (Permission Override)",
+ "operationId": "deleteGateGroupSkill",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "skillId",
+ "in": "path",
+ "name": "skillId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "*/*": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Deletes a skill for a queue group (AKA gate group)",
+ "tags": [
+ "Queue Skills"
+ ]
+ },
+ "get": {
+ "description": "Permissions: READ on Gate Group",
+ "operationId": "getDetail",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "skillId",
+ "in": "path",
+ "name": "skillId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateGroupSkill"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a skill for a queue group (AKA gate group)",
+ "tags": [
+ "Queue Skills"
+ ]
+ },
+ "put": {
+ "description": "Permissions: UPDATE on Gate Group",
+ "operationId": "updateGateGroupSkill",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "gateGroupId",
+ "in": "path",
+ "name": "gateGroupId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ {
+ "description": "skillId",
+ "in": "path",
+ "name": "skillId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateGroupSkill"
+ }
+ }
+ },
+ "description": "skill",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GateGroupSkill"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates a skill for a queue group (AKA gate group)",
+ "tags": [
+ "Queue Skills"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/reports/{reportType}": {
+ "get": {
+ "description": "Permissions: Authenticated User",
+ "operationId": "getReportCriteriaTemplate",
+ "parameters": [
+ {
+ "description": "reportType",
+ "in": "path",
+ "name": "reportType",
+ "required": true,
+ "schema": {
+ "enum": [
+ "DIALER_RESULT_DOWNLOAD",
+ "GLOBAL_CALL_TYPE_EXCEL",
+ "GLOBAL_CALL_TYPE_DELIMITED",
+ "ALL_CALLS",
+ "IVR_DETAIL",
+ "TFN_DID_MANAGER_SUPERUSER_EXCEL",
+ "TFN_DID_MANAGER_EXCEL",
+ "TFN_DID_MANAGER_DELIMITED",
+ "CASPER_REPORT"
+ ],
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ReportCriteria"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "500": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ }
+ }
},
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "updateGate",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Gate"
- }
- }
- },
- "description": "gate",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Gate"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a queue (AKA gate) for a queue group",
- "tags": [
- "Queues"
- ]
+ "description": "Unexpected error"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Returns a report criteria definition for a report type",
+ "tags": [
+ "Reporting"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/token": {
+ "get": {
+ "description": "Permissions: Authenticated User",
+ "operationId": "getApiTokensForLoggedInUser",
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Retrieves all Api Tokens for AuthenticatedUser",
+ "tags": [
+ "Legacy Auth"
+ ]
+ },
+ "post": {
+ "description": "Permissions: Authenticated User",
+ "operationId": "createApiTokenForLoggedInUser",
+ "responses": {
+ "200": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates a new 'Api Token' based AuthenticatedUser that does not expire",
+ "tags": [
+ "Legacy Auth"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/token/{token}": {
+ "delete": {
+ "description": "Permissions: Anonymous User",
+ "operationId": "removeApiToken",
+ "parameters": [
+ {
+ "description": "token",
+ "in": "path",
+ "name": "token",
+ "required": true,
+ "schema": {
+ "type": "string"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ },
+ "description": "OK"
+ },
+ "204": {
+ "description": "No Content"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/assignAgents": {
- "put": {
- "description": "Permissions: UPDATE on Gate and READ on Agents",
- "operationId": "assignAgentsToGate",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/AgentGateAccess"
- },
- "type": "array"
- }
- }
- },
- "description": "agentAccessRequests",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/Agent"
- },
- "type": "array"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
+ "security": [
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ },
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Removes an api token",
+ "tags": [
+ "Legacy Auth"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users": {
+ "get": {
+ "tags": [
+ "Users"
+ ],
+ "summary": "Returns a listing of all users that a user has access to",
+ "description": "Permissions: MANAGE_USERS or SUPER_USER role",
+ "operationId": "listAllUsers",
+ "parameters": [
+ {
+ "name": "activeOnly",
+ "in": "query",
+ "description": "activeOnly",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ {
+ "name": "flatten",
+ "in": "query",
+ "description": "flatten",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/User"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Users"
+ ],
+ "summary": "Creates a single new user",
+ "description": "Permissions: MANAGE_USERS or SUPER_USER role",
+ "operationId": "createUser",
+ "parameters": [
+ {
+ "name": "parentUserId",
+ "in": "query",
+ "description": "parentUserId",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "returnUri",
+ "in": "query",
+ "description": "returnUri",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ {
+ "name": "isSSO",
+ "in": "query",
+ "description": "isSSO",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AdminUserRequest"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/User"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/auth/login": {
+ "post": {
+ "tags": [
+ "Legacy Auth"
+ ],
+ "summary": "Application login to authenticate and receive an X-Auth-Token",
+ "description": "Permissions: Anonymous User",
+ "operationId": "doLogin",
+ "parameters": [
+ {
+ "name": "username",
+ "in": "query",
+ "description": "username",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "password",
+ "in": "query",
+ "description": "password",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "stayLoggedIn",
+ "in": "query",
+ "description": "stayLoggedIn",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UserLoginView"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/integration/v1/admin/users/{mainAccountId}": {
+ "get": {
+ "tags": [
+ "Integration User Controller"
+ ],
+ "summary": "Returns a listing of all users that a user has access to",
+ "description": "Permissions: WFO_ACCESS role",
+ "operationId": "getUserList",
+ "parameters": [
+ {
+ "name": "mainAccountId",
+ "in": "path",
+ "description": "Main Account Id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "99990033"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/User"
+ }
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Assigns a listing of agents to a queue (AKA gate)",
- "tags": [
- "Agents"
+ "example": [
+ {
+ "rcUserId": 1009,
+ "userId": 3289,
+ "engageUserName": "jane.doe+wfo1@ringcentral.com",
+ "userName": "jane.doe+wfo1+eo1@ringcentral.com",
+ "email": "jane.doe@ringcentral.com",
+ "firstName": "Jane",
+ "lastName": "Doe",
+ "parentPath": "2181.2979.2983.3064",
+ "envID": "eo1"
+ },
+ {
+ "rcUserId": 1010,
+ "userId": 3290,
+ "engageUserName": "joe.doe+wfo1@ringcentral.com",
+ "userName": "joe.doe+wfo1+eo1@ringcentral.com",
+ "email": "joe.doe@ringcentral.com",
+ "firstName": "Joe",
+ "lastName": "Doe",
+ "parentPath": "2181.2979.2983.3064",
+ "envID": "eo1"
+ }
]
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "The supplied data is not valid",
+ "generalMessage": "The supplied data is not valid",
+ "requestUri": "voice/api/integration/v1/admin/users/99990033 - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "Jwt is expired"
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "generalMessage": "You do not have permission to access this resource",
+ "details": "",
+ "developerMessage": "Access is denied",
+ "cause": "",
+ "requestUri": "voice/api/integration/v1/admin/users/99990033 - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "The resource you have requested does not exist",
+ "generalMessage": "The resource you have requested does not exist",
+ "requestUri": "voice/api/integration/v1/admin/users/99990033 - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "An Internal Server Error occurred while processing this request",
+ "generalMessage": "An Internal Server Error occurred while processing this request",
+ "requestUri": "voice/api/integration/v1/admin/users/99990033 - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/integration/v1/admin/accounts/{mainAccountId}/subaccounts": {
+ "get": {
+ "tags": [
+ "Integration Account Controller"
+ ],
+ "summary": "Returns a listing of sub accounts by Engage Voice Main account identifier",
+ "description": "Permissions: WFO_ACCESS role",
+ "operationId": "getSubAccountsByMainAccountId",
+ "parameters": [
+ {
+ "name": "mainAccountId",
+ "in": "path",
+ "description": "Main Account Id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "99990033"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/SubAccount"
+ },
+ "example": [
+ {
+ "subAccountId": "15910001",
+ "subAccountName": "Cappuccino Engage Development",
+ "isActive": true
+ },
+ {
+ "subAccountId": "15910006",
+ "subAccountName": "Cappuccino Engage Development",
+ "isActive": true
+ }
+ ]
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "The supplied data is not valid",
+ "generalMessage": "The supplied data is not valid",
+ "requestUri": "voice/api/integration/v1/admin/accounts/99990033/subaccounts - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "Jwt is expired"
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "generalMessage": "You do not have permission to access this resource",
+ "details": "",
+ "developerMessage": "Access is denied",
+ "cause": "",
+ "requestUri": "voice/api/integration/v1/admin/accounts/99990033/subaccounts - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "The resource you have requested does not exist",
+ "generalMessage": "The resource you have requested does not exist",
+ "requestUri": "voice/api/integration/v1/admin/accounts/99990033/subaccounts - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "An Internal Server Error occurred while processing this request",
+ "generalMessage": "An Internal Server Error occurred while processing this request",
+ "requestUri": "voice/api/integration/v1/admin/accounts/99990033/subaccounts - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/integration/v1/admin/accounts/{subAccountId}/agentGroups/{agentGroupId}/agents": {
+ "get": {
+ "tags": [
+ "Integration Agent Controller"
+ ],
+ "summary": "Returns a list of read only agents for an agent group",
+ "description": "Permissions: WFO_ACCESS role",
+ "operationId": "getAgentList",
+ "parameters": [
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "Engage Voice sub-account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "99990033"
+ }
+ },
+ {
+ "name": "agentGroupId",
+ "in": "path",
+ "description": "Agent Group Id",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32",
+ "example": 30
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Agent"
+ },
+ "example": [
+ {
+ "rcUserId": 1009,
+ "agentId": 1386703,
+ "agentGroupId": 30,
+ "firstName": "Jane",
+ "lastName": "Doe",
+ "engageUserName": "jane.doe+wfo1@ringcentral.com",
+ "userName": "jane.doe+wfo1+eo1@ringcentral.com",
+ "email": "jane.doe@ringcentral.com",
+ "agentType": "SUPERVISOR",
+ "isActive": true,
+ "supervisorAgentIds": [
+ 1386605,
+ 1386600
+ ],
+ "superviseeAgentIds": [
+ 1386804,
+ 1386905
+ ],
+ "envID": "eo1"
+ },
+ {
+ "rcUserId": 1010,
+ "agentId": 1389175,
+ "agentGroupId": 30,
+ "firstName": "Joe",
+ "lastName": "Doe",
+ "userName": "Joe.D+15910001_172+eo1@c1.local",
+ "engageUserName": "Joe.D+15910001_172@c1.local",
+ "email": "joe.d@ringcentral.com",
+ "agentType": "AGENT",
+ "isActive": true,
+ "supervisorAgentIds": [
+ 1386605
+ ],
+ "superviseeAgentIds": [],
+ "envID": "eo1"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "The supplied data is not valid",
+ "generalMessage": "The supplied data is not valid",
+ "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups/30/agents - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "Jwt is expired"
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "generalMessage": "You do not have permission to access this resource",
+ "details": "",
+ "developerMessage": "Access is denied",
+ "cause": "",
+ "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups/30/agents - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "The resource you have requested does not exist",
+ "generalMessage": "The resource you have requested does not exist",
+ "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups/30/agents - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "An Internal Server Error occurred while processing this request",
+ "generalMessage": "An Internal Server Error occurred while processing this request",
+ "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups/30/agents - GET",
+ "timestamp": 1611847650696
+ }
+ }
}
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/assignGateToPriorityGroup": {
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "assignGateToPriorityGroup",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "priorityGroupId",
- "in": "query",
- "name": "priorityGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "priorityGroupRank",
- "in": "query",
- "name": "priorityGroupRank",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "*/*": {
- "schema": {
- "$ref": "#/components/schemas/Gate"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Assigns a queue (AKA gate) to a queue priority group for an account",
- "tags": [
- "Queues"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/integration/v1/admin/accounts/{subAccountId}/agentGroups": {
+ "get": {
+ "tags": [
+ "Integration Agent Group Controller"
+ ],
+ "summary": "Returns a list of agent groups for a sub-account",
+ "description": "Permissions: WFO_ACCESS role",
+ "operationId": "getAgentGroups",
+ "parameters": [
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "Engage Voice sub-account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "99990033"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AgentGroup"
+ },
+ "example": [
+ {
+ "agentGroupId": 1009,
+ "groupName": "Team A1"
+ },
+ {
+ "agentGroupId": 1010,
+ "groupName": "Team A2"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "The supplied data is not valid",
+ "generalMessage": "The supplied data is not valid",
+ "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "Jwt is expired"
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "generalMessage": "You do not have permission to access this resource",
+ "details": "",
+ "developerMessage": "Access is denied",
+ "cause": "",
+ "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "The resource you have requested does not exist",
+ "generalMessage": "The resource you have requested does not exist",
+ "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "An Internal Server Error occurred while processing this request",
+ "generalMessage": "An Internal Server Error occurred while processing this request",
+ "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/assignedAgents": {
- "get": {
- "description": "Permissions: READ on Gate",
- "operationId": "getAssignedAgentsForGate",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "page",
- "in": "query",
- "name": "page",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "maxRows",
- "in": "query",
- "name": "maxRows",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/Agent"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of assigned agents for a queue (AKA gate) ",
- "tags": [
- "Agents"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/recordings/dialogs/{dialogId}/segments/{segmentId}": {
+ "get": {
+ "tags": [
+ "Public Integration API"
+ ],
+ "summary": "Fetches recordings data",
+ "description": "This API fetches recording data for a specified dialog and segment. This is a streaming API, it will return an audio stream for given request.",
+ "operationId": "getRecordingSegmentData",
+ "parameters": [
+ {
+ "name": "rcAccountId",
+ "in": "path",
+ "description": "RC account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "980634004"
+ }
+ },
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "subaccount id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "99999999"
+ }
+ },
+ {
+ "name": "dialogId",
+ "in": "path",
+ "description": "dialog id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "d-65f286b0ee1c4900074c1bb2-1710393008514"
+ }
+ },
+ {
+ "name": "segmentId",
+ "in": "path",
+ "description": "segment id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "d-668cf767a626550007d021f6-668cf767a626550007d021f5"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK. The response body contains the WAV recording audio stream.",
+ "content": {
+ "audio/wav": {
+ "schema": {
+ "type": "string",
+ "format": "binary"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Bad request",
+ "cause": "",
+ "generalMessage": "The supplied data is not valid",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/recordings/dialogs/d-65f286b0ee1c4900074c1bb2-1710393008514/segments/d-668cf767a626550007d021f6-668cf767a626550007d021f5 - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "JWT is expired."
+ }
+ }
+ },
+ "403": {
+ "description": "You do not have permission to access this resource.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Access is denied.",
+ "cause": "",
+ "generalMessage": "You do not have permission to access this resource",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/recordings/dialogs/d-65f286b0ee1c4900074c1bb2-1710393008514/segments/d-668cf767a626550007d021f6-668cf767a626550007d021f5 - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The resource you requested does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Not found",
+ "cause": "",
+ "generalMessage": "The resource you have requested does not exist",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/recordings/dialogs/d-65f286b0ee1c4900074c1bb2-1710393008514/segments/d-668cf767a626550007d021f6-668cf767a626550007d021f5 - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Internal server error",
+ "cause": "",
+ "generalMessage": "An Internal Server Error occurred while processing this request",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/recordings/dialogs/d-65f286b0ee1c4900074c1bb2-1710393008514/segments/d-668cf767a626550007d021f6-668cf767a626550007d021f5 - GET",
+ "timestamp": 1611847650696
+ }
+ }
}
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/clone": {
- "post": {
- "description": "Permissions: READ on cloned Gate and CREATE on new Gate Group (Permission Override",
- "operationId": "cloneGate",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "newGateGroupId",
- "in": "query",
- "name": "newGateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "newGateName",
- "in": "query",
- "name": "newGateName",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Gate"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates a clone of a queue (AKA gate) for a queue group",
- "tags": [
- "Queues"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/interaction-metadata": {
+ "post": {
+ "tags": [
+ "Public Integration API"
+ ],
+ "summary": "Returns Interaction Segment Metadata",
+ "description": "This API is used to fetch interaction metadata for VOICE/DIGITAL for all segments under provided time duration.",
+ "operationId": "getInteractionMetadata",
+ "parameters": [
+ {
+ "name": "rcAccountId",
+ "in": "path",
+ "description": "RC account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "980634004"
+ }
+ },
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "RingCX subAccount id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "99999999"
}
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/InteractionMetadataRequest"
+ }
+ }
+ },
+ "required": true
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/dispositions": {
- "get": {
- "description": "Permissions: READ on Gate, Post Filtered Results",
- "operationId": "getGateDispositionList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateDisposition"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of dispositions for a queue (AKA gate)",
- "tags": [
- "Queue Dispositions"
- ]
- },
- "post": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "createGateDisposition",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateDisposition"
- }
- }
- },
- "description": "gateDisposition",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateDisposition"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates a disposition for a queue (AKA gate)",
- "tags": [
- "Queue Dispositions"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "saveGateDispositionList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateDisposition"
- },
- "type": "array"
- }
- }
- },
- "description": "gateDispositions",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateDisposition"
- },
- "type": "array"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/WEMInteractionSegmentMetaData2Array"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Bad request",
+ "cause": "",
+ "generalMessage": "The supplied data is not valid",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/interaction-metadata - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "JWT is expired."
+ }
+ }
+ },
+ "403": {
+ "description": "You do not have permission to access this resource.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Access is denied.",
+ "cause": "",
+ "generalMessage": "You do not have permission to access this resource",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/interaction-metadata - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The resource you requested does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Not found",
+ "cause": "",
+ "generalMessage": "The resource you have requested does not exist",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/interaction-metadata - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Internal server error",
+ "cause": "",
+ "generalMessage": "An Internal Server Error occurred while processing this request",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/interaction-metadata - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/transcripts/dialogs/{dialogId}/segments/{segmentId}": {
+ "get": {
+ "tags": [
+ "Public Integration API"
+ ],
+ "summary": "Fetches Transcript data for both voice and digital",
+ "description": "This API fetches interaction transcript data for provided dialogId and segmentId. This is a streaming API, it will return an audio stream for given request.",
+ "operationId": "getTranscriptSegmentData",
+ "parameters": [
+ {
+ "name": "rcAccountId",
+ "in": "path",
+ "description": "RC account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "980634004"
+ }
+ },
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "Sub Account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "99999999"
+ }
+ },
+ {
+ "name": "dialogId",
+ "in": "path",
+ "description": "dialog id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "d-668cf1d0a626550007d01d1b-1720512976864-1909690a312da"
+ }
+ },
+ {
+ "name": "segmentId",
+ "in": "path",
+ "description": "segment id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "d-668d1051a626550007d02828-1720520785904-19097081cf749"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RCInteractionTranscriptData"
+ },
+ "examples": {
+ "example1": {
+ "value": {
+ "channelClass": "DIGITAL",
+ "errorCode": null,
+ "errorMessage": null,
+ "transcript": [
+ {
+ "message": "I cannot transfer number porting",
+ "participantId": "d-6555aa00cd0df30007872d38-6555aa00cd0df30007872d37",
+ "participantType": "contact",
+ "rcUserId": "665127314",
+ "timestamp": "1721651880000"
+ },
+ {
+ "message": "Can you provide your RC account? And describe the steps you met?",
+ "participantId": "d-6555b45ccd0df30007872dd2-1700115548459-18bd6d7301135",
+ "participantType": "agent",
+ "rcUserId": "665127314",
+ "timestamp": "1721651881000"
+ }
+ ]
+ }
+ },
+ "example2": {
+ "value": {
+ "channelClass": "VOICE",
+ "errorCode": null,
+ "errorMessage": null,
+ "transcript": [
+ {
+ "participantId": "d-6555aa00cd0df30007872d38-6555aa00cd0df30007872d37",
+ "rcUserId": null,
+ "participantName": null,
+ "participantType": null,
+ "timestamp": "1721651880000",
+ "message": "yes sir"
+ },
+ {
+ "participantId": "d-6555b45ccd0df30007872dd2-1700115548459-18bd6d7301135",
+ "rcUserId": null,
+ "participantName": null,
+ "participantType": null,
+ "timestamp": "1721651881000",
+ "message": "ok"
+ }
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Bad request",
+ "cause": "",
+ "generalMessage": "The supplied data is not valid",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/transcripts/dialogs/d-668cf1d0a626550007d01d1b-1720512976864-1909690a312da/segments/d-668d1051a626550007d02828-1720520785904-19097081cf749 - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "JWT is expired."
+ }
+ }
+ },
+ "403": {
+ "description": "You do not have permission to access this resource.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Access is denied.",
+ "cause": "",
+ "generalMessage": "You do not have permission to access this resource",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/transcripts/dialogs/d-668cf1d0a626550007d01d1b-1720512976864-1909690a312da/segments/d-668d1051a626550007d02828-1720520785904-19097081cf749 - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The resource you requested does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Not found",
+ "cause": "",
+ "generalMessage": "The resource you have requested does not exist",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/transcripts/dialogs/d-668cf1d0a626550007d01d1b-1720512976864-1909690a312da/segments/d-668d1051a626550007d02828-1720520785904-19097081cf749 - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Internal server error",
+ "cause": "",
+ "generalMessage": "An Internal Server Error occurred while processing this request",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/transcripts/dialogs/d-668cf1d0a626550007d01d1b-1720512976864-1909690a312da/segments/d-668d1051a626550007d02828-1720520785904-19097081cf749 - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/voice/api/v1/summary/accounts/{subAccountId}/segments/{segmentId}/agent": {
+ "get": {
+ "tags": [
+ "Reporting"
+ ],
+ "summary": "Returns the agent-edited summary for an interaction segment",
+ "description": "Returns the summary filled in or edited by the agent for the specified interaction segment. This endpoint requires the RingCX access token in a lowercase `cookie` header formatted as `access_token=`.",
+ "operationId": "getAgentSummaryBySegment",
+ "parameters": [
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "RingCX sub-account ID. This is the account ID path value used by the Summary API.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+",
+ "example": "21630001"
+ }
+ },
+ {
+ "name": "segmentId",
+ "in": "path",
+ "description": "Unique interaction segment ID from interaction metadata.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "p-v-0b338efb877e48f0a3a321c73fcd4634-1772456952229-50caeaadd482c"
+ }
+ },
+ {
+ "name": "cookie",
+ "in": "header",
+ "description": "Required lowercase cookie header containing the RingCX access token. Use the format `access_token=`.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "access_token="
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "Customer requested a billing adjustment. Agent confirmed the account details and submitted the request for review."
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/voice/api/v1/summary/accounts/{subAccountId}/segments/{segmentId}/auto": {
+ "get": {
+ "tags": [
+ "Reporting"
+ ],
+ "summary": "Returns the AI-generated summary for an interaction segment",
+ "description": "Returns the auto-generated summary for the specified interaction segment. This endpoint requires the RingCX access token in a lowercase `cookie` header formatted as `access_token=`.",
+ "operationId": "getAutoSummaryBySegment",
+ "parameters": [
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "RingCX sub-account ID. This is the account ID path value used by the Summary API.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+",
+ "example": "21630001"
+ }
+ },
+ {
+ "name": "segmentId",
+ "in": "path",
+ "description": "Unique interaction segment ID from interaction metadata.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "p-v-0b338efb877e48f0a3a321c73fcd4634-1772456952229-50caeaadd482c"
+ }
+ },
+ {
+ "name": "cookie",
+ "in": "header",
+ "description": "Required lowercase cookie header containing the RingCX access token. Use the format `access_token=`.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "access_token="
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Ok",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "The customer called about a billing issue. The agent reviewed the account, explained the next steps, and created a follow-up request."
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/queue-groups": {
+ "get": {
+ "tags": [
+ "Public Integration API"
+ ],
+ "summary": "Returns a list of queue groups",
+ "description": "This API returns a list of all queue-groups for given sub-account",
+ "operationId": "getQueueGroups",
+ "parameters": [
+ {
+ "name": "rcAccountId",
+ "in": "path",
+ "description": "RC account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "138885004"
+ }
+ },
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "Engage Voice sub-account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "99999033"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/QueueGroup"
+ },
+ "example": [
+ {
+ "queueGroupId": 1009,
+ "groupName": "Queue group 1",
+ "queueGroupType": "VOICE"
+ },
+ {
+ "queueGroupId": 1010,
+ "groupName": "Queue group 2",
+ "queueGroupType": "DIGITAL"
+ }
+ ]
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Bad request",
+ "cause": "",
+ "generalMessage": "The supplied data is not valid",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "JWT is expired."
+ }
+ }
+ },
+ "403": {
+ "description": "You do not have permission to access this resource.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Access is denied.",
+ "cause": "",
+ "generalMessage": "You do not have permission to access this resource",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The resource you requested does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Not found",
+ "cause": "",
+ "generalMessage": "The resource you have requested does not exist",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Internal server error",
+ "cause": "",
+ "generalMessage": "An Internal Server Error occurred while processing this request",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/queue-groups/{queueGroupId}/with-agents": {
+ "get": {
+ "tags": [
+ "Public Integration API"
+ ],
+ "summary": "Returns a list of agent ids of the queue group.",
+ "description": "This API returns a list of all queues and their associated agents for given sub-account and queue-group id. Note: Maximum number of records returned by this API is 2000.",
+ "operationId": "getQueuesWithAgents",
+ "parameters": [
+ {
+ "name": "rcAccountId",
+ "in": "path",
+ "description": "RC account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "138885004"
+ }
+ },
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "Engage Voice sub-account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "99990033"
+ }
+ },
+ {
+ "name": "queueGroupId",
+ "in": "path",
+ "description": "Queue group ID",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64",
+ "example": 1009
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CXQueueWithAgents"
+ },
+ "example": [
+ {
+ "queueId": 555,
+ "queueType": "VOICE",
+ "queueName": "Test queue 1",
+ "queueGroupId": 1009,
+ "isActive": true,
+ "createdOn": "2020-07-21T17:32:28Z",
+ "agentIds": [
+ 10,
+ 20
+ ]
+ },
+ {
+ "queueId": 556,
+ "queueType": "DIGITAL",
+ "queueName": "Test queue 2",
+ "queueGroupId": 1009,
+ "isActive": true,
+ "createdOn": "2020-07-21T17:32:28Z",
+ "agentIds": [
+ 30
+ ]
+ }
+ ]
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Bad request",
+ "cause": "",
+ "generalMessage": "The supplied data is not valid",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups/1009/with-agents - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "JWT is expired."
+ }
+ }
+ },
+ "403": {
+ "description": "You do not have permission to access this resource.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Access is denied.",
+ "cause": "",
+ "generalMessage": "You do not have permission to access this resource",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups/1009/with-agents - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The resource you requested does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Not found",
+ "cause": "",
+ "generalMessage": "The resource you have requested does not exist",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups/1009/with-agents - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Internal server error",
+ "cause": "",
+ "generalMessage": "An Internal Server Error occurred while processing this request",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups/1009/with-agents - GET",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/agg-queue-stats": {
+ "post": {
+ "tags": [
+ "Public Integration API"
+ ],
+ "summary": "Builds queue statistics",
+ "operationId": "buildAggQueueStats",
+ "description": "This API returns statistics of all queues for given sub-account and duration.",
+ "parameters": [
+ {
+ "name": "rcAccountId",
+ "in": "path",
+ "description": "RC account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "138885004"
+ }
+ },
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "Engage Voice sub-account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "99999033"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AggregatedIntegrationParams"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AggregatedQueueStats"
+ }
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Saves a list of dispositions for a queue (AKA gate)",
- "tags": [
- "Queue Dispositions"
+ "example": [
+ {
+ "abandIxnCnt": 0,
+ "abandShortIxnCnt": 0,
+ "abandWithinSlCnt": 0,
+ "ansServicelevelCnt": 0,
+ "answIxnCnt": 3,
+ "completedContacts": 122,
+ "dateTimeFrom": "03-04-2024T01:00:00",
+ "interval": 60,
+ "offdDirectIxnCnt": 3,
+ "overflowInIxnCnt": 0,
+ "overflowOutIxnCnt": 0,
+ "queue": 5686,
+ "queuedAbandLongestQueDur": 0,
+ "queuedAndAbandIxnDur": 0,
+ "queuedAndAnswIxnDur": 9,
+ "queuedAnswLongestQueDur": 1,
+ "queueName": "Queue",
+ "segmentHoldTime": 512000,
+ "talkingIxnDur": 90,
+ "waitDur": 13,
+ "wrapUpDur": 13
+ },
+ {
+ "abandIxnCnt": 0,
+ "abandShortIxnCnt": 0,
+ "abandWithinSlCnt": 0,
+ "ansServicelevelCnt": 0,
+ "answIxnCnt": 3,
+ "completedContacts": 21,
+ "dateTimeFrom": "03-04-2024T02:00:00",
+ "interval": 60,
+ "offdDirectIxnCnt": 3,
+ "overflowInIxnCnt": 0,
+ "overflowOutIxnCnt": 0,
+ "queue": 5686,
+ "queuedAbandLongestQueDur": 0,
+ "queuedAndAbandIxnDur": 0,
+ "queuedAndAnswIxnDur": 9,
+ "queuedAnswLongestQueDur": 1,
+ "queueName": "Queue 2",
+ "segmentHoldTime": 12000,
+ "talkingIxnDur": 90,
+ "waitDur": 13,
+ "wrapUpDur": 13
+ }
]
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Bad request",
+ "cause": "",
+ "generalMessage": "The supplied data is not valid",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-queue-stats - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "JWT is expired."
+ }
+ }
+ },
+ "403": {
+ "description": "You do not have permission to access this resource.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Access is denied.",
+ "cause": "",
+ "generalMessage": "You do not have permission to access this resource",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-queue-stats - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The resource you requested does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Not found",
+ "cause": "",
+ "generalMessage": "The resource you have requested does not exist",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-queue-stats - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Internal server error",
+ "cause": "",
+ "generalMessage": "An Internal Server Error occurred while processing this request",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-queue-stats - POST",
+ "timestamp": 1611847650696
+ }
+ }
}
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/dispositions/{gateDispositionId}": {
- "delete": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "deleteGateDisposition",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateDispositionId",
- "in": "path",
- "name": "gateDispositionId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "*/*": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/agg-agent-extended-stats": {
+ "post": {
+ "tags": [
+ "Public Integration API"
+ ],
+ "summary": "Builds extended agent queue statistics",
+ "operationId": "buildExtendedAggAgentStats",
+ "description": "This API returns statistics of all queues along with their agents for given Sub-Account and duration.",
+ "parameters": [
+ {
+ "name": "rcAccountId",
+ "in": "path",
+ "description": "RC account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "138885004"
+ }
+ },
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "Engage Voice sub-account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "99990033"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AggregatedIntegrationParams"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ExtendedAggregatedQueueStats"
+ }
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Deletes a disposition for a queue (AKA gate)",
- "tags": [
- "Queue Dispositions"
+ "example": [
+ {
+ "interval": 60,
+ "dateTimeFrom": "03-04-2024T05:00:00",
+ "agentId": 1,
+ "agentName": "aws93-l13-las01 test number",
+ "queue": 5682,
+ "queueName": "Queue",
+ "talkingIxnDur": 56,
+ "wrapUpDur": 0,
+ "answIxnCnt": 1,
+ "transferOutIxnCnt": 4
+ },
+ {
+ "interval": 60,
+ "dateTimeFrom": "03-04-2024T06:00:00",
+ "agentId": 10693,
+ "agentName": "Neringa Norkute",
+ "queue": 5688,
+ "queueName": "Neringa queue 2",
+ "talkingIxnDur": 137,
+ "wrapUpDur": 5,
+ "answIxnCnt": 2,
+ "transferOutIxnCnt": 0
+ }
]
- },
- "get": {
- "description": "Permissions: READ on Gate",
- "operationId": "getGateDisposition",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateDispositionId",
- "in": "path",
- "name": "gateDispositionId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateDisposition"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Bad request",
+ "cause": "",
+ "generalMessage": "The supplied data is not valid",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-extended-stats - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "JWT is expired."
+ }
+ }
+ },
+ "403": {
+ "description": "You do not have permission to access this resource.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Access is denied.",
+ "cause": "",
+ "generalMessage": "You do not have permission to access this resource",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-extended-stats - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The resource you requested does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Not found",
+ "cause": "",
+ "generalMessage": "The resource you have requested does not exist",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-extended-stats - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Internal server error",
+ "cause": "",
+ "generalMessage": "An Internal Server Error occurred while processing this request",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-extended-stats - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/agg-agent-stats": {
+ "post": {
+ "tags": [
+ "Public Integration API"
+ ],
+ "summary": "Builds agent statistics",
+ "description": "This API returns statistics of all agents for given sub-account and duration.",
+ "operationId": "buildAggAgentStats",
+ "parameters": [
+ {
+ "name": "rcAccountId",
+ "in": "path",
+ "description": "RC account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "138885004"
+ }
+ },
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "Engage Voice sub-account id",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "example": "99990033"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AggregatedIntegrationParams"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AggregatedAgentStats"
+ }
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a single disposition for a queue (AKA gate)",
- "tags": [
- "Queue Dispositions"
+ "example": [
+ {
+ "interval": 60,
+ "dateTimeFrom": "03-04-2024T08:00:00",
+ "agentId": 33,
+ "agentName": "test number, aws91-l22-engage",
+ "availDur": 3376,
+ "totWorkDur": 3376,
+ "pauseDur": 900,
+ "waitDur": 2476,
+ "adminDur": 0,
+ "directOutIxnCnt": 0,
+ "directOutIxnDur": 0,
+ "directInIxnCnt": 0,
+ "directInIxnDur": 0
+ },
+ {
+ "interval": 60,
+ "dateTimeFrom": "03-04-2024T09:00:00",
+ "agentId": 132598,
+ "agentName": "kaduk, alena",
+ "availDur": 117,
+ "totWorkDur": 117,
+ "pauseDur": 0,
+ "waitDur": 113,
+ "adminDur": 0,
+ "directOutIxnCnt": 0,
+ "directOutIxnDur": 0,
+ "directInIxnCnt": 1,
+ "directInIxnDur": 5
+ }
]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "updateGateDisposition",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateDispositionId",
- "in": "path",
- "name": "gateDispositionId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateDisposition"
- }
- }
- },
- "description": "gateDisposition",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateDisposition"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Bad request",
+ "cause": "",
+ "generalMessage": "The supplied data is not valid",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-stats - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "text/plain": {
+ "schema": {
+ "type": "string"
+ },
+ "example": "JWT is expired."
+ }
+ }
+ },
+ "403": {
+ "description": "You do not have permission to access this resource.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Access is denied.",
+ "cause": "",
+ "generalMessage": "You do not have permission to access this resource",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-stats - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "The resource you requested does not exist.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Not found",
+ "cause": "",
+ "generalMessage": "The resource you have requested does not exist",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-stats - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Errors"
+ },
+ "example": {
+ "details": "",
+ "developerMessage": "Internal server error",
+ "cause": "",
+ "generalMessage": "An Internal Server Error occurred while processing this request",
+ "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-stats - POST",
+ "timestamp": 1611847650696
+ }
+ }
+ }
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/v1/admin/utilities/tnManager/updateCustomerDnisBulk": {
+ "put": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Update Dnis Records in Bulk",
+ "operationId": "updateCustomerDnisBulkUsingPUT",
+ "requestBody": {
+ "description": "request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DnisBulkUpdateRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created",
+ "content": {}
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {}
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {}
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {}
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-codegen-request-body-name": "request"
+ }
+ },
+ "/v1/admin/utilities/tnManager/searchDnis": {
+ "post": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Returns all dnis pools for Customer",
+ "description": "Permissions: READ on Account, READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "getCustomerDnisPoolListUsingPOST",
+ "requestBody": {
+ "description": "request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DnisListRequest"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created",
+ "content": {}
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {}
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {}
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {}
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-codegen-request-body-name": "request"
+ }
+ },
+ "/v1/admin/utilities/tnManager/updateBulkDnisPool": {
+ "put": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Updates for bulk csv data dnis pool, will update assignments too",
+ "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "updateBulkDnisPoolListUsingPUT",
+ "requestBody": {
+ "description": "dnisPools",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DnisPool"
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DnisBulkUpdateRespose"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created",
+ "content": {}
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {}
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {}
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {}
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "x-codegen-request-body-name": "dnisPools"
+ }
+ },
+ "/v1/admin/utilities/tnManager/uploadDnisPool": {
+ "post": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Creates a list of dnis pools from upload file",
+ "description": "Has Role: SUPER_USER",
+ "operationId": "previewDnisListUsingPOST",
+ "parameters": [
+ {
+ "name": "fileType",
+ "in": "query",
+ "description": "fileType",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "COMMA"
+ ]
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "required": [
+ "file"
],
- "summary": "Updates a single disposition for a queue (AKA gate)",
- "tags": [
- "Queue Dispositions"
- ]
+ "properties": {
+ "file": {
+ "type": "string",
+ "description": "file",
+ "format": "binary"
+ }
+ }
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DnisListPreviewResponse"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created",
+ "content": {}
+ },
+ "401": {
+ "description": "Unauthorized",
+ "content": {}
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {}
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {}
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/persona-phone-config": {
+ "get": {
+ "description": "Permissions: Read on Account (Permission Override), READ on Outbound",
+ "operationId": "fetchPersonaPhoneConfig",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "pattern": "[0-9]+",
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PersonaPhoneConfig"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Fetches persona phone configurations",
+ "tags": [
+ "Outbound"
+ ]
+ },
+ "post": {
+ "description": "Permissions: Read on Account (Permission Override), CREATE on Outbound",
+ "operationId": "createPersonaPhoneConfig",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "pattern": "[0-9]+",
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PersonaPhoneConfig"
+ }
+ }
+ },
+ "description": "personaPhoneConfig",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PersonaPhoneConfig"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Creates persona phone configuration",
+ "tags": [
+ "Outbound"
+ ],
+ "x-codegen-request-body-name": "personaPhoneConfig"
+ },
+ "put": {
+ "description": "Permissions: Read on Account (Permission Override), UPDATE on Outbound",
+ "operationId": "updatePersonaPhoneConfig",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "pattern": "[0-9]+",
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/PersonaPhoneConfig"
+ }
+ }
+ },
+ "description": "personaPhoneConfig",
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/PersonaPhoneConfig"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Updates persona phone configuration",
+ "tags": [
+ "Outbound"
+ ],
+ "x-codegen-request-body-name": "personaPhoneConfig"
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/persona-phone-config/active-campaigns/{phoneId}": {
+ "get": {
+ "description": "Returns campaign names that currently use the specified persona phone ID in calling preferences.",
+ "operationId": "getCampaignsUsingPhoneId",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "pattern": "[0-9]+",
+ "type": "string"
+ }
+ },
+ {
+ "description": "phoneId",
+ "in": "path",
+ "name": "phoneId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Fetches campaigns using a persona phone ID",
+ "tags": [
+ "Outbound"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/persona-phone-config/{phoneId}": {
+ "delete": {
+ "description": "Permissions: Read on Account (Permission Override), DELETE on Outbound",
+ "operationId": "deletePersonaPhoneConfig",
+ "parameters": [
+ {
+ "description": "accountId",
+ "in": "path",
+ "name": "accountId",
+ "required": true,
+ "schema": {
+ "pattern": "[0-9]+",
+ "type": "string"
+ }
+ },
+ {
+ "description": "phoneId",
+ "in": "path",
+ "name": "phoneId",
+ "required": true,
+ "schema": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Deleted"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "summary": "Deletes persona phone configuration",
+ "tags": [
+ "Outbound"
+ ]
+ }
+ },
+ "/voice/api/v1/admin/auth": {
+ "get": {
+ "tags": [
+ "User Auth Utilities"
+ ],
+ "summary": "Returns information provided by /v1/auth/login for users who are already authenticated. Additionally, we return the host name of this platform.",
+ "description": "",
+ "operationId": "getUserLoginView",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/UserLoginView"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/rightsDocs/{rightsDocId}/assignments": {
+ "get": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Returns a listing of users assigned to a rights document",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "getRightsDocAssignments",
+ "parameters": [
+ {
+ "name": "rightsDocId",
+ "in": "path",
+ "description": "rightsDocId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/User"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Assigns a rights document to a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "assignRightsDoc",
+ "parameters": [
+ {
+ "name": "rightsDocId",
+ "in": "path",
+ "description": "rightsDocId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "userIds",
+ "in": "query",
+ "description": "Repeat the parameter (e.g. ?userIds=1&userIds=2) to assign the rights document to multiple users.",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "style": "form",
+ "explode": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/rightsDocs/{rightsDocId}/assignments/{assignedUserId}": {
+ "delete": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Deletes a rights document from a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "deleteRightsDocAssignment",
+ "parameters": [
+ {
+ "name": "assignedUserId",
+ "in": "path",
+ "description": "assignedUserId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "rightsDocId",
+ "in": "path",
+ "description": "rightsDocId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "successful operation"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/availableUserNames": {
+ "get": {
+ "tags": [
+ "Users"
+ ],
+ "summary": "Checks if username is available",
+ "description": "Permissions: Authenticated User",
+ "operationId": "isUserNameTaken",
+ "parameters": [
+ {
+ "name": "userName",
+ "in": "query",
+ "description": "userName",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/duplicateAuthenticatedUser": {
+ "post": {
+ "tags": [
+ "User Auth Utilities"
+ ],
+ "summary": "Duplicates this authenticated user's session and returns a new auth token",
+ "description": "Permissions: Authenticated User",
+ "operationId": "duplicateAuthenticatedUsers",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthenticatedUser"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/passwordReset": {
+ "post": {
+ "tags": [
+ "User Auth Utilities"
+ ],
+ "summary": "Resets a user's password",
+ "description": "Permissions: Authenticated User",
+ "operationId": "securedPasswordRequestRequest",
+ "parameters": [
+ {
+ "name": "currentPassword",
+ "in": "query",
+ "description": "currentPassword",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "newPassword",
+ "in": "query",
+ "description": "newPassword",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/reassign": {
+ "put": {
+ "tags": [
+ "Users"
+ ],
+ "summary": "Reassigns all existing child users to a new parent user",
+ "description": "Permissions: MANAGE_USERS or SUPER_USER role",
+ "operationId": "reassignUsers",
+ "parameters": [
+ {
+ "name": "oldUserId",
+ "in": "query",
+ "description": "oldUserId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "reassignUserId",
+ "in": "query",
+ "description": "reassignUserId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/root": {
+ "post": {
+ "tags": [
+ "Users"
+ ],
+ "summary": "Creates a single root user",
+ "description": "Permissions: SUPER_USER role",
+ "operationId": "createRootUser",
+ "parameters": [
+ {
+ "name": "returnUri",
+ "in": "query",
+ "description": "returnUri",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "format": "uri"
+ }
+ },
+ {
+ "name": "isSSO",
+ "in": "query",
+ "description": "isSSO",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AdminUserRequest"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/User"
+ }
+ }
}
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/gateAgentAccessLogin": {
- "get": {
- "description": "Permissions: READ on Account and Read on Agent, Post Filtered Results",
- "operationId": "getGatesAgentsLoggedInto",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GatesLoggedInAgentsView"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of all agents that have access to the queue (AKA gate) - this includes data to indicate if an agent is currently logged into the queue",
- "tags": [
- "Agent Access"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/root/{userId}/assignAccount": {
+ "post": {
+ "tags": [
+ "Users"
+ ],
+ "summary": "Assigns an account to a root user",
+ "description": "Permissions: SUPER_USER role",
+ "operationId": "assignAccountToRootUser",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "accountId",
+ "in": "query",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "isMaster",
+ "in": "query",
+ "description": "isMaster",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
}
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/gateQueueEvents": {
- "get": {
- "description": "Permissions: READ on Gate",
- "operationId": "getGateQueueEventList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateQueueEvent"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of gate queue events for a queue",
- "tags": [
- "Queue Events"
- ]
- },
- "post": {
- "deprecated": true,
- "operationId": "createGateQueueEvent",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateQueueEvent"
- }
- }
- },
- "description": "queueEvent",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateQueueEvent"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "createGateQueueEvent",
- "tags": [
- "Queue Events"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "saveGateQueueEventList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateQueueEvent"
- },
- "type": "array"
- }
- }
- },
- "description": "queueEvents",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateQueueEvent"
- },
- "type": "array"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Saves a list of gate queue events for a queue",
- "tags": [
- "Queue Events"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}": {
+ "get": {
+ "tags": [
+ "Users"
+ ],
+ "summary": "Returns a user",
+ "description": "Permissions: MANAGE_USERS or SUPER_USER role",
+ "operationId": "getUser",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/User"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/gateQueueEvents/{eventId}": {
- "delete": {
- "description": "Permissions: UPDATE on Gate (Override Permission Request)",
- "operationId": "deleteGateQueueEvent",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "eventId",
- "in": "path",
- "name": "eventId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Deletes a gate queue event for a queue",
- "tags": [
- "Queue Events"
- ]
- },
- "get": {
- "description": "Permissions: READ on Gate",
- "operationId": "getGateQueueEvent",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "eventId",
- "in": "path",
- "name": "eventId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateQueueEvent"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a single gate queue event for a queue",
- "tags": [
- "Queue Events"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "updateGateQueueEvent",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "eventId",
- "in": "path",
- "name": "eventId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateQueueEvent"
- }
- }
- },
- "description": "queueEvent",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateQueueEvent"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a single gate queue event for a queue",
- "tags": [
- "Queue Events"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Users"
+ ],
+ "summary": "Deletes a user",
+ "description": "Permissions: MANAGE_USERS or SUPER_USER role",
+ "operationId": "deleteUser",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "reassignUserId",
+ "in": "query",
+ "description": "reassignUserId",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cascadeDelete",
+ "in": "query",
+ "description": "cascadeDelete",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": true
+ }
+ }
+ ],
+ "responses": {
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "successful operation"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Users"
+ ],
+ "summary": "Updates a user",
+ "description": "Permissions: MANAGE_USERS or SUPER_USER role",
+ "operationId": "updateUser",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AdminUserRequest"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/User"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/aggregatedRightsDocs": {
+ "get": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Returns a map of aggregated rights documents for a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "getAggregatedRightsDocForAllAccounts",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/assignAccountToAnyUser": {
+ "post": {
+ "tags": [
+ "Users"
+ ],
+ "summary": "Assigns an account to any user",
+ "description": "Permissions: hasRole('MANAGE_RIGHTS') or hasRole('SUPER_USER')",
+ "operationId": "assignAccountToAnyUser",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "accountId",
+ "in": "query",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "isMaster",
+ "in": "query",
+ "description": "isMaster",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/assignedMasterRightsDocs": {
+ "get": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Returns a map of assigned master rights documents for a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "getUsersAssignedRightsDocs",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/assignedRightsDocs": {
+ "get": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Returns a map of assigned rights documents for a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "getUsersAssignedRightsDocs2",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/bulkAssignAccountToAnyUser": {
+ "post": {
+ "tags": [
+ "Users"
+ ],
+ "summary": "Assigns an account to any user",
+ "description": "Permissions: hasRole('MANAGE_RIGHTS') or hasRole('SUPER_USER')",
+ "operationId": "assignAccountToAnyUser2",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RightsDocTable"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/children": {
+ "get": {
+ "tags": [
+ "Users"
+ ],
+ "summary": "Returns a hierarchical listing of all users that a user has access to",
+ "description": "Permissions: MANAGE_USERS or SUPER_USER role",
+ "operationId": "listAllUsersChildren",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/User"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/dashboards": {
+ "get": {
+ "tags": [
+ "User Dashboards"
+ ],
+ "summary": "Returns a listing of a dashboards for a user",
+ "description": "Permissions: Authenticated User",
+ "operationId": "getDashboardList",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Dashboard"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "User Dashboards"
+ ],
+ "summary": "Creates a new dashboard for a user",
+ "description": "Permissions: Authenticated User",
+ "operationId": "createDashboard",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Dashboard"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Dashboard"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/dashboards/{dashboardId}": {
+ "get": {
+ "tags": [
+ "User Dashboards"
+ ],
+ "summary": "Returns a dashboard for a user",
+ "description": "Permissions: Authenticated User",
+ "operationId": "getDashboardDetail",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "dashboardId",
+ "in": "path",
+ "description": "dashboardId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Dashboard"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/gateQueueEvents/{eventId}/gateQueueDtmfEvents": {
- "get": {
- "description": "Permissions: READ on Gate",
- "operationId": "getGateQueueDtmfEventList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "eventId",
- "in": "path",
- "name": "eventId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateQueueDtmfEvent"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of Gate Queue Dtmp Events for a Queue",
- "tags": [
- "Queue Events"
- ]
- },
- "post": {
- "description": "Permissions: UPDATE on Gate (Permission Override)",
- "operationId": "createGateQueueDtmfEvent",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "eventId",
- "in": "path",
- "name": "eventId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateQueueDtmfEvent"
- }
- }
- },
- "description": "postPayload",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateQueueDtmfEvent"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates a new Gate Queue Dtmp Event",
- "tags": [
- "Queue Events"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "saveGateQueueDtmfEventList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "eventId",
- "in": "path",
- "name": "eventId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateQueueDtmfEvent"
- },
- "type": "array"
- }
- }
- },
- "description": "postPayload",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateQueueDtmfEvent"
- },
- "type": "array"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a listing of Gate Queue Dtmp Events",
- "tags": [
- "Queue Events"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "User Dashboards"
+ ],
+ "summary": "Updates an existing dashboard for a user",
+ "description": "Permissions: Authenticated User",
+ "operationId": "updateDashboard",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "dashboardId",
+ "in": "path",
+ "description": "dashboardId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Dashboard"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/gateQueueEvents/{eventId}/gateQueueDtmfEvents/{dtmfEventId}": {
- "delete": {
- "description": "Permissions: UPDATE on Gate (Permission Override)",
- "operationId": "deleteGateQueueDtmfEvent",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "eventId",
- "in": "path",
- "name": "eventId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "dtmfEventId",
- "in": "path",
- "name": "dtmfEventId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Deletes a Gate Queue Dtmp Event",
- "tags": [
- "Queue Events"
- ]
- },
- "get": {
- "description": "Permissions: READ on Gate",
- "operationId": "getGateQueueDtmfEvent",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "eventId",
- "in": "path",
- "name": "eventId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "dtmfEventId",
- "in": "path",
- "name": "dtmfEventId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateQueueDtmfEvent"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a single Gate Queue Dtmp Event",
- "tags": [
- "Queue Events"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "updateGateQueueDtmfEvent",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "eventId",
- "in": "path",
- "name": "eventId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "dtmfEventId",
- "in": "path",
- "name": "dtmfEventId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateQueueDtmfEvent"
- }
- }
- },
- "description": "postPayload",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateQueueDtmfEvent"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a single Gate Queue Dtmp Event",
- "tags": [
- "Queue Events"
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Dashboard"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "User Dashboards"
+ ],
+ "summary": "Deletes a dashboard for a user",
+ "description": "Permissions: Authenticated User",
+ "operationId": "deleteDashboard",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "dashboardId",
+ "in": "path",
+ "description": "dashboardId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/dashboards/{dashboardId}/share": {
+ "put": {
+ "tags": [
+ "User Dashboards"
+ ],
+ "summary": "Creates a copy of the dashboard for each admin id supplied",
+ "description": "Permissions: Authenticated User",
+ "operationId": "shareDashboard",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "dashboardId",
+ "in": "path",
+ "description": "dashboardId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "userIds",
+ "in": "query",
+ "description": "Repeat the parameter (e.g. ?userIds=1&userIds=2) to share the dashboard with multiple users.",
+ "required": true,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ "style": "form",
+ "explode": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/effectiveAssignedRightsDocs": {
+ "get": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Returns a map of merged (master and regular) and aggregated assigned rights documents for a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "getEffectiveAssignedRightsDocForAllAccounts",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/masterRightsDocs": {
+ "get": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Returns a map of master rights documents for a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "getUsersRightsDocs",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Creates a new master rights document for a user",
+ "description": "Permissions: SUPER_USER roles",
+ "operationId": "createRightsDoc",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/masterRightsDocs/{rightsDocId}": {
+ "get": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Returns a single master rights document for a user",
+ "description": "Permissions: SUPER_USER roles",
+ "operationId": "getRightsDoc",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "rightsDocId",
+ "in": "path",
+ "description": "rightsDocId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Updates an existing master rights document for a user",
+ "description": "Permissions: SUPER_USER roles",
+ "operationId": "updateRightsDoc",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "rightsDocId",
+ "in": "path",
+ "description": "rightsDocId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Deletes an existing master rights document for a user",
+ "description": "Permissions: SUPER_USER roles",
+ "operationId": "deleteRightsDoc",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "rightsDocId",
+ "in": "path",
+ "description": "rightsDocId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "successful operation"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/ownedMasterRightsDocs": {
+ "get": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Returns a map of owned master rights documents for a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "getUsersOwnedRightsDocs",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/ownedRightsDocs": {
+ "get": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Returns a map of owned rights documents for a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "getUsersOwnedRightsDocs2",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/passwordReset": {
+ "post": {
+ "tags": [
+ "User Auth Utilities"
+ ],
+ "summary": "Resets a user's password and sends reset password email",
+ "description": "Permissions: Authenticated User",
+ "operationId": "securePasswordRequestResetForUse",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "returnPath",
+ "in": "query",
+ "description": "returnPath",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "resetViaEngageAuth",
+ "in": "query",
+ "description": "resetViaEngageAuth",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/rightsDocs": {
+ "get": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Returns a map of rights documents for a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "getRightsDocs",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/moveToGroup": {
- "post": {
- "deprecated": true,
- "description": "Permissions: UPDATE on Gate and CREATE on new Gate Group (Permission Override)",
- "operationId": "moveGateToGroup",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "newGateGroupId",
- "in": "query",
- "name": "newGateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "201": {
- "content": {
- "*/*": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Move an existing queue (AKA gate) to a new existing queue group",
- "tags": [
- "Queues"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Creates a new rights document for a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "createRightsDoc2",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
}
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/phoneBookEntries": {
- "get": {
- "description": "Permissions: READ on Gate",
- "operationId": "getGatePhoneBookEntries",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "page",
- "in": "query",
- "name": "page",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "maxRows",
- "in": "query",
- "name": "maxRows",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/PhoneBookEntry"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns all phone book entries for a queue (AKA gate)",
- "tags": [
- "Queue Phone Book"
- ]
- },
- "post": {
- "description": "Permissions: UPDATE on Gate (Permission Override)",
- "operationId": "create",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PhoneBookEntry"
- }
- }
- },
- "description": "entry",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PhoneBookEntry"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates a phone book entry for a queue (AKA gate)",
- "tags": [
- "Queue Phone Book"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "updateGatePhoneBookEntries",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/PhoneBookEntry"
- },
- "type": "array"
- }
- }
- },
- "description": "entries",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/PhoneBookEntry"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a listing of phone book entries for a queue (AKA gate)",
- "tags": [
- "Queue Phone Book"
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
}
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/phoneBookEntries/{entryId}": {
- "delete": {
- "description": "Permissions: UPDATE on Gate (Permission Override)",
- "operationId": "delete",
- "parameters": [
- {
- "description": "entryId",
- "in": "path",
- "name": "entryId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Deletes a single phone book entry for a queue (AKA gate)",
- "tags": [
- "Queue Phone Book"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "updatePhoneBookEntry",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "entryId",
- "in": "path",
- "name": "entryId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PhoneBookEntry"
- }
- }
- },
- "description": "entry",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PhoneBookEntry"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a phone book entry for a queue (AKA gate)",
- "tags": [
- "Queue Phone Book"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/rightsDocs/{rightsDocId}": {
+ "get": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Returns a single rights document for a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "getRightsDoc2",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "rightsDocId",
+ "in": "path",
+ "description": "rightsDocId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Updates an existing rights document for a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "updateRightsDoc2",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "rightsDocId",
+ "in": "path",
+ "description": "rightsDocId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Deletes an existing rights document for a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "deleteRightsDoc2",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "rightsDocId",
+ "in": "path",
+ "description": "rightsDocId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "successful operation"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/rightsDocsWithSubAccounts": {
+ "get": {
+ "tags": [
+ "Rights Documents"
+ ],
+ "summary": "Returns a map of rights documents for a user",
+ "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
+ "operationId": "getUsersRightsDocsByMasterDoc",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "enablePreBuiltRoles",
+ "in": "query",
+ "description": "enablePreBuiltRoles",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RightsDocument"
+ }
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/roles": {
+ "get": {
+ "tags": [
+ "User Roles"
+ ],
+ "summary": "Returns a listing of roles for a user",
+ "description": "Permissions: MANAGE_USERS or SUPER_USER roles",
+ "operationId": "getRoles",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "SUPER_USER",
+ "USER",
+ "MANAGE_USERS",
+ "MANAGE_RIGHTS",
+ "ACCESS_SIBLINGS",
+ "ACCESS_AUDIT_LOG",
+ "ASSUME_USERS",
+ "REPORT_ADMINISTRATIVE_USER",
+ "WFO_ACCESS",
+ "ACCESS_GOODDATA_EDITOR",
+ "ACCESS_GOODDATA_ANALYST",
+ "ACCESS_GOODDATA_VIEWER",
+ "NO_ACCESS"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/roles/{roleType}": {
+ "post": {
+ "tags": [
+ "User Roles"
+ ],
+ "summary": "Adds a role to a user",
+ "description": "Permissions: MANAGE_USERS or SUPER_USER roles",
+ "operationId": "addRole",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "roleType",
+ "in": "path",
+ "description": "roleType",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "User Roles"
+ ],
+ "summary": "Removes a role from a user",
+ "description": "Permissions: MANAGE_USERS or SUPER_USER roles",
+ "operationId": "removeRole",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "roleType",
+ "in": "path",
+ "description": "roleType",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/users/{userId}/setIsActive": {
+ "put": {
+ "tags": [
+ "Users"
+ ],
+ "summary": "Set user is active",
+ "description": "Permissions: Authenticated User",
+ "operationId": "setUserIsActive",
+ "parameters": [
+ {
+ "name": "userId",
+ "in": "path",
+ "description": "userId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ActiveStateBoolean"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/auth/isTokenValid": {
+ "get": {
+ "tags": [
+ "User Auth Utilities"
+ ],
+ "summary": "Checks to see if a given token is valid",
+ "description": "Permissions: NONE",
+ "operationId": "isTokenValid",
+ "parameters": [
+ {
+ "name": "token",
+ "in": "query",
+ "description": "token",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/auth/passwordReset": {
+ "post": {
+ "tags": [
+ "User Auth Utilities"
+ ],
+ "summary": "Used to reset a users password",
+ "description": "Permissions: NONE",
+ "operationId": "passwordReset",
+ "parameters": [
+ {
+ "name": "token",
+ "in": "query",
+ "description": "token",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "password",
+ "in": "query",
+ "description": "password",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/auth/passwordResetRequest": {
+ "post": {
+ "tags": [
+ "User Auth Utilities"
+ ],
+ "summary": "Resets a password if a user is locked out, an email will be sent to the user",
+ "description": "Permissions: NONE",
+ "operationId": "passwordResetRequest",
+ "parameters": [
+ {
+ "name": "userName",
+ "in": "query",
+ "description": "userName",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "returnPath",
+ "in": "query",
+ "description": "returnPath",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/agent-states/subscriptions": {
+ "get": {
+ "tags": [
+ "Agent State Subscriptions"
+ ],
+ "summary": "List agent state subscriptions",
+ "description": "Permissions: WFO_ACCESS role",
+ "operationId": "getAllSubscriptions",
+ "parameters": [
+ {
+ "name": "rcAccountId",
+ "in": "path",
+ "description": "rcAccountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "subAccountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RTASubscriptionResponse"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Agent State Subscriptions"
+ ],
+ "summary": "Create agent state subscription",
+ "description": "Permissions: WFO_ACCESS role",
+ "operationId": "subscribe",
+ "parameters": [
+ {
+ "name": "rcAccountId",
+ "in": "path",
+ "description": "rcAccountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "subAccountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RTASubscriptionRequest"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RTASubscriptionResponse"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/agent-states/subscriptions/{subscriptionId}": {
+ "put": {
+ "tags": [
+ "Agent State Subscriptions"
+ ],
+ "summary": "Update agent state subscription",
+ "description": "Permissions: WFO_ACCESS role",
+ "operationId": "updateSubscription",
+ "parameters": [
+ {
+ "name": "rcAccountId",
+ "in": "path",
+ "description": "rcAccountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "subAccountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "subscriptionId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RTASubscriptionRequest"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RTASubscriptionResponse"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/requeueShortcuts": {
- "get": {
- "description": "Permissions: READ on Gate",
- "operationId": "getGateRequeueShortcutList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/RequeueShortcut"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of requeue shortcuts for a queue (AKA gate)",
- "tags": [
- "Requeue Shortcuts"
- ]
- },
- "post": {
- "description": "Permissions: UPDATE on Gate (Override Permission Request)",
- "operationId": "createGateRequeueShortcut",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RequeueShortcut"
- }
- }
- },
- "description": "shortcut",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RequeueShortcut"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a requeue shortcut for a queue (AKA gate)",
- "tags": [
- "Requeue Shortcuts"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "createGateRequeueShortcuts",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/RequeueShortcut"
- },
- "type": "array"
- }
- }
- },
- "description": "shortcuts",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/RequeueShortcut"
- },
- "type": "array"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates a list of requeue shortcuts for a queue (AKA gate)",
- "tags": [
- "Requeue Shortcuts"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Agent State Subscriptions"
+ ],
+ "summary": "Delete agent state subscription",
+ "description": "Permissions: WFO_ACCESS role",
+ "operationId": "deleteSubscription",
+ "parameters": [
+ {
+ "name": "rcAccountId",
+ "in": "path",
+ "description": "rcAccountId",
+ "required": true,
+ "schema": {
+ "type": "string"
}
+ },
+ {
+ "name": "subAccountId",
+ "in": "path",
+ "description": "subAccountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "subscriptionId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "default": {
+ "description": "successful operation"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/requeueShortcuts/{requeueShortcutId}": {
- "delete": {
- "description": "Permissions: UPDATE on Gate (Permission Override)",
- "operationId": "deleteGateRequeueShortcut",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "requeueShortcutId",
- "in": "path",
- "name": "requeueShortcutId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "*/*": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of requeue shortcuts for a queue (AKA gate)",
- "tags": [
- "Requeue Shortcuts"
- ]
- },
- "get": {
- "description": "Permissions: READ on Gate",
- "operationId": "getGateRequeueShortcut",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "requeueShortcutId",
- "in": "path",
- "name": "requeueShortcutId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RequeueShortcut"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a requeue shortcut for a queue (AKA gate)",
- "tags": [
- "Requeue Shortcuts"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "updateGateRequeueShortcut",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "requeueShortcutId",
- "in": "path",
- "name": "requeueShortcutId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RequeueShortcut"
- }
- }
- },
- "description": "requeueShortcut",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RequeueShortcut"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a requeue shortcut for a queue (AKA gate)",
- "tags": [
- "Requeue Shortcuts"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups": {
+ "get": {
+ "tags": [
+ "Cloud Route Destination Groups"
+ ],
+ "summary": "Returns a listing of cloud route groups for an account",
+ "description": "Permissions: READ on Account, Post Filtered Results",
+ "operationId": "getCloudRouteDestinationGroupList",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteGroup"
+ }
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/scheduleOverrides": {
- "get": {
- "description": "Permissions: READ on Gate",
- "operationId": "getOverridesForGate",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateScheduleOverride"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of schedule overrides for a queue (AKA gate)",
- "tags": [
- "Queue Schedule"
- ]
- },
- "post": {
- "description": "Permissions: UPDATE on Gate (Permission Override)",
- "operationId": "createGateScheduledOverride",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateScheduleOverride"
- }
- }
- },
- "description": "scheduleOverride",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateScheduleOverride"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates a schedule override for a queue (AKA gate)",
- "tags": [
- "Queue Schedule"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "saveList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateScheduleOverride"
- },
- "type": "array"
- }
- }
- },
- "description": "scheduleOverrides",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateScheduleOverride"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Saves a listing of schedule overrides for a queue (AKA gate)",
- "tags": [
- "Queue Schedule"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Cloud Route Destination Groups"
+ ],
+ "summary": "Create a cloud route group for an account",
+ "description": "Permissions: CREATE on Account",
+ "operationId": "createCloudRouteGroup",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteGroup"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteGroup"
+ }
+ }
}
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/scheduleOverrides/{scheduleOverrideId}": {
- "delete": {
- "description": "Permissions: UPDATE on Gate (Permission Override)",
- "operationId": "deleteGateScheduledOverride",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "scheduleOverrideId",
- "in": "path",
- "name": "scheduleOverrideId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Deletes a schedule override for a queue (AKA gate)",
- "tags": [
- "Queue Schedule"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "updateGateScheduledOverride",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "scheduleOverrideId",
- "in": "path",
- "name": "scheduleOverrideId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateScheduleOverride"
- }
- }
- },
- "description": "scheduleOverride",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateScheduleOverride"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a schedule override for a queue (AKA gate)",
- "tags": [
- "Queue Schedule"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/withChildren": {
+ "get": {
+ "tags": [
+ "Cloud Route Destination Groups"
+ ],
+ "summary": "Returns a listing of cloud route groups with related data for an account",
+ "description": "Permissions: READ on Account, Post Filtered Results",
+ "operationId": "getListWithProfileChildren",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "includePermissions",
+ "in": "query",
+ "description": "includePermissions",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteGroup"
+ }
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/setIsActive": {
- "put": {
- "description": "Permissions: UPDATE on Gate",
- "operationId": "setGateIsActive",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ActiveState_boolean_"
- }
- }
- },
- "description": "state",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "*/*": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Set queue (AKA gate) active state",
- "tags": [
- "Queues"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}": {
+ "get": {
+ "tags": [
+ "Cloud Route Destination Groups"
+ ],
+ "summary": "Returns a cloud route group for an account",
+ "description": "Permissions: READ on Cloud Route Group",
+ "operationId": "getCloudRouteDestinationGroupsCloudRouteGroupId",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteGroup"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/specialAnis": {
- "delete": {
- "description": "Permissions: UPDATE on Gate (Permission Override)",
- "operationId": "deleteSpecialAni",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "type",
- "in": "query",
- "name": "type",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "ani",
- "in": "query",
- "name": "ani",
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "*/*": {
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Deletes a special ani for a queue (AKA gate)",
- "tags": [
- "Queue Special ANI"
- ]
- },
- "get": {
- "description": "Permissions: READ on Gate",
- "operationId": "getGateSpecialAniList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "type",
- "in": "query",
- "name": "type",
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "filter",
- "in": "query",
- "name": "filter",
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "page",
- "in": "query",
- "name": "page",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "maxRows",
- "in": "query",
- "name": "maxRows",
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateSpecialAni"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of special anis for a queue (AKA gate)",
- "tags": [
- "Queue Special ANI"
- ]
- },
- "post": {
- "description": "Permissions: UPDATE on Gate (Permission Override)",
- "operationId": "createGateSpecialAni",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateSpecialAni"
- }
- }
- },
- "description": "gateSpecialAni",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateSpecialAni"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates a special ani for a queue (AKA gate)",
- "tags": [
- "Queue Special ANI"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Cloud Route Destination Groups"
+ ],
+ "summary": "Updates a cloud route group for an account",
+ "description": "Permissions: UPDATE on Cloud Route Group",
+ "operationId": "updateCloudRouteGroup",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteGroup"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteGroup"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Cloud Route Destination Groups"
+ ],
+ "summary": "Deletes a cloud route group for an account",
+ "description": "Permissions: DELETE on Cloud Route Group",
+ "operationId": "deleteCloudRouteGroup",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations": {
+ "get": {
+ "tags": [
+ "Cloud Route Destinations"
+ ],
+ "summary": "Returns a listing of cloud destinations for a cloud route group",
+ "description": "Permissions: READ on Cloud Destination, Post Filtered Results",
+ "operationId": "getCloudRouteDestinationList",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteDestination"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Cloud Route Destinations"
+ ],
+ "summary": "Create a cloud destination for a cloud route group",
+ "description": "Permissions: CREATE on Cloud Destination",
+ "operationId": "createCloudRouteDestination",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDestination"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDestination"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/withChildren": {
+ "get": {
+ "tags": [
+ "Cloud Route Destinations"
+ ],
+ "summary": "Returns a listing of cloud destinations with related data for a cloud route group",
+ "description": "Permissions: READ on Cloud Destinations, Post Filtered Results",
+ "operationId": "getListWithChildren",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "includePermissions",
+ "in": "query",
+ "description": "includePermissions",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteDestination"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}": {
+ "get": {
+ "tags": [
+ "Cloud Route Destinations"
+ ],
+ "summary": "Returns a cloud destination for a cloud route group",
+ "description": "Permissions: READ on Cloud Destination",
+ "operationId": "getCloudRouteDestination",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDestination"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Cloud Route Destinations"
+ ],
+ "summary": "Updates a cloud destination for a cloud route group",
+ "description": "Permissions: UPDATE on Cloud Destination",
+ "operationId": "updateCloudRouteDestination",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDestination"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDestination"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}/assignedProfiles": {
+ "get": {
+ "tags": [
+ "Cloud Route Assignments"
+ ],
+ "summary": "Returns a listing of assigned profiles for a cloud route destination",
+ "description": "Permissions: READ on Cloud Destination",
+ "operationId": "getListByDestination",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Cloud Route Assignments"
+ ],
+ "summary": "Creates an assigned profile for a cloud route destination",
+ "description": "Permissions: UPDATE on Cloud Destination (Permissions Override)",
+ "operationId": "createCloudAssignedDestination",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}/assignedProfiles/{cloudAssignedDestinationId}": {
+ "get": {
+ "tags": [
+ "Cloud Route Assignments"
+ ],
+ "summary": "Returns an assigned profile for a cloud route destination",
+ "description": "Permissions: READ on Cloud Destination",
+ "operationId": "getCloudRouteDestinationGroupsCloudRouteGroupIdCloudRouteDestinationsCloudRouteDestinationIdAssignedProfilesCloudAssignedDestinationId",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ },
+ {
+ "name": "cloudAssignedDestinationId",
+ "in": "path",
+ "description": "cloudAssignedDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/specialAnis/upload": {
- "post": {
- "description": "Permissions: UPDATE on Gate (Permission Override)",
- "operationId": "uploadSpecialAniList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "operation",
- "in": "query",
- "name": "operation",
- "schema": {
- "default": "APPEND",
- "type": "string"
- }
- },
- {
- "description": "type",
- "in": "query",
- "name": "type",
- "required": true,
- "schema": {
- "enum": [
- "S-ANI",
- "THROTTLE"
- ],
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "content": {
- "multipart/form-data": {
- "schema": {
- "properties": {
- "file": {
- "description": "file",
- "format": "binary",
- "type": "string"
- }
- },
- "required": [
- "file"
- ],
- "type": "object"
- }
- }
- }
- },
- "responses": {
- "200": {
- "content": {
- "text/plain": {
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Uploads a special ani for a queue (AKA gate)",
- "tags": [
- "Queue Special ANI"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Cloud Route Assignments"
+ ],
+ "summary": "Updates an assigned profile for a cloud route destination",
+ "description": "Permissions: UPDATE on Cloud Destination",
+ "operationId": "updateCloudAssignedDestination",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudAssignedDestinationId",
+ "in": "path",
+ "description": "cloudAssignedDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/gates/{gateId}/unassignAgent/{agentId}": {
- "delete": {
- "description": "Permissions: UPDATE on Gate (Permission Override), READ on agent",
- "operationId": "unassignAgentFromGate",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "gateId",
- "in": "path",
- "name": "gateId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "agentId",
- "in": "path",
- "name": "agentId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "*/*": {
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- },
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Unassigns a single agent from a queue (AKA gate)",
- "tags": [
- "Agents"
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/skills": {
- "get": {
- "description": "Permissions: READ on Gate Group",
- "operationId": "getList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateGroupSkill"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a listing of skills for a queue group (AKA gate group)",
- "tags": [
- "Queue Skills"
- ]
- },
- "post": {
- "description": "Permissions: UPDATE on Gate Group (Permission Override)",
- "operationId": "createGateGroupSkill",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateGroupSkill"
- }
- }
- },
- "description": "skill",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateGroupSkill"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates a skill for a queue group (AKA gate group)",
- "tags": [
- "Queue Skills"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate Group",
- "operationId": "saveGateGroupSkillList",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateGroupSkill"
- },
- "type": "array"
- }
- }
- },
- "description": "skills",
- "required": true
- },
- "responses": {
- "201": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "$ref": "#/components/schemas/GateGroupSkill"
- },
- "type": "array"
- }
- }
- },
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Cloud Route Assignments"
+ ],
+ "summary": "Deletes an assigned profile for a cloud route destination",
+ "description": "Permissions: UPDATE on Cloud Destination (Permissions Override)",
+ "operationId": "deleteCloudAssignedDestination",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudAssignedDestinationId",
+ "in": "path",
+ "description": "cloudAssignedDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}/clone": {
+ "post": {
+ "tags": [
+ "Cloud Route Destinations"
+ ],
+ "summary": "Creates a clone of the cloud route destination for a cloud group",
+ "description": "Permissions: READ on existing Cloud Route Destination and CREATE on Cloud Group (Permission Override)",
+ "operationId": "cloneCloudRouteDestination",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "newDestinationName",
+ "in": "query",
+ "description": "newDestinationName",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDestination"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}/dnisOverrides": {
+ "get": {
+ "tags": [
+ "Cloud Route DNIS Overrides"
+ ],
+ "summary": "Returns a listing of dnis overrides for a cloud route destination",
+ "description": "Permissions: READ on Cloud Destination",
+ "operationId": "getDnisOverrideList",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteDestinationOverride"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Cloud Route DNIS Overrides"
+ ],
+ "summary": "Create a dnis override for a cloud route destination",
+ "description": "Permissions: UPDATE on Cloud Destination (Permission Override)",
+ "operationId": "createDnisOverride",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudDestinationType",
+ "in": "query",
+ "description": "cloudDestinationType",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "STANDARD",
+ "DID",
+ "SIP",
+ "IN_NETWORK_DID",
+ "ACD",
+ "IVR",
+ "IVR_STUDIO"
+ ]
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDestinationOverride"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDestinationOverride"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}/dnisOverrides/batch": {
+ "post": {
+ "tags": [
+ "Cloud Route DNIS Overrides"
+ ],
+ "summary": "Create a list dnis overrides for a cloud route destination",
+ "description": "Permissions: UPDATE on Cloud Destination (Permission Override)",
+ "operationId": "createDnisOverrideBatch",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "replaceAll",
+ "in": "query",
+ "description": "replaceAll",
+ "required": true,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "phoneNumbersI18nEnabled",
+ "in": "query",
+ "description": "phoneNumbersI18nEnabled",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteDestinationOverride"
+ }
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "file": {
+ "type": "string",
+ "format": "binary",
+ "description": "DNIS override upload file."
+ }
},
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates an existing list of skills for a queue group (AKA gate group)",
- "tags": [
- "Queue Skills"
+ "required": [
+ "file"
]
+ }
+ }
+ },
+ "description": "Delimited file containing DNIS overrides for the cloud route destination."
+ }
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}/dnisOverrides/{cloudRouteDestinationOverrideId}": {
+ "get": {
+ "tags": [
+ "Cloud Route DNIS Overrides"
+ ],
+ "summary": "Returns a dnis override for a cloud route destination",
+ "description": "Permissions: READ on Cloud Destination",
+ "operationId": "getCloudRouteDestinationOverride",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationOverrideId",
+ "in": "path",
+ "description": "cloudRouteDestinationOverrideId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDestinationOverride"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Cloud Route DNIS Overrides"
+ ],
+ "summary": "Updates a dnis override for a cloud route destination",
+ "description": "Permissions: UPDATE on Cloud Destination",
+ "operationId": "updateCloudRouteDestinationOverride",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationOverrideId",
+ "in": "path",
+ "description": "cloudRouteDestinationOverrideId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudDestinationType",
+ "in": "query",
+ "description": "cloudDestinationType",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "STANDARD",
+ "DID",
+ "SIP",
+ "IN_NETWORK_DID",
+ "ACD",
+ "IVR",
+ "IVR_STUDIO"
+ ]
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDestinationOverride"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDestinationOverride"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Cloud Route DNIS Overrides"
+ ],
+ "summary": "Deletes a dnis override for a cloud route destination",
+ "description": "Permissions: UPDATE on Cloud Destination (Permission Override)",
+ "operationId": "deleteCloudRoute",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationOverrideId",
+ "in": "path",
+ "description": "cloudRouteDestinationOverrideId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}/setIsActive": {
+ "put": {
+ "tags": [
+ "Cloud Route Destinations"
+ ],
+ "summary": "Set active state for a cloud route destination",
+ "description": "Permissions: UPDATE on Cloud Destination",
+ "operationId": "setCloudRouteDestinationIsActive",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteDestinationId",
+ "in": "path",
+ "description": "cloudRouteDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ActiveStateBoolean"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/withChildren": {
+ "get": {
+ "tags": [
+ "Cloud Route Profile Groups"
+ ],
+ "summary": "Returns a listing of Cloud Route Groups with children for an Account",
+ "description": "Permissions: READ on Account, Post Filtered Results",
+ "operationId": "getListWithProfileChildren2",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "includePermissions",
+ "in": "query",
+ "description": "includePermissions",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteGroup"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}": {
+ "get": {
+ "tags": [
+ "Cloud Route Profile Groups"
+ ],
+ "summary": "Returns a single Cloud Route Group",
+ "description": "Permissions: READ on Cloud Route Group",
+ "operationId": "getCloudRouteProfileGroupsCloudRouteGroupId",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteGroup"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Cloud Route Profile Groups"
+ ],
+ "summary": "Updates a single Cloud Route Group",
+ "description": "Permissions: UPDATE on Cloud Route Group",
+ "operationId": "updateCloudRouteGroup2",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteGroup"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteGroup"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Cloud Route Profile Groups"
+ ],
+ "summary": "Deletes a specific Cloud Route Group",
+ "description": "Permissions: DELETE on Cloud Route Group",
+ "operationId": "deleteCloudRouteGroup2",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles": {
+ "get": {
+ "tags": [
+ "Cloud Route Profiles"
+ ],
+ "summary": "Returns a listing of cloud route profiles for a cloud group",
+ "description": "Permissions: READ on Cloud Group, Post Filtered Results",
+ "operationId": "getCloudRouteProfileList",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteProfile"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Cloud Route Profiles"
+ ],
+ "summary": "Create a cloud route profile for a cloud group",
+ "description": "Permissions: CREATE on Cloud Group",
+ "operationId": "createCloudRouteProfile",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteProfile"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteProfile"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudProfileId}": {
+ "get": {
+ "tags": [
+ "Cloud Route Profiles"
+ ],
+ "summary": "Returns a cloud route profile for a cloud group",
+ "description": "Permissions: READ on Cloud Group",
+ "operationId": "getCloudRouteProfile",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ },
+ {
+ "name": "cloudProfileId",
+ "in": "path",
+ "description": "cloudProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteProfile"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/gateGroups/{gateGroupId}/skills/{skillId}": {
- "delete": {
- "description": "Permissions: UPDATE on Gate Group (Permission Override)",
- "operationId": "deleteGateGroupSkill",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "skillId",
- "in": "path",
- "name": "skillId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "*/*": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Deletes a skill for a queue group (AKA gate group)",
- "tags": [
- "Queue Skills"
- ]
- },
- "get": {
- "description": "Permissions: READ on Gate Group",
- "operationId": "getDetail",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "skillId",
- "in": "path",
- "name": "skillId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateGroupSkill"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a skill for a queue group (AKA gate group)",
- "tags": [
- "Queue Skills"
- ]
- },
- "put": {
- "description": "Permissions: UPDATE on Gate Group",
- "operationId": "updateGateGroupSkill",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "description": "gateGroupId",
- "in": "path",
- "name": "gateGroupId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- },
- {
- "description": "skillId",
- "in": "path",
- "name": "skillId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateGroupSkill"
- }
- }
- },
- "description": "skill",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GateGroupSkill"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates a skill for a queue group (AKA gate group)",
- "tags": [
- "Queue Skills"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}": {
+ "put": {
+ "tags": [
+ "Cloud Route Profiles"
+ ],
+ "summary": "Updates a cloud route profile for a cloud group",
+ "description": "Permissions: UPDATE on Cloud Profile",
+ "operationId": "updateCloudRouteProfile",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteProfile"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v1/admin/reports/{reportType}": {
- "get": {
- "description": "Permissions: Authenticated User",
- "operationId": "getReportCriteriaTemplate",
- "parameters": [
- {
- "description": "reportType",
- "in": "path",
- "name": "reportType",
- "required": true,
- "schema": {
- "enum": [
- "DIALER_RESULT_DOWNLOAD",
- "GLOBAL_CALL_TYPE_EXCEL",
- "GLOBAL_CALL_TYPE_DELIMITED",
- "ALL_CALLS",
- "IVR_DETAIL",
- "TFN_DID_MANAGER_SUPERUSER_EXCEL",
- "TFN_DID_MANAGER_EXCEL",
- "TFN_DID_MANAGER_DELIMITED",
- "CASPER_REPORT"
- ],
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ReportCriteria"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- },
- "500": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- }
- }
- },
- "description": "Unexpected error"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Returns a report criteria definition for a report type",
- "tags": [
- "Reporting"
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteProfile"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/token": {
- "get": {
- "description": "Permissions: Authenticated User",
- "operationId": "getApiTokensForLoggedInUser",
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- }
- },
- "description": "OK"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Retrieves all Api Tokens for AuthenticatedUser",
- "tags": [
- "Legacy Auth"
- ]
- },
- "post": {
- "description": "Permissions: Authenticated User",
- "operationId": "createApiTokenForLoggedInUser",
- "responses": {
- "200": {
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- },
- "description": "OK"
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates a new 'Api Token' based AuthenticatedUser that does not expire",
- "tags": [
- "Legacy Auth"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations": {
+ "get": {
+ "tags": [
+ "Cloud Route Assignments"
+ ],
+ "summary": "Returns a listing of assigned destinations for a cloud route profile",
+ "description": "Permissions: READ on Cloud Profile",
+ "operationId": "getCloudAssignedDestinationList",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/token/{token}": {
- "delete": {
- "description": "Permissions: Anonymous User",
- "operationId": "removeApiToken",
- "parameters": [
- {
- "description": "token",
- "in": "path",
- "name": "token",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "content": {
- "text/plain": {
- "schema": {
- "type": "boolean"
- }
- }
- },
- "description": "OK"
- },
- "204": {
- "description": "No Content"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- }
- },
- "security": [
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- },
- {
- "BearerAuth": []
- }
- ],
- "summary": "Removes an api token",
- "tags": [
- "Legacy Auth"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Cloud Route Assignments"
+ ],
+ "summary": "Creates an assigned destination for a cloud route profile",
+ "description": "Permissions: CREATE on Cloud Profile",
+ "operationId": "createCloudAssignedDestination2",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v1/admin/users": {
- "get": {
- "tags": [
- "Users"
- ],
- "summary": "Returns a listing of all users that a user has access to",
- "description": "Permissions: MANAGE_USERS or SUPER_USER role",
- "operationId": "listAllUsers",
- "parameters": [
- {
- "name": "activeOnly",
- "in": "query",
- "description": "activeOnly",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- },
- {
- "name": "flatten",
- "in": "query",
- "description": "flatten",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "post": {
- "tags": [
- "Users"
- ],
- "summary": "Creates a single new user",
- "description": "Permissions: MANAGE_USERS or SUPER_USER role",
- "operationId": "createUser",
- "parameters": [
- {
- "name": "parentUserId",
- "in": "query",
- "description": "parentUserId",
- "required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "returnUri",
- "in": "query",
- "description": "returnUri",
- "required": false,
- "schema": {
- "type": "string",
- "format": "uri"
- }
- },
- {
- "name": "isSSO",
- "in": "query",
- "description": "isSSO",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AdminUserRequest"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
}
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/auth/login": {
- "post": {
- "tags": [
- "Legacy Auth"
- ],
- "summary": "Application login to authenticate and receive an X-Auth-Token",
- "description": "Permissions: Anonymous User",
- "operationId": "doLogin",
- "parameters": [
- {
- "name": "username",
- "in": "query",
- "description": "username",
- "required": false,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "password",
- "in": "query",
- "description": "password",
- "required": false,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "stayLoggedIn",
- "in": "query",
- "description": "stayLoggedIn",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UserLoginView"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations/batch": {
+ "put": {
+ "tags": [
+ "Cloud Route Assignments"
+ ],
+ "summary": "Updates a list of assigned destinations for a cloud route profile",
+ "description": "Permissions: UPDATE on Cloud Profile",
+ "operationId": "batchUpdateCloudAssignedDestinations",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
}
+ },
+ "required": false
},
- "/voice/api/integration/v1/admin/users/{mainAccountId}": {
- "get": {
- "tags": [
- "Integration User Controller"
- ],
- "summary": "Returns a listing of all users that a user has access to",
- "description": "Permissions: WFO_ACCESS role",
- "operationId": "getUserList",
- "parameters": [
- {
- "name": "mainAccountId",
- "in": "path",
- "description": "Main Account Id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "99990033"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/User"
- }
- },
- "example": [
- {
- "rcUserId": 1009,
- "userId": 3289,
- "engageUserName": "jane.doe+wfo1@ringcentral.com",
- "userName": "jane.doe+wfo1+eo1@ringcentral.com",
- "email": "jane.doe@ringcentral.com",
- "firstName": "Jane",
- "lastName": "Doe",
- "parentPath": "2181.2979.2983.3064",
- "envID": "eo1"
- },
- {
- "rcUserId": 1010,
- "userId": 3290,
- "engageUserName": "joe.doe+wfo1@ringcentral.com",
- "userName": "joe.doe+wfo1+eo1@ringcentral.com",
- "email": "joe.doe@ringcentral.com",
- "firstName": "Joe",
- "lastName": "Doe",
- "parentPath": "2181.2979.2983.3064",
- "envID": "eo1"
- }
- ]
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "The supplied data is not valid",
- "generalMessage": "The supplied data is not valid",
- "requestUri": "voice/api/integration/v1/admin/users/99990033 - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- },
- "example": "Jwt is expired"
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "generalMessage": "You do not have permission to access this resource",
- "details": "",
- "developerMessage": "Access is denied",
- "cause": "",
- "requestUri": "voice/api/integration/v1/admin/users/99990033 - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "The resource you have requested does not exist",
- "generalMessage": "The resource you have requested does not exist",
- "requestUri": "voice/api/integration/v1/admin/users/99990033 - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "An Internal Server Error occurred while processing this request",
- "generalMessage": "An Internal Server Error occurred while processing this request",
- "requestUri": "voice/api/integration/v1/admin/users/99990033 - GET",
- "timestamp": 1611847650696
- }
- }
- }
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations/percentAllocationHours/export": {
+ "post": {
+ "tags": [
+ "Cloud Route Assignments"
+ ],
+ "summary": "Exports the percent allocations for a list of assigned destinations for a cloud route profile",
+ "description": "Permissions: READ on Cloud Profile (Permission Override)",
+ "operationId": "exportPercentAllocationHours",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ },
+ "default": {
+ "description": "successful operation"
+ }
},
- "/voice/api/integration/v1/admin/accounts/{mainAccountId}/subaccounts": {
- "get": {
- "tags": [
- "Integration Account Controller"
- ],
- "summary": "Returns a listing of sub accounts by Engage Voice Main account identifier",
- "description": "Permissions: WFO_ACCESS role",
- "operationId": "getSubAccountsByMainAccountId",
- "parameters": [
- {
- "name": "mainAccountId",
- "in": "path",
- "description": "Main Account Id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "99990033"
- }
- }
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations/percentAllocationHours/import": {
+ "post": {
+ "tags": [
+ "Cloud Route Assignments"
+ ],
+ "summary": "Updates the percent allocations for a list of assigned destinations for a cloud route profile",
+ "description": "Permissions: UPDATE on Cloud Profile (Permission Override)",
+ "operationId": "importPercentAllocationHours",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "extension",
+ "in": "query",
+ "description": "Delimiter used in the uploaded allocation-hours file.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "PIPE",
+ "COMMA",
+ "TAB"
+ ]
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Allocation-hours file exported from the matching `percentAllocationHours/export` endpoint and edited offline.",
+ "required": true,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "file"
],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/SubAccount"
- },
- "example": [
- {
- "subAccountId": "15910001",
- "subAccountName": "Cappuccino Engage Development",
- "isActive": true
- },
- {
- "subAccountId": "15910006",
- "subAccountName": "Cappuccino Engage Development",
- "isActive": true
- }
- ]
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "The supplied data is not valid",
- "generalMessage": "The supplied data is not valid",
- "requestUri": "voice/api/integration/v1/admin/accounts/99990033/subaccounts - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- },
- "example": "Jwt is expired"
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "generalMessage": "You do not have permission to access this resource",
- "details": "",
- "developerMessage": "Access is denied",
- "cause": "",
- "requestUri": "voice/api/integration/v1/admin/accounts/99990033/subaccounts - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "The resource you have requested does not exist",
- "generalMessage": "The resource you have requested does not exist",
- "requestUri": "voice/api/integration/v1/admin/accounts/99990033/subaccounts - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "An Internal Server Error occurred while processing this request",
- "generalMessage": "An Internal Server Error occurred while processing this request",
- "requestUri": "voice/api/integration/v1/admin/accounts/99990033/subaccounts - GET",
- "timestamp": 1611847650696
- }
- }
- }
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "properties": {
+ "file": {
+ "type": "string",
+ "format": "binary",
+ "description": "Updated allocation-hours file."
+ }
+ }
+ }
}
+ }
},
- "/voice/api/integration/v1/admin/accounts/{subAccountId}/agentGroups/{agentGroupId}/agents": {
- "get": {
- "tags": [
- "Integration Agent Controller"
- ],
- "summary": "Returns a list of read only agents for an agent group",
- "description": "Permissions: WFO_ACCESS role",
- "operationId": "getAgentList",
- "parameters": [
- {
- "name": "subAccountId",
- "in": "path",
- "description": "Engage Voice sub-account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "99990033"
- }
- },
- {
- "name": "agentGroupId",
- "in": "path",
- "description": "Agent Group Id",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32",
- "example": 30
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Agent"
- },
- "example": [
- {
- "rcUserId": 1009,
- "agentId": 1386703,
- "agentGroupId": 30,
- "firstName": "Jane",
- "lastName": "Doe",
- "engageUserName": "jane.doe+wfo1@ringcentral.com",
- "userName": "jane.doe+wfo1+eo1@ringcentral.com",
- "email": "jane.doe@ringcentral.com",
- "agentType": "SUPERVISOR",
- "isActive": true,
- "supervisorAgentIds": [
- 1386605,
- 1386600
- ],
- "superviseeAgentIds": [
- 1386804,
- 1386905
- ],
- "envID": "eo1"
- },
- {
- "rcUserId": 1010,
- "agentId": 1389175,
- "agentGroupId": 30,
- "firstName": "Joe",
- "lastName": "Doe",
- "userName": "Joe.D+15910001_172+eo1@c1.local",
- "engageUserName": "Joe.D+15910001_172@c1.local",
- "email": "joe.d@ringcentral.com",
- "agentType": "AGENT",
- "isActive": true,
- "supervisorAgentIds": [
- 1386605
- ],
- "superviseeAgentIds": [],
- "envID": "eo1"
- }
- ]
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "The supplied data is not valid",
- "generalMessage": "The supplied data is not valid",
- "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups/30/agents - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- },
- "example": "Jwt is expired"
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "generalMessage": "You do not have permission to access this resource",
- "details": "",
- "developerMessage": "Access is denied",
- "cause": "",
- "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups/30/agents - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "The resource you have requested does not exist",
- "generalMessage": "The resource you have requested does not exist",
- "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups/30/agents - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "An Internal Server Error occurred while processing this request",
- "generalMessage": "An Internal Server Error occurred while processing this request",
- "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups/30/agents - GET",
- "timestamp": 1611847650696
- }
- }
- }
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/integration/v1/admin/accounts/{subAccountId}/agentGroups": {
- "get": {
- "tags": [
- "Integration Agent Group Controller"
- ],
- "summary": "Returns a list of agent groups for a sub-account",
- "description": "Permissions: WFO_ACCESS role",
- "operationId": "getAgentGroups",
- "parameters": [
- {
- "name": "subAccountId",
- "in": "path",
- "description": "Engage Voice sub-account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "99990033"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AgentGroup"
- },
- "example": [
- {
- "agentGroupId": 1009,
- "groupName": "Team A1"
- },
- {
- "agentGroupId": 1010,
- "groupName": "Team A2"
- }
- ]
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "The supplied data is not valid",
- "generalMessage": "The supplied data is not valid",
- "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- },
- "example": "Jwt is expired"
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "generalMessage": "You do not have permission to access this resource",
- "details": "",
- "developerMessage": "Access is denied",
- "cause": "",
- "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "The resource you have requested does not exist",
- "generalMessage": "The resource you have requested does not exist",
- "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "An Internal Server Error occurred while processing this request",
- "generalMessage": "An Internal Server Error occurred while processing this request",
- "requestUri": "voice/api/integration/v1/admin/accounts/99990033/agentGroups - GET",
- "timestamp": 1611847650696
- }
- }
- }
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations/{cloudAssignedDestinationId}": {
+ "get": {
+ "tags": [
+ "Cloud Route Assignments"
+ ],
+ "summary": "Returns an assigned destination for a cloud route profile",
+ "description": "Permissions: READ on Cloud Profile",
+ "operationId": "getCloudRouteProfileGroupsCloudRouteGroupIdCloudRouteProfilesCloudRouteProfileIdAssignedDestinationsCloudAssignedDestinationId",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudAssignedDestinationId",
+ "in": "path",
+ "description": "cloudAssignedDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/recordings/dialogs/{dialogId}/segments/{segmentId}": {
- "get": {
- "tags": [
- "Public Integration API"
- ],
- "summary": "Fetches recordings data",
- "description": "This API fetches recording data for a specified dialog and segment. This is a streaming API, it will return an audio stream for given request.",
- "operationId": "getRecordingSegmentData",
- "parameters": [
- {
- "name": "rcAccountId",
- "in": "path",
- "description": "RC account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "980634004"
- }
- },
- {
- "name": "subAccountId",
- "in": "path",
- "description": "subaccount id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "99999999"
- }
- },
- {
- "name": "dialogId",
- "in": "path",
- "description": "dialog id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "d-65f286b0ee1c4900074c1bb2-1710393008514"
- }
- },
- {
- "name": "segmentId",
- "in": "path",
- "description": "segment id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "d-668cf767a626550007d021f6-668cf767a626550007d021f5"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK. The response body contains the WAV recording audio stream.",
- "content": {
- "audio/wav": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Bad request",
- "cause": "",
- "generalMessage": "The supplied data is not valid",
- "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/recordings/dialogs/d-65f286b0ee1c4900074c1bb2-1710393008514/segments/d-668cf767a626550007d021f6-668cf767a626550007d021f5 - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- },
- "example": "JWT is expired."
- }
- }
- },
- "403": {
- "description": "You do not have permission to access this resource.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Access is denied.",
- "cause": "",
- "generalMessage": "You do not have permission to access this resource",
- "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/recordings/dialogs/d-65f286b0ee1c4900074c1bb2-1710393008514/segments/d-668cf767a626550007d021f6-668cf767a626550007d021f5 - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "404": {
- "description": "The resource you requested does not exist.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Not found",
- "cause": "",
- "generalMessage": "The resource you have requested does not exist",
- "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/recordings/dialogs/d-65f286b0ee1c4900074c1bb2-1710393008514/segments/d-668cf767a626550007d021f6-668cf767a626550007d021f5 - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Internal server error",
- "cause": "",
- "generalMessage": "An Internal Server Error occurred while processing this request",
- "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/recordings/dialogs/d-65f286b0ee1c4900074c1bb2-1710393008514/segments/d-668cf767a626550007d021f6-668cf767a626550007d021f5 - GET",
- "timestamp": 1611847650696
- }
- }
- }
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Cloud Route Assignments"
+ ],
+ "summary": "Updates an assigned destination for a cloud route profile",
+ "description": "Permissions: UPDATE on Cloud Profile",
+ "operationId": "updateCloudAssignedDestination2",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ },
+ {
+ "name": "cloudAssignedDestinationId",
+ "in": "path",
+ "description": "cloudAssignedDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/interaction-metadata": {
- "post": {
- "tags": [
- "Public Integration API"
- ],
- "summary": "Returns Interaction Segment Metadata",
- "description": "This API is used to fetch interaction metadata for VOICE/DIGITAL for all segments under provided time duration.",
- "operationId": "getInteractionMetadata",
- "parameters": [
- {
- "name": "rcAccountId",
- "in": "path",
- "description": "RC account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "980634004"
- }
- },
- {
- "name": "subAccountId",
- "in": "path",
- "description": "RingCX subAccount id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "99999999"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/InteractionMetadataRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/WEMInteractionSegmentMetaData2Array"
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Bad request",
- "cause": "",
- "generalMessage": "The supplied data is not valid",
- "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/interaction-metadata - POST",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- },
- "example": "JWT is expired."
- }
- }
- },
- "403": {
- "description": "You do not have permission to access this resource.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Access is denied.",
- "cause": "",
- "generalMessage": "You do not have permission to access this resource",
- "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/interaction-metadata - POST",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "404": {
- "description": "The resource you requested does not exist.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Not found",
- "cause": "",
- "generalMessage": "The resource you have requested does not exist",
- "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/interaction-metadata - POST",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Internal server error",
- "cause": "",
- "generalMessage": "An Internal Server Error occurred while processing this request",
- "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/interaction-metadata - POST",
- "timestamp": 1611847650696
- }
- }
- }
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedDestination"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/transcripts/dialogs/{dialogId}/segments/{segmentId}": {
- "get": {
- "tags": [
- "Public Integration API"
- ],
- "summary": "Fetches Transcript data for both voice and digital",
- "description": "This API fetches interaction transcript data for provided dialogId and segmentId. This is a streaming API, it will return an audio stream for given request.",
- "operationId": "getTranscriptSegmentData",
- "parameters": [
- {
- "name": "rcAccountId",
- "in": "path",
- "description": "RC account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "980634004"
- }
- },
- {
- "name": "subAccountId",
- "in": "path",
- "description": "Sub Account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "99999999"
- }
- },
- {
- "name": "dialogId",
- "in": "path",
- "description": "dialog id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "d-668cf1d0a626550007d01d1b-1720512976864-1909690a312da"
- }
- },
- {
- "name": "segmentId",
- "in": "path",
- "description": "segment id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "d-668d1051a626550007d02828-1720520785904-19097081cf749"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RCInteractionTranscriptData"
- },
- "examples": {
- "example1": {
- "value": {
- "channelClass": "DIGITAL",
- "errorCode": null,
- "errorMessage": null,
- "transcript": [
- {
- "message": "I cannot transfer number porting",
- "participantId": "d-6555aa00cd0df30007872d38-6555aa00cd0df30007872d37",
- "participantType": "contact",
- "rcUserId": "665127314",
- "timestamp": "1721651880000"
- },
- {
- "message": "Can you provide your RC account? And describe the steps you met?",
- "participantId": "d-6555b45ccd0df30007872dd2-1700115548459-18bd6d7301135",
- "participantType": "agent",
- "rcUserId": "665127314",
- "timestamp": "1721651881000"
- }
- ]
- }
- },
- "example2": {
- "value": {
- "channelClass": "VOICE",
- "errorCode": null,
- "errorMessage": null,
- "transcript": [
- {
- "participantId": "d-6555aa00cd0df30007872d38-6555aa00cd0df30007872d37",
- "rcUserId": null,
- "participantName": null,
- "participantType": null,
- "timestamp": "1721651880000",
- "message": "yes sir"
- },
- {
- "participantId": "d-6555b45ccd0df30007872dd2-1700115548459-18bd6d7301135",
- "rcUserId": null,
- "participantName": null,
- "participantType": null,
- "timestamp": "1721651881000",
- "message": "ok"
- }
- ]
- }
- }
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Bad request",
- "cause": "",
- "generalMessage": "The supplied data is not valid",
- "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/transcripts/dialogs/d-668cf1d0a626550007d01d1b-1720512976864-1909690a312da/segments/d-668d1051a626550007d02828-1720520785904-19097081cf749 - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- },
- "example": "JWT is expired."
- }
- }
- },
- "403": {
- "description": "You do not have permission to access this resource.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Access is denied.",
- "cause": "",
- "generalMessage": "You do not have permission to access this resource",
- "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/transcripts/dialogs/d-668cf1d0a626550007d01d1b-1720512976864-1909690a312da/segments/d-668d1051a626550007d02828-1720520785904-19097081cf749 - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "404": {
- "description": "The resource you requested does not exist.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Not found",
- "cause": "",
- "generalMessage": "The resource you have requested does not exist",
- "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/transcripts/dialogs/d-668cf1d0a626550007d01d1b-1720512976864-1909690a312da/segments/d-668d1051a626550007d02828-1720520785904-19097081cf749 - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Internal server error",
- "cause": "",
- "generalMessage": "An Internal Server Error occurred while processing this request",
- "requestUri": "/voice/api/cx/integration/v1/accounts/980634004/sub-accounts/99999999/transcripts/dialogs/d-668cf1d0a626550007d01d1b-1720512976864-1909690a312da/segments/d-668d1051a626550007d02828-1720520785904-19097081cf749 - GET",
- "timestamp": 1611847650696
- }
- }
- }
- }
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Cloud Route Assignments"
+ ],
+ "summary": "Deletes an assigned destination for a cloud route profile",
+ "description": "Permissions: DELETE on Cloud Profile",
+ "operationId": "deleteCloudAssignedDestination2",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudAssignedDestinationId",
+ "in": "path",
+ "description": "cloudAssignedDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
}
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/summary/accounts/{subAccountId}/segments/{segmentId}/agent": {
- "get": {
- "tags": [
- "Reporting"
- ],
- "summary": "Returns the agent-edited summary for an interaction segment",
- "description": "Returns the summary filled in or edited by the agent for the specified interaction segment. This endpoint requires the RingCX access token in a lowercase `cookie` header formatted as `access_token=`.",
- "operationId": "getAgentSummaryBySegment",
- "parameters": [
- {
- "name": "subAccountId",
- "in": "path",
- "description": "RingCX sub-account ID. This is the account ID path value used by the Summary API.",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+",
- "example": "21630001"
- }
- },
- {
- "name": "segmentId",
- "in": "path",
- "description": "Unique interaction segment ID from interaction metadata.",
- "required": true,
- "schema": {
- "type": "string",
- "example": "p-v-0b338efb877e48f0a3a321c73fcd4634-1772456952229-50caeaadd482c"
- }
- },
- {
- "name": "cookie",
- "in": "header",
- "description": "Required lowercase cookie header containing the RingCX access token. Use the format `access_token=`.",
- "required": true,
- "schema": {
- "type": "string",
- "example": "access_token="
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Ok",
- "content": {
- "application/json": {
- "schema": {
- "type": "string"
- },
- "example": "Customer requested a billing adjustment. Agent confirmed the account details and submitted the request for review."
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- }
- }
- }
- }
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations/{cloudAssignedDestinationId}/dnisOverrides": {
+ "get": {
+ "tags": [
+ "Cloud Route DNIS Overrides"
+ ],
+ "summary": "Returns a listing of dnis overrides for a cloud route profile assigned destination",
+ "description": "Permissions: READ on Cloud Profile",
+ "operationId": "getCloudRouteProfileGroupsCloudRouteGroupIdCloudRouteProfilesCloudRouteProfileIdAssignedDestinationsCloudAssignedDestinationIdDnisOverrides",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudAssignedDestinationId",
+ "in": "path",
+ "description": "cloudAssignedDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteAssignedOverride"
+ }
}
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/summary/accounts/{subAccountId}/segments/{segmentId}/auto": {
- "get": {
- "tags": [
- "Reporting"
- ],
- "summary": "Returns the AI-generated summary for an interaction segment",
- "description": "Returns the auto-generated summary for the specified interaction segment. This endpoint requires the RingCX access token in a lowercase `cookie` header formatted as `access_token=`.",
- "operationId": "getAutoSummaryBySegment",
- "parameters": [
- {
- "name": "subAccountId",
- "in": "path",
- "description": "RingCX sub-account ID. This is the account ID path value used by the Summary API.",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+",
- "example": "21630001"
- }
- },
- {
- "name": "segmentId",
- "in": "path",
- "description": "Unique interaction segment ID from interaction metadata.",
- "required": true,
- "schema": {
- "type": "string",
- "example": "p-v-0b338efb877e48f0a3a321c73fcd4634-1772456952229-50caeaadd482c"
- }
- },
- {
- "name": "cookie",
- "in": "header",
- "description": "Required lowercase cookie header containing the RingCX access token. Use the format `access_token=`.",
- "required": true,
- "schema": {
- "type": "string",
- "example": "access_token="
- }
- }
- ],
- "responses": {
- "200": {
- "description": "Ok",
- "content": {
- "application/json": {
- "schema": {
- "type": "string"
- },
- "example": "The customer called about a billing issue. The agent reviewed the account, explained the next steps, and created a follow-up request."
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- }
- }
- }
- },
- "500": {
- "description": "Internal Server",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- }
- }
- }
- }
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Cloud Route DNIS Overrides"
+ ],
+ "summary": "Creates a dnis override for a cloud route profile assigned destination",
+ "description": "Permissions: UPDATE on Cloud Profile (Permission Override)",
+ "operationId": "createCloudRouteAssignedOverride",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudAssignedDestinationId",
+ "in": "path",
+ "description": "cloudAssignedDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudDestinationType",
+ "in": "query",
+ "description": "cloudDestinationType",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "STANDARD",
+ "DID",
+ "SIP",
+ "IN_NETWORK_DID",
+ "ACD",
+ "IVR",
+ "IVR_STUDIO"
+ ]
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedOverride"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedOverride"
}
+ }
}
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/queue-groups": {
- "get": {
- "tags": [
- "Public Integration API"
- ],
- "summary": "Returns a list of queue groups",
- "description": "This API returns a list of all queue-groups for given sub-account",
- "operationId": "getQueueGroups",
- "parameters": [
- {
- "name": "rcAccountId",
- "in": "path",
- "description": "RC account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "138885004"
- }
- },
- {
- "name": "subAccountId",
- "in": "path",
- "description": "Engage Voice sub-account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "99999033"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/QueueGroup"
- },
- "example": [
- {
- "queueGroupId": 1009,
- "groupName": "Queue group 1",
- "queueGroupType": "VOICE"
- },
- {
- "queueGroupId": 1010,
- "groupName": "Queue group 2",
- "queueGroupType": "DIGITAL"
- }
- ]
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Bad request",
- "cause": "",
- "generalMessage": "The supplied data is not valid",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- },
- "example": "JWT is expired."
- }
- }
- },
- "403": {
- "description": "You do not have permission to access this resource.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Access is denied.",
- "cause": "",
- "generalMessage": "You do not have permission to access this resource",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "404": {
- "description": "The resource you requested does not exist.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Not found",
- "cause": "",
- "generalMessage": "The resource you have requested does not exist",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Internal server error",
- "cause": "",
- "generalMessage": "An Internal Server Error occurred while processing this request",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups - GET",
- "timestamp": 1611847650696
- }
- }
- }
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations/{cloudAssignedDestinationId}/dnisOverrides/batch": {
+ "post": {
+ "tags": [
+ "Cloud Route DNIS Overrides"
+ ],
+ "summary": "Create a list of dnis overrides for a cloud route profile assigned destination",
+ "description": "Permissions: UPDATE on Cloud Profile (Permission Override) ",
+ "operationId": "createCloudRouteAssignedOverrideList",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudAssignedDestinationId",
+ "in": "path",
+ "description": "cloudAssignedDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "replaceAll",
+ "in": "query",
+ "description": "replaceAll",
+ "required": true,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "phoneNumbersI18nEnabled",
+ "in": "query",
+ "description": "phoneNumbersI18nEnabled",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteAssignedOverride"
+ }
+ }
+ }
}
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/queue-groups/{queueGroupId}/with-agents": {
- "get": {
- "tags": [
- "Public Integration API"
- ],
- "summary": "Returns a list of agent ids of the queue group.",
- "description": "This API returns a list of all queues and their associated agents for given sub-account and queue-group id. Note: Maximum number of records returned by this API is 2000.",
- "operationId": "getQueuesWithAgents",
- "parameters": [
- {
- "name": "rcAccountId",
- "in": "path",
- "description": "RC account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "138885004"
- }
- },
- {
- "name": "subAccountId",
- "in": "path",
- "description": "Engage Voice sub-account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "99990033"
- }
- },
- {
- "name": "queueGroupId",
- "in": "path",
- "description": "Queue group ID",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int64",
- "example": 1009
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CXQueueWithAgents"
- },
- "example": [
- {
- "queueId": 555,
- "queueType": "VOICE",
- "queueName": "Test queue 1",
- "queueGroupId": 1009,
- "isActive": true,
- "createdOn": "2020-07-21T17:32:28Z",
- "agentIds": [
- 10,
- 20
- ]
- },
- {
- "queueId": 556,
- "queueType": "DIGITAL",
- "queueName": "Test queue 2",
- "queueGroupId": 1009,
- "isActive": true,
- "createdOn": "2020-07-21T17:32:28Z",
- "agentIds": [
- 30
- ]
- }
- ]
- }
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Bad request",
- "cause": "",
- "generalMessage": "The supplied data is not valid",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups/1009/with-agents - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- },
- "example": "JWT is expired."
- }
- }
- },
- "403": {
- "description": "You do not have permission to access this resource.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Access is denied.",
- "cause": "",
- "generalMessage": "You do not have permission to access this resource",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups/1009/with-agents - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "404": {
- "description": "The resource you requested does not exist.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Not found",
- "cause": "",
- "generalMessage": "The resource you have requested does not exist",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups/1009/with-agents - GET",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Internal server error",
- "cause": "",
- "generalMessage": "An Internal Server Error occurred while processing this request",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/queue-groups/1009/with-agents - GET",
- "timestamp": 1611847650696
- }
- }
- }
- }
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ],
+ "requestBody": {
+ "required": true,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "file": {
+ "type": "string",
+ "format": "binary",
+ "description": "DNIS override upload file."
+ }
},
- "security": [
- {
- "BearerAuth": []
- }
+ "required": [
+ "file"
]
+ }
+ }
+ },
+ "description": "Delimited file containing DNIS overrides for the assigned destination."
+ }
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations/{cloudAssignedDestinationId}/dnisOverrides/{cloudAssignedOverrideId}": {
+ "get": {
+ "tags": [
+ "Cloud Route DNIS Overrides"
+ ],
+ "summary": "Returns a dnis override for a cloud route profile assigned destination",
+ "description": "Permissions: READ on Cloud Profile",
+ "operationId": "getOverride",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudAssignedDestinationId",
+ "in": "path",
+ "description": "cloudAssignedDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudAssignedOverrideId",
+ "in": "path",
+ "description": "cloudAssignedOverrideId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedOverride"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/agg-queue-stats": {
- "post": {
- "tags": [
- "Public Integration API"
- ],
- "summary": "Builds queue statistics",
- "operationId": "buildAggQueueStats",
- "description": "This API returns statistics of all queues for given sub-account and duration.",
- "parameters": [
- {
- "name": "rcAccountId",
- "in": "path",
- "description": "RC account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "138885004"
- }
- },
- {
- "name": "subAccountId",
- "in": "path",
- "description": "Engage Voice sub-account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "99999033"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AggregatedIntegrationParams"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AggregatedQueueStats"
- }
- },
- "example": [
- {
- "abandIxnCnt": 0,
- "abandShortIxnCnt": 0,
- "abandWithinSlCnt": 0,
- "ansServicelevelCnt": 0,
- "answIxnCnt": 3,
- "completedContacts": 122,
- "dateTimeFrom": "03-04-2024T01:00:00",
- "interval": 60,
- "offdDirectIxnCnt": 3,
- "overflowInIxnCnt": 0,
- "overflowOutIxnCnt": 0,
- "queue": 5686,
- "queuedAbandLongestQueDur": 0,
- "queuedAndAbandIxnDur": 0,
- "queuedAndAnswIxnDur": 9,
- "queuedAnswLongestQueDur": 1,
- "queueName": "Queue",
- "segmentHoldTime": 512000,
- "talkingIxnDur": 90,
- "waitDur": 13,
- "wrapUpDur": 13
- },
- {
- "abandIxnCnt": 0,
- "abandShortIxnCnt": 0,
- "abandWithinSlCnt": 0,
- "ansServicelevelCnt": 0,
- "answIxnCnt": 3,
- "completedContacts": 21,
- "dateTimeFrom": "03-04-2024T02:00:00",
- "interval": 60,
- "offdDirectIxnCnt": 3,
- "overflowInIxnCnt": 0,
- "overflowOutIxnCnt": 0,
- "queue": 5686,
- "queuedAbandLongestQueDur": 0,
- "queuedAndAbandIxnDur": 0,
- "queuedAndAnswIxnDur": 9,
- "queuedAnswLongestQueDur": 1,
- "queueName": "Queue 2",
- "segmentHoldTime": 12000,
- "talkingIxnDur": 90,
- "waitDur": 13,
- "wrapUpDur": 13
- }
- ]
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Bad request",
- "cause": "",
- "generalMessage": "The supplied data is not valid",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-queue-stats - POST",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- },
- "example": "JWT is expired."
- }
- }
- },
- "403": {
- "description": "You do not have permission to access this resource.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Access is denied.",
- "cause": "",
- "generalMessage": "You do not have permission to access this resource",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-queue-stats - POST",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "404": {
- "description": "The resource you requested does not exist.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Not found",
- "cause": "",
- "generalMessage": "The resource you have requested does not exist",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-queue-stats - POST",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Internal server error",
- "cause": "",
- "generalMessage": "An Internal Server Error occurred while processing this request",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-queue-stats - POST",
- "timestamp": 1611847650696
- }
- }
- }
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Cloud Route DNIS Overrides"
+ ],
+ "summary": "Updates a dnis override for a cloud route profile assigned destination",
+ "description": "Permissions: UPDATE on Cloud Profile",
+ "operationId": "updateCloudRouteDestinationOverride2",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
}
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudAssignedDestinationId",
+ "in": "path",
+ "description": "cloudAssignedDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudAssignedOverrideId",
+ "in": "path",
+ "description": "cloudAssignedOverrideId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudDestinationType",
+ "in": "query",
+ "description": "cloudDestinationType",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "STANDARD",
+ "DID",
+ "SIP",
+ "IN_NETWORK_DID",
+ "ACD",
+ "IVR",
+ "IVR_STUDIO"
+ ]
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedOverride"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/agg-agent-extended-stats": {
- "post": {
- "tags": [
- "Public Integration API"
- ],
- "summary": "Builds extended agent queue statistics",
- "operationId": "buildExtendedAggAgentStats",
- "description": "This API returns statistics of all queues along with their agents for given Sub-Account and duration.",
- "parameters": [
- {
- "name": "rcAccountId",
- "in": "path",
- "description": "RC account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "138885004"
- }
- },
- {
- "name": "subAccountId",
- "in": "path",
- "description": "Engage Voice sub-account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "99990033"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AggregatedIntegrationParams"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ExtendedAggregatedQueueStats"
- }
- },
- "example": [
- {
- "interval": 60,
- "dateTimeFrom": "03-04-2024T05:00:00",
- "agentId": 1,
- "agentName": "aws93-l13-las01 test number",
- "queue": 5682,
- "queueName": "Queue",
- "talkingIxnDur": 56,
- "wrapUpDur": 0,
- "answIxnCnt": 1,
- "transferOutIxnCnt": 4
- },
- {
- "interval": 60,
- "dateTimeFrom": "03-04-2024T06:00:00",
- "agentId": 10693,
- "agentName": "Neringa Norkute",
- "queue": 5688,
- "queueName": "Neringa queue 2",
- "talkingIxnDur": 137,
- "wrapUpDur": 5,
- "answIxnCnt": 2,
- "transferOutIxnCnt": 0
- }
- ]
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Bad request",
- "cause": "",
- "generalMessage": "The supplied data is not valid",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-extended-stats - POST",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- },
- "example": "JWT is expired."
- }
- }
- },
- "403": {
- "description": "You do not have permission to access this resource.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Access is denied.",
- "cause": "",
- "generalMessage": "You do not have permission to access this resource",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-extended-stats - POST",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "404": {
- "description": "The resource you requested does not exist.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Not found",
- "cause": "",
- "generalMessage": "The resource you have requested does not exist",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-extended-stats - POST",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Internal server error",
- "cause": "",
- "generalMessage": "An Internal Server Error occurred while processing this request",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-extended-stats - POST",
- "timestamp": 1611847650696
- }
- }
- }
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteAssignedOverride"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/agg-agent-stats": {
- "post": {
- "tags": [
- "Public Integration API"
- ],
- "summary": "Builds agent statistics",
- "description": "This API returns statistics of all agents for given sub-account and duration.",
- "operationId": "buildAggAgentStats",
- "parameters": [
- {
- "name": "rcAccountId",
- "in": "path",
- "description": "RC account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "138885004"
- }
- },
- {
- "name": "subAccountId",
- "in": "path",
- "description": "Engage Voice sub-account id",
- "required": true,
- "schema": {
- "type": "string",
- "example": "99990033"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AggregatedIntegrationParams"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AggregatedAgentStats"
- }
- },
- "example": [
- {
- "interval": 60,
- "dateTimeFrom": "03-04-2024T08:00:00",
- "agentId": 33,
- "agentName": "test number, aws91-l22-engage",
- "availDur": 3376,
- "totWorkDur": 3376,
- "pauseDur": 900,
- "waitDur": 2476,
- "adminDur": 0,
- "directOutIxnCnt": 0,
- "directOutIxnDur": 0,
- "directInIxnCnt": 0,
- "directInIxnDur": 0
- },
- {
- "interval": 60,
- "dateTimeFrom": "03-04-2024T09:00:00",
- "agentId": 132598,
- "agentName": "kaduk, alena",
- "availDur": 117,
- "totWorkDur": 117,
- "pauseDur": 0,
- "waitDur": 113,
- "adminDur": 0,
- "directOutIxnCnt": 0,
- "directOutIxnDur": 0,
- "directInIxnCnt": 1,
- "directInIxnDur": 5
- }
- ]
- }
- }
- },
- "400": {
- "description": "Bad request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Bad request",
- "cause": "",
- "generalMessage": "The supplied data is not valid",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-stats - POST",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- },
- "example": "JWT is expired."
- }
- }
- },
- "403": {
- "description": "You do not have permission to access this resource.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Access is denied.",
- "cause": "",
- "generalMessage": "You do not have permission to access this resource",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-stats - POST",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "404": {
- "description": "The resource you requested does not exist.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Not found",
- "cause": "",
- "generalMessage": "The resource you have requested does not exist",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-stats - POST",
- "timestamp": 1611847650696
- }
- }
- }
- },
- "500": {
- "description": "Internal Server Error",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Errors"
- },
- "example": {
- "details": "",
- "developerMessage": "Internal server error",
- "cause": "",
- "generalMessage": "An Internal Server Error occurred while processing this request",
- "requestUri": "/voice/api/cx/integration/v1/accounts/138885004/sub-accounts/99999033/agg-agent-stats - POST",
- "timestamp": 1611847650696
- }
- }
- }
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Cloud Route DNIS Overrides"
+ ],
+ "summary": "Deletes a dnis override for a cloud route profile assigned destination",
+ "description": "Permissions: UPDATE on Cloud Profile (Permission Override)",
+ "operationId": "deleteCloudRouteAssignedOverride",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudAssignedDestinationId",
+ "in": "path",
+ "description": "cloudAssignedDestinationId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ },
+ {
+ "name": "cloudAssignedOverrideId",
+ "in": "path",
+ "description": "cloudAssignedOverrideId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/v1/admin/utilities/tnManager/updateCustomerDnisBulk": {
- "put": {
- "tags": [
- "Number Management"
- ],
- "summary": "Update Dnis Records in Bulk",
- "operationId": "updateCustomerDnisBulkUsingPUT",
- "requestBody": {
- "description": "request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DnisBulkUpdateRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "201": {
- "description": "Created",
- "content": {}
- },
- "401": {
- "description": "Unauthorized",
- "content": {}
- },
- "403": {
- "description": "Forbidden",
- "content": {}
- },
- "404": {
- "description": "Not Found",
- "content": {}
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ],
- "x-codegen-request-body-name": "request"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/clone": {
+ "post": {
+ "tags": [
+ "Cloud Route Profiles"
+ ],
+ "summary": "Creates a clone of the cloud route profile for a cloud group",
+ "description": "Permissions: READ on cloned Cloud Route Profile and CREATE on Cloud Group (Permission Override)",
+ "operationId": "cloneCloudRouteProfile",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ },
+ {
+ "name": "newCloudRouteProfileName",
+ "in": "query",
+ "description": "newCloudRouteProfileName",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteProfile"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/v1/admin/utilities/tnManager/searchDnis": {
- "post": {
- "tags": [
- "Number Management"
- ],
- "summary": "Returns all dnis pools for Customer",
- "description": "Permissions: READ on Account, READ on TN_MANAGER, filter out restricted accounts",
- "operationId": "getCustomerDnisPoolListUsingPOST",
- "requestBody": {
- "description": "request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DnisListRequest"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "object"
- }
- }
- }
- },
- "201": {
- "description": "Created",
- "content": {}
- },
- "401": {
- "description": "Unauthorized",
- "content": {}
- },
- "403": {
- "description": "Forbidden",
- "content": {}
- },
- "404": {
- "description": "Not Found",
- "content": {}
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ],
- "x-codegen-request-body-name": "request"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/dtmfEvents": {
+ "get": {
+ "tags": [
+ "Cloud Route DTMF Events"
+ ],
+ "summary": "Returns a listing of dtmf events for a cloud route profile",
+ "description": "Permissions: READ Cloud Profile",
+ "operationId": "getCloudRouteDtmfEventList",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteDtmfEvent"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/v1/admin/utilities/tnManager/updateBulkDnisPool": {
- "put": {
- "tags": [
- "Number Management"
- ],
- "summary": "Updates for bulk csv data dnis pool, will update assignments too",
- "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts",
- "operationId": "updateBulkDnisPoolListUsingPUT",
- "requestBody": {
- "description": "dnisPools",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/DnisPool"
- }
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DnisBulkUpdateRespose"
- }
- }
- }
- },
- "201": {
- "description": "Created",
- "content": {}
- },
- "401": {
- "description": "Unauthorized",
- "content": {}
- },
- "403": {
- "description": "Forbidden",
- "content": {}
- },
- "404": {
- "description": "Not Found",
- "content": {}
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ],
- "x-codegen-request-body-name": "dnisPools"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Cloud Route DTMF Events"
+ ],
+ "summary": "Creates a dtmf event for a cloud profile",
+ "description": "Permissions: UPDATE on Cloud Profile (Permission Override)",
+ "operationId": "createCloudRouteDtmfEvent",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
}
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDtmfEvent"
+ }
+ }
+ },
+ "required": false
},
- "/v1/admin/utilities/tnManager/uploadDnisPool": {
- "post": {
- "tags": [
- "Number Management"
- ],
- "summary": "Creates a list of dnis pools from upload file",
- "description": "Has Role: SUPER_USER",
- "operationId": "previewDnisListUsingPOST",
- "parameters": [
- {
- "name": "fileType",
- "in": "query",
- "description": "fileType",
- "required": true,
- "schema": {
- "type": "string",
- "enum": [
- "COMMA"
- ]
- }
- }
- ],
- "requestBody": {
- "content": {
- "multipart/form-data": {
- "schema": {
- "required": [
- "file"
- ],
- "properties": {
- "file": {
- "type": "string",
- "description": "file",
- "format": "binary"
- }
- }
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DnisListPreviewResponse"
- }
- }
- }
- },
- "201": {
- "description": "Created",
- "content": {}
- },
- "401": {
- "description": "Unauthorized",
- "content": {}
- },
- "403": {
- "description": "Forbidden",
- "content": {}
- },
- "404": {
- "description": "Not Found",
- "content": {}
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDtmfEvent"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/persona-phone-config": {
- "get": {
- "description": "Permissions: Read on Account (Permission Override), READ on Outbound",
- "operationId": "fetchPersonaPhoneConfig",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "pattern": "[0-9]+",
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PersonaPhoneConfig"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ],
- "summary": "Fetches persona phone configurations",
- "tags": [
- "Outbound"
- ]
- },
- "post": {
- "description": "Permissions: Read on Account (Permission Override), CREATE on Outbound",
- "operationId": "createPersonaPhoneConfig",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "pattern": "[0-9]+",
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PersonaPhoneConfig"
- }
- }
- },
- "description": "personaPhoneConfig",
- "required": true
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PersonaPhoneConfig"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ],
- "summary": "Creates persona phone configuration",
- "tags": [
- "Outbound"
- ],
- "x-codegen-request-body-name": "personaPhoneConfig"
- },
- "put": {
- "description": "Permissions: Read on Account (Permission Override), UPDATE on Outbound",
- "operationId": "updatePersonaPhoneConfig",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "pattern": "[0-9]+",
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PersonaPhoneConfig"
- }
- }
- },
- "description": "personaPhoneConfig",
- "required": true
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PersonaPhoneConfig"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ],
- "summary": "Updates persona phone configuration",
- "tags": [
- "Outbound"
- ],
- "x-codegen-request-body-name": "personaPhoneConfig"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/dtmfEvents/{dtmfEventId}": {
+ "get": {
+ "tags": [
+ "Cloud Route DTMF Events"
+ ],
+ "summary": "Returns a dtmf event for a cloud profile",
+ "description": "Permissions: READ on Cloud Profile",
+ "operationId": "getCloudRouteDtmfEvent",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "dtmfEventId",
+ "in": "path",
+ "description": "dtmfEventId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDtmfEvent"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/persona-phone-config/active-campaigns/{phoneId}": {
- "get": {
- "description": "Returns campaign names that currently use the specified persona phone ID in calling preferences.",
- "operationId": "getCampaignsUsingPhoneId",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "pattern": "[0-9]+",
- "type": "string"
- }
- },
- {
- "description": "phoneId",
- "in": "path",
- "name": "phoneId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ],
- "summary": "Fetches campaigns using a persona phone ID",
- "tags": [
- "Outbound"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Cloud Route DTMF Events"
+ ],
+ "summary": "Updates a dtmf event for a cloud route profile",
+ "description": "Permissions: UPDATE on Cloud Profile",
+ "operationId": "updateCloudRouteDtmfEvent",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "dtmfEventId",
+ "in": "path",
+ "description": "dtmfEventId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDtmfEvent"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/persona-phone-config/{phoneId}": {
- "delete": {
- "description": "Permissions: Read on Account (Permission Override), DELETE on Outbound",
- "operationId": "deletePersonaPhoneConfig",
- "parameters": [
- {
- "description": "accountId",
- "in": "path",
- "name": "accountId",
- "required": true,
- "schema": {
- "pattern": "[0-9]+",
- "type": "string"
- }
- },
- {
- "description": "phoneId",
- "in": "path",
- "name": "phoneId",
- "required": true,
- "schema": {
- "format": "int32",
- "type": "integer"
- }
- }
- ],
- "responses": {
- "204": {
- "description": "Deleted"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ],
- "summary": "Deletes persona phone configuration",
- "tags": [
- "Outbound"
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/CloudRouteDtmfEvent"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/auth": {
- "get": {
- "tags": [
- "User Auth Utilities"
- ],
- "summary": "Returns information provided by /v1/auth/login for users who are already authenticated. Additionally, we return the host name of this platform.",
- "description": "",
- "operationId": "getUserLoginView",
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/UserLoginView"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Cloud Route DTMF Events"
+ ],
+ "summary": "Deletes a dtmf event for a cloud route profile",
+ "description": "Permissions: UPDATE on Cloud Profile (Permission Override) ",
+ "operationId": "deleteCloudRouteDtmfEvent",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ },
+ {
+ "name": "dtmfEventId",
+ "in": "path",
+ "description": "dtmfEventId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/rightsDocs/{rightsDocId}/assignments": {
- "get": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Returns a listing of users assigned to a rights document",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "getRightsDocAssignments",
- "parameters": [
- {
- "name": "rightsDocId",
- "in": "path",
- "description": "rightsDocId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "post": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Assigns a rights document to a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "assignRightsDoc",
- "parameters": [
- {
- "name": "rightsDocId",
- "in": "path",
- "description": "rightsDocId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "userIds",
- "in": "query",
- "description": "Repeat the parameter (e.g. ?userIds=1&userIds=2) to assign the rights document to multiple users.",
- "required": true,
- "schema": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "style": "form",
- "explode": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/setIsActive": {
+ "put": {
+ "tags": [
+ "Cloud Route Profiles"
+ ],
+ "summary": "Set active state for a cloud route profile",
+ "description": "Permissions: UPDATE on Cloud Profile",
+ "operationId": "setCloudRouteProfileIsActive",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ActiveStateBoolean"
+ }
}
+ },
+ "required": false
},
- "/voice/api/v1/admin/rightsDocs/{rightsDocId}/assignments/{assignedUserId}": {
- "delete": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Deletes a rights document from a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "deleteRightsDocAssignment",
- "parameters": [
- {
- "name": "assignedUserId",
- "in": "path",
- "description": "assignedUserId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "rightsDocId",
- "in": "path",
- "description": "rightsDocId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- },
- "default": {
- "description": "successful operation"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/availableUserNames": {
- "get": {
- "tags": [
- "Users"
- ],
- "summary": "Checks if username is available",
- "description": "Permissions: Authenticated User",
- "operationId": "isUserNameTaken",
- "parameters": [
- {
- "name": "userName",
- "in": "query",
- "description": "userName",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "object"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/stickyDestinations/searchByAnis": {
+ "get": {
+ "tags": [
+ "Cloud Route Sticky Destinations"
+ ],
+ "summary": "Returns a listing of sticky destinations by ani for a cloud route profile",
+ "description": "Permissions: READ on Cloud Profile",
+ "operationId": "getListByAni",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
}
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "aniParams",
+ "in": "query",
+ "description": "aniParams",
+ "required": true,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "anis",
+ "in": "query",
+ "description": "anis",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ {
+ "name": "fullAni",
+ "in": "query",
+ "description": "fullAni",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ }
+ },
+ {
+ "name": "count",
+ "in": "query",
+ "description": "count",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ {
+ "name": "page",
+ "in": "query",
+ "description": "page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "maxRows",
+ "in": "query",
+ "description": "maxRows",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/duplicateAuthenticatedUser": {
- "post": {
- "tags": [
- "User Auth Utilities"
- ],
- "summary": "Duplicates this authenticated user's session and returns a new auth token",
- "description": "Permissions: Authenticated User",
- "operationId": "duplicateAuthenticatedUsers",
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AuthenticatedUser"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/stickyDestinations/{ani}": {
+ "delete": {
+ "tags": [
+ "Cloud Route Sticky Destinations"
+ ],
+ "summary": "Deletes a sticky destination by ani for a cloud route profile",
+ "description": "Permissions: UPDATE on Cloud Profile (Permission Override)",
+ "operationId": "deleteByAni",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "cloudRouteGroupId",
+ "in": "path",
+ "description": "cloudRouteGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "ani",
+ "in": "path",
+ "description": "ani",
+ "required": true,
+ "schema": {
+ "type": "string"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/passwordReset": {
- "post": {
- "tags": [
- "User Auth Utilities"
- ],
- "summary": "Resets a user's password",
- "description": "Permissions: Authenticated User",
- "operationId": "securedPasswordRequestRequest",
- "parameters": [
- {
- "name": "currentPassword",
- "in": "query",
- "description": "currentPassword",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "newPassword",
- "in": "query",
- "description": "newPassword",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v2-skinny/admin/accounts/{accountId}/cloudRouteDestinationGroups": {
+ "get": {
+ "tags": [
+ "Cloud Route Destination Groups"
+ ],
+ "summary": "Returns a listing of cloud route groups by account. This will not return the destinations under a group. Pass in the account id you'd like to search by as a parameter.",
+ "description": "Permissions: READ on Account, Post Filtered Results",
+ "operationId": "getSkinnyCloudRouteDestinationGroups",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteGroupSkinny"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/reassign": {
- "put": {
- "tags": [
- "Users"
- ],
- "summary": "Reassigns all existing child users to a new parent user",
- "description": "Permissions: MANAGE_USERS or SUPER_USER role",
- "operationId": "reassignUsers",
- "parameters": [
- {
- "name": "oldUserId",
- "in": "query",
- "description": "oldUserId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "reassignUserId",
- "in": "query",
- "description": "reassignUserId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v2-skinny/admin/accounts/{accountId}/cloudRouteDestinationGroups/withChildren": {
+ "get": {
+ "tags": [
+ "Cloud Route Destination Groups"
+ ],
+ "summary": "Returns a listing of cloud route groups, and the individual cloud destinations underneath each group, by account. Pass in the account id you'd like to search by as a parameter.",
+ "description": "Permissions: READ on Account, Post Filtered Results",
+ "operationId": "getListWithProfileChildren3",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteGroupSkinny"
+ }
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/root": {
- "post": {
- "tags": [
- "Users"
- ],
- "summary": "Creates a single root user",
- "description": "Permissions: SUPER_USER role",
- "operationId": "createRootUser",
- "parameters": [
- {
- "name": "returnUri",
- "in": "query",
- "description": "returnUri",
- "required": false,
- "schema": {
- "type": "string",
- "format": "uri"
- }
- },
- {
- "name": "isSSO",
- "in": "query",
- "description": "isSSO",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AdminUserRequest"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v2-skinny/admin/accounts/{accountId}/cloudRouteProfileGroups": {
+ "get": {
+ "tags": [
+ "Cloud Route Profile Groups"
+ ],
+ "summary": "Returns a listing of cloud route groups by account. This will not return the cloud route profiles under a group.Pass in the account id you'd like to search by as a parameter.",
+ "description": "Permissions: READ on Account, Post Filtered Results",
+ "operationId": "getSkinnyCloudRouteProfileGroups",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteGroupSkinny"
+ }
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/root/{userId}/assignAccount": {
- "post": {
- "tags": [
- "Users"
- ],
- "summary": "Assigns an account to a root user",
- "description": "Permissions: SUPER_USER role",
- "operationId": "assignAccountToRootUser",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "accountId",
- "in": "query",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "isMaster",
- "in": "query",
- "description": "isMaster",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v2-skinny/admin/accounts/{accountId}/cloudRouteProfileGroups/withChildren": {
+ "get": {
+ "tags": [
+ "Cloud Route Profile Groups"
+ ],
+ "summary": "Returns a listing of cloud route groups, and the individual cloud profiles underneath each group, by account. Pass in the account id you'd like to search by as a parameter.",
+ "description": "Permissions: READ on Account, Post Filtered Results",
+ "operationId": "getListWithProfileChildren4",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/CloudRouteGroupSkinny"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/tracGroups/withChildren": {
+ "get": {
+ "tags": [
+ "Tracking Numbers"
+ ],
+ "summary": "List tracking number groups with numbers",
+ "description": "Permissions: READ on Account, Post Filtered Results",
+ "operationId": "getTracGroupListWithChildren",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "includePermissions",
+ "in": "query",
+ "description": "includePermissions",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TracGroup"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/tracGroups/{tracGroupId}": {
+ "get": {
+ "tags": [
+ "Tracking Numbers"
+ ],
+ "summary": "Get tracking number group",
+ "description": "Permissions: READ on Trac Group",
+ "operationId": "getTracGroup",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracGroup"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Tracking Numbers"
+ ],
+ "summary": "Update tracking number group",
+ "description": "Permissions: Update on Trac Group",
+ "operationId": "updateTracGroup",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
- },
- "/voice/api/v1/admin/users/{userId}": {
- "get": {
- "tags": [
- "Users"
- ],
- "summary": "Returns a user",
- "description": "Permissions: MANAGE_USERS or SUPER_USER role",
- "operationId": "getUser",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "delete": {
- "tags": [
- "Users"
- ],
- "summary": "Deletes a user",
- "description": "Permissions: MANAGE_USERS or SUPER_USER role",
- "operationId": "deleteUser",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "reassignUserId",
- "in": "query",
- "description": "reassignUserId",
- "required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cascadeDelete",
- "in": "query",
- "description": "cascadeDelete",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": true
- }
- }
- ],
- "responses": {
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- },
- "default": {
- "description": "successful operation"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "put": {
- "tags": [
- "Users"
- ],
- "summary": "Updates a user",
- "description": "Permissions: MANAGE_USERS or SUPER_USER role",
- "operationId": "updateUser",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AdminUserRequest"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracGroup"
+ }
}
+ },
+ "required": false
},
- "/voice/api/v1/admin/users/{userId}/aggregatedRightsDocs": {
- "get": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Returns a map of aggregated rights documents for a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "getAggregatedRightsDocForAllAccounts",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "additionalProperties": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracGroup"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/assignAccountToAnyUser": {
- "post": {
- "tags": [
- "Users"
- ],
- "summary": "Assigns an account to any user",
- "description": "Permissions: hasRole('MANAGE_RIGHTS') or hasRole('SUPER_USER')",
- "operationId": "assignAccountToAnyUser",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "accountId",
- "in": "query",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "isMaster",
- "in": "query",
- "description": "isMaster",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Tracking Numbers"
+ ],
+ "summary": "Delete tracking number group",
+ "description": "Permissions: Delete on Trac Group",
+ "operationId": "deleteTracGroup",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/assignedMasterRightsDocs": {
- "get": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Returns a map of assigned master rights documents for a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "getUsersAssignedRightsDocs",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/tracGroups/{tracGroupId}/tracNumbers": {
+ "get": {
+ "tags": [
+ "Tracking Numbers"
+ ],
+ "summary": "List tracking numbers",
+ "description": "Permissions: READ on Trac Group, Post Filtered Results",
+ "operationId": "getTracNumberList",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TracNumber"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/assignedRightsDocs": {
- "get": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Returns a map of assigned rights documents for a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "getUsersAssignedRightsDocs2",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Tracking Numbers"
+ ],
+ "summary": "Create tracking number",
+ "description": "Permissions: Create on Trac Group",
+ "operationId": "createTracNumber",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
}
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracNumber"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v1/admin/users/{userId}/bulkAssignAccountToAnyUser": {
- "post": {
- "tags": [
- "Users"
- ],
- "summary": "Assigns an account to any user",
- "description": "Permissions: hasRole('MANAGE_RIGHTS') or hasRole('SUPER_USER')",
- "operationId": "assignAccountToAnyUser2",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RightsDocTable"
- }
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracNumber"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/children": {
- "get": {
- "tags": [
- "Users"
- ],
- "summary": "Returns a hierarchical listing of all users that a user has access to",
- "description": "Permissions: MANAGE_USERS or SUPER_USER role",
- "operationId": "listAllUsersChildren",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/tracGroups/{tracGroupId}/tracNumbers/{tracId}": {
+ "get": {
+ "tags": [
+ "Tracking Numbers"
+ ],
+ "summary": "Get tracking number",
+ "description": "Permissions: READ on Trac Number",
+ "operationId": "getTracNumber",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
}
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "tracId",
+ "in": "path",
+ "description": "tracId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracNumber"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/dashboards": {
- "get": {
- "tags": [
- "User Dashboards"
- ],
- "summary": "Returns a listing of a dashboards for a user",
- "description": "Permissions: Authenticated User",
- "operationId": "getDashboardList",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Dashboard"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "post": {
- "tags": [
- "User Dashboards"
- ],
- "summary": "Creates a new dashboard for a user",
- "description": "Permissions: Authenticated User",
- "operationId": "createDashboard",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Dashboard"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Dashboard"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Tracking Numbers"
+ ],
+ "summary": "Update tracking number",
+ "description": "Permissions: Update on Trac Group",
+ "operationId": "updateTracNumber",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
}
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "tracId",
+ "in": "path",
+ "description": "tracId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracNumber"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v1/admin/users/{userId}/dashboards/{dashboardId}": {
- "get": {
- "tags": [
- "User Dashboards"
- ],
- "summary": "Returns a dashboard for a user",
- "description": "Permissions: Authenticated User",
- "operationId": "getDashboardDetail",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "dashboardId",
- "in": "path",
- "description": "dashboardId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Dashboard"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "put": {
- "tags": [
- "User Dashboards"
- ],
- "summary": "Updates an existing dashboard for a user",
- "description": "Permissions: Authenticated User",
- "operationId": "updateDashboard",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "dashboardId",
- "in": "path",
- "description": "dashboardId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Dashboard"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Dashboard"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "delete": {
- "tags": [
- "User Dashboards"
- ],
- "summary": "Deletes a dashboard for a user",
- "description": "Permissions: Authenticated User",
- "operationId": "deleteDashboard",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "dashboardId",
- "in": "path",
- "description": "dashboardId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracNumber"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/dashboards/{dashboardId}/share": {
- "put": {
- "tags": [
- "User Dashboards"
- ],
- "summary": "Creates a copy of the dashboard for each admin id supplied",
- "description": "Permissions: Authenticated User",
- "operationId": "shareDashboard",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "dashboardId",
- "in": "path",
- "description": "dashboardId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "userIds",
- "in": "query",
- "description": "Repeat the parameter (e.g. ?userIds=1&userIds=2) to share the dashboard with multiple users.",
- "required": true,
- "schema": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- },
- "style": "form",
- "explode": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int32"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/tracGroups/{tracGroupId}/tracNumbers/{tracId}/routingRules": {
+ "get": {
+ "tags": [
+ "Tracking Number Routing Rules"
+ ],
+ "summary": "List tracking number routing rules",
+ "description": "Permissions: READ on Trac Number",
+ "operationId": "getTracRoutingRuleByNumber",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "tracId",
+ "in": "path",
+ "description": "tracId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TracRoutingRule"
+ }
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/effectiveAssignedRightsDocs": {
- "get": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Returns a map of merged (master and regular) and aggregated assigned rights documents for a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "getEffectiveAssignedRightsDocForAllAccounts",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "additionalProperties": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Tracking Number Routing Rules"
+ ],
+ "summary": "Create tracking number routing rule",
+ "description": "Permissions: UPDATE on Trac Number",
+ "operationId": "createTracRoutingRule",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ },
+ {
+ "name": "tracId",
+ "in": "path",
+ "description": "tracId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracRoutingRule"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v1/admin/users/{userId}/masterRightsDocs": {
- "get": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Returns a map of master rights documents for a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "getUsersRightsDocs",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "post": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Creates a new master rights document for a user",
- "description": "Permissions: SUPER_USER roles",
- "operationId": "createRightsDoc",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracRoutingRule"
+ }
+ }
}
+ },
+ "default": {
+ "description": "successful operation"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/masterRightsDocs/{rightsDocId}": {
- "get": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Returns a single master rights document for a user",
- "description": "Permissions: SUPER_USER roles",
- "operationId": "getRightsDoc",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "rightsDocId",
- "in": "path",
- "description": "rightsDocId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "put": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Updates an existing master rights document for a user",
- "description": "Permissions: SUPER_USER roles",
- "operationId": "updateRightsDoc",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "rightsDocId",
- "in": "path",
- "description": "rightsDocId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "delete": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Deletes an existing master rights document for a user",
- "description": "Permissions: SUPER_USER roles",
- "operationId": "deleteRightsDoc",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "rightsDocId",
- "in": "path",
- "description": "rightsDocId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- },
- "default": {
- "description": "successful operation"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/tracGroups/{tracGroupId}/tracNumbers/{tracId}/routingRules/{ruleId}": {
+ "get": {
+ "tags": [
+ "Tracking Number Routing Rules"
+ ],
+ "summary": "Get tracking number routing rule",
+ "description": "Permissions: READ on Trac Number",
+ "operationId": "getTracRoutingRule",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "tracId",
+ "in": "path",
+ "description": "tracId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "ruleId",
+ "in": "path",
+ "description": "ruleId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracRoutingRule"
+ }
+ }
}
+ },
+ "default": {
+ "description": "successful operation"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/ownedMasterRightsDocs": {
- "get": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Returns a map of owned master rights documents for a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "getUsersOwnedRightsDocs",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Tracking Number Routing Rules"
+ ],
+ "summary": "Update tracking number routing rule",
+ "description": "Permissions: UPDATE on Trac Number",
+ "operationId": "updateTracRoutingRule",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ },
+ {
+ "name": "tracId",
+ "in": "path",
+ "description": "tracId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "ruleId",
+ "in": "path",
+ "description": "ruleId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracRoutingRule"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v1/admin/users/{userId}/ownedRightsDocs": {
- "get": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Returns a map of owned rights documents for a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "getUsersOwnedRightsDocs2",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracRoutingRule"
+ }
+ }
}
+ },
+ "default": {
+ "description": "successful operation"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/passwordReset": {
- "post": {
- "tags": [
- "User Auth Utilities"
- ],
- "summary": "Resets a user's password and sends reset password email",
- "description": "Permissions: Authenticated User",
- "operationId": "securePasswordRequestResetForUse",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "returnPath",
- "in": "query",
- "description": "returnPath",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "resetViaEngageAuth",
- "in": "query",
- "description": "resetViaEngageAuth",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Tracking Number Routing Rules"
+ ],
+ "summary": "Delete tracking number routing rule",
+ "description": "Permissions: UPDATE on Trac Number",
+ "operationId": "deleteTracRoutingRule",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "tracId",
+ "in": "path",
+ "description": "tracId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ },
+ {
+ "name": "ruleId",
+ "in": "path",
+ "description": "ruleId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/rightsDocs": {
- "get": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Returns a map of rights documents for a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "getRightsDocs",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "post": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Creates a new rights document for a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "createRightsDoc2",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/tracGroups/{tracGroupId}/tracNumbers/{tracId}/scheduleOverrides": {
+ "get": {
+ "tags": [
+ "Tracking Number Schedules"
+ ],
+ "summary": "List tracking number schedule overrides",
+ "description": "Permissions: READ on Trac Number",
+ "operationId": "getTracScheduleOverridesByNumber",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "tracId",
+ "in": "path",
+ "description": "tracId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/TracScheduleOverride"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Tracking Number Schedules"
+ ],
+ "summary": "Create tracking number schedule override",
+ "description": "Permissions: UPDATE on Trac Number (Permission Override)",
+ "operationId": "createTracScheduleOverridesByNumber",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "tracId",
+ "in": "path",
+ "description": "tracId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracScheduleOverride"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracScheduleOverride"
+ }
+ }
+ }
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/tracGroups/{tracGroupId}/tracNumbers/{tracId}/scheduleOverrides/{overrideId}": {
+ "get": {
+ "tags": [
+ "Tracking Number Schedules"
+ ],
+ "summary": "Get tracking number schedule override",
+ "description": "Permissions: READ on Trac Number",
+ "operationId": "getTracScheduleOverride",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "tracId",
+ "in": "path",
+ "description": "tracId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "overrideId",
+ "in": "path",
+ "description": "overrideId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracScheduleOverride"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Tracking Number Schedules"
+ ],
+ "summary": "Update tracking number schedule override",
+ "description": "Permissions: UPDATE on Trac Number",
+ "operationId": "updateTracScheduleOverridesByNumber",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "tracId",
+ "in": "path",
+ "description": "tracId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "overrideId",
+ "in": "path",
+ "description": "overrideId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracScheduleOverride"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TracScheduleOverride"
+ }
+ }
}
+ },
+ "201": {
+ "description": "Created"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/rightsDocs/{rightsDocId}": {
- "get": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Returns a single rights document for a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "getRightsDoc2",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "rightsDocId",
- "in": "path",
- "description": "rightsDocId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "put": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Updates an existing rights document for a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "updateRightsDoc2",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "rightsDocId",
- "in": "path",
- "description": "rightsDocId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "delete": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Deletes an existing rights document for a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "deleteRightsDoc2",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "rightsDocId",
- "in": "path",
- "description": "rightsDocId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- },
- "default": {
- "description": "successful operation"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Tracking Number Schedules"
+ ],
+ "summary": "Delete tracking number schedule override",
+ "description": "Permissions: UPDATE on Trac Number (Permission Override)",
+ "operationId": "deleteTracScheduleOverridesByNumber",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "tracGroupId",
+ "in": "path",
+ "description": "tracGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "tracId",
+ "in": "path",
+ "description": "tracId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "overrideId",
+ "in": "path",
+ "description": "overrideId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/rightsDocsWithSubAccounts": {
- "get": {
- "tags": [
- "Rights Documents"
- ],
- "summary": "Returns a map of rights documents for a user",
- "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles",
- "operationId": "getUsersRightsDocsByMasterDoc",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "enablePreBuiltRoles",
- "in": "query",
- "description": "enablePreBuiltRoles",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "additionalProperties": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RightsDocument"
- }
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/accounts": {
+ "get": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "List telephone number manager accounts",
+ "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "getAccounts",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/Account"
+ }
+ }
+ }
}
+ },
+ "500": {
+ "description": "Internal Server Error"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/roles": {
- "get": {
- "tags": [
- "User Roles"
- ],
- "summary": "Returns a listing of roles for a user",
- "description": "Permissions: MANAGE_USERS or SUPER_USER roles",
- "operationId": "getRoles",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "type": "string",
- "enum": [
- "SUPER_USER",
- "USER",
- "MANAGE_USERS",
- "MANAGE_RIGHTS",
- "ACCESS_SIBLINGS",
- "ACCESS_AUDIT_LOG",
- "ASSUME_USERS",
- "REPORT_ADMINISTRATIVE_USER",
- "WFO_ACCESS",
- "ACCESS_GOODDATA_EDITOR",
- "ACCESS_GOODDATA_ANALYST",
- "ACCESS_GOODDATA_VIEWER",
- "NO_ACCESS"
- ]
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/assignedDnis": {
+ "put": {
+ "tags": [
+ "DNIS Assignments"
+ ],
+ "summary": "Update DNIS assignment",
+ "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "updateDnisAssignment",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssignedDnis"
+ }
+ }
}
+ },
+ "required": false
},
- "/voice/api/v1/admin/users/{userId}/roles/{roleType}": {
- "post": {
- "tags": [
- "User Roles"
- ],
- "summary": "Adds a role to a user",
- "description": "Permissions: MANAGE_USERS or SUPER_USER roles",
- "operationId": "addRole",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "roleType",
- "in": "path",
- "description": "roleType",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "delete": {
- "tags": [
- "User Roles"
- ],
- "summary": "Removes a role from a user",
- "description": "Permissions: MANAGE_USERS or SUPER_USER roles",
- "operationId": "removeRole",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "roleType",
- "in": "path",
- "description": "roleType",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssignedDnis"
+ }
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/users/{userId}/setIsActive": {
- "put": {
- "tags": [
- "Users"
- ],
- "summary": "Set user is active",
- "description": "Permissions: Authenticated User",
- "operationId": "setUserIsActive",
- "parameters": [
- {
- "name": "userId",
- "in": "path",
- "description": "userId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ActiveStateBoolean"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "DNIS Assignments"
+ ],
+ "summary": "Delete DNIS assignment",
+ "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "deleteDnisAssignment",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DeleteDnisRequest"
+ }
}
+ },
+ "required": false
},
- "/voice/api/v1/auth/isTokenValid": {
- "get": {
- "tags": [
- "User Auth Utilities"
- ],
- "summary": "Checks to see if a given token is valid",
- "description": "Permissions: NONE",
- "operationId": "isTokenValid",
- "parameters": [
- {
- "name": "token",
- "in": "query",
- "description": "token",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/auth/passwordReset": {
- "post": {
- "tags": [
- "User Auth Utilities"
- ],
- "summary": "Used to reset a users password",
- "description": "Permissions: NONE",
- "operationId": "passwordReset",
- "parameters": [
- {
- "name": "token",
- "in": "query",
- "description": "token",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "password",
- "in": "query",
- "description": "password",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/assignedDnis/cloudRouteProfiles/{cloudRouteProfileId}": {
+ "put": {
+ "tags": [
+ "DNIS Assignments"
+ ],
+ "summary": "Assign DNIS to cloud route profile",
+ "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "updateAssignedDnisForCloudRouteProfile",
+ "parameters": [
+ {
+ "name": "cloudRouteProfileId",
+ "in": "path",
+ "description": "cloudRouteProfileId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssignedDnis"
+ }
+ }
}
+ },
+ "required": false
},
- "/voice/api/v1/auth/passwordResetRequest": {
- "post": {
- "tags": [
- "User Auth Utilities"
- ],
- "summary": "Resets a password if a user is locked out, an email will be sent to the user",
- "description": "Permissions: NONE",
- "operationId": "passwordResetRequest",
- "parameters": [
- {
- "name": "userName",
- "in": "query",
- "description": "userName",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "returnPath",
- "in": "query",
- "description": "returnPath",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssignedDnis"
+ }
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/agent-states/subscriptions": {
- "get": {
- "tags": [
- "Agent State Subscriptions"
- ],
- "summary": "List agent state subscriptions",
- "description": "Permissions: WFO_ACCESS role",
- "operationId": "getAllSubscriptions",
- "parameters": [
- {
- "name": "rcAccountId",
- "in": "path",
- "description": "rcAccountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "subAccountId",
- "in": "path",
- "description": "subAccountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/RTASubscriptionResponse"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "post": {
- "tags": [
- "Agent State Subscriptions"
- ],
- "summary": "Create agent state subscription",
- "description": "Permissions: WFO_ACCESS role",
- "operationId": "subscribe",
- "parameters": [
- {
- "name": "rcAccountId",
- "in": "path",
- "description": "rcAccountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "subAccountId",
- "in": "path",
- "description": "subAccountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RTASubscriptionRequest"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RTASubscriptionResponse"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/assignedDnis/gates/{gateId}": {
+ "put": {
+ "tags": [
+ "DNIS Assignments"
+ ],
+ "summary": "Assign DNIS to queue",
+ "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "updateAssignedDnisForGate",
+ "parameters": [
+ {
+ "name": "gateId",
+ "in": "path",
+ "description": "gateId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssignedDnis"
+ }
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssignedDnis"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/assignedDnis/visualIvrs/{visualIvrId}": {
+ "put": {
+ "tags": [
+ "DNIS Assignments"
+ ],
+ "summary": "Assign DNIS to visual IVR",
+ "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "updateAssignedDnisForVisualIvr",
+ "parameters": [
+ {
+ "name": "visualIvrId",
+ "in": "path",
+ "description": "visualIvrId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssignedDnis"
+ }
+ }
}
+ },
+ "required": false
},
- "/voice/api/cx/integration/v1/accounts/{rcAccountId}/sub-accounts/{subAccountId}/agent-states/subscriptions/{subscriptionId}": {
- "put": {
- "tags": [
- "Agent State Subscriptions"
- ],
- "summary": "Update agent state subscription",
- "description": "Permissions: WFO_ACCESS role",
- "operationId": "updateSubscription",
- "parameters": [
- {
- "name": "rcAccountId",
- "in": "path",
- "description": "rcAccountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "subAccountId",
- "in": "path",
- "description": "subAccountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "subscriptionId",
- "in": "path",
- "description": "subscriptionId",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RTASubscriptionRequest"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/RTASubscriptionResponse"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "delete": {
- "tags": [
- "Agent State Subscriptions"
- ],
- "summary": "Delete agent state subscription",
- "description": "Permissions: WFO_ACCESS role",
- "operationId": "deleteSubscription",
- "parameters": [
- {
- "name": "rcAccountId",
- "in": "path",
- "description": "rcAccountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "subAccountId",
- "in": "path",
- "description": "subAccountId",
- "required": true,
- "schema": {
- "type": "string"
- }
- },
- {
- "name": "subscriptionId",
- "in": "path",
- "description": "subscriptionId",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "default": {
- "description": "successful operation"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/AssignedDnis"
+ }
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups": {
- "get": {
- "tags": [
- "Cloud Route Destination Groups"
- ],
- "summary": "Returns a listing of cloud route groups for an account",
- "description": "Permissions: READ on Account, Post Filtered Results",
- "operationId": "getCloudRouteDestinationGroupList",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteGroup"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "post": {
- "tags": [
- "Cloud Route Destination Groups"
- ],
- "summary": "Create a cloud route group for an account",
- "description": "Permissions: CREATE on Account",
- "operationId": "createCloudRouteGroup",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteGroup"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteGroup"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/assignedDnis/{dnis}": {
+ "get": {
+ "tags": [
+ "DNIS Assignments"
+ ],
+ "summary": "Get DNIS assignment",
+ "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "getAssignedDnis",
+ "parameters": [
+ {
+ "name": "dnis",
+ "in": "path",
+ "description": "dnis",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AssignedDnis"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/withChildren": {
- "get": {
- "tags": [
- "Cloud Route Destination Groups"
- ],
- "summary": "Returns a listing of cloud route groups with related data for an account",
- "description": "Permissions: READ on Account, Post Filtered Results",
- "operationId": "getListWithProfileChildren",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "includePermissions",
- "in": "query",
- "description": "includePermissions",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteGroup"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "DNIS Assignments"
+ ],
+ "summary": "Delete DNIS assignment",
+ "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "deleteAssignedDnis",
+ "parameters": [
+ {
+ "name": "dnis",
+ "in": "path",
+ "description": "dnis",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}": {
- "get": {
- "tags": [
- "Cloud Route Destination Groups"
- ],
- "summary": "Returns a cloud route group for an account",
- "description": "Permissions: READ on Cloud Route Group",
- "operationId": "getCloudRouteDestinationGroupsCloudRouteGroupId",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteGroup"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "put": {
- "tags": [
- "Cloud Route Destination Groups"
- ],
- "summary": "Updates a cloud route group for an account",
- "description": "Permissions: UPDATE on Cloud Route Group",
- "operationId": "updateCloudRouteGroup",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteGroup"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteGroup"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "delete": {
- "tags": [
- "Cloud Route Destination Groups"
- ],
- "summary": "Deletes a cloud route group for an account",
- "description": "Permissions: DELETE on Cloud Route Group",
- "operationId": "deleteCloudRouteGroup",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/checkNewDnisList": {
+ "post": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Check DNIS pool records",
+ "description": "Permissions: UPDATE on TN_MANAGER, filter out restricted accounts",
+ "operationId": "validateNewDnisList",
+ "parameters": [
+ {
+ "name": "phoneNumbersI18nEnabled",
+ "in": "query",
+ "description": "phoneNumbersI18nEnabled",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
}
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations": {
- "get": {
- "tags": [
- "Cloud Route Destinations"
- ],
- "summary": "Returns a listing of cloud destinations for a cloud route group",
- "description": "Permissions: READ on Cloud Destination, Post Filtered Results",
- "operationId": "getCloudRouteDestinationList",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteDestination"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "post": {
- "tags": [
- "Cloud Route Destinations"
- ],
- "summary": "Create a cloud destination for a cloud route group",
- "description": "Permissions: CREATE on Cloud Destination",
- "operationId": "createCloudRouteDestination",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDestination"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDestination"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/withChildren": {
- "get": {
- "tags": [
- "Cloud Route Destinations"
- ],
- "summary": "Returns a listing of cloud destinations with related data for a cloud route group",
- "description": "Permissions: READ on Cloud Destinations, Post Filtered Results",
- "operationId": "getListWithChildren",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "includePermissions",
- "in": "query",
- "description": "includePermissions",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteDestination"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/dnisPool": {
+ "post": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Create DNIS pool records",
+ "description": "Has Role: SUPER_USER",
+ "operationId": "createDnisPool",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DnisPool"
+ }
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DnisPool"
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Update DNIS pool record",
+ "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "updateDnisPool",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DnisPool"
+ }
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DnisPool"
+ }
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/dnisPool/bulkDelete": {
+ "put": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Bulk delete DNIS pools",
+ "description": "Has Role: SUPER_USER",
+ "operationId": "deleteDnisList",
+ "parameters": [
+ {
+ "name": "phoneNumbersI18nEnabled",
+ "in": "query",
+ "description": "phoneNumbersI18nEnabled",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/dnisPool/{dnis}": {
+ "get": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Get DNIS pool record",
+ "description": "Permissions: READ on TN_MANAGER",
+ "operationId": "getUtilitiesTnManagerDnisPoolDnis",
+ "parameters": [
+ {
+ "name": "dnis",
+ "in": "path",
+ "description": "dnis",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "phoneNumbersI18nEnabled",
+ "in": "query",
+ "description": "phoneNumbersI18nEnabled",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DnisPool"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}": {
- "get": {
- "tags": [
- "Cloud Route Destinations"
- ],
- "summary": "Returns a cloud destination for a cloud route group",
- "description": "Permissions: READ on Cloud Destination",
- "operationId": "getCloudRouteDestination",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDestination"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "put": {
- "tags": [
- "Cloud Route Destinations"
- ],
- "summary": "Updates a cloud destination for a cloud route group",
- "description": "Permissions: UPDATE on Cloud Destination",
- "operationId": "updateCloudRouteDestination",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDestination"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDestination"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Delete DNIS pool record",
+ "description": "Has Role: SUPER_USER",
+ "operationId": "deleteDnis",
+ "parameters": [
+ {
+ "name": "dnis",
+ "in": "path",
+ "description": "dnis",
+ "required": true,
+ "schema": {
+ "type": "string"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}/assignedProfiles": {
- "get": {
- "tags": [
- "Cloud Route Assignments"
- ],
- "summary": "Returns a listing of assigned profiles for a cloud route destination",
- "description": "Permissions: READ on Cloud Destination",
- "operationId": "getListByDestination",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "post": {
- "tags": [
- "Cloud Route Assignments"
- ],
- "summary": "Creates an assigned profile for a cloud route destination",
- "description": "Permissions: UPDATE on Cloud Destination (Permissions Override)",
- "operationId": "createCloudAssignedDestination",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/mediaValues": {
+ "get": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "List telephone number media values",
+ "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "getMediaValues",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/MediaCodeValuesOnDnisPool"
+ }
+ }
}
+ },
+ "500": {
+ "description": "Internal Server Error"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}/assignedProfiles/{cloudAssignedDestinationId}": {
- "get": {
- "tags": [
- "Cloud Route Assignments"
- ],
- "summary": "Returns an assigned profile for a cloud route destination",
- "description": "Permissions: READ on Cloud Destination",
- "operationId": "getCloudRouteDestinationGroupsCloudRouteGroupIdCloudRouteDestinationsCloudRouteDestinationIdAssignedProfilesCloudAssignedDestinationId",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedDestinationId",
- "in": "path",
- "description": "cloudAssignedDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "put": {
- "tags": [
- "Cloud Route Assignments"
- ],
- "summary": "Updates an assigned profile for a cloud route destination",
- "description": "Permissions: UPDATE on Cloud Destination",
- "operationId": "updateCloudAssignedDestination",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedDestinationId",
- "in": "path",
- "description": "cloudAssignedDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "delete": {
- "tags": [
- "Cloud Route Assignments"
- ],
- "summary": "Deletes an assigned profile for a cloud route destination",
- "description": "Permissions: UPDATE on Cloud Destination (Permissions Override)",
- "operationId": "deleteCloudAssignedDestination",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedDestinationId",
- "in": "path",
- "description": "cloudAssignedDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/report": {
+ "post": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Create DNIS pool report",
+ "description": "Permissions: READ on Account, READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "getDnisPoolListAsReport",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TnManagerSearchCriteria"
+ }
}
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}/clone": {
- "post": {
- "tags": [
- "Cloud Route Destinations"
- ],
- "summary": "Creates a clone of the cloud route destination for a cloud group",
- "description": "Permissions: READ on existing Cloud Route Destination and CREATE on Cloud Group (Permission Override)",
- "operationId": "cloneCloudRouteDestination",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "newDestinationName",
- "in": "query",
- "description": "newDestinationName",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDestination"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "500": {
+ "description": "Internal Server Error"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/search": {
+ "post": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Search DNIS pools",
+ "description": "Permissions: READ on Account, READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "search",
+ "parameters": [
+ {
+ "name": "count",
+ "in": "query",
+ "description": "count",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ },
+ {
+ "name": "page",
+ "in": "query",
+ "description": "page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "maxRows",
+ "in": "query",
+ "description": "maxRows",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/TnManagerSearchCriteria"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}/dnisOverrides": {
- "get": {
- "tags": [
- "Cloud Route DNIS Overrides"
- ],
- "summary": "Returns a listing of dnis overrides for a cloud route destination",
- "description": "Permissions: READ on Cloud Destination",
- "operationId": "getDnisOverrideList",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteDestinationOverride"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "post": {
- "tags": [
- "Cloud Route DNIS Overrides"
- ],
- "summary": "Create a dnis override for a cloud route destination",
- "description": "Permissions: UPDATE on Cloud Destination (Permission Override)",
- "operationId": "createDnisOverride",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudDestinationType",
- "in": "query",
- "description": "cloudDestinationType",
- "required": true,
- "schema": {
- "type": "string",
- "enum": [
- "STANDARD",
- "DID",
- "SIP",
- "IN_NETWORK_DID",
- "ACD",
- "IVR",
- "IVR_STUDIO"
- ]
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDestinationOverride"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDestinationOverride"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/searchDnis": {
+ "post": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Search customer DNIS pools",
+ "description": "Permissions: READ on Account, READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "searchDnis",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DnisListRequest"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/updateBulkDnisPool": {
+ "put": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Bulk update DNIS pools",
+ "description": "Permissions: READ/WRITE on TN_MANAGER, filter out restricted accounts",
+ "operationId": "updateBulkDnisPool",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DnisPool"
+ }
+ }
}
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}/dnisOverrides/batch": {
- "post": {
- "tags": [
- "Cloud Route DNIS Overrides"
- ],
- "summary": "Create a list dnis overrides for a cloud route destination",
- "description": "Permissions: UPDATE on Cloud Destination (Permission Override)",
- "operationId": "createDnisOverrideBatch",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "replaceAll",
- "in": "query",
- "description": "replaceAll",
- "required": true,
- "schema": {
- "type": "boolean"
- }
- },
- {
- "name": "phoneNumbersI18nEnabled",
- "in": "query",
- "description": "phoneNumbersI18nEnabled",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteDestinationOverride"
- }
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "multipart/form-data": {
- "schema": {
- "type": "object",
- "properties": {
- "file": {
- "type": "string",
- "format": "binary",
- "description": "DNIS override upload file."
- }
- },
- "required": [
- "file"
- ]
- }
- }
- },
- "description": "Delimited file containing DNIS overrides for the cloud route destination."
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DnisBulkUpdateRespose"
}
+ }
}
+ },
+ "500": {
+ "description": "Internal Server Error"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}/dnisOverrides/{cloudRouteDestinationOverrideId}": {
- "get": {
- "tags": [
- "Cloud Route DNIS Overrides"
- ],
- "summary": "Returns a dnis override for a cloud route destination",
- "description": "Permissions: READ on Cloud Destination",
- "operationId": "getCloudRouteDestinationOverride",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationOverrideId",
- "in": "path",
- "description": "cloudRouteDestinationOverrideId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDestinationOverride"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "put": {
- "tags": [
- "Cloud Route DNIS Overrides"
- ],
- "summary": "Updates a dnis override for a cloud route destination",
- "description": "Permissions: UPDATE on Cloud Destination",
- "operationId": "updateCloudRouteDestinationOverride",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationOverrideId",
- "in": "path",
- "description": "cloudRouteDestinationOverrideId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudDestinationType",
- "in": "query",
- "description": "cloudDestinationType",
- "required": true,
- "schema": {
- "type": "string",
- "enum": [
- "STANDARD",
- "DID",
- "SIP",
- "IN_NETWORK_DID",
- "ACD",
- "IVR",
- "IVR_STUDIO"
- ]
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDestinationOverride"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDestinationOverride"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "delete": {
- "tags": [
- "Cloud Route DNIS Overrides"
- ],
- "summary": "Deletes a dnis override for a cloud route destination",
- "description": "Permissions: UPDATE on Cloud Destination (Permission Override)",
- "operationId": "deleteCloudRoute",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationOverrideId",
- "in": "path",
- "description": "cloudRouteDestinationOverrideId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/updateCustomerDnisBulk": {
+ "put": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Bulk update customer DNIS records",
+ "description": "",
+ "operationId": "updateCustomerDnisBulk",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "string"
+ }
}
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteDestinationGroups/{cloudRouteGroupId}/cloudRouteDestinations/{cloudRouteDestinationId}/setIsActive": {
- "put": {
- "tags": [
- "Cloud Route Destinations"
- ],
- "summary": "Set active state for a cloud route destination",
- "description": "Permissions: UPDATE on Cloud Destination",
- "operationId": "setCloudRouteDestinationIsActive",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteDestinationId",
- "in": "path",
- "description": "cloudRouteDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ActiveStateBoolean"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
}
+ },
+ "500": {
+ "description": "Internal Server Error"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/withChildren": {
- "get": {
- "tags": [
- "Cloud Route Profile Groups"
- ],
- "summary": "Returns a listing of Cloud Route Groups with children for an Account",
- "description": "Permissions: READ on Account, Post Filtered Results",
- "operationId": "getListWithProfileChildren2",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "includePermissions",
- "in": "query",
- "description": "includePermissions",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteGroup"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/updatePoolAndAssignment": {
+ "put": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Update DNIS pool and assignments",
+ "description": "",
+ "operationId": "UpdateDnisPoolAndAssignments",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/DnisPoolUpdateRequest"
+ }
+ }
}
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}": {
- "get": {
- "tags": [
- "Cloud Route Profile Groups"
- ],
- "summary": "Returns a single Cloud Route Group",
- "description": "Permissions: READ on Cloud Route Group",
- "operationId": "getCloudRouteProfileGroupsCloudRouteGroupId",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteGroup"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "put": {
- "tags": [
- "Cloud Route Profile Groups"
- ],
- "summary": "Updates a single Cloud Route Group",
- "description": "Permissions: UPDATE on Cloud Route Group",
- "operationId": "updateCloudRouteGroup2",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteGroup"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteGroup"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "delete": {
- "tags": [
- "Cloud Route Profile Groups"
- ],
- "summary": "Deletes a specific Cloud Route Group",
- "description": "Permissions: DELETE on Cloud Route Group",
- "operationId": "deleteCloudRouteGroup2",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
}
+ },
+ "500": {
+ "description": "Internal Server Error"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles": {
- "get": {
- "tags": [
- "Cloud Route Profiles"
- ],
- "summary": "Returns a listing of cloud route profiles for a cloud group",
- "description": "Permissions: READ on Cloud Group, Post Filtered Results",
- "operationId": "getCloudRouteProfileList",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteProfile"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "post": {
- "tags": [
- "Cloud Route Profiles"
- ],
- "summary": "Create a cloud route profile for a cloud group",
- "description": "Permissions: CREATE on Cloud Group",
- "operationId": "createCloudRouteProfile",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteProfile"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteProfile"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/utilities/tnManager/uploadDnisPool": {
+ "post": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Upload DNIS pool records",
+ "description": "Has Role: USER",
+ "operationId": "uploadDnisPool",
+ "parameters": [
+ {
+ "name": "fileType",
+ "in": "query",
+ "description": "Delimiter format of the uploaded file.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "enum": [
+ "COMMA"
+ ]
+ }
+ },
+ {
+ "name": "quoteCharacter",
+ "in": "query",
+ "description": "Quote character used in the uploaded file when fields contain the delimiter.",
+ "required": false,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "phoneNumbersI18nEnabled",
+ "in": "query",
+ "description": "phoneNumbersI18nEnabled",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Delimited file containing DNIS pool records.",
+ "required": true,
+ "content": {
+ "multipart/form-data": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "file"
+ ],
+ "properties": {
+ "file": {
+ "type": "string",
+ "format": "binary",
+ "description": "DNIS pool upload file."
+ }
+ }
+ }
}
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudProfileId}": {
- "get": {
- "tags": [
- "Cloud Route Profiles"
- ],
- "summary": "Returns a cloud route profile for a cloud group",
- "description": "Permissions: READ on Cloud Group",
- "operationId": "getCloudRouteProfile",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudProfileId",
- "in": "path",
- "description": "cloudProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteProfile"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DnisListPreviewResponse"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}": {
- "put": {
- "tags": [
- "Cloud Route Profiles"
- ],
- "summary": "Updates a cloud route profile for a cloud group",
- "description": "Permissions: UPDATE on Cloud Profile",
- "operationId": "updateCloudRouteProfile",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteProfile"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteProfile"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v2/admin/utilities/tnManager/searchDnis": {
+ "post": {
+ "tags": [
+ "Number Management"
+ ],
+ "summary": "Search customer DNIS pools",
+ "description": "Permissions: READ on Account, READ on TN_MANAGER, filter out restricted accounts",
+ "operationId": "getCustomerDnisPoolList2",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DnisListRequest"
+ }
}
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations": {
- "get": {
- "tags": [
- "Cloud Route Assignments"
- ],
- "summary": "Returns a listing of assigned destinations for a cloud route profile",
- "description": "Permissions: READ on Cloud Profile",
- "operationId": "getCloudAssignedDestinationList",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "post": {
- "tags": [
- "Cloud Route Assignments"
- ],
- "summary": "Creates an assigned destination for a cloud route profile",
- "description": "Permissions: CREATE on Cloud Profile",
- "operationId": "createCloudAssignedDestination2",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DnisSearchResultDTO"
+ }
+ }
}
+ },
+ "500": {
+ "description": "Internal Server Error"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations/batch": {
- "put": {
- "tags": [
- "Cloud Route Assignments"
- ],
- "summary": "Updates a list of assigned destinations for a cloud route profile",
- "description": "Permissions: UPDATE on Cloud Profile",
- "operationId": "batchUpdateCloudAssignedDestinations",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/external/authConfigs": {
+ "get": {
+ "tags": [
+ "External Auth Configurations"
+ ],
+ "summary": "List external auth configurations",
+ "description": "",
+ "operationId": "getExternalAuthConfigsList",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "page",
+ "in": "query",
+ "description": "page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "maxRows",
+ "in": "query",
+ "description": "maxRows",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
}
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigList"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations/percentAllocationHours/export": {
- "post": {
- "tags": [
- "Cloud Route Assignments"
- ],
- "summary": "Exports the percent allocations for a list of assigned destinations for a cloud route profile",
- "description": "Permissions: READ on Cloud Profile (Permission Override)",
- "operationId": "exportPercentAllocationHours",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- },
- "default": {
- "description": "successful operation"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/oauth/info": {
+ "get": {
+ "tags": [
+ "External Auth Configurations"
+ ],
+ "summary": "Get external auth OAuth metadata",
+ "description": "",
+ "operationId": "getExternalAccountAuthConfigOauthInfo",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "oauthProvider",
+ "in": "query",
+ "description": "oauthProvider",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigOAuthUrl"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations/percentAllocationHours/import": {
- "post": {
- "tags": [
- "Cloud Route Assignments"
- ],
- "summary": "Updates the percent allocations for a list of assigned destinations for a cloud route profile",
- "description": "Permissions: UPDATE on Cloud Profile (Permission Override)",
- "operationId": "importPercentAllocationHours",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "extension",
- "in": "query",
- "description": "Delimiter used in the uploaded allocation-hours file.",
- "required": true,
- "schema": {
- "type": "string",
- "enum": [
- "PIPE",
- "COMMA",
- "TAB"
- ]
- }
- }
- ],
- "requestBody": {
- "description": "Allocation-hours file exported from the matching `percentAllocationHours/export` endpoint and edited offline.",
- "required": true,
- "content": {
- "multipart/form-data": {
- "schema": {
- "type": "object",
- "required": [
- "file"
- ],
- "properties": {
- "file": {
- "type": "string",
- "format": "binary",
- "description": "Updated allocation-hours file."
- }
- }
- }
- }
- }
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/{authConfigId}": {
+ "get": {
+ "tags": [
+ "External Auth Configurations"
+ ],
+ "summary": "Get external auth configuration",
+ "description": "",
+ "operationId": "getExternalAuthConfigById",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
}
+ },
+ {
+ "name": "authConfigId",
+ "in": "path",
+ "description": "authConfigId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/GetExternalAuthConfigById200Response"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations/{cloudAssignedDestinationId}": {
- "get": {
- "tags": [
- "Cloud Route Assignments"
- ],
- "summary": "Returns an assigned destination for a cloud route profile",
- "description": "Permissions: READ on Cloud Profile",
- "operationId": "getCloudRouteProfileGroupsCloudRouteGroupIdCloudRouteProfilesCloudRouteProfileIdAssignedDestinationsCloudAssignedDestinationId",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedDestinationId",
- "in": "path",
- "description": "cloudAssignedDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "put": {
- "tags": [
- "Cloud Route Assignments"
- ],
- "summary": "Updates an assigned destination for a cloud route profile",
- "description": "Permissions: UPDATE on Cloud Profile",
- "operationId": "updateCloudAssignedDestination2",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedDestinationId",
- "in": "path",
- "description": "cloudAssignedDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedDestination"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "delete": {
- "tags": [
- "Cloud Route Assignments"
- ],
- "summary": "Deletes an assigned destination for a cloud route profile",
- "description": "Permissions: DELETE on Cloud Profile",
- "operationId": "deleteCloudAssignedDestination2",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedDestinationId",
- "in": "path",
- "description": "cloudAssignedDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "External Auth Configurations"
+ ],
+ "summary": "Delete external auth configuration",
+ "description": "",
+ "operationId": "deleteExternalAuthConfigById",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "authConfigId",
+ "in": "path",
+ "description": "authConfigId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": ""
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/{authConfigId}/apiKey": {
+ "post": {
+ "tags": [
+ "External Auth Configurations"
+ ],
+ "summary": "Create API key external auth configuration",
+ "description": "",
+ "operationId": "createExternalAccountAuthConfigApiKey",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "authConfigId",
+ "in": "path",
+ "description": "authConfigId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigApiKey"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigApiKey"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations/{cloudAssignedDestinationId}/dnisOverrides": {
- "get": {
- "tags": [
- "Cloud Route DNIS Overrides"
- ],
- "summary": "Returns a listing of dnis overrides for a cloud route profile assigned destination",
- "description": "Permissions: READ on Cloud Profile",
- "operationId": "getCloudRouteProfileGroupsCloudRouteGroupIdCloudRouteProfilesCloudRouteProfileIdAssignedDestinationsCloudAssignedDestinationIdDnisOverrides",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedDestinationId",
- "in": "path",
- "description": "cloudAssignedDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteAssignedOverride"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "post": {
- "tags": [
- "Cloud Route DNIS Overrides"
- ],
- "summary": "Creates a dnis override for a cloud route profile assigned destination",
- "description": "Permissions: UPDATE on Cloud Profile (Permission Override)",
- "operationId": "createCloudRouteAssignedOverride",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedDestinationId",
- "in": "path",
- "description": "cloudAssignedDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudDestinationType",
- "in": "query",
- "description": "cloudDestinationType",
- "required": true,
- "schema": {
- "type": "string",
- "enum": [
- "STANDARD",
- "DID",
- "SIP",
- "IN_NETWORK_DID",
- "ACD",
- "IVR",
- "IVR_STUDIO"
- ]
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedOverride"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedOverride"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "patch": {
+ "tags": [
+ "External Auth Configurations"
+ ],
+ "summary": "Update API key external auth configuration",
+ "description": "",
+ "operationId": "patchExternalAuthConfigApiKey",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
}
+ },
+ {
+ "name": "authConfigId",
+ "in": "path",
+ "description": "authConfigId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigApiKey"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations/{cloudAssignedDestinationId}/dnisOverrides/batch": {
- "post": {
- "tags": [
- "Cloud Route DNIS Overrides"
- ],
- "summary": "Create a list of dnis overrides for a cloud route profile assigned destination",
- "description": "Permissions: UPDATE on Cloud Profile (Permission Override) ",
- "operationId": "createCloudRouteAssignedOverrideList",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedDestinationId",
- "in": "path",
- "description": "cloudAssignedDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "replaceAll",
- "in": "query",
- "description": "replaceAll",
- "required": true,
- "schema": {
- "type": "boolean"
- }
- },
- {
- "name": "phoneNumbersI18nEnabled",
- "in": "query",
- "description": "phoneNumbersI18nEnabled",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteAssignedOverride"
- }
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "multipart/form-data": {
- "schema": {
- "type": "object",
- "properties": {
- "file": {
- "type": "string",
- "format": "binary",
- "description": "DNIS override upload file."
- }
- },
- "required": [
- "file"
- ]
- }
- }
- },
- "description": "Delimited file containing DNIS overrides for the assigned destination."
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigApiKey"
}
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/assignedDestinations/{cloudAssignedDestinationId}/dnisOverrides/{cloudAssignedOverrideId}": {
- "get": {
- "tags": [
- "Cloud Route DNIS Overrides"
- ],
- "summary": "Returns a dnis override for a cloud route profile assigned destination",
- "description": "Permissions: READ on Cloud Profile",
- "operationId": "getOverride",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedDestinationId",
- "in": "path",
- "description": "cloudAssignedDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedOverrideId",
- "in": "path",
- "description": "cloudAssignedOverrideId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedOverride"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "put": {
- "tags": [
- "Cloud Route DNIS Overrides"
- ],
- "summary": "Updates a dnis override for a cloud route profile assigned destination",
- "description": "Permissions: UPDATE on Cloud Profile",
- "operationId": "updateCloudRouteDestinationOverride2",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedDestinationId",
- "in": "path",
- "description": "cloudAssignedDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedOverrideId",
- "in": "path",
- "description": "cloudAssignedOverrideId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudDestinationType",
- "in": "query",
- "description": "cloudDestinationType",
- "required": true,
- "schema": {
- "type": "string",
- "enum": [
- "STANDARD",
- "DID",
- "SIP",
- "IN_NETWORK_DID",
- "ACD",
- "IVR",
- "IVR_STUDIO"
- ]
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedOverride"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteAssignedOverride"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "delete": {
- "tags": [
- "Cloud Route DNIS Overrides"
- ],
- "summary": "Deletes a dnis override for a cloud route profile assigned destination",
- "description": "Permissions: UPDATE on Cloud Profile (Permission Override)",
- "operationId": "deleteCloudRouteAssignedOverride",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedDestinationId",
- "in": "path",
- "description": "cloudAssignedDestinationId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudAssignedOverrideId",
- "in": "path",
- "description": "cloudAssignedOverrideId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/{authConfigId}/basic": {
+ "post": {
+ "tags": [
+ "External Auth Configurations"
+ ],
+ "summary": "Create basic external auth configuration",
+ "description": "",
+ "operationId": "createExternalAccountAuthConfigBasic",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "authConfigId",
+ "in": "path",
+ "description": "authConfigId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
}
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigBasic"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/clone": {
- "post": {
- "tags": [
- "Cloud Route Profiles"
- ],
- "summary": "Creates a clone of the cloud route profile for a cloud group",
- "description": "Permissions: READ on cloned Cloud Route Profile and CREATE on Cloud Group (Permission Override)",
- "operationId": "cloneCloudRouteProfile",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "newCloudRouteProfileName",
- "in": "query",
- "description": "newCloudRouteProfileName",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteProfile"
- }
- }
- }
- },
- "201": {
- "description": "Created"
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigBasic"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/dtmfEvents": {
- "get": {
- "tags": [
- "Cloud Route DTMF Events"
- ],
- "summary": "Returns a listing of dtmf events for a cloud route profile",
- "description": "Permissions: READ Cloud Profile",
- "operationId": "getCloudRouteDtmfEventList",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteDtmfEvent"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "post": {
- "tags": [
- "Cloud Route DTMF Events"
- ],
- "summary": "Creates a dtmf event for a cloud profile",
- "description": "Permissions: UPDATE on Cloud Profile (Permission Override)",
- "operationId": "createCloudRouteDtmfEvent",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDtmfEvent"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDtmfEvent"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "patch": {
+ "tags": [
+ "External Auth Configurations"
+ ],
+ "summary": "Update basic external auth configuration",
+ "description": "",
+ "operationId": "patchExternalAuthConfigBasic",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "authConfigId",
+ "in": "path",
+ "description": "authConfigId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigBasic"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigBasic"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/{authConfigId}/customAuth": {
+ "post": {
+ "tags": [
+ "External Auth Configurations"
+ ],
+ "summary": "Create custom external auth configuration",
+ "description": "",
+ "operationId": "createExternalAccountAuthConfigCustomAuth",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
}
+ },
+ {
+ "name": "authConfigId",
+ "in": "path",
+ "description": "authConfigId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigCustomAuth"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/dtmfEvents/{dtmfEventId}": {
- "get": {
- "tags": [
- "Cloud Route DTMF Events"
- ],
- "summary": "Returns a dtmf event for a cloud profile",
- "description": "Permissions: READ on Cloud Profile",
- "operationId": "getCloudRouteDtmfEvent",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "dtmfEventId",
- "in": "path",
- "description": "dtmfEventId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDtmfEvent"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "put": {
- "tags": [
- "Cloud Route DTMF Events"
- ],
- "summary": "Updates a dtmf event for a cloud route profile",
- "description": "Permissions: UPDATE on Cloud Profile",
- "operationId": "updateCloudRouteDtmfEvent",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "dtmfEventId",
- "in": "path",
- "description": "dtmfEventId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDtmfEvent"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/CloudRouteDtmfEvent"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
- },
- "delete": {
- "tags": [
- "Cloud Route DTMF Events"
- ],
- "summary": "Deletes a dtmf event for a cloud route profile",
- "description": "Permissions: UPDATE on Cloud Profile (Permission Override) ",
- "operationId": "deleteCloudRouteDtmfEvent",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "dtmfEventId",
- "in": "path",
- "description": "dtmfEventId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigCustomAuth"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/setIsActive": {
- "put": {
- "tags": [
- "Cloud Route Profiles"
- ],
- "summary": "Set active state for a cloud route profile",
- "description": "Permissions: UPDATE on Cloud Profile",
- "operationId": "setCloudRouteProfileIsActive",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/ActiveStateBoolean"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "patch": {
+ "tags": [
+ "External Auth Configurations"
+ ],
+ "summary": "Update custom external auth configuration",
+ "description": "",
+ "operationId": "patchExternalAuthConfigCustomAuth",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
}
+ },
+ {
+ "name": "authConfigId",
+ "in": "path",
+ "description": "authConfigId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigCustomAuth"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/stickyDestinations/searchByAnis": {
- "get": {
- "tags": [
- "Cloud Route Sticky Destinations"
- ],
- "summary": "Returns a listing of sticky destinations by ani for a cloud route profile",
- "description": "Permissions: READ on Cloud Profile",
- "operationId": "getListByAni",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "aniParams",
- "in": "query",
- "description": "aniParams",
- "required": true,
- "schema": {
- "type": "boolean"
- }
- },
- {
- "name": "anis",
- "in": "query",
- "description": "anis",
- "required": false,
- "schema": {
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- },
- {
- "name": "fullAni",
- "in": "query",
- "description": "fullAni",
- "required": false,
- "schema": {
- "type": "boolean"
- }
- },
- {
- "name": "count",
- "in": "query",
- "description": "count",
- "required": false,
- "schema": {
- "type": "boolean",
- "default": false
- }
- },
- {
- "name": "page",
- "in": "query",
- "description": "page",
- "required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "maxRows",
- "in": "query",
- "description": "maxRows",
- "required": false,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "object"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigCustomAuth"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v1/admin/accounts/{accountId}/cloudRouteProfileGroups/{cloudRouteGroupId}/cloudRouteProfiles/{cloudRouteProfileId}/stickyDestinations/{ani}": {
- "delete": {
- "tags": [
- "Cloud Route Sticky Destinations"
- ],
- "summary": "Deletes a sticky destination by ani for a cloud route profile",
- "description": "Permissions: UPDATE on Cloud Profile (Permission Override)",
- "operationId": "deleteByAni",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- },
- {
- "name": "cloudRouteGroupId",
- "in": "path",
- "description": "cloudRouteGroupId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "cloudRouteProfileId",
- "in": "path",
- "description": "cloudRouteProfileId",
- "required": true,
- "schema": {
- "type": "integer",
- "format": "int32"
- }
- },
- {
- "name": "ani",
- "in": "path",
- "description": "ani",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "boolean"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/{authConfigId}/jwt": {
+ "post": {
+ "tags": [
+ "External Auth Configurations"
+ ],
+ "summary": "Create JWT external auth configuration",
+ "description": "",
+ "operationId": "createExternalAccountAuthConfigJwt",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "authConfigId",
+ "in": "path",
+ "description": "authConfigId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
}
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigJwt"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v2-skinny/admin/accounts/{accountId}/cloudRouteDestinationGroups": {
- "get": {
- "tags": [
- "Cloud Route Destination Groups"
- ],
- "summary": "Returns a listing of cloud route groups by account. This will not return the destinations under a group. Pass in the account id you'd like to search by as a parameter.",
- "description": "Permissions: READ on Account, Post Filtered Results",
- "operationId": "getSkinnyCloudRouteDestinationGroups",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteGroupSkinny"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigJwt"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v2-skinny/admin/accounts/{accountId}/cloudRouteDestinationGroups/withChildren": {
- "get": {
- "tags": [
- "Cloud Route Destination Groups"
- ],
- "summary": "Returns a listing of cloud route groups, and the individual cloud destinations underneath each group, by account. Pass in the account id you'd like to search by as a parameter.",
- "description": "Permissions: READ on Account, Post Filtered Results",
- "operationId": "getListWithProfileChildren3",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteGroupSkinny"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "patch": {
+ "tags": [
+ "External Auth Configurations"
+ ],
+ "summary": "Update JWT external auth configuration",
+ "description": "",
+ "operationId": "patchExternalAuthConfigJwt",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
}
+ },
+ {
+ "name": "authConfigId",
+ "in": "path",
+ "description": "authConfigId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigJwt"
+ }
+ }
+ },
+ "required": false
},
- "/voice/api/v2-skinny/admin/accounts/{accountId}/cloudRouteProfileGroups": {
- "get": {
- "tags": [
- "Cloud Route Profile Groups"
- ],
- "summary": "Returns a listing of cloud route groups by account. This will not return the cloud route profiles under a group.Pass in the account id you'd like to search by as a parameter.",
- "description": "Permissions: READ on Account, Post Filtered Results",
- "operationId": "getSkinnyCloudRouteProfileGroups",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteGroupSkinny"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigJwt"
+ }
+ }
}
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- "/voice/api/v2-skinny/admin/accounts/{accountId}/cloudRouteProfileGroups/withChildren": {
- "get": {
- "tags": [
- "Cloud Route Profile Groups"
- ],
- "summary": "Returns a listing of cloud route groups, and the individual cloud profiles underneath each group, by account. Pass in the account id you'd like to search by as a parameter.",
- "description": "Permissions: READ on Account, Post Filtered Results",
- "operationId": "getListWithProfileChildren4",
- "parameters": [
- {
- "name": "accountId",
- "in": "path",
- "description": "accountId",
- "required": true,
- "schema": {
- "type": "string",
- "pattern": "[0-9]+"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/CloudRouteGroupSkinny"
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized"
- },
- "403": {
- "description": "Forbidden"
- },
- "404": {
- "description": "Not Found"
- }
- },
- "security": [
- {
- "BearerAuth": []
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/external/authConfigs/{authConfigId}/oauth": {
+ "post": {
+ "tags": [
+ "External Auth Configurations"
+ ],
+ "summary": "Create OAuth external auth configuration",
+ "description": "",
+ "operationId": "createExternalAccountAuthConfigOAuth",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "authConfigId",
+ "in": "path",
+ "description": "authConfigId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigOAuth"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigOAuth"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "patch": {
+ "tags": [
+ "External Auth Configurations"
+ ],
+ "summary": "Update OAuth external auth configuration",
+ "description": "",
+ "operationId": "patchExternalAuthConfigOAuth",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int64"
+ }
+ },
+ {
+ "name": "authConfigId",
+ "in": "path",
+ "description": "authConfigId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "format": "uuid"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigOAuth"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/AuthConfigOAuth"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups": {
+ "get": {
+ "tags": [
+ "Remote HTTP Service Groups"
+ ],
+ "summary": "List remote HTTP service groups",
+ "description": "Permissions: READ on Account",
+ "operationId": "getHttpServiceGroupList",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "page",
+ "in": "query",
+ "description": "page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "maxRows",
+ "in": "query",
+ "description": "maxRows",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RemoteHttpServiceGroup"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Remote HTTP Service Groups"
+ ],
+ "summary": "Create remote HTTP service group",
+ "description": "Permissions: CREATE on Account",
+ "operationId": "createHttpServiceGroup",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RemoteHttpServiceGroup"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RemoteHttpServiceGroup"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/withChildren": {
+ "get": {
+ "tags": [
+ "Remote HTTP Service Groups"
+ ],
+ "summary": "List remote HTTP service groups with services",
+ "description": "Permissions: READ on Account",
+ "operationId": "getHttpServiceGroupListWithChildren",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
}
- }
+ },
+ {
+ "name": "includePermissions",
+ "in": "query",
+ "description": "includePermissions",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RemoteHttpServiceGroup"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
},
- "servers": [
- {
- "url": "https://engage.ringcentral.com"
- }
- ],
- "tags": [
- {
- "name": "Active Calls"
+ "/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}": {
+ "get": {
+ "tags": [
+ "Remote HTTP Service Groups"
+ ],
+ "summary": "Get remote HTTP service group",
+ "description": "Permissions: READ on HTTP Service Group",
+ "operationId": "getHttpServiceGroup",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RemoteHttpServiceGroup"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
+ },
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Remote HTTP Service Groups"
+ ],
+ "summary": "Update remote HTTP service group",
+ "description": "Permissions: UPDATE on HTTP Service Group",
+ "operationId": "updateHttpServiceGroup",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RemoteHttpServiceGroup"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RemoteHttpServiceGroup"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Audio Streaming",
- "description": "Manage audio streaming resources for RingCX call streaming workflows."
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices": {
+ "get": {
+ "tags": [
+ "Remote HTTP Services"
+ ],
+ "summary": "List remote HTTP services",
+ "description": "Permissions: READ on Web Service Group",
+ "operationId": "getHttpServiceList",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page",
+ "in": "query",
+ "description": "page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "maxRows",
+ "in": "query",
+ "description": "maxRows",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Agent Access"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Remote HTTP Services"
+ ],
+ "summary": "Create remote HTTP service",
+ "description": "Permissions: CREATE on Web Service Group",
+ "operationId": "createHttpService",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ }
+ }
+ },
+ "required": false
},
- {
- "name": "Agent Groups"
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Agents"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}": {
+ "get": {
+ "tags": [
+ "Remote HTTP Services"
+ ],
+ "summary": "Get remote HTTP service",
+ "description": "Permissions: READ on Web Service",
+ "operationId": "getHttpService",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "description": "serviceId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Campaigns"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Remote HTTP Services"
+ ],
+ "summary": "Update remote HTTP service",
+ "description": "Permissions: UPDATE on Web Service",
+ "operationId": "updateHttpService",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "description": "serviceId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ }
+ }
+ },
+ "required": false
},
- {
- "name": "Countries"
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Dial Groups"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}/clone": {
+ "post": {
+ "tags": [
+ "Remote HTTP Services"
+ ],
+ "summary": "Clone remote HTTP service",
+ "description": "Permissions: READ on Web Service (Permission Override), CREATE on Web Service Group",
+ "operationId": "cloneHttpService",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "description": "serviceId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "newName",
+ "in": "query",
+ "description": "newName",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RemoteHttpService"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Leads"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}/inputs": {
+ "get": {
+ "tags": [
+ "Remote HTTP Service Inputs"
+ ],
+ "summary": "List remote HTTP service inputs",
+ "description": "Permissions: READ on HTTP Service",
+ "operationId": "getHttpServiceInputList",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "description": "serviceId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RemoteHttpServiceInput"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Legacy Auth"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Remote HTTP Service Inputs"
+ ],
+ "summary": "Create remote HTTP service input",
+ "description": "Permissions: UPDATE on HTTP Service",
+ "operationId": "createHttpServiceInput",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "description": "serviceId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RemoteHttpServiceInput"
+ }
+ }
+ }
+ },
+ "required": false
},
- {
- "name": "Outbound"
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/RemoteHttpServiceInput"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Queue Dispositions"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}/inputs/{inputId}": {
+ "get": {
+ "tags": [
+ "Remote HTTP Service Inputs"
+ ],
+ "summary": "Get remote HTTP service input",
+ "description": "Permissions: READ on HTTP Service",
+ "operationId": "getHttpServiceInput",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "description": "serviceId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "inputId",
+ "in": "path",
+ "description": "inputId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/RemoteHttpServiceInput"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Queue Events"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Remote HTTP Service Inputs"
+ ],
+ "summary": "Delete remote HTTP service input",
+ "description": "Permissions: UPDATE on HTTP Service",
+ "operationId": "deleteHttpServiceInput",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "description": "serviceId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "inputId",
+ "in": "path",
+ "description": "inputId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Queue Groups"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}/setIsActive": {
+ "put": {
+ "tags": [
+ "Remote HTTP Services"
+ ],
+ "summary": "Set remote HTTP service active state",
+ "description": "Permissions: UPDATE on Web Service",
+ "operationId": "setHttpServiceIsActive",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "description": "serviceId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ActiveStateBoolean"
+ }
+ }
+ },
+ "required": false
},
- {
- "name": "Queue Phone Book"
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Queue Schedule"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v2/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices": {
+ "get": {
+ "tags": [
+ "Remote HTTP Services"
+ ],
+ "summary": "List remote HTTP services",
+ "description": "Permissions: READ on Web Service Group",
+ "operationId": "getRemoteHttpServiceListUsingGET",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "page",
+ "in": "query",
+ "description": "page",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "maxRows",
+ "in": "query",
+ "description": "maxRows",
+ "required": false,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ExternalHttpService"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Queue Skills"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Remote HTTP Services"
+ ],
+ "summary": "Create remote HTTP service",
+ "description": "",
+ "operationId": "createRemoteHttpServiceUsingPOST",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExternalHttpService"
+ }
+ }
+ },
+ "required": false
},
- {
- "name": "Queue Special ANI"
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExternalHttpService"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Queues"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v2/admin/accounts/{accountId}/httpServiceGroups/{serviceGroupId}/httpServices/{serviceId}": {
+ "get": {
+ "tags": [
+ "Remote HTTP Services"
+ ],
+ "summary": "Get remote HTTP service",
+ "description": "Permissions: READ on Web Service",
+ "operationId": "getRemoteHttpServiceUsingGET",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "description": "serviceId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExternalHttpService"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Reporting"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Remote HTTP Services"
+ ],
+ "summary": "Update remote HTTP service",
+ "description": "",
+ "operationId": "updateRemoteHttpServiceUsingPUT",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "description": "serviceId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExternalHttpService"
+ }
+ }
+ },
+ "required": false
},
- {
- "name": "Requeue Shortcuts"
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ExternalHttpService"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "RingCentral Auth"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Remote HTTP Services"
+ ],
+ "summary": "Delete remote HTTP service",
+ "description": "",
+ "operationId": "deleteRemoteHttpServiceUsingDELETE",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "serviceGroupId",
+ "in": "path",
+ "description": "serviceGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "serviceId",
+ "in": "path",
+ "description": "serviceId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "default": {
+ "description": "successful operation"
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Number Management"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/withChildren": {
+ "get": {
+ "tags": [
+ "Knowledge Base Groups"
+ ],
+ "summary": "List knowledge base groups with children",
+ "description": "Permissions: READ on Account, Post Filtered Results",
+ "operationId": "getKnowledgeBaseGroupListWithChildren",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "includePermissions",
+ "in": "query",
+ "description": "includePermissions",
+ "required": false,
+ "schema": {
+ "type": "boolean",
+ "default": false
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/KnowledgeBaseGroup"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Users"
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}": {
+ "get": {
+ "tags": [
+ "Knowledge Base Groups"
+ ],
+ "summary": "Get knowledge base group",
+ "description": "Permissions: READ on Knowledge Base Group",
+ "operationId": "getKnowledgeBaseGroup",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "knowledgeBaseGroupId",
+ "in": "path",
+ "description": "knowledgeBaseGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/KnowledgeBaseGroup"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Cloud Route Destination Groups",
- "description": "Manage groups that organize cloud route destinations for an account."
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Knowledge Base Groups"
+ ],
+ "summary": "Update knowledge base group",
+ "description": "Permissions: UPDATE on Knowledge Base Group",
+ "operationId": "updateKnowledgeBaseGroup",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "knowledgeBaseGroupId",
+ "in": "path",
+ "description": "knowledgeBaseGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/KnowledgeBaseGroup"
+ }
+ }
+ },
+ "required": false
},
- {
- "name": "Cloud Route Destinations",
- "description": "Manage cloud route destinations used as routing targets."
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/KnowledgeBaseGroup"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Cloud Route Profile Groups",
- "description": "Manage groups that organize cloud route profiles for an account."
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Knowledge Base Groups"
+ ],
+ "summary": "Delete knowledge base group",
+ "description": "Permissions: DELETE on Knowledge Base Group",
+ "operationId": "deleteKnowledgeBaseGroup",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "knowledgeBaseGroupId",
+ "in": "path",
+ "description": "knowledgeBaseGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Cloud Route Profiles",
- "description": "Manage cloud route profiles that define routing behavior."
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories": {
+ "get": {
+ "tags": [
+ "Knowledge Base Categories"
+ ],
+ "summary": "List knowledge base categories",
+ "description": "Permissions: READ on Knowledge Base, Post Filtered Results",
+ "operationId": "getKnowledgeBaseCategoryList",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "knowledgeBaseGroupId",
+ "in": "path",
+ "description": "knowledgeBaseGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/KnowledgeBaseCategory"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Cloud Route Assignments",
- "description": "Manage assignments between cloud route profiles and destinations."
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Knowledge Base Categories"
+ ],
+ "summary": "Create knowledge base category",
+ "description": "Permissions: CREATE on Knowledge Base Group",
+ "operationId": "createKnowledgeBaseCategory",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "knowledgeBaseGroupId",
+ "in": "path",
+ "description": "knowledgeBaseGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/KnowledgeBaseCategory"
+ }
+ }
+ },
+ "required": false
},
- {
- "name": "Cloud Route DNIS Overrides",
- "description": "Manage DNIS-specific routing overrides for cloud route destinations and assignments."
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/KnowledgeBaseCategory"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Cloud Route DTMF Events",
- "description": "Manage DTMF event configuration for cloud route profiles."
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories/withChildren": {
+ "get": {
+ "tags": [
+ "Knowledge Base Categories"
+ ],
+ "summary": "List knowledge base categories with articles",
+ "description": "Permissions: READ on Knowledge Base, Post Filtered Results",
+ "operationId": "getKnowledgeBaseCategoryListWithChildren",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "knowledgeBaseGroupId",
+ "in": "path",
+ "description": "knowledgeBaseGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/KnowledgeBaseCategory"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Cloud Route Sticky Destinations",
- "description": "Manage sticky destination lookups and routing state for cloud route profiles."
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories/{knowledgeBaseCategoryId}": {
+ "get": {
+ "tags": [
+ "Knowledge Base Categories"
+ ],
+ "summary": "Get knowledge base category",
+ "description": "Permissions: READ on Knowledge Base Category",
+ "operationId": "getKnowledgeBaseCategory",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "knowledgeBaseGroupId",
+ "in": "path",
+ "description": "knowledgeBaseGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "knowledgeBaseCategoryId",
+ "in": "path",
+ "description": "knowledgeBaseCategoryId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/KnowledgeBaseCategory"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "User Roles",
- "description": "Manage role assignments for RingCX administrative users."
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Knowledge Base Categories"
+ ],
+ "summary": "Update knowledge base category",
+ "description": "Permissions: UPDATE on Knowledge Base Category",
+ "operationId": "updateKnowledgeBaseCategory",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "knowledgeBaseGroupId",
+ "in": "path",
+ "description": "knowledgeBaseGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "knowledgeBaseCategoryId",
+ "in": "path",
+ "description": "knowledgeBaseCategoryId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/KnowledgeBaseCategory"
+ }
+ }
+ },
+ "required": false
},
- {
- "name": "Rights Documents",
- "description": "Manage rights documents and rights document assignments for administrative users."
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/KnowledgeBaseCategory"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "User Dashboards",
- "description": "Manage dashboards associated with administrative users."
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Knowledge Base Categories"
+ ],
+ "summary": "Delete knowledge base category",
+ "description": "Permissions: DELETE on Knowledge Base Category",
+ "operationId": "deleteKnowledgeBaseCategory",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "knowledgeBaseGroupId",
+ "in": "path",
+ "description": "knowledgeBaseGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "knowledgeBaseCategoryId",
+ "in": "path",
+ "description": "knowledgeBaseCategoryId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "User Auth Utilities",
- "description": "Validate tokens and support administrative authentication utility workflows."
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories/{knowledgeBaseCategoryId}/knowledgeBaseArticles": {
+ "get": {
+ "tags": [
+ "Knowledge Base Articles"
+ ],
+ "summary": "List knowledge base articles",
+ "description": "Permissions: READ on Scripting",
+ "operationId": "getKnowledgeBaseArticleList",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "knowledgeBaseGroupId",
+ "in": "path",
+ "description": "knowledgeBaseGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "knowledgeBaseCategoryId",
+ "in": "path",
+ "description": "knowledgeBaseCategoryId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/KnowledgeBaseArticle"
+ }
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Agent State Subscriptions",
- "description": "Manage subscriptions that deliver RingCX agent-state notifications to external workforce management or monitoring systems."
- }
- ],
- "x-tag-groups": [
- {
- "name": "Analytics",
- "popular": true,
- "tags": [
- "Reporting",
- "Real Time Reporting",
- "Audit Logs"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "post": {
+ "tags": [
+ "Knowledge Base Articles"
+ ],
+ "summary": "Create knowledge base article",
+ "description": "Permissions: CREATE on Scripting",
+ "operationId": "createKnowledgeBaseArticle",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "knowledgeBaseGroupId",
+ "in": "path",
+ "description": "knowledgeBaseGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "knowledgeBaseCategoryId",
+ "in": "path",
+ "description": "knowledgeBaseCategoryId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/KnowledgeBaseArticle"
+ }
+ }
+ },
+ "required": false
},
- {
- "name": "Users",
- "popular": true,
- "tags": [
- "Agents",
- "Agent Groups",
- "Users",
- "User Roles",
- "Rights Documents",
- "User Dashboards",
- "User Auth Utilities"
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/KnowledgeBaseArticle"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Routing",
- "popular": true,
- "tags": [
- "Queues",
- "Queue Groups",
- "Agent Access",
- "Queue Dispositions",
- "Queue Events",
- "Queue Phone Book",
- "Queue Skills",
- "Requeue Shortcuts",
- "Queue Schedule",
- "Queue Special ANI",
- "Number Management",
- "Cloud Route Destination Groups",
- "Cloud Route Destinations",
- "Cloud Route Profile Groups",
- "Cloud Route Profiles",
- "Cloud Route Assignments",
- "Cloud Route DNIS Overrides",
- "Cloud Route DTMF Events",
- "Cloud Route Sticky Destinations"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ },
+ "/voice/api/v1/admin/accounts/{accountId}/knowledgeBaseGroups/{knowledgeBaseGroupId}/knowledgeBaseCategories/{knowledgeBaseCategoryId}/knowledgeBaseArticles/{knowledgeBaseArticleId}": {
+ "get": {
+ "tags": [
+ "Knowledge Base Articles"
+ ],
+ "summary": "Get knowledge base article",
+ "description": "Permissions: READ on Scripting",
+ "operationId": "getKnowledgeBaseArticle",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "knowledgeBaseGroupId",
+ "in": "path",
+ "description": "knowledgeBaseGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "knowledgeBaseCategoryId",
+ "in": "path",
+ "description": "knowledgeBaseCategoryId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "knowledgeBaseArticleId",
+ "in": "path",
+ "description": "knowledgeBaseArticleId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/KnowledgeBaseArticle"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Dialing",
- "popular": true,
- "tags": [
- "Active Calls",
- "Campaigns",
- "Campaign Groups",
- "Leads",
- "Dial Groups",
- "Outbound"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "put": {
+ "tags": [
+ "Knowledge Base Articles"
+ ],
+ "summary": "Update knowledge base article",
+ "description": "Permissions: UPDATE on Scripting",
+ "operationId": "updateKnowledgeBaseArticle",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "knowledgeBaseGroupId",
+ "in": "path",
+ "description": "knowledgeBaseGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "knowledgeBaseCategoryId",
+ "in": "path",
+ "description": "knowledgeBaseCategoryId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "knowledgeBaseArticleId",
+ "in": "path",
+ "description": "knowledgeBaseArticleId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/KnowledgeBaseArticle"
+ }
+ }
+ },
+ "required": false
},
- {
- "name": "Authentication",
- "popular": false,
- "tags": [
- "Authentication",
- "Password Reset",
- "Token",
- "OAuth",
- "RingCentral Auth",
- "Legacy Auth"
- ]
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/KnowledgeBaseArticle"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Utilities",
- "popular": false,
- "tags": [
- "Countries"
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ },
+ "delete": {
+ "tags": [
+ "Knowledge Base Articles"
+ ],
+ "summary": "Delete knowledge base article",
+ "description": "Permissions: DELETE on Scripting",
+ "operationId": "deleteKnowledgeBaseArticle",
+ "parameters": [
+ {
+ "name": "accountId",
+ "in": "path",
+ "description": "accountId",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "pattern": "[0-9]+"
+ }
+ },
+ {
+ "name": "knowledgeBaseGroupId",
+ "in": "path",
+ "description": "knowledgeBaseGroupId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "knowledgeBaseCategoryId",
+ "in": "path",
+ "description": "knowledgeBaseCategoryId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ },
+ {
+ "name": "knowledgeBaseArticleId",
+ "in": "path",
+ "description": "knowledgeBaseArticleId",
+ "required": true,
+ "schema": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "boolean"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized"
+ },
+ "403": {
+ "description": "Forbidden"
+ },
+ "404": {
+ "description": "Not Found"
+ }
},
- {
- "name": "Integration",
- "popular": false,
- "tags": [
- "Integration User Controller",
- "Integration Account Controller",
- "Integration Agent Controller",
- "Integration Agent Group Controller",
- "Integration Gate Group Controller",
- "Public Integration API",
- "Agent State Subscriptions"
- ]
- }
- ]
+ "security": [
+ {
+ "BearerAuth": []
+ }
+ ]
+ }
+ }
+ },
+ "servers": [
+ {
+ "url": "https://engage.ringcentral.com"
+ }
+ ],
+ "tags": [
+ {
+ "name": "Active Calls"
+ },
+ {
+ "name": "Audio Streaming",
+ "description": "Manage audio streaming resources for RingCX call streaming workflows."
+ },
+ {
+ "name": "Agent Access"
+ },
+ {
+ "name": "Agent Groups"
+ },
+ {
+ "name": "Agents"
+ },
+ {
+ "name": "Campaigns"
+ },
+ {
+ "name": "Countries"
+ },
+ {
+ "name": "Dial Groups"
+ },
+ {
+ "name": "Leads"
+ },
+ {
+ "name": "Legacy Auth"
+ },
+ {
+ "name": "Outbound"
+ },
+ {
+ "name": "Queue Dispositions"
+ },
+ {
+ "name": "Queue Events"
+ },
+ {
+ "name": "Queue Groups"
+ },
+ {
+ "name": "Queue Phone Book"
+ },
+ {
+ "name": "Queue Schedule"
+ },
+ {
+ "name": "Queue Skills"
+ },
+ {
+ "name": "Queue Special ANI"
+ },
+ {
+ "name": "Queues"
+ },
+ {
+ "name": "Reporting"
+ },
+ {
+ "name": "Requeue Shortcuts"
+ },
+ {
+ "name": "RingCentral Auth"
+ },
+ {
+ "name": "Number Management",
+ "description": "Manage DNIS pools, tracking numbers, and related phone-number assignment utilities."
+ },
+ {
+ "name": "Users"
+ },
+ {
+ "name": "Cloud Route Destination Groups",
+ "description": "Manage groups that organize cloud route destinations for an account."
+ },
+ {
+ "name": "Cloud Route Destinations",
+ "description": "Manage cloud route destinations used as routing targets."
+ },
+ {
+ "name": "Cloud Route Profile Groups",
+ "description": "Manage groups that organize cloud route profiles for an account."
+ },
+ {
+ "name": "Cloud Route Profiles",
+ "description": "Manage cloud route profiles that define routing behavior."
+ },
+ {
+ "name": "Cloud Route Assignments",
+ "description": "Manage assignments between cloud route profiles and destinations."
+ },
+ {
+ "name": "Cloud Route DNIS Overrides",
+ "description": "Manage DNIS-specific routing overrides for cloud route destinations and assignments."
+ },
+ {
+ "name": "Cloud Route DTMF Events",
+ "description": "Manage DTMF event configuration for cloud route profiles."
+ },
+ {
+ "name": "Cloud Route Sticky Destinations",
+ "description": "Manage sticky destination lookups and routing state for cloud route profiles."
+ },
+ {
+ "name": "User Roles",
+ "description": "Manage role assignments for RingCX administrative users."
+ },
+ {
+ "name": "Rights Documents",
+ "description": "Manage rights documents and rights document assignments for administrative users."
+ },
+ {
+ "name": "User Dashboards",
+ "description": "Manage dashboards associated with administrative users."
+ },
+ {
+ "name": "User Auth Utilities",
+ "description": "Validate tokens and support administrative authentication utility workflows."
+ },
+ {
+ "name": "Agent State Subscriptions",
+ "description": "Manage subscriptions that deliver RingCX agent-state notifications to external workforce management or monitoring systems."
+ },
+ {
+ "name": "DNIS Assignments",
+ "description": "Manage voice DNIS assignments for queues, Visual IVRs, and cloud route profiles."
+ },
+ {
+ "name": "Tracking Numbers",
+ "description": "Manage tracking-number groups and numbers used for attribution and routing."
+ },
+ {
+ "name": "Tracking Number Routing Rules",
+ "description": "Manage routing rules associated with tracking numbers."
+ },
+ {
+ "name": "Tracking Number Schedules",
+ "description": "Manage schedule overrides associated with tracking numbers."
+ },
+ {
+ "name": "Remote HTTP Service Groups",
+ "description": "Manage groups that organize reusable remote HTTP service definitions for an account."
+ },
+ {
+ "name": "Remote HTTP Services",
+ "description": "Manage reusable external HTTP and SOAP service definitions used by RingCX workflows."
+ },
+ {
+ "name": "Remote HTTP Service Inputs",
+ "description": "Manage input mappings that pass RingCX runtime values into remote HTTP services."
+ },
+ {
+ "name": "External Auth Configurations",
+ "description": "Manage reusable authentication configurations for outbound remote HTTP service calls."
+ },
+ {
+ "name": "Knowledge Base Groups",
+ "description": "Manage top-level knowledge base groups for RingCX support content."
+ },
+ {
+ "name": "Knowledge Base Categories",
+ "description": "Manage categories that organize articles within RingCX knowledge base groups."
+ },
+ {
+ "name": "Knowledge Base Articles",
+ "description": "Manage article content and metadata within RingCX knowledge base categories."
+ }
+ ],
+ "x-tag-groups": [
+ {
+ "name": "Analytics",
+ "popular": true,
+ "tags": [
+ "Reporting",
+ "Real Time Reporting",
+ "Audit Logs"
+ ]
+ },
+ {
+ "name": "Users",
+ "popular": true,
+ "tags": [
+ "Agents",
+ "Agent Groups",
+ "Users",
+ "User Roles",
+ "Rights Documents",
+ "User Dashboards",
+ "User Auth Utilities"
+ ]
+ },
+ {
+ "name": "Routing",
+ "popular": true,
+ "tags": [
+ "Queues",
+ "Queue Groups",
+ "Agent Access",
+ "Queue Dispositions",
+ "Queue Events",
+ "Queue Phone Book",
+ "Queue Skills",
+ "Requeue Shortcuts",
+ "Queue Schedule",
+ "Queue Special ANI",
+ "Number Management",
+ "Cloud Route Destination Groups",
+ "Cloud Route Destinations",
+ "Cloud Route Profile Groups",
+ "Cloud Route Profiles",
+ "Cloud Route Assignments",
+ "Cloud Route DNIS Overrides",
+ "Cloud Route DTMF Events",
+ "Cloud Route Sticky Destinations",
+ "DNIS Assignments",
+ "Tracking Numbers",
+ "Tracking Number Routing Rules",
+ "Tracking Number Schedules",
+ "Knowledge Base Groups",
+ "Knowledge Base Categories",
+ "Knowledge Base Articles"
+ ]
+ },
+ {
+ "name": "Dialing",
+ "popular": true,
+ "tags": [
+ "Active Calls",
+ "Campaigns",
+ "Campaign Groups",
+ "Leads",
+ "Dial Groups",
+ "Outbound"
+ ]
+ },
+ {
+ "name": "Authentication",
+ "popular": false,
+ "tags": [
+ "Authentication",
+ "Password Reset",
+ "Token",
+ "OAuth",
+ "RingCentral Auth",
+ "Legacy Auth"
+ ]
+ },
+ {
+ "name": "Utilities",
+ "popular": false,
+ "tags": [
+ "Countries"
+ ]
+ },
+ {
+ "name": "Integration",
+ "popular": false,
+ "tags": [
+ "Integration User Controller",
+ "Integration Account Controller",
+ "Integration Agent Controller",
+ "Integration Agent Group Controller",
+ "Integration Gate Group Controller",
+ "Public Integration API",
+ "Agent State Subscriptions",
+ "Remote HTTP Service Groups",
+ "Remote HTTP Services",
+ "Remote HTTP Service Inputs",
+ "External Auth Configurations"
+ ]
+ },
+ {
+ "name": "Workforce",
+ "popular": true,
+ "tags": [
+ "Audio Streaming"
+ ]
+ }
+ ]
}