{ "info": { "name": "RingCentral RingCX Voice API", "description": "Requests for the public RingCX Voice APIs. Import the companion environment template, configure JWT credentials, and run Auth and setup before calling API requests. Select requests individually; running the entire collection would invoke operations that create, update, or delete RingCX resources.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{ringcx_bearer_token}}", "type": "string" } ] }, "variable": [ { "key": "ringcx_base_url", "value": "https://ringcx.ringcentral.com", "type": "default" }, { "key": "ringcentral_base_url", "value": "https://platform.ringcentral.com", "type": "default" }, { "key": "RINGCENTRAL_CLIENT_ID", "value": "", "type": "secret" }, { "key": "RINGCENTRAL_CLIENT_SECRET", "value": "", "type": "secret" }, { "key": "RINGCENTRAL_JWT", "value": "", "type": "secret" }, { "key": "rco_access_token", "value": "", "type": "secret" }, { "key": "ringcx_bearer_token", "value": "", "type": "secret" }, { "key": "rcev_access_token", "value": "", "type": "secret" }, { "key": "ringcx_token_expires_at", "value": "", "type": "default" }, { "key": "rcx_sub_account_id", "value": "", "type": "default" }, { "key": "rcx_main_account_id", "value": "", "type": "default" }, { "key": "rc_account_uid", "value": "", "type": "default" }, { "key": "agentGroupId", "value": "", "type": "default" }, { "key": "agentId", "value": "", "type": "default" }, { "key": "ani", "value": "", "type": "default" }, { "key": "assignedUserId", "value": "", "type": "default" }, { "key": "authConfigId", "value": "", "type": "default" }, { "key": "campaignId", "value": "", "type": "default" }, { "key": "cloudAssignedDestinationId", "value": "", "type": "default" }, { "key": "cloudAssignedOverrideId", "value": "", "type": "default" }, { "key": "cloudRouteDestinationId", "value": "", "type": "default" }, { "key": "cloudRouteDestinationOverrideId", "value": "", "type": "default" }, { "key": "cloudRouteGroupId", "value": "", "type": "default" }, { "key": "cloudRouteProfileId", "value": "", "type": "default" }, { "key": "dashboardId", "value": "", "type": "default" }, { "key": "dialGroupId", "value": "", "type": "default" }, { "key": "dialogId", "value": "", "type": "default" }, { "key": "dnis", "value": "", "type": "default" }, { "key": "dtmfEventId", "value": "", "type": "default" }, { "key": "entryId", "value": "", "type": "default" }, { "key": "eventId", "value": "", "type": "default" }, { "key": "gateDispositionId", "value": "", "type": "default" }, { "key": "gateGroupId", "value": "", "type": "default" }, { "key": "gateId", "value": "", "type": "default" }, { "key": "inputId", "value": "", "type": "default" }, { "key": "leadId", "value": "", "type": "default" }, { "key": "overrideId", "value": "", "type": "default" }, { "key": "phoneId", "value": "", "type": "default" }, { "key": "queueGroupId", "value": "", "type": "default" }, { "key": "reportType", "value": "", "type": "default" }, { "key": "requeueShortcutId", "value": "", "type": "default" }, { "key": "rightsDocId", "value": "", "type": "default" }, { "key": "roleType", "value": "", "type": "default" }, { "key": "ruleId", "value": "", "type": "default" }, { "key": "scheduleOverrideId", "value": "", "type": "default" }, { "key": "segmentId", "value": "", "type": "default" }, { "key": "serviceGroupId", "value": "", "type": "default" }, { "key": "serviceId", "value": "", "type": "default" }, { "key": "skillId", "value": "", "type": "default" }, { "key": "streamId", "value": "", "type": "default" }, { "key": "subscriptionId", "value": "", "type": "default" }, { "key": "token", "value": "", "type": "default" }, { "key": "tracGroupId", "value": "", "type": "default" }, { "key": "tracId", "value": "", "type": "default" }, { "key": "uii", "value": "", "type": "default" }, { "key": "userId", "value": "", "type": "default" }, { "key": "visualIvrId", "value": "", "type": "default" } ], "item": [ { "name": "Auth and setup", "description": "Run these requests in order. They use environment variables and save only short-lived tokens and account identifiers to the selected Postman environment.", "item": [ { "name": "1. Get RingCentral access token", "id": "205210e9-3711-55a2-90c7-17ef32874257", "request": { "method": "POST", "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{RINGCENTRAL_CLIENT_ID}}", "type": "string" }, { "key": "password", "value": "{{RINGCENTRAL_CLIENT_SECRET}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/x-www-form-urlencoded", "type": "text" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "urn:ietf:params:oauth:grant-type:jwt-bearer", "type": "text" }, { "key": "assertion", "value": "{{RINGCENTRAL_JWT}}", "type": "text" } ] }, "url": { "raw": "{{ringcentral_base_url}}/restapi/oauth/token", "host": [ "{{ringcentral_base_url}}" ], "path": [ "restapi", "oauth", "token" ] }, "description": "Uses the app client credentials and JWT from the selected environment to obtain a RingCentral access token. This token is used for the RingCX token exchange and RingCentral account UID lookup." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('RingCentral token request succeeds', function () {", " pm.response.to.have.status(200);", "});", "const body = pm.response.json();", "pm.expect(body).to.have.property('access_token');", "pm.environment.set('rco_access_token', body.access_token);" ] } } ], "response": [] }, { "name": "2. Exchange for RingCX access token", "id": "3e99d1a9-c40f-5872-9957-49e72a180098", "request": { "method": "POST", "auth": { "type": "noauth" }, "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/x-www-form-urlencoded", "type": "text" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "rcTokenType", "value": "Bearer", "type": "text" }, { "key": "rcAccessToken", "value": "{{rco_access_token}}", "type": "text" } ] }, "url": { "raw": "{{ringcx_base_url}}/api/auth/login/rc/accesstoken", "host": [ "{{ringcx_base_url}}" ], "path": [ "api", "auth", "login", "rc", "accesstoken" ] }, "description": "Exchanges the RingCentral access token for a RingCX access token. The exchange is limited to five requests per minute, and the returned RingCX token is valid for five minutes." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('RingCX token exchange succeeds', function () {", " pm.response.to.have.status(200);", "});", "const body = pm.response.json();", "pm.expect(body).to.have.property('accessToken');", "pm.environment.set('ringcx_bearer_token', body.accessToken);", "pm.environment.set('rcev_access_token', body.accessToken);", "pm.environment.set('ringcx_token_expires_at', String(Date.now() + (5 * 60 * 1000)));" ] } } ], "response": [] }, { "name": "3. Get RingCX account IDs", "id": "442ee6d3-9d94-5e45-a5f2-dda2947d294e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts" ] }, "description": "Returns the RingCX accounts available to the authenticated user. The test script stores the first accountId as rcx_sub_account_id and its mainAccountId as rcx_main_account_id." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('RingCX accounts request succeeds', function () {", " pm.response.to.have.status(200);", "});", "const accounts = pm.response.json();", "pm.expect(accounts).to.be.an('array').that.is.not.empty;", "const account = accounts[0];", "pm.expect(account).to.have.property('accountId');", "pm.environment.set('rcx_sub_account_id', String(account.accountId));", "if (account.mainAccountId !== undefined && account.mainAccountId !== null) {", " pm.environment.set('rcx_main_account_id', String(account.mainAccountId));", "}" ] } } ], "response": [] }, { "name": "4. Get RingCentral account UID", "id": "3f7fac8b-2c24-5f9d-84f6-d7482513f25b", "request": { "method": "GET", "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{rco_access_token}}", "type": "string" } ] }, "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcentral_base_url}}/restapi/v1.0/account/~", "host": [ "{{ringcentral_base_url}}" ], "path": [ "restapi", "v1.0", "account", "~" ] }, "description": "Uses the RingCentral access token from step 1 to retrieve the RingCentral account UID used by RingCX CX integration paths." }, "event": [ { "listen": "test", "script": { "type": "text/javascript", "exec": [ "pm.test('RingCentral account request succeeds', function () {", " pm.response.to.have.status(200);", "});", "const account = pm.response.json();", "pm.expect(account).to.have.property('id');", "pm.environment.set('rc_account_uid', String(account.id));" ] } } ], "response": [] } ] }, { "name": "Analytics", "item": [ { "name": "Reporting", "item": [ { "name": "Returns a report criteria definition for a report type", "id": "be727649-e1d3-5269-b171-02b1aed54b67", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/reports/{{reportType}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "reports", "{{reportType}}" ] }, "description": "Permissions: Authenticated User" }, "response": [] }, { "name": "Returns the agent-edited summary for an interaction segment", "id": "a6064aab-c176-594c-a006-5da73855792c", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "cookie", "value": "access_token={{ringcx_bearer_token}}", "type": "text", "disabled": false, "description": "Required lowercase cookie header containing the RingCX access token. Use the format `access_token=`." } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/summary/accounts/{{rcx_sub_account_id}}/segments/{{segmentId}}/agent", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "summary", "accounts", "{{rcx_sub_account_id}}", "segments", "{{segmentId}}", "agent" ] }, "description": "Permissions: READ on Account. 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=`.", "auth": { "type": "noauth" } }, "response": [ { "name": "200 Ok", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "cookie", "value": "access_token={{ringcx_bearer_token}}", "type": "text", "disabled": false, "description": "Required lowercase cookie header containing the RingCX access token. Use the format `access_token=`." } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/summary/accounts/{{rcx_sub_account_id}}/segments/{{segmentId}}/agent", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "summary", "accounts", "{{rcx_sub_account_id}}", "segments", "{{segmentId}}", "agent" ] }, "description": "Permissions: READ on Account. 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=`.", "auth": { "type": "noauth" } }, "status": "Ok", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "Customer requested a billing adjustment. Agent confirmed the account details and submitted the request for review." } ] }, { "name": "Returns the AI-generated summary for an interaction segment", "id": "d4b540b1-3dd7-54d6-8885-f13057749c5c", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "cookie", "value": "access_token={{ringcx_bearer_token}}", "type": "text", "disabled": false, "description": "Required lowercase cookie header containing the RingCX access token. Use the format `access_token=`." } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/summary/accounts/{{rcx_sub_account_id}}/segments/{{segmentId}}/auto", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "summary", "accounts", "{{rcx_sub_account_id}}", "segments", "{{segmentId}}", "auto" ] }, "description": "Permissions: READ on Account. 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=`.", "auth": { "type": "noauth" } }, "response": [ { "name": "200 Ok", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "cookie", "value": "access_token={{ringcx_bearer_token}}", "type": "text", "disabled": false, "description": "Required lowercase cookie header containing the RingCX access token. Use the format `access_token=`." } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/summary/accounts/{{rcx_sub_account_id}}/segments/{{segmentId}}/auto", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "summary", "accounts", "{{rcx_sub_account_id}}", "segments", "{{segmentId}}", "auto" ] }, "description": "Permissions: READ on Account. 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=`.", "auth": { "type": "noauth" } }, "status": "Ok", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "The customer called about a billing issue. The agent reviewed the account, explained the next steps, and created a follow-up request." } ] } ], "description": "Retrieve reports and reporting-related resources." }, { "name": "Audit Logs", "item": [ { "name": "Identify system entities eligible for auditing", "id": "3065d5ed-c950-5149-aa92-90b645c02241", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/auditLogs/auditable", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "auditLogs", "auditable" ] }, "description": "Identify system entities eligible for auditing" }, "response": [] }, { "name": "Search administrative audit records", "id": "761bc505-0aa7-544c-8e9f-26296d6d3c86", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/auditLogs/search", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "auditLogs", "search" ] }, "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.", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"ascOrDesc\": \"ASCENDING\",\n \"auditActions\": [\n \"DELETE\"\n ],\n \"auditedEntityId\": \"\",\n \"createUserId\": \"\",\n \"endDateTime\": \"2026-08-12T22:30:00.000+0000\",\n \"endDateTimeAsUnix\": 0,\n \"orderBy\": \"\",\n \"searchEntities\": [\n \"\"\n ],\n \"startDateTime\": \"2026-08-12T22:30:00.000+0000\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Search and discover administrative audit log records." } ] }, { "name": "Users", "item": [ { "name": "Agents", "item": [ { "name": "Returns a listing of agents for an agent group", "id": "0c22280f-a56c-59d9-bb61-12c67bc0d946", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/agentGroups/{{agentGroupId}}/agents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "agentGroups", "{{agentGroupId}}", "agents" ] }, "description": "Permissions: READ on Agent Group, Post Filtered Results" }, "response": [] }, { "name": "Creates a single agent for an agent group", "id": "9c317c6a-08d6-5e25-9b15-68eed172f239", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/agentGroups/{{agentGroupId}}/agents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "agentGroups", "{{agentGroupId}}", "agents" ] }, "description": "Permissions: CREATE on Agent Group", "body": { "mode": "raw", "raw": "{\n \"accountAccess\": [\n {\n \"account\": {},\n \"accountId\": \"\",\n \"accountName\": \"\",\n \"agent\": {},\n \"agentId\": 0,\n \"name\": \"\"\n }\n ],\n \"active\": false,\n \"agentAccountAccess\": [\n {\n \"account\": {},\n \"accountId\": \"\",\n \"accountName\": \"\",\n \"agent\": {},\n \"agentId\": 0,\n \"name\": \"\"\n }\n ],\n \"agentChatGroupAccess\": [\n {\n \"agentId\": 0,\n \"chatGroupId\": 0\n }\n ],\n \"agentChatQueueAccesses\": {},\n \"agentDialGroupMembers\": {},\n \"agentGateAccess\": [\n {\n \"agentId\": 0,\n \"agentRank\": 0,\n \"defaultDestOverride\": \"\",\n \"gateId\": 0\n }\n ],\n \"agentGateGroupAccess\": [\n {\n \"agentId\": 0,\n \"gateGroupId\": 0\n }\n ],\n \"agentGroup\": {\n \"account\": {},\n \"agentGroupId\": 0,\n \"agents\": {},\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"agentId\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Updates a listing of agents for an agent group", "id": "7b5ad23e-d844-5c2a-a78a-99f1c3799d55", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/agentGroups/{{agentGroupId}}/agents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "agentGroups", "{{agentGroupId}}", "agents" ] }, "description": "Permissions: UPDATE on Agent Group", "body": { "mode": "raw", "raw": "[\n {\n \"accountAccess\": {},\n \"active\": false,\n \"agentAccountAccess\": [\n {}\n ],\n \"agentChatGroupAccess\": [\n {}\n ],\n \"agentChatQueueAccesses\": {},\n \"agentDialGroupMembers\": {},\n \"agentGateAccess\": {},\n \"agentGateGroupAccess\": [\n {}\n ],\n \"agentGroup\": {\n \"account\": {},\n \"agentGroupId\": 0,\n \"agents\": {},\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"agentId\": 0\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a single agent for an agent group", "id": "70663d56-cd02-55ad-bd0a-80dacb228015", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/agentGroups/{{agentGroupId}}/agents/{{agentId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "agentGroups", "{{agentGroupId}}", "agents", "{{agentId}}" ] }, "description": "Permissions: READ on Agent" }, "response": [] }, { "name": "Updates a single agent for an agent group", "id": "4634a391-f7ae-5f43-8464-f3ccf6640cca", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/agentGroups/{{agentGroupId}}/agents/{{agentId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "agentGroups", "{{agentGroupId}}", "agents", "{{agentId}}" ] }, "description": "Permissions: UPDATE on Agent", "body": { "mode": "raw", "raw": "{\n \"accountAccess\": [\n {\n \"account\": {},\n \"accountId\": \"\",\n \"accountName\": \"\",\n \"agent\": {},\n \"agentId\": 0,\n \"name\": \"\"\n }\n ],\n \"active\": false,\n \"agentAccountAccess\": [\n {\n \"account\": {},\n \"accountId\": \"\",\n \"accountName\": \"\",\n \"agent\": {},\n \"agentId\": 0,\n \"name\": \"\"\n }\n ],\n \"agentChatGroupAccess\": [\n {\n \"agentId\": 0,\n \"chatGroupId\": 0\n }\n ],\n \"agentChatQueueAccesses\": {},\n \"agentDialGroupMembers\": {},\n \"agentGateAccess\": [\n {\n \"agentId\": 0,\n \"agentRank\": 0,\n \"defaultDestOverride\": \"\",\n \"gateId\": 0\n }\n ],\n \"agentGateGroupAccess\": [\n {\n \"agentId\": 0,\n \"gateGroupId\": 0\n }\n ],\n \"agentGroup\": {\n \"account\": {},\n \"agentGroupId\": 0,\n \"agents\": {},\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"agentId\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes an agent for an agent group", "id": "9c4bcb46-61b1-5c6c-8fd0-12e1bef97d69", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/agentGroups/{{agentGroupId}}/agents/{{agentId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "agentGroups", "{{agentGroupId}}", "agents", "{{agentId}}" ] }, "description": "Permissions: DELETE on Agent" }, "response": [] }, { "name": "Assigns a listing of agents to a queue (AKA gate)", "id": "4b6e9d7e-8c46-5026-be4d-387c2759560e", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/assignAgents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "assignAgents" ] }, "description": "Permissions: UPDATE on Gate and READ on Agents", "body": { "mode": "raw", "raw": "[\n {\n \"agentId\": 0,\n \"agentRank\": 0,\n \"defaultDestOverride\": \"\",\n \"gateId\": 0\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a listing of assigned agents for a queue (AKA gate) ", "id": "3438e11e-7073-50ce-93e6-f90742515519", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/assignedAgents?page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "assignedAgents" ], "query": [ { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Gate" }, "response": [] }, { "name": "Unassigns a single agent from a queue (AKA gate)", "id": "99a099c9-550f-5c24-b699-da73396c0ab2", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/unassignAgent/{{agentId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "unassignAgent", "{{agentId}}" ] }, "description": "Permissions: UPDATE on Gate (Permission Override), READ on agent" }, "response": [] } ], "description": "Manage RingCX agent records and assignments." }, { "name": "Agent Groups", "item": [ { "name": "Returns a listing of agent groups for an account [GET]", "id": "077c6555-56c0-5a4b-8b65-4163a396717c", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/agentGroups?page=0&maxRows=0&includePermissions=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "agentGroups" ], "query": [ { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" }, { "key": "includePermissions", "value": "false", "disabled": true, "description": "includePermissions" } ] }, "description": "Permissions: READ on Account, Post Filtered Results" }, "response": [] }, { "name": "Creates a single new agent group for an account", "id": "e4d069ae-e1ee-57ed-aa59-b44f613a78eb", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/agentGroups", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "agentGroups" ] }, "description": "Permissions: CREATE on Account", "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"accountId\": \"\",\n \"accountName\": \"\",\n \"amdDefaultProfile\": 0,\n \"archivedAccount\": false,\n \"audioRetentionDays\": 0,\n \"concurrentLogins\": 0,\n \"crmHost\": \"\",\n \"crmInstance\": \"\",\n \"crmPwd\": \"\",\n \"crmUid\": \"\"\n },\n \"agentGroupId\": 0,\n \"agents\": {},\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a listing of agent groups for an account [GET]", "id": "f0db8bc0-5d9d-5e9d-8592-2b469b6a0c53", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/agentGroups/{{agentGroupId}}?includePermissions=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "agentGroups", "{{agentGroupId}}" ], "query": [ { "key": "includePermissions", "value": "false", "disabled": true, "description": "includePermissions" } ] }, "description": "Permissions: READ on Gate Group" }, "response": [] }, { "name": "Updates an agent group for an account", "id": "7ccbcada-a2f3-5511-a41b-8de7dfdb297a", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/agentGroups/{{agentGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "agentGroups", "{{agentGroupId}}" ] }, "description": "Permissions: UPDATE on Agent Group", "body": { "mode": "raw", "raw": "{\n \"account\": {\n \"accountId\": \"\",\n \"accountName\": \"\",\n \"amdDefaultProfile\": 0,\n \"archivedAccount\": false,\n \"audioRetentionDays\": 0,\n \"concurrentLogins\": 0,\n \"crmHost\": \"\",\n \"crmInstance\": \"\",\n \"crmPwd\": \"\",\n \"crmUid\": \"\"\n },\n \"agentGroupId\": 0,\n \"agents\": {},\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "[Deprecated] Deletes an agent group for an account", "id": "a2ad4991-cb90-5538-ab6f-c42540fb22a6", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/agentGroups/{{agentGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "agentGroups", "{{agentGroupId}}" ] }, "description": "Deprecated operation. Permissions: DELETE on Agent Group" }, "response": [] } ], "description": "Manage RingCX agent groups." }, { "name": "Users", "item": [ { "name": "Returns a listing of all users that a user has access to", "id": "2c6c4101-dd6e-5171-b230-0a7f741529bb", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users?activeOnly=false&flatten=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users" ], "query": [ { "key": "activeOnly", "value": "false", "disabled": true, "description": "activeOnly" }, { "key": "flatten", "value": "false", "disabled": true, "description": "flatten" } ] }, "description": "Permissions: MANAGE_USERS or SUPER_USER role" }, "response": [] }, { "name": "Creates a single new user", "id": "6b2979ff-c349-5209-ac0e-a44564d7f6d7", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users?parentUserId=0&returnUri=https://example.com/resource&isSSO=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users" ], "query": [ { "key": "parentUserId", "value": "0", "disabled": true, "description": "parentUserId" }, { "key": "returnUri", "value": "https://example.com/resource", "disabled": true, "description": "returnUri" }, { "key": "isSSO", "value": "false", "disabled": true, "description": "isSSO" } ] }, "description": "Permissions: MANAGE_USERS or SUPER_USER role", "body": { "mode": "raw", "raw": "{\n \"children\": [\n {\n \"children\": [\n {}\n ],\n \"creationDate\": \"2026-08-12T22:30:00.000+0000\",\n \"enabled\": false,\n \"firstName\": \"\",\n \"fullName\": \"\",\n \"lastName\": \"\",\n \"parentPath\": \"\",\n \"phoneNumber\": \"\",\n \"phoneNumberE164\": \"\",\n \"phoneNumbersI18nEnabled\": false\n }\n ],\n \"creationDate\": \"2026-08-12T22:30:00.000+0000\",\n \"enabled\": false,\n \"firstName\": \"\",\n \"fullName\": \"\",\n \"lastName\": \"\",\n \"parentPath\": \"\",\n \"phoneNumber\": \"\",\n \"phoneNumberE164\": \"\",\n \"phoneNumbersI18nEnabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Checks if username is available", "id": "bc31e1f7-a1ad-5668-b6f7-09d49af2cb32", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/availableUserNames?userName=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "availableUserNames" ], "query": [ { "key": "userName", "value": "", "disabled": false, "description": "userName" } ] }, "description": "Permissions: Authenticated User" }, "response": [] }, { "name": "Reassigns all existing child users to a new parent user", "id": "9df6e306-e9b4-5b47-ba73-a849ef75c624", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/reassign?oldUserId=0&reassignUserId=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "reassign" ], "query": [ { "key": "oldUserId", "value": "0", "disabled": false, "description": "oldUserId" }, { "key": "reassignUserId", "value": "0", "disabled": false, "description": "reassignUserId" } ] }, "description": "Permissions: MANAGE_USERS or SUPER_USER role" }, "response": [] }, { "name": "Creates a single root user", "id": "d4a377bd-9ccc-54dd-b60c-9131a00f2c9a", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/root?returnUri=https://example.com/resource&isSSO=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "root" ], "query": [ { "key": "returnUri", "value": "https://example.com/resource", "disabled": true, "description": "returnUri" }, { "key": "isSSO", "value": "false", "disabled": true, "description": "isSSO" } ] }, "description": "Permissions: SUPER_USER role", "body": { "mode": "raw", "raw": "{\n \"children\": [\n {\n \"children\": [\n {}\n ],\n \"creationDate\": \"2026-08-12T22:30:00.000+0000\",\n \"enabled\": false,\n \"firstName\": \"\",\n \"fullName\": \"\",\n \"lastName\": \"\",\n \"parentPath\": \"\",\n \"phoneNumber\": \"\",\n \"phoneNumberE164\": \"\",\n \"phoneNumbersI18nEnabled\": false\n }\n ],\n \"creationDate\": \"2026-08-12T22:30:00.000+0000\",\n \"enabled\": false,\n \"firstName\": \"\",\n \"fullName\": \"\",\n \"lastName\": \"\",\n \"parentPath\": \"\",\n \"phoneNumber\": \"\",\n \"phoneNumberE164\": \"\",\n \"phoneNumbersI18nEnabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Assigns an account to a root user", "id": "85e01d70-81ec-5c6a-9174-d1282d7e1173", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/root/{{userId}}/assignAccount?accountId=&isMaster=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "root", "{{userId}}", "assignAccount" ], "query": [ { "key": "accountId", "value": "", "disabled": false, "description": "accountId" }, { "key": "isMaster", "value": "false", "disabled": true, "description": "isMaster" } ] }, "description": "Permissions: SUPER_USER role" }, "response": [] }, { "name": "Returns a user", "id": "6c6ad116-8057-529f-b625-356494879d46", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}" ] }, "description": "Permissions: MANAGE_USERS or SUPER_USER role" }, "response": [] }, { "name": "Updates a user", "id": "e9560626-d6df-5464-8b81-76e0cc438a32", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}" ] }, "description": "Permissions: MANAGE_USERS or SUPER_USER role", "body": { "mode": "raw", "raw": "{\n \"children\": [\n {\n \"children\": [\n {}\n ],\n \"creationDate\": \"2026-08-12T22:30:00.000+0000\",\n \"enabled\": false,\n \"firstName\": \"\",\n \"fullName\": \"\",\n \"lastName\": \"\",\n \"parentPath\": \"\",\n \"phoneNumber\": \"\",\n \"phoneNumberE164\": \"\",\n \"phoneNumbersI18nEnabled\": false\n }\n ],\n \"creationDate\": \"2026-08-12T22:30:00.000+0000\",\n \"enabled\": false,\n \"firstName\": \"\",\n \"fullName\": \"\",\n \"lastName\": \"\",\n \"parentPath\": \"\",\n \"phoneNumber\": \"\",\n \"phoneNumberE164\": \"\",\n \"phoneNumbersI18nEnabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a user", "id": "44c2ded2-37b6-5198-9723-010de9c09b26", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}?reassignUserId=0&cascadeDelete=true", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}" ], "query": [ { "key": "reassignUserId", "value": "0", "disabled": true, "description": "reassignUserId" }, { "key": "cascadeDelete", "value": "true", "disabled": true, "description": "cascadeDelete" } ] }, "description": "Permissions: MANAGE_USERS or SUPER_USER role" }, "response": [] }, { "name": "Assigns an account to any user [POST]", "id": "935fbb96-7b75-55a2-9215-08c89e4e72be", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/assignAccountToAnyUser?accountId=&isMaster=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "assignAccountToAnyUser" ], "query": [ { "key": "accountId", "value": "", "disabled": false, "description": "accountId" }, { "key": "isMaster", "value": "false", "disabled": true, "description": "isMaster" } ] }, "description": "Permissions: hasRole('MANAGE_RIGHTS') or hasRole('SUPER_USER')" }, "response": [] }, { "name": "Assigns an account to any user [POST]", "id": "34dea591-ec04-5e83-81af-30ef88804d07", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/bulkAssignAccountToAnyUser", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "bulkAssignAccountToAnyUser" ] }, "description": "Permissions: hasRole('MANAGE_RIGHTS') or hasRole('SUPER_USER')", "body": { "mode": "raw", "raw": "[\n \"\"\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a hierarchical listing of all users that a user has access to", "id": "ef1eae57-b2fc-5b8c-ba19-94d3a5f0a03e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/children", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "children" ] }, "description": "Permissions: MANAGE_USERS or SUPER_USER role" }, "response": [] }, { "name": "Set user is active", "id": "ae345a72-9ec1-5c34-b2fd-d00b85cfb635", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/setIsActive", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "setIsActive" ] }, "description": "Permissions: Authenticated User", "body": { "mode": "raw", "raw": "{\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Manage RingCX administrative users." }, { "name": "User Roles", "item": [ { "name": "Returns a listing of roles for a user", "id": "785f06a3-09c6-596b-849f-a6f5a47f22d0", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/roles", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "roles" ] }, "description": "Permissions: MANAGE_USERS or SUPER_USER roles" }, "response": [] }, { "name": "Adds a role to a user", "id": "14741178-9932-54d6-8fc6-ee404a04db89", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/roles/{{roleType}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "roles", "{{roleType}}" ] }, "description": "Permissions: MANAGE_USERS or SUPER_USER roles" }, "response": [] }, { "name": "Removes a role from a user", "id": "358f53af-d5b7-5093-a426-7b43a39315d2", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/roles/{{roleType}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "roles", "{{roleType}}" ] }, "description": "Permissions: MANAGE_USERS or SUPER_USER roles" }, "response": [] } ], "description": "Manage role assignments for RingCX administrative users." }, { "name": "Rights Documents", "item": [ { "name": "Returns a listing of users assigned to a rights document", "id": "09942e02-fd0d-51c8-b74d-b4df676b399d", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/rightsDocs/{{rightsDocId}}/assignments", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "rightsDocs", "{{rightsDocId}}", "assignments" ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles" }, "response": [] }, { "name": "Assigns a rights document to a user", "id": "d3e737f8-3c5e-52eb-82d9-99fae948cce1", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/rightsDocs/{{rightsDocId}}/assignments?userIds=[0]", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "rightsDocs", "{{rightsDocId}}", "assignments" ], "query": [ { "key": "userIds", "value": "[0]", "disabled": false, "description": "Repeat the parameter (e.g. ?userIds=1&userIds=2) to assign the rights document to multiple users." } ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles" }, "response": [] }, { "name": "Deletes a rights document from a user", "id": "9a2c0ecf-cb78-5f01-9d40-8b7ab5d75545", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/rightsDocs/{{rightsDocId}}/assignments/{{assignedUserId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "rightsDocs", "{{rightsDocId}}", "assignments", "{{assignedUserId}}" ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles" }, "response": [] }, { "name": "Returns a map of aggregated rights documents for a user", "id": "8bea0467-e317-5158-86aa-a1e796643ee4", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/aggregatedRightsDocs", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "aggregatedRightsDocs" ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles" }, "response": [] }, { "name": "Returns a map of assigned master rights documents for a user", "id": "43918a1f-6f2b-5bcd-9bc1-67ff80ed783e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/assignedMasterRightsDocs", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "assignedMasterRightsDocs" ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles" }, "response": [] }, { "name": "Returns a map of assigned rights documents for a user", "id": "738a9eb6-7250-58e3-906d-9ae6d082d099", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/assignedRightsDocs", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "assignedRightsDocs" ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles" }, "response": [] }, { "name": "Returns a map of merged (master and regular) and aggregated assigned rights documents for a user", "id": "aed4771b-81b6-56fd-a292-024419ec9977", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/effectiveAssignedRightsDocs", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "effectiveAssignedRightsDocs" ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles" }, "response": [] }, { "name": "Returns a map of master rights documents for a user", "id": "b2c418b9-1003-5809-a258-9a45ab0a59a6", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/masterRightsDocs", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "masterRightsDocs" ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles" }, "response": [] }, { "name": "Creates a new master rights document for a user", "id": "8a344706-cee9-5f5f-b092-57d3ab8591ec", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/masterRightsDocs", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "masterRightsDocs" ] }, "description": "Permissions: SUPER_USER roles", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"accountPermissions\": [\n \"CREATE\"\n ],\n \"assigned\": false,\n \"cascade\": false,\n \"isMaster\": false,\n \"ownerId\": 0,\n \"productPermissions\": [\n {\n \"cascade\": false,\n \"permissions\": [\n \"CREATE\"\n ],\n \"product\": \"ACCOUNT\"\n }\n ],\n \"resourcePermissions\": [\n {\n \"cascade\": false,\n \"permissions\": [\n \"CREATE\"\n ],\n \"resourceId\": 0,\n \"resourceType\": \"ACCOUNT\"\n }\n ],\n \"rightsDocId\": 0,\n \"rightsDocName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a single master rights document for a user", "id": "d4fe8474-2d4e-5fa8-b6bd-b1dcf19a80cd", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/masterRightsDocs/{{rightsDocId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "masterRightsDocs", "{{rightsDocId}}" ] }, "description": "Permissions: SUPER_USER roles" }, "response": [] }, { "name": "Updates an existing master rights document for a user", "id": "c46dda6b-9c1c-5ca7-9621-35db67fdadf0", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/masterRightsDocs/{{rightsDocId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "masterRightsDocs", "{{rightsDocId}}" ] }, "description": "Permissions: SUPER_USER roles", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"accountPermissions\": [\n \"CREATE\"\n ],\n \"assigned\": false,\n \"cascade\": false,\n \"isMaster\": false,\n \"ownerId\": 0,\n \"productPermissions\": [\n {\n \"cascade\": false,\n \"permissions\": [\n \"CREATE\"\n ],\n \"product\": \"ACCOUNT\"\n }\n ],\n \"resourcePermissions\": [\n {\n \"cascade\": false,\n \"permissions\": [\n \"CREATE\"\n ],\n \"resourceId\": 0,\n \"resourceType\": \"ACCOUNT\"\n }\n ],\n \"rightsDocId\": 0,\n \"rightsDocName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes an existing master rights document for a user", "id": "c573f223-8f42-510e-aa2e-b464370f363d", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/masterRightsDocs/{{rightsDocId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "masterRightsDocs", "{{rightsDocId}}" ] }, "description": "Permissions: SUPER_USER roles" }, "response": [] }, { "name": "Returns a map of owned master rights documents for a user", "id": "50fdf7d0-ee0c-5360-9fee-8939cbd45746", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/ownedMasterRightsDocs", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "ownedMasterRightsDocs" ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles" }, "response": [] }, { "name": "Returns a map of owned rights documents for a user", "id": "9e5ee62e-15fe-58b7-929a-87689d05bc27", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/ownedRightsDocs", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "ownedRightsDocs" ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles" }, "response": [] }, { "name": "Returns a map of rights documents for a user [GET]", "id": "13654065-fac7-5502-85a2-47c9eead0452", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/rightsDocs", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "rightsDocs" ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles" }, "response": [] }, { "name": "Creates a new rights document for a user", "id": "8a796e95-f0aa-54e7-abaa-f270b6da7436", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/rightsDocs", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "rightsDocs" ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"accountPermissions\": [\n \"CREATE\"\n ],\n \"assigned\": false,\n \"cascade\": false,\n \"isMaster\": false,\n \"ownerId\": 0,\n \"productPermissions\": [\n {\n \"cascade\": false,\n \"permissions\": [\n \"CREATE\"\n ],\n \"product\": \"ACCOUNT\"\n }\n ],\n \"resourcePermissions\": [\n {\n \"cascade\": false,\n \"permissions\": [\n \"CREATE\"\n ],\n \"resourceId\": 0,\n \"resourceType\": \"ACCOUNT\"\n }\n ],\n \"rightsDocId\": 0,\n \"rightsDocName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a single rights document for a user", "id": "be65078e-fd46-51d9-a6f0-de27fdafa93d", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/rightsDocs/{{rightsDocId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "rightsDocs", "{{rightsDocId}}" ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles" }, "response": [] }, { "name": "Updates an existing rights document for a user", "id": "bc764c38-d875-5049-bee1-edef691b0d64", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/rightsDocs/{{rightsDocId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "rightsDocs", "{{rightsDocId}}" ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"accountPermissions\": [\n \"CREATE\"\n ],\n \"assigned\": false,\n \"cascade\": false,\n \"isMaster\": false,\n \"ownerId\": 0,\n \"productPermissions\": [\n {\n \"cascade\": false,\n \"permissions\": [\n \"CREATE\"\n ],\n \"product\": \"ACCOUNT\"\n }\n ],\n \"resourcePermissions\": [\n {\n \"cascade\": false,\n \"permissions\": [\n \"CREATE\"\n ],\n \"resourceId\": 0,\n \"resourceType\": \"ACCOUNT\"\n }\n ],\n \"rightsDocId\": 0,\n \"rightsDocName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes an existing rights document for a user", "id": "d352647b-ed26-5d52-9c1e-556da1abc430", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/rightsDocs/{{rightsDocId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "rightsDocs", "{{rightsDocId}}" ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles" }, "response": [] }, { "name": "Returns a map of rights documents for a user [GET]", "id": "aa566ca5-7fd5-50d1-b459-f31542964234", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/rightsDocsWithSubAccounts?enablePreBuiltRoles=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "rightsDocsWithSubAccounts" ], "query": [ { "key": "enablePreBuiltRoles", "value": "false", "disabled": true, "description": "enablePreBuiltRoles" } ] }, "description": "Permissions: MANAGE_RIGHTS or SUPER_USER roles" }, "response": [] } ], "description": "Manage rights documents and rights document assignments for administrative users." }, { "name": "User Dashboards", "item": [ { "name": "Returns a listing of a dashboards for a user", "id": "5af083da-faf0-538c-8466-7a2e56ce54e8", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/dashboards", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "dashboards" ] }, "description": "Permissions: Authenticated User" }, "response": [] }, { "name": "Creates a new dashboard for a user", "id": "4ffb365a-737b-5d24-a127-0a1b0ab5ed65", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/dashboards", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "dashboards" ] }, "description": "Permissions: Authenticated User", "body": { "mode": "raw", "raw": "{\n \"creationDate\": \"2026-08-12T22:30:00.000+0000\",\n \"data\": {\n \"array\": false,\n \"bigDecimal\": false,\n \"bigInteger\": false,\n \"binary\": false,\n \"boolean\": false,\n \"containerNode\": false,\n \"double\": false,\n \"empty\": false,\n \"float\": false,\n \"floatingPointNumber\": false\n },\n \"id\": 0,\n \"name\": \"\",\n \"shared\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a dashboard for a user", "id": "a49e4361-a1cc-5b77-af58-e4fdb2306526", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/dashboards/{{dashboardId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "dashboards", "{{dashboardId}}" ] }, "description": "Permissions: Authenticated User" }, "response": [] }, { "name": "Updates an existing dashboard for a user", "id": "4099d878-6d43-5d9a-9e55-0835cedd14a6", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/dashboards/{{dashboardId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "dashboards", "{{dashboardId}}" ] }, "description": "Permissions: Authenticated User", "body": { "mode": "raw", "raw": "{\n \"creationDate\": \"2026-08-12T22:30:00.000+0000\",\n \"data\": {\n \"array\": false,\n \"bigDecimal\": false,\n \"bigInteger\": false,\n \"binary\": false,\n \"boolean\": false,\n \"containerNode\": false,\n \"double\": false,\n \"empty\": false,\n \"float\": false,\n \"floatingPointNumber\": false\n },\n \"id\": 0,\n \"name\": \"\",\n \"shared\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a dashboard for a user", "id": "3ec6132c-f641-51c5-8938-2f822101df50", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/dashboards/{{dashboardId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "dashboards", "{{dashboardId}}" ] }, "description": "Permissions: Authenticated User" }, "response": [] }, { "name": "Creates a copy of the dashboard for each admin id supplied", "id": "691b4404-82dc-5396-b6d9-a0dff5dc1761", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/dashboards/{{dashboardId}}/share?userIds=[0]", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "dashboards", "{{dashboardId}}", "share" ], "query": [ { "key": "userIds", "value": "[0]", "disabled": false, "description": "Repeat the parameter (e.g. ?userIds=1&userIds=2) to share the dashboard with multiple users." } ] }, "description": "Permissions: Authenticated User" }, "response": [] } ], "description": "Manage dashboards associated with administrative users." }, { "name": "User Auth Utilities", "item": [ { "name": "Returns information provided by /v1/auth/login for users who are already authenticated. Additionally, we return the host name of this platform.", "id": "ff88c43c-f424-5b8e-a174-37c4b71a6803", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/auth", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "auth" ] }, "description": "Returns information provided by /v1/auth/login for users who are already authenticated. Additionally, we return the host name of this platform." }, "response": [] }, { "name": "Duplicates this authenticated user's session and returns a new auth token", "id": "827a0783-f7fb-506d-89b2-d5f0b35d92a7", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/duplicateAuthenticatedUser", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "duplicateAuthenticatedUser" ] }, "description": "Permissions: Authenticated User" }, "response": [] }, { "name": "Resets a user's password", "id": "ea84eb48-b6c9-5c86-9985-1fd911cb55da", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/passwordReset?currentPassword=&newPassword=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "passwordReset" ], "query": [ { "key": "currentPassword", "value": "", "disabled": false, "description": "currentPassword" }, { "key": "newPassword", "value": "", "disabled": false, "description": "newPassword" } ] }, "description": "Permissions: Authenticated User" }, "response": [] }, { "name": "Resets a user's password and sends reset password email", "id": "92948d39-b0d2-50ee-b6c0-b4af8190b61b", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/users/{{userId}}/passwordReset?returnPath=&resetViaEngageAuth=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "users", "{{userId}}", "passwordReset" ], "query": [ { "key": "returnPath", "value": "", "disabled": false, "description": "returnPath" }, { "key": "resetViaEngageAuth", "value": "false", "disabled": true, "description": "resetViaEngageAuth" } ] }, "description": "Permissions: Authenticated User" }, "response": [] }, { "name": "Checks to see if a given token is valid", "id": "d7a3f5a9-8e34-586a-97c2-aed849b9980c", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/auth/isTokenValid?token=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "auth", "isTokenValid" ], "query": [ { "key": "token", "value": "", "disabled": false, "description": "token" } ] }, "description": "Permissions: NONE" }, "response": [] }, { "name": "Used to reset a users password", "id": "6f64c558-2fe9-5ab0-aac8-86f6fb53b835", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/auth/passwordReset?token=&password=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "auth", "passwordReset" ], "query": [ { "key": "token", "value": "", "disabled": false, "description": "token" }, { "key": "password", "value": "", "disabled": false, "description": "password" } ] }, "description": "Permissions: NONE" }, "response": [] }, { "name": "Resets a password if a user is locked out, an email will be sent to the user", "id": "a26187d8-c5c4-5cec-b7dc-931bf3aefd52", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/auth/passwordResetRequest?userName=&returnPath=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "auth", "passwordResetRequest" ], "query": [ { "key": "userName", "value": "", "disabled": false, "description": "userName" }, { "key": "returnPath", "value": "", "disabled": false, "description": "returnPath" } ] }, "description": "Permissions: NONE" }, "response": [] } ], "description": "Validate tokens and support administrative authentication utility workflows." } ] }, { "name": "Routing", "item": [ { "name": "Queues", "item": [ { "name": "Returns a listing of all queues (AKA gates) for a queue group", "id": "dc83133c-9ce5-51fe-84ff-0d526ed3ccf5", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates?page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates" ], "query": [ { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Gate Group, Post Filtered Results" }, "response": [] }, { "name": "Creates a new queue (AKA gate) for a queue group", "id": "d1791a9b-709d-5db5-99b8-305842db2f87", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates" ] }, "description": "Permissions: CREATE on Gate Group", "body": { "mode": "raw", "raw": "{\n \"abandonCampaign\": {\n \"abandonMsg\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnectSoapService\": {},\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"allowLeadInserts\": \"\",\n \"allowLeadUpdates\": \"\",\n \"amdProfileId\": {},\n \"appUrl\": \"\"\n },\n \"acceptTime\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {\n \"agentAuxState\": \"\",\n \"baseAgentState\": {},\n \"description\": \"\",\n \"isActive\": false,\n \"isAgentSelectable\": false,\n \"isRequired\": false,\n \"rank\": 0,\n \"stateId\": 0\n },\n \"agentConnSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"agentGateAccess\": [\n {\n \"agentId\": 0,\n \"agentRank\": 0,\n \"defaultDestOverride\": \"\",\n \"gateId\": 0\n }\n ],\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"appUrl\": \"\",\n \"backupAppUrl\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a single queue (AKA gate) for a queue group", "id": "8f4f3695-c65f-53fd-8b41-16f664542179", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}" ] }, "description": "Permissions: READ on Gate" }, "response": [] }, { "name": "Updates a queue (AKA gate) for a queue group", "id": "4aca9c03-e2bb-5d7b-a375-314ecff8a225", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "{\n \"abandonCampaign\": {\n \"abandonMsg\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnectSoapService\": {},\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"allowLeadInserts\": \"\",\n \"allowLeadUpdates\": \"\",\n \"amdProfileId\": {},\n \"appUrl\": \"\"\n },\n \"acceptTime\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {\n \"agentAuxState\": \"\",\n \"baseAgentState\": {},\n \"description\": \"\",\n \"isActive\": false,\n \"isAgentSelectable\": false,\n \"isRequired\": false,\n \"rank\": 0,\n \"stateId\": 0\n },\n \"agentConnSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"agentGateAccess\": [\n {\n \"agentId\": 0,\n \"agentRank\": 0,\n \"defaultDestOverride\": \"\",\n \"gateId\": 0\n }\n ],\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"appUrl\": \"\",\n \"backupAppUrl\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "[Deprecated] Deletes a queue (AKA gate) for a queue group", "id": "f73b2a15-73a9-5cd3-8851-a95069235ebc", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}" ] }, "description": "Deprecated operation. Permissions: DELETE on Gate" }, "response": [] }, { "name": "Assigns a queue (AKA gate) to a queue priority group for an account", "id": "4ee03e55-8abb-5160-bbcc-b685977ab985", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/assignGateToPriorityGroup?priorityGroupId=0&priorityGroupRank=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "assignGateToPriorityGroup" ], "query": [ { "key": "priorityGroupId", "value": "0", "disabled": false, "description": "priorityGroupId" }, { "key": "priorityGroupRank", "value": "0", "disabled": false, "description": "priorityGroupRank" } ] }, "description": "Permissions: UPDATE on Gate" }, "response": [] }, { "name": "Creates a clone of a queue (AKA gate) for a queue group", "id": "d33f4363-e6f0-547d-9c2e-96d2f038023f", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/clone?newGateGroupId=0&newGateName=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "clone" ], "query": [ { "key": "newGateGroupId", "value": "0", "disabled": false, "description": "newGateGroupId" }, { "key": "newGateName", "value": "", "disabled": false, "description": "newGateName" } ] }, "description": "Permissions: READ on cloned Gate and CREATE on new Gate Group (Permission Override" }, "response": [] }, { "name": "[Deprecated] Move an existing queue (AKA gate) to a new existing queue group", "id": "c9dfedb2-6f8a-5a37-947d-12ccbecc83e6", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/moveToGroup?newGateGroupId=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "moveToGroup" ], "query": [ { "key": "newGateGroupId", "value": "0", "disabled": false, "description": "newGateGroupId" } ] }, "description": "Deprecated operation. Permissions: UPDATE on Gate and CREATE on new Gate Group (Permission Override)" }, "response": [] }, { "name": "Set queue (AKA gate) active state", "id": "4699f7c8-3074-5f3a-b72d-a2be74148fe7", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/setIsActive", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "setIsActive" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "{\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Manage RingCX voice queues." }, { "name": "Queue Groups", "item": [ { "name": "Returns a listing of queue groups (AKA gate groups) with related data for an account", "id": "ca2523c8-ef27-50e6-8afd-9c9f36bc7328", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/withChildren?includePermissions=false&page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "withChildren" ], "query": [ { "key": "includePermissions", "value": "false", "disabled": true, "description": "includePermissions" }, { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Account, Post Filtered Results" }, "response": [] }, { "name": "Returns a listing of queue groups (AKA gate groups) with related and additional data for an account", "id": "6a94c988-5343-5937-bd20-f9465b74a0f6", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/withChildren/additionalData?page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "withChildren", "additionalData" ], "query": [ { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Account, Post Filtered Results" }, "response": [] }, { "name": "Returns a single queue group (AKA gate group) for an account", "id": "2c903ca2-6827-52b5-b725-a01170812366", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}" ] }, "description": "Permissions: READ on Gate Group" }, "response": [] }, { "name": "Updates a single queue group (AKA gate group) for an account", "id": "c28af650-830f-5559-9224-8ea5f2775c03", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}" ] }, "description": "Permissions: UPDATE on Gate Group", "body": { "mode": "raw", "raw": "{\n \"billingKey\": \"\",\n \"createdOn\": \"2026-08-12T22:30:00.000+0000\",\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"gateGroupId\": 0,\n \"gates\": [\n {\n \"abandonCampaign\": {},\n \"acceptTime\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnSoapService\": {},\n \"agentGateAccess\": [\n {}\n ],\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"appUrl\": \"\",\n \"backupAppUrl\": \"\"\n }\n ],\n \"groupName\": \"\",\n \"groupSkills\": [\n {\n \"active\": false,\n \"agentSkillProfiles\": {},\n \"createdOn\": \"2026-08-12T22:30:00.000+0000\",\n \"requeueShortcut\": [\n {}\n ],\n \"skillDesc\": \"\",\n \"skillId\": 0,\n \"skillName\": \"\",\n \"whisperAudio\": \"\"\n }\n ],\n \"permissions\": [\n \"CREATE\"\n ],\n \"startDate\": \"2026-08-12T22:30:00.000+0000\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "[Deprecated] Deletes a single queue group (AKA gate group)", "id": "5a5d26aa-a925-5375-955a-3a086545f47b", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}" ] }, "description": "Deprecated operation. Permissions: DELETE on Gate Group" }, "response": [] } ], "description": "Manage voice queue groups." }, { "name": "Agent Access", "item": [ { "name": "Returns the count of agents in an agentGroup logged into a Queue ", "id": "bffbbd7e-af13-52ed-97d6-adf23c4a4883", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/agentGroups/{{agentGroupId}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "agentGroups", "{{agentGroupId}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}" ] }, "description": "Permissions: READ on Account, READ on requested Gate" }, "response": [] }, { "name": "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", "id": "8d7dc64e-ca49-5b76-b5fd-495f542eda43", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/gateAgentAccessLogin", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "gateAgentAccessLogin" ] }, "description": "Permissions: READ on Account and Read on Agent, Post Filtered Results" }, "response": [] } ], "description": "Manage agent access to queues and queue groups." }, { "name": "Queue Dispositions", "item": [ { "name": "Returns a listing of dispositions for a queue (AKA gate)", "id": "57abba42-8a4f-570e-935b-e6e3f60ce7b9", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/dispositions", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "dispositions" ] }, "description": "Permissions: READ on Gate, Post Filtered Results" }, "response": [] }, { "name": "Creates a disposition for a queue (AKA gate)", "id": "21a70930-f421-598e-8a7f-aacc1e1ccb58", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/dispositions", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "dispositions" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "{\n \"destCampaign\": {\n \"abandonMsg\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnectSoapService\": {},\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"allowLeadInserts\": \"\",\n \"allowLeadUpdates\": \"\",\n \"amdProfileId\": {},\n \"appUrl\": \"\"\n },\n \"dispSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"disposition\": \"\",\n \"dncTagLabel\": \"\",\n \"doNotCall\": false,\n \"dtmfMapping\": \"\",\n \"emailDestinations\": \"\",\n \"emailTemplate\": {\n \"accountId\": \"\",\n \"allowBccChange\": false,\n \"allowBodyChange\": false,\n \"allowCcChange\": false,\n \"allowFromChange\": false,\n \"allowSubjectChange\": false,\n \"allowToChange\": false,\n \"emailBcc\": \"\",\n \"emailCc\": \"\",\n \"emailFrom\": \"\"\n },\n \"gateDispositionId\": 0,\n \"isComplete\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Saves a list of dispositions for a queue (AKA gate)", "id": "08036e8c-faf5-56c2-ade5-61d25eb19e0d", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/dispositions", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "dispositions" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "[\n {\n \"destCampaign\": {\n \"abandonMsg\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnectSoapService\": {},\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"allowLeadInserts\": \"\",\n \"allowLeadUpdates\": \"\",\n \"amdProfileId\": {},\n \"appUrl\": \"\"\n },\n \"dispSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"disposition\": \"\",\n \"dncTagLabel\": \"\",\n \"doNotCall\": false,\n \"dtmfMapping\": \"\",\n \"emailDestinations\": \"\",\n \"emailTemplate\": {\n \"accountId\": \"\",\n \"allowBccChange\": false,\n \"allowBodyChange\": false,\n \"allowCcChange\": false,\n \"allowFromChange\": false,\n \"allowSubjectChange\": false,\n \"allowToChange\": false,\n \"emailBcc\": \"\",\n \"emailCc\": \"\",\n \"emailFrom\": \"\"\n },\n \"gateDispositionId\": 0,\n \"isComplete\": false\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a single disposition for a queue (AKA gate)", "id": "ae4d0077-0d30-5241-8543-293251d549df", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/dispositions/{{gateDispositionId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "dispositions", "{{gateDispositionId}}" ] }, "description": "Permissions: READ on Gate" }, "response": [] }, { "name": "Updates a single disposition for a queue (AKA gate)", "id": "a8aa1106-0bab-510b-ba56-5e8c8dba3bf3", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/dispositions/{{gateDispositionId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "dispositions", "{{gateDispositionId}}" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "{\n \"destCampaign\": {\n \"abandonMsg\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnectSoapService\": {},\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"allowLeadInserts\": \"\",\n \"allowLeadUpdates\": \"\",\n \"amdProfileId\": {},\n \"appUrl\": \"\"\n },\n \"dispSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"disposition\": \"\",\n \"dncTagLabel\": \"\",\n \"doNotCall\": false,\n \"dtmfMapping\": \"\",\n \"emailDestinations\": \"\",\n \"emailTemplate\": {\n \"accountId\": \"\",\n \"allowBccChange\": false,\n \"allowBodyChange\": false,\n \"allowCcChange\": false,\n \"allowFromChange\": false,\n \"allowSubjectChange\": false,\n \"allowToChange\": false,\n \"emailBcc\": \"\",\n \"emailCc\": \"\",\n \"emailFrom\": \"\"\n },\n \"gateDispositionId\": 0,\n \"isComplete\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a disposition for a queue (AKA gate)", "id": "a995a18d-ad7c-5a91-8157-e9b61e3d35be", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/dispositions/{{gateDispositionId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "dispositions", "{{gateDispositionId}}" ] }, "description": "Permissions: UPDATE on Gate" }, "response": [] } ], "description": "Manage dispositions used by voice queues." }, { "name": "Queue Events", "item": [ { "name": "Returns a listing of gate queue events for a queue", "id": "910879f6-08ec-517c-9f66-1aaf842ace9b", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/gateQueueEvents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "gateQueueEvents" ] }, "description": "Permissions: READ on Gate" }, "response": [] }, { "name": "[Deprecated] createGateQueueEvent", "id": "7078c116-393e-5bda-b150-9484d1edb6d2", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/gateQueueEvents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "gateQueueEvents" ] }, "description": "Deprecated operation. createGateQueueEvent", "body": { "mode": "raw", "raw": "{\n \"enableDtmf\": \"\",\n \"eventDuration\": 0,\n \"eventId\": 0,\n \"eventRank\": 0,\n \"gate\": {\n \"abandonCampaign\": {},\n \"acceptTime\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnSoapService\": {},\n \"agentGateAccess\": [\n {}\n ],\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"appUrl\": \"\",\n \"backupAppUrl\": \"\"\n },\n \"queueEvent\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Saves a list of gate queue events for a queue", "id": "39ac9977-18eb-57fb-bd72-b07b55d2122b", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/gateQueueEvents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "gateQueueEvents" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "[\n {\n \"enableDtmf\": \"\",\n \"eventDuration\": 0,\n \"eventId\": 0,\n \"eventRank\": 0,\n \"gate\": {\n \"abandonCampaign\": {},\n \"acceptTime\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnSoapService\": {},\n \"agentGateAccess\": [\n {}\n ],\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"appUrl\": \"\",\n \"backupAppUrl\": \"\"\n },\n \"queueEvent\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a single gate queue event for a queue", "id": "a8fa1ff9-b2b9-5c01-add7-a94ce807844d", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/gateQueueEvents/{{eventId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "gateQueueEvents", "{{eventId}}" ] }, "description": "Permissions: READ on Gate" }, "response": [] }, { "name": "Updates a single gate queue event for a queue", "id": "ac4fa903-9106-5553-9326-4f8a9068c7bb", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/gateQueueEvents/{{eventId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "gateQueueEvents", "{{eventId}}" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "{\n \"enableDtmf\": \"\",\n \"eventDuration\": 0,\n \"eventId\": 0,\n \"eventRank\": 0,\n \"gate\": {\n \"abandonCampaign\": {},\n \"acceptTime\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnSoapService\": {},\n \"agentGateAccess\": [\n {}\n ],\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"appUrl\": \"\",\n \"backupAppUrl\": \"\"\n },\n \"queueEvent\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a gate queue event for a queue", "id": "d9f03444-dadc-5c0f-a392-d18ce28ed812", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/gateQueueEvents/{{eventId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "gateQueueEvents", "{{eventId}}" ] }, "description": "Permissions: UPDATE on Gate (Override Permission Request)" }, "response": [] }, { "name": "Returns a listing of Gate Queue Dtmp Events for a Queue", "id": "36eee46d-42da-5e49-8adc-257546b4a57b", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/gateQueueEvents/{{eventId}}/gateQueueDtmfEvents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "gateQueueEvents", "{{eventId}}", "gateQueueDtmfEvents" ] }, "description": "Permissions: READ on Gate" }, "response": [] }, { "name": "Creates a new Gate Queue Dtmp Event", "id": "5e216928-46a3-5833-b223-a439f235ff4a", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/gateQueueEvents/{{eventId}}/gateQueueDtmfEvents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "gateQueueEvents", "{{eventId}}", "gateQueueDtmfEvents" ] }, "description": "Permissions: UPDATE on Gate (Permission Override)", "body": { "mode": "raw", "raw": "{\n \"dtmf\": \"\",\n \"dtmfEvent\": \"\",\n \"dtmfEventId\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Updates a listing of Gate Queue Dtmp Events", "id": "54d72a00-9842-59ea-b7ee-deb7fef313a4", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/gateQueueEvents/{{eventId}}/gateQueueDtmfEvents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "gateQueueEvents", "{{eventId}}", "gateQueueDtmfEvents" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "[\n {\n \"dtmf\": \"\",\n \"dtmfEvent\": \"\",\n \"dtmfEventId\": 0\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a single Gate Queue Dtmp Event", "id": "912672ac-f9cf-55fb-9df0-97bb57479e8a", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/gateQueueEvents/{{eventId}}/gateQueueDtmfEvents/{{dtmfEventId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "gateQueueEvents", "{{eventId}}", "gateQueueDtmfEvents", "{{dtmfEventId}}" ] }, "description": "Permissions: READ on Gate" }, "response": [] }, { "name": "Updates a single Gate Queue Dtmp Event", "id": "513a21c1-629d-5bf5-b552-5346b5238f87", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/gateQueueEvents/{{eventId}}/gateQueueDtmfEvents/{{dtmfEventId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "gateQueueEvents", "{{eventId}}", "gateQueueDtmfEvents", "{{dtmfEventId}}" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "{\n \"dtmf\": \"\",\n \"dtmfEvent\": \"\",\n \"dtmfEventId\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a Gate Queue Dtmp Event", "id": "9a45f5b8-600a-5bb5-a059-f81b90cfcc53", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/gateQueueEvents/{{eventId}}/gateQueueDtmfEvents/{{dtmfEventId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "gateQueueEvents", "{{eventId}}", "gateQueueDtmfEvents", "{{dtmfEventId}}" ] }, "description": "Permissions: UPDATE on Gate (Permission Override)" }, "response": [] } ], "description": "Manage events and DTMF actions for voice queues." }, { "name": "Queue Phone Book", "item": [ { "name": "Returns all phone book entries for a queue (AKA gate)", "id": "214b6421-b00f-5967-8290-b598c019ed1f", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/phoneBookEntries?page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "phoneBookEntries" ], "query": [ { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Gate" }, "response": [] }, { "name": "Creates a phone book entry for a queue (AKA gate)", "id": "9d18d942-fa26-5668-9974-6eb5effa9370", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/phoneBookEntries", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "phoneBookEntries" ] }, "description": "Permissions: UPDATE on Gate (Permission Override)", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"countryId\": \"\",\n \"dateCreated\": \"2026-08-12T22:30:00.000+0000\",\n \"destName\": \"\",\n \"destination\": \"\",\n \"entryId\": 0,\n \"notes\": \"\",\n \"type\": \"GATE\",\n \"typeId\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Updates a listing of phone book entries for a queue (AKA gate)", "id": "69d77422-aaee-566b-8ed2-4839b645fce1", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/phoneBookEntries", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "phoneBookEntries" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "[\n {\n \"accountId\": \"\",\n \"countryId\": \"\",\n \"dateCreated\": \"2026-08-12T22:30:00.000+0000\",\n \"destName\": \"\",\n \"destination\": \"\",\n \"entryId\": 0,\n \"notes\": \"\",\n \"type\": \"GATE\",\n \"typeId\": 0\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Updates a phone book entry for a queue (AKA gate)", "id": "42091133-465b-5b85-919e-edbce8a7755e", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/phoneBookEntries/{{entryId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "phoneBookEntries", "{{entryId}}" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"countryId\": \"\",\n \"dateCreated\": \"2026-08-12T22:30:00.000+0000\",\n \"destName\": \"\",\n \"destination\": \"\",\n \"entryId\": 0,\n \"notes\": \"\",\n \"type\": \"GATE\",\n \"typeId\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a single phone book entry for a queue (AKA gate)", "id": "0d95e29e-2e22-59b2-bf58-d72e68aae7f1", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/phoneBookEntries/{{entryId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "phoneBookEntries", "{{entryId}}" ] }, "description": "Permissions: UPDATE on Gate (Permission Override)" }, "response": [] } ], "description": "Manage phone book entries for voice queues." }, { "name": "Queue Skills", "item": [ { "name": "Returns a listing of skills for a queue group (AKA gate group)", "id": "aaafac8c-3a23-5e17-98c1-6b44fd068130", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/skills", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "skills" ] }, "description": "Permissions: READ on Gate Group" }, "response": [] }, { "name": "Creates a skill for a queue group (AKA gate group)", "id": "50290ba1-dc3c-5c19-b4f0-7d55e19ac651", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/skills", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "skills" ] }, "description": "Permissions: UPDATE on Gate Group (Permission Override)", "body": { "mode": "raw", "raw": "{\n \"active\": false,\n \"agentSkillProfiles\": {},\n \"createdOn\": \"2026-08-12T22:30:00.000+0000\",\n \"requeueShortcut\": [\n {\n \"campaign\": {},\n \"gate\": {},\n \"groupSkill\": {},\n \"name\": \"\",\n \"rank\": 0,\n \"requeueGate\": {},\n \"requeueGateGroup\": {},\n \"requeueShortcutId\": 0\n }\n ],\n \"skillDesc\": \"\",\n \"skillId\": 0,\n \"skillName\": \"\",\n \"whisperAudio\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Updates an existing list of skills for a queue group (AKA gate group)", "id": "4093eb4c-c5a7-53a4-bb03-413852422fc7", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/skills", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "skills" ] }, "description": "Permissions: UPDATE on Gate Group", "body": { "mode": "raw", "raw": "[\n {\n \"active\": false,\n \"agentSkillProfiles\": {},\n \"createdOn\": \"2026-08-12T22:30:00.000+0000\",\n \"requeueShortcut\": [\n {}\n ],\n \"skillDesc\": \"\",\n \"skillId\": 0,\n \"skillName\": \"\",\n \"whisperAudio\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a skill for a queue group (AKA gate group)", "id": "e5d5c1bf-0ce7-5d34-8fb2-db7c7e17f555", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/skills/{{skillId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "skills", "{{skillId}}" ] }, "description": "Permissions: READ on Gate Group" }, "response": [] }, { "name": "Updates a skill for a queue group (AKA gate group)", "id": "c5d3abd9-e33b-54ed-b647-0a1a23c4876c", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/skills/{{skillId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "skills", "{{skillId}}" ] }, "description": "Permissions: UPDATE on Gate Group", "body": { "mode": "raw", "raw": "{\n \"active\": false,\n \"agentSkillProfiles\": {},\n \"createdOn\": \"2026-08-12T22:30:00.000+0000\",\n \"requeueShortcut\": [\n {\n \"campaign\": {},\n \"gate\": {},\n \"groupSkill\": {},\n \"name\": \"\",\n \"rank\": 0,\n \"requeueGate\": {},\n \"requeueGateGroup\": {},\n \"requeueShortcutId\": 0\n }\n ],\n \"skillDesc\": \"\",\n \"skillId\": 0,\n \"skillName\": \"\",\n \"whisperAudio\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a skill for a queue group (AKA gate group)", "id": "8c857898-256f-5c57-931b-4486395c1b3c", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/skills/{{skillId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "skills", "{{skillId}}" ] }, "description": "Permissions: UPDATE on Gate Group (Permission Override)" }, "response": [] } ], "description": "Manage skills associated with voice queue groups." }, { "name": "Requeue Shortcuts", "item": [ { "name": "Returns a listing of requeue shortcuts for a queue (AKA gate) [GET]", "id": "5cc65968-d2dc-5049-aa9a-99db12f64f7f", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/requeueShortcuts", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "requeueShortcuts" ] }, "description": "Permissions: READ on Gate" }, "response": [] }, { "name": "Updates a requeue shortcut for a queue (AKA gate) [POST]", "id": "a07948a6-ad70-558b-8d8d-deb5cf8e3145", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/requeueShortcuts", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "requeueShortcuts" ] }, "description": "Permissions: UPDATE on Gate (Override Permission Request)", "body": { "mode": "raw", "raw": "{\n \"campaign\": {\n \"abandonMsg\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnectSoapService\": {},\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"allowLeadInserts\": \"\",\n \"allowLeadUpdates\": \"\",\n \"amdProfileId\": {},\n \"appUrl\": \"\"\n },\n \"gate\": {\n \"abandonCampaign\": {},\n \"acceptTime\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnSoapService\": {},\n \"agentGateAccess\": [\n {}\n ],\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"appUrl\": \"\",\n \"backupAppUrl\": \"\"\n },\n \"groupSkill\": {\n \"active\": false,\n \"agentSkillProfiles\": {},\n \"createdOn\": \"2026-08-12T22:30:00.000+0000\",\n \"requeueShortcut\": [\n {}\n ],\n \"skillDesc\": \"\",\n \"skillId\": 0,\n \"skillName\": \"\",\n \"whisperAudio\": \"\"\n },\n \"name\": \"\",\n \"rank\": 0,\n \"requeueGate\": {\n \"abandonCampaign\": {},\n \"acceptTime\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnSoapService\": {},\n \"agentGateAccess\": [\n {}\n ],\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"appUrl\": \"\",\n \"backupAppUrl\": \"\"\n },\n \"requeueGateGroup\": {\n \"billingKey\": \"\",\n \"createdOn\": \"2026-08-12T22:30:00.000+0000\",\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"gateGroupId\": 0,\n \"gates\": [\n {}\n ],\n \"groupName\": \"\",\n \"groupSkills\": [\n {}\n ],\n \"permissions\": [\n \"CREATE\"\n ],\n \"startDate\": \"2026-08-12T22:30:00.000+0000\"\n },\n \"requeueShortcutId\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Creates a list of requeue shortcuts for a queue (AKA gate)", "id": "5af77b12-ea9b-58a8-b489-a99b13d3c3fb", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/requeueShortcuts", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "requeueShortcuts" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "[\n {\n \"campaign\": {\n \"abandonMsg\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnectSoapService\": {},\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"allowLeadInserts\": \"\",\n \"allowLeadUpdates\": \"\",\n \"amdProfileId\": {},\n \"appUrl\": \"\"\n },\n \"gate\": {\n \"abandonCampaign\": {},\n \"acceptTime\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnSoapService\": {},\n \"agentGateAccess\": [\n {}\n ],\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"appUrl\": \"\",\n \"backupAppUrl\": \"\"\n },\n \"groupSkill\": {\n \"active\": false,\n \"agentSkillProfiles\": {},\n \"createdOn\": \"2026-08-12T22:30:00.000+0000\",\n \"requeueShortcut\": [\n {}\n ],\n \"skillDesc\": \"\",\n \"skillId\": 0,\n \"skillName\": \"\",\n \"whisperAudio\": \"\"\n },\n \"name\": \"\",\n \"rank\": 0,\n \"requeueGate\": {\n \"abandonCampaign\": {},\n \"acceptTime\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnSoapService\": {},\n \"agentGateAccess\": [\n {}\n ],\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"appUrl\": \"\",\n \"backupAppUrl\": \"\"\n },\n \"requeueGateGroup\": {\n \"billingKey\": \"\",\n \"createdOn\": \"2026-08-12T22:30:00.000+0000\",\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"gateGroupId\": 0,\n \"gates\": [\n {}\n ],\n \"groupName\": \"\",\n \"groupSkills\": [\n {}\n ],\n \"permissions\": [\n \"CREATE\"\n ],\n \"startDate\": \"2026-08-12T22:30:00.000+0000\"\n },\n \"requeueShortcutId\": 0\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a requeue shortcut for a queue (AKA gate)", "id": "8b0460c3-78b9-5a7b-9a92-4bf416931e90", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/requeueShortcuts/{{requeueShortcutId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "requeueShortcuts", "{{requeueShortcutId}}" ] }, "description": "Permissions: READ on Gate" }, "response": [] }, { "name": "Updates a requeue shortcut for a queue (AKA gate) [PUT]", "id": "82e5846b-daf5-59f3-ac9c-83ac6ebb0d80", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/requeueShortcuts/{{requeueShortcutId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "requeueShortcuts", "{{requeueShortcutId}}" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "{\n \"campaign\": {\n \"abandonMsg\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnectSoapService\": {},\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"allowLeadInserts\": \"\",\n \"allowLeadUpdates\": \"\",\n \"amdProfileId\": {},\n \"appUrl\": \"\"\n },\n \"gate\": {\n \"abandonCampaign\": {},\n \"acceptTime\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnSoapService\": {},\n \"agentGateAccess\": [\n {}\n ],\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"appUrl\": \"\",\n \"backupAppUrl\": \"\"\n },\n \"groupSkill\": {\n \"active\": false,\n \"agentSkillProfiles\": {},\n \"createdOn\": \"2026-08-12T22:30:00.000+0000\",\n \"requeueShortcut\": [\n {}\n ],\n \"skillDesc\": \"\",\n \"skillId\": 0,\n \"skillName\": \"\",\n \"whisperAudio\": \"\"\n },\n \"name\": \"\",\n \"rank\": 0,\n \"requeueGate\": {\n \"abandonCampaign\": {},\n \"acceptTime\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {},\n \"agentConnSoapService\": {},\n \"agentGateAccess\": [\n {}\n ],\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {},\n \"appUrl\": \"\",\n \"backupAppUrl\": \"\"\n },\n \"requeueGateGroup\": {\n \"billingKey\": \"\",\n \"createdOn\": \"2026-08-12T22:30:00.000+0000\",\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"gateGroupId\": 0,\n \"gates\": [\n {}\n ],\n \"groupName\": \"\",\n \"groupSkills\": [\n {}\n ],\n \"permissions\": [\n \"CREATE\"\n ],\n \"startDate\": \"2026-08-12T22:30:00.000+0000\"\n },\n \"requeueShortcutId\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a listing of requeue shortcuts for a queue (AKA gate) [DELETE]", "id": "55638b5b-515a-5246-a102-6edb2197d946", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/requeueShortcuts/{{requeueShortcutId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "requeueShortcuts", "{{requeueShortcutId}}" ] }, "description": "Permissions: UPDATE on Gate (Permission Override)" }, "response": [] } ], "description": "Manage queue transfer shortcuts." }, { "name": "Queue Schedule", "item": [ { "name": "Returns a listing of schedule overrides for a queue (AKA gate)", "id": "c528fc39-e0f3-55d9-8dc7-d4452d9eef98", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/scheduleOverrides", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "scheduleOverrides" ] }, "description": "Permissions: READ on Gate" }, "response": [] }, { "name": "Creates a schedule override for a queue (AKA gate)", "id": "0c499b2b-df26-5a14-9998-528f50fd5384", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/scheduleOverrides", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "scheduleOverrides" ] }, "description": "Permissions: UPDATE on Gate (Permission Override)", "body": { "mode": "raw", "raw": "{\n \"overrideClosedEvent\": \"\",\n \"overrideDate\": \"2026-08-12T22:30:00.000+0000\",\n \"overrideLabel\": \"\",\n \"overrideSched\": \"\",\n \"scheduleOverrideId\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Saves a listing of schedule overrides for a queue (AKA gate)", "id": "ac80f440-1a1f-5424-ae13-3a801497a9e6", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/scheduleOverrides", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "scheduleOverrides" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "[\n {\n \"overrideClosedEvent\": \"\",\n \"overrideDate\": \"2026-08-12T22:30:00.000+0000\",\n \"overrideLabel\": \"\",\n \"overrideSched\": \"\",\n \"scheduleOverrideId\": 0\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Updates a schedule override for a queue (AKA gate)", "id": "8f916334-3239-5244-a057-6c306ebc318c", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/scheduleOverrides/{{scheduleOverrideId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "scheduleOverrides", "{{scheduleOverrideId}}" ] }, "description": "Permissions: UPDATE on Gate", "body": { "mode": "raw", "raw": "{\n \"overrideClosedEvent\": \"\",\n \"overrideDate\": \"2026-08-12T22:30:00.000+0000\",\n \"overrideLabel\": \"\",\n \"overrideSched\": \"\",\n \"scheduleOverrideId\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a schedule override for a queue (AKA gate)", "id": "313360d3-f3a6-55f3-8253-9272d0d74ba6", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/scheduleOverrides/{{scheduleOverrideId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "scheduleOverrides", "{{scheduleOverrideId}}" ] }, "description": "Permissions: UPDATE on Gate (Permission Override)" }, "response": [] } ], "description": "Manage schedule overrides for voice queues." }, { "name": "Queue Special ANI", "item": [ { "name": "Returns a listing of special anis for a queue (AKA gate)", "id": "771cdeec-cae5-540f-8cf5-a9ad944deeae", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/specialAnis?type=&filter=&page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "specialAnis" ], "query": [ { "key": "type", "value": "", "disabled": true, "description": "type" }, { "key": "filter", "value": "", "disabled": true, "description": "filter" }, { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Gate" }, "response": [] }, { "name": "Creates a special ani for a queue (AKA gate)", "id": "03dbcc07-eb1e-5147-a105-a62bbbbc2dd3", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/specialAnis", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "specialAnis" ] }, "description": "Permissions: UPDATE on Gate (Permission Override)", "body": { "mode": "raw", "raw": "{\n \"ani\": \"\",\n \"aniE164\": \"\",\n \"dateAdded\": \"2026-08-12T22:30:00.000+0000\",\n \"phoneNumbersI18nEnabled\": false,\n \"type\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a special ani for a queue (AKA gate)", "id": "0f0e184f-5708-510a-bfa1-7ed13e18d2ea", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/specialAnis?type=&ani=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "specialAnis" ], "query": [ { "key": "type", "value": "", "disabled": false, "description": "type" }, { "key": "ani", "value": "", "disabled": true, "description": "ani" } ] }, "description": "Permissions: UPDATE on Gate (Permission Override)" }, "response": [] }, { "name": "Uploads a special ani for a queue (AKA gate)", "id": "8971c79d-0681-53be-bb1d-5e5cad4e152d", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "multipart/form-data", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/gateGroups/{{gateGroupId}}/gates/{{gateId}}/specialAnis/upload?operation=APPEND&type=S-ANI", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "gateGroups", "{{gateGroupId}}", "gates", "{{gateId}}", "specialAnis", "upload" ], "query": [ { "key": "operation", "value": "APPEND", "disabled": true, "description": "operation" }, { "key": "type", "value": "S-ANI", "disabled": false, "description": "type" } ] }, "description": "Permissions: UPDATE on Gate (Permission Override)", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "disabled": false, "src": [] } ] } }, "response": [] } ], "description": "Manage special ANI routing entries for voice queues." }, { "name": "Number Management", "item": [ { "name": "Update Dnis Records in Bulk", "id": "6293792f-b065-5c25-87ec-45adcbb68f60", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/v1/admin/utilities/tnManager/updateCustomerDnisBulk", "host": [ "{{ringcx_base_url}}" ], "path": [ "v1", "admin", "utilities", "tnManager", "updateCustomerDnisBulk" ] }, "description": "Update Dnis Records in Bulk", "body": { "mode": "raw", "raw": "{\n \"assignedDnis\": {\n \"dnisType\": \"ACCOUNT\",\n \"endDate\": \"2026-01-15T12:00:00Z\",\n \"id\": 0,\n \"startDate\": \"2026-01-15T12:00:00Z\"\n },\n \"assignedSmsDnis\": {\n \"endDate\": \"2026-01-15T12:00:00Z\",\n \"id\": 0,\n \"startDate\": \"2026-01-15T12:00:00Z\"\n },\n \"dnisPool\": [\n {\n \"dnis\": [\n \"\"\n ],\n \"reservedAccountId\": \"\"\n }\n ],\n \"general\": {\n \"dnisDescription\": \"\",\n \"inboundContext\": \"\",\n \"originatingDnis\": \"\",\n \"reservedAccountId\": \"\"\n },\n \"mediaCodes\": {\n \"dnisCategory\": \"\",\n \"mediaCode\": \"\",\n \"mediaFormat\": \"\",\n \"mediaIsci\": \"\",\n \"mediaLength\": \"\",\n \"mediaMarket\": \"\",\n \"mediaNetwork\": \"\",\n \"mediaUrl\": \"\",\n \"mediaVersion\": \"\",\n \"mediaWebSourcecode\": \"\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns all dnis pools for Customer", "id": "ca290848-2626-58ff-973a-917b322ede22", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/v1/admin/utilities/tnManager/searchDnis", "host": [ "{{ringcx_base_url}}" ], "path": [ "v1", "admin", "utilities", "tnManager", "searchDnis" ] }, "description": "Permissions: READ on Account, READ on TN_MANAGER, filter out restricted accounts", "body": { "mode": "raw", "raw": "{\n \"accountIds\": [\n \"\"\n ],\n \"dnisState\": \"\",\n \"phoneNumbersI18nEnabled\": false,\n \"searchText\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Updates for bulk csv data dnis pool, will update assignments too", "id": "cbae97c8-fde1-5a4a-a4c2-6b5474dab02c", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/v1/admin/utilities/tnManager/updateBulkDnisPool", "host": [ "{{ringcx_base_url}}" ], "path": [ "v1", "admin", "utilities", "tnManager", "updateBulkDnisPool" ] }, "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts", "body": { "mode": "raw", "raw": "[\n {\n \"active\": false,\n \"assignedDnis\": {\n \"cloudRouteProfile\": {},\n \"dnis\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\",\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"endPointId\": \"\",\n \"endPointType\": \"\",\n \"gate\": {},\n \"isActive\": false,\n \"originatingDnis\": \"\"\n },\n \"assignedSmsDnis\": {\n \"chatQueue\": {},\n \"dnis\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\",\n \"dnisPool\": {},\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"isActive\": false,\n \"originatingDnis\": \"\",\n \"phoneNumbersI18nEnabled\": false,\n \"startDate\": \"2026-08-12T22:30:00.000+0000\"\n },\n \"carrier\": \"\",\n \"customAppString\": \"\",\n \"dateCreated\": \"2026-08-12T22:30:00.000+0000\",\n \"dnis\": \"\",\n \"dnisCategory\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Creates a list of dnis pools from upload file", "id": "e2c56cca-b4af-5326-9067-a43db64e9ac6", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "multipart/form-data", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/v1/admin/utilities/tnManager/uploadDnisPool?fileType=COMMA", "host": [ "{{ringcx_base_url}}" ], "path": [ "v1", "admin", "utilities", "tnManager", "uploadDnisPool" ], "query": [ { "key": "fileType", "value": "COMMA", "disabled": false, "description": "fileType" } ] }, "description": "Has Role: SUPER_USER", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "disabled": false, "src": [] } ] } }, "response": [] }, { "name": "List telephone number manager accounts", "id": "385bb66a-93bb-5f96-98d1-417ba5c135ba", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/accounts", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "accounts" ] }, "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts" }, "response": [] }, { "name": "Check DNIS pool records", "id": "ff2b1a2b-eeff-5c2b-b1c2-55b9c91019f5", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/checkNewDnisList?phoneNumbersI18nEnabled=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "checkNewDnisList" ], "query": [ { "key": "phoneNumbersI18nEnabled", "value": "false", "disabled": true, "description": "phoneNumbersI18nEnabled" } ] }, "description": "Permissions: UPDATE on TN_MANAGER, filter out restricted accounts", "body": { "mode": "raw", "raw": "[\n \"\"\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create DNIS pool records", "id": "b1cb5035-b5f1-512a-8873-23d2e152679e", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/dnisPool", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "dnisPool" ] }, "description": "Has Role: SUPER_USER", "body": { "mode": "raw", "raw": "[\n {\n \"active\": false,\n \"assignedDnis\": {\n \"cloudRouteProfile\": {},\n \"dnis\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\",\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"endPointId\": \"\",\n \"endPointType\": \"\",\n \"gate\": {},\n \"isActive\": false,\n \"originatingDnis\": \"\"\n },\n \"assignedSmsDnis\": {\n \"chatQueue\": {},\n \"dnis\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\",\n \"dnisPool\": {},\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"isActive\": false,\n \"originatingDnis\": \"\",\n \"phoneNumbersI18nEnabled\": false,\n \"startDate\": \"2026-08-12T22:30:00.000+0000\"\n },\n \"carrier\": \"\",\n \"customAppString\": \"\",\n \"dateCreated\": \"2026-08-12T22:30:00.000+0000\",\n \"dnis\": \"\",\n \"dnisCategory\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update DNIS pool record", "id": "7373d24a-ba72-5859-acf0-f1af5a609631", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/dnisPool", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "dnisPool" ] }, "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts", "body": { "mode": "raw", "raw": "[\n {\n \"active\": false,\n \"assignedDnis\": {\n \"cloudRouteProfile\": {},\n \"dnis\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\",\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"endPointId\": \"\",\n \"endPointType\": \"\",\n \"gate\": {},\n \"isActive\": false,\n \"originatingDnis\": \"\"\n },\n \"assignedSmsDnis\": {\n \"chatQueue\": {},\n \"dnis\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\",\n \"dnisPool\": {},\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"isActive\": false,\n \"originatingDnis\": \"\",\n \"phoneNumbersI18nEnabled\": false,\n \"startDate\": \"2026-08-12T22:30:00.000+0000\"\n },\n \"carrier\": \"\",\n \"customAppString\": \"\",\n \"dateCreated\": \"2026-08-12T22:30:00.000+0000\",\n \"dnis\": \"\",\n \"dnisCategory\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Bulk delete DNIS pools", "id": "235ac37a-6d49-572c-8e16-d0fa51ef195e", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/dnisPool/bulkDelete?phoneNumbersI18nEnabled=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "dnisPool", "bulkDelete" ], "query": [ { "key": "phoneNumbersI18nEnabled", "value": "false", "disabled": true, "description": "phoneNumbersI18nEnabled" } ] }, "description": "Has Role: SUPER_USER", "body": { "mode": "raw", "raw": "[\n \"\"\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get DNIS pool record", "id": "adf17c7c-2bbc-5ca7-ae64-745cd2a0ac67", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/dnisPool/{{dnis}}?phoneNumbersI18nEnabled=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "dnisPool", "{{dnis}}" ], "query": [ { "key": "phoneNumbersI18nEnabled", "value": "false", "disabled": true, "description": "phoneNumbersI18nEnabled" } ] }, "description": "Permissions: READ on TN_MANAGER" }, "response": [] }, { "name": "Delete DNIS pool record", "id": "3aae9546-ea10-57c1-80fb-af8a1e36b65c", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/dnisPool/{{dnis}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "dnisPool", "{{dnis}}" ] }, "description": "Has Role: SUPER_USER" }, "response": [] }, { "name": "List telephone number media values", "id": "bb5e1810-dfbb-5ef7-805e-5e0044b3979a", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/mediaValues", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "mediaValues" ] }, "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts" }, "response": [] }, { "name": "Create DNIS pool report", "id": "ef9f5c06-68a4-5536-9e27-ad8dc6bd69b1", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/report", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "report" ] }, "description": "Permissions: READ on Account, READ on TN_MANAGER, filter out restricted accounts", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"accountIds\": [\n \"\"\n ],\n \"active\": false,\n \"assigned\": false,\n \"assignedSms\": false,\n \"criteriaType\": \"DIALER_RESULT_DOWNLOAD_CRITERIA\",\n \"customAppString\": \"\",\n \"databaseTimezone\": \"\",\n \"dnis\": [\n \"\"\n ],\n \"dnisFilter\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search DNIS pools", "id": "845531e8-1f06-5d35-b94f-3067f99f19ff", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/search?count=false&page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "search" ], "query": [ { "key": "count", "value": "false", "disabled": true, "description": "count" }, { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Account, READ on TN_MANAGER, filter out restricted accounts", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"accountIds\": [\n \"\"\n ],\n \"active\": false,\n \"assigned\": false,\n \"assignedSms\": false,\n \"criteriaType\": \"DIALER_RESULT_DOWNLOAD_CRITERIA\",\n \"customAppString\": \"\",\n \"databaseTimezone\": \"\",\n \"dnis\": [\n \"\"\n ],\n \"dnisFilter\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search customer DNIS pools [POST]", "id": "28687676-1323-5da7-8a6f-5322bba4d304", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/searchDnis", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "searchDnis" ] }, "description": "Permissions: READ on Account, READ on TN_MANAGER, filter out restricted accounts", "body": { "mode": "raw", "raw": "{\n \"accountIds\": [\n \"\"\n ],\n \"dnisState\": \"\",\n \"phoneNumbersI18nEnabled\": false,\n \"searchText\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Bulk update DNIS pools", "id": "cf3e9dbc-2de6-51a9-99ab-6be08fc13cad", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/updateBulkDnisPool", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "updateBulkDnisPool" ] }, "description": "Permissions: READ/WRITE on TN_MANAGER, filter out restricted accounts", "body": { "mode": "raw", "raw": "[\n {\n \"active\": false,\n \"assignedDnis\": {\n \"cloudRouteProfile\": {},\n \"dnis\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\",\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"endPointId\": \"\",\n \"endPointType\": \"\",\n \"gate\": {},\n \"isActive\": false,\n \"originatingDnis\": \"\"\n },\n \"assignedSmsDnis\": {\n \"chatQueue\": {},\n \"dnis\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\",\n \"dnisPool\": {},\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"isActive\": false,\n \"originatingDnis\": \"\",\n \"phoneNumbersI18nEnabled\": false,\n \"startDate\": \"2026-08-12T22:30:00.000+0000\"\n },\n \"carrier\": \"\",\n \"customAppString\": \"\",\n \"dateCreated\": \"2026-08-12T22:30:00.000+0000\",\n \"dnis\": \"\",\n \"dnisCategory\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Bulk update customer DNIS records", "id": "b3d6d662-f28a-5584-8829-7147b3e2e342", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/updateCustomerDnisBulk", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "updateCustomerDnisBulk" ] }, "description": "Bulk update customer DNIS records", "body": { "mode": "raw", "raw": "\"\"", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update DNIS pool and assignments", "id": "9d5cb574-2259-597f-9a46-7822acd07809", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/updatePoolAndAssignment", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "updatePoolAndAssignment" ] }, "description": "Update DNIS pool and assignments", "body": { "mode": "raw", "raw": "[\n {\n \"chatQueueId\": 0,\n \"dnisPool\": {\n \"active\": false,\n \"assignedDnis\": {},\n \"assignedSmsDnis\": {},\n \"carrier\": \"\",\n \"customAppString\": \"\",\n \"dateCreated\": \"2026-08-12T22:30:00.000+0000\",\n \"dnis\": \"\",\n \"dnisCategory\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\"\n },\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"product\": \"ACCOUNT\",\n \"productId\": 0,\n \"smsEndDate\": \"2026-08-12T22:30:00.000+0000\",\n \"smsStartDate\": \"2026-08-12T22:30:00.000+0000\",\n \"startDate\": \"2026-08-12T22:30:00.000+0000\",\n \"unassignProduct\": false,\n \"unassignSmsProduct\": false\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Upload DNIS pool records", "id": "1f51aa7f-ee24-5ee2-b70f-26e56bbc6cfd", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "multipart/form-data", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/uploadDnisPool?fileType=COMMA"eCharacter=&phoneNumbersI18nEnabled=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "uploadDnisPool" ], "query": [ { "key": "fileType", "value": "COMMA", "disabled": false, "description": "Delimiter format of the uploaded file." }, { "key": "quoteCharacter", "value": "", "disabled": true, "description": "Quote character used in the uploaded file when fields contain the delimiter." }, { "key": "phoneNumbersI18nEnabled", "value": "false", "disabled": true, "description": "phoneNumbersI18nEnabled" } ] }, "description": "Has Role: USER", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "disabled": false, "src": [] } ] } }, "response": [] }, { "name": "Search customer DNIS pools [POST]", "id": "5140190a-cea8-5de0-9bec-cc0ec38a85d2", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v2/admin/utilities/tnManager/searchDnis", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v2", "admin", "utilities", "tnManager", "searchDnis" ] }, "description": "Permissions: READ on Account, READ on TN_MANAGER, filter out restricted accounts", "body": { "mode": "raw", "raw": "{\n \"accountIds\": [\n \"\"\n ],\n \"dnisState\": \"\",\n \"phoneNumbersI18nEnabled\": false,\n \"searchText\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Manage DNIS pools, tracking numbers, and related phone-number assignment utilities." }, { "name": "Cloud Route Destination Groups", "item": [ { "name": "Returns a listing of cloud route groups for an account", "id": "c30def99-ff23-54af-8eab-d69911387a36", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups" ] }, "description": "Permissions: READ on Account, Post Filtered Results" }, "response": [] }, { "name": "Create a cloud route group for an account", "id": "9869cecd-72fe-5dc7-adf8-d290976e4e62", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups" ] }, "description": "Permissions: CREATE on Account", "body": { "mode": "raw", "raw": "{\n \"cloudGroupId\": 0,\n \"cloudRouteDestinations\": {},\n \"cloudRouteProfiles\": {},\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a listing of cloud route groups with related data for an account", "id": "c4828d63-1b86-5306-b26a-9478becb528d", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/withChildren?includePermissions=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "withChildren" ], "query": [ { "key": "includePermissions", "value": "false", "disabled": true, "description": "includePermissions" } ] }, "description": "Permissions: READ on Account, Post Filtered Results" }, "response": [] }, { "name": "Returns a cloud route group for an account", "id": "ab5c0495-8173-5309-9841-175cf3ebd8ed", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}" ] }, "description": "Permissions: READ on Cloud Route Group" }, "response": [] }, { "name": "Updates a cloud route group for an account", "id": "3349ed3b-bb1d-5916-82f8-b644950b7f51", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}" ] }, "description": "Permissions: UPDATE on Cloud Route Group", "body": { "mode": "raw", "raw": "{\n \"cloudGroupId\": 0,\n \"cloudRouteDestinations\": {},\n \"cloudRouteProfiles\": {},\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a cloud route group for an account", "id": "94875b2f-a556-59cb-81bd-c00cfc359260", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}" ] }, "description": "Permissions: DELETE on Cloud Route Group" }, "response": [] }, { "name": "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.", "id": "cef2cc90-6716-5800-baca-6bf5e18cf561", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v2-skinny/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v2-skinny", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups" ] }, "description": "Permissions: READ on Account, Post Filtered Results" }, "response": [] }, { "name": "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.", "id": "eb6999bd-1459-5898-8622-d93d7bcefcbc", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v2-skinny/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/withChildren", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v2-skinny", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "withChildren" ] }, "description": "Permissions: READ on Account, Post Filtered Results" }, "response": [] } ], "description": "Manage groups that organize cloud route destinations for an account." }, { "name": "Cloud Route Destinations", "item": [ { "name": "Returns a listing of cloud destinations for a cloud route group", "id": "1badec09-5214-5d2d-9f18-202a9a2d375e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations" ] }, "description": "Permissions: READ on Cloud Destination, Post Filtered Results" }, "response": [] }, { "name": "Create a cloud destination for a cloud route group", "id": "0858c9b0-a67f-5636-bee7-2b2d817b1e9e", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations" ] }, "description": "Permissions: CREATE on Cloud Destination", "body": { "mode": "raw", "raw": "{\n \"active\": false,\n \"address\": \"
\",\n \"authKey\": \"\",\n \"city\": \"\",\n \"cloudDestinationId\": 0,\n \"cloudRouteGroup\": {\n \"cloudGroupId\": 0,\n \"cloudRouteDestinations\": {},\n \"cloudRouteProfiles\": {},\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"countryCode\": {\n \"countryCode\": \"\",\n \"countryId\": \"\",\n \"countryName\": \"\",\n \"maxAniLength\": 0,\n \"maxUtcOffset\": 0,\n \"minAniLength\": 0,\n \"minUtcOffset\": 0\n },\n \"deleted\": false,\n \"destinationDesc\": \"\",\n \"destinationName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a listing of cloud destinations with related data for a cloud route group", "id": "393c0500-890f-58bc-9927-36ed460d2207", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/withChildren?includePermissions=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "withChildren" ], "query": [ { "key": "includePermissions", "value": "false", "disabled": true, "description": "includePermissions" } ] }, "description": "Permissions: READ on Cloud Destinations, Post Filtered Results" }, "response": [] }, { "name": "Returns a cloud destination for a cloud route group", "id": "1a27c00c-bfd8-5542-8c71-d512ed1d4b87", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}" ] }, "description": "Permissions: READ on Cloud Destination" }, "response": [] }, { "name": "Updates a cloud destination for a cloud route group", "id": "39c304ce-9b8b-511b-a5dc-80a38b7f8ad2", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}" ] }, "description": "Permissions: UPDATE on Cloud Destination", "body": { "mode": "raw", "raw": "{\n \"active\": false,\n \"address\": \"
\",\n \"authKey\": \"\",\n \"city\": \"\",\n \"cloudDestinationId\": 0,\n \"cloudRouteGroup\": {\n \"cloudGroupId\": 0,\n \"cloudRouteDestinations\": {},\n \"cloudRouteProfiles\": {},\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"countryCode\": {\n \"countryCode\": \"\",\n \"countryId\": \"\",\n \"countryName\": \"\",\n \"maxAniLength\": 0,\n \"maxUtcOffset\": 0,\n \"minAniLength\": 0,\n \"minUtcOffset\": 0\n },\n \"deleted\": false,\n \"destinationDesc\": \"\",\n \"destinationName\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Creates a clone of the cloud route destination for a cloud group", "id": "c4d36483-5957-5d54-8593-da10210856ab", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}/clone?newDestinationName=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}", "clone" ], "query": [ { "key": "newDestinationName", "value": "", "disabled": false, "description": "newDestinationName" } ] }, "description": "Permissions: READ on existing Cloud Route Destination and CREATE on Cloud Group (Permission Override)" }, "response": [] }, { "name": "Set active state for a cloud route destination", "id": "c443e721-9859-5c66-ad9f-6f03c8c8f293", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}/setIsActive", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}", "setIsActive" ] }, "description": "Permissions: UPDATE on Cloud Destination", "body": { "mode": "raw", "raw": "{\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Manage cloud route destinations used as routing targets." }, { "name": "Cloud Route Profile Groups", "item": [ { "name": "Returns a listing of Cloud Route Groups with children for an Account", "id": "9a523712-2ab1-58f3-a519-b4bf823f775d", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/withChildren?includePermissions=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "withChildren" ], "query": [ { "key": "includePermissions", "value": "false", "disabled": true, "description": "includePermissions" } ] }, "description": "Permissions: READ on Account, Post Filtered Results" }, "response": [] }, { "name": "Returns a single Cloud Route Group", "id": "708c7b97-ae2a-5a4c-95e4-b6085a04dfee", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}" ] }, "description": "Permissions: READ on Cloud Route Group" }, "response": [] }, { "name": "Updates a single Cloud Route Group", "id": "d090cefc-d36f-588c-902d-9924f89374cb", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}" ] }, "description": "Permissions: UPDATE on Cloud Route Group", "body": { "mode": "raw", "raw": "{\n \"cloudGroupId\": 0,\n \"cloudRouteDestinations\": {},\n \"cloudRouteProfiles\": {},\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a specific Cloud Route Group", "id": "3792ddb3-bb41-5561-9c11-41c9708441e8", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}" ] }, "description": "Permissions: DELETE on Cloud Route Group" }, "response": [] }, { "name": "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.", "id": "7a8562da-8bae-51b7-a043-2a844bf137e2", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v2-skinny/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v2-skinny", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups" ] }, "description": "Permissions: READ on Account, Post Filtered Results" }, "response": [] }, { "name": "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.", "id": "828b907f-7271-555e-940e-dea020252e4e", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v2-skinny/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/withChildren", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v2-skinny", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "withChildren" ] }, "description": "Permissions: READ on Account, Post Filtered Results" }, "response": [] } ], "description": "Manage groups that organize cloud route profiles for an account." }, { "name": "Cloud Route Profiles", "item": [ { "name": "Returns a listing of cloud route profiles for a cloud group", "id": "e376115a-8d5a-5016-8e45-aa82fd0863f7", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles" ] }, "description": "Permissions: READ on Cloud Group, Post Filtered Results" }, "response": [] }, { "name": "Create a cloud route profile for a cloud group", "id": "f7e9cee3-27ea-54fe-8714-63ebad4e735f", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles" ] }, "description": "Permissions: CREATE on Cloud Group", "body": { "mode": "raw", "raw": "{\n \"billingCode\": \"\",\n \"billingKey\": \"\",\n \"callConnSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"callEndSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"callStartSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"cloudProfileId\": 0,\n \"cloudRouteGroup\": {\n \"cloudGroupId\": 0,\n \"cloudRouteDestinations\": {},\n \"cloudRouteProfiles\": {},\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"dequeueDelay\": 0,\n \"endcallMsg\": \"\",\n \"geoMaxDistance\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a cloud route profile for a cloud group", "id": "bf07679c-4396-5983-b5cb-75e517f92ead", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}" ] }, "description": "Permissions: READ on Cloud Group" }, "response": [] }, { "name": "Updates a cloud route profile for a cloud group", "id": "ad077c18-e2f0-5e41-8c36-06e2e8cfec7b", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}" ] }, "description": "Permissions: UPDATE on Cloud Profile", "body": { "mode": "raw", "raw": "{\n \"billingCode\": \"\",\n \"billingKey\": \"\",\n \"callConnSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"callEndSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"callStartSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"cloudProfileId\": 0,\n \"cloudRouteGroup\": {\n \"cloudGroupId\": 0,\n \"cloudRouteDestinations\": {},\n \"cloudRouteProfiles\": {},\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"dequeueDelay\": 0,\n \"endcallMsg\": \"\",\n \"geoMaxDistance\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Creates a clone of the cloud route profile for a cloud group", "id": "a46c9333-d8a0-518a-b32d-40a4d8b925fb", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/clone?newCloudRouteProfileName=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "clone" ], "query": [ { "key": "newCloudRouteProfileName", "value": "", "disabled": false, "description": "newCloudRouteProfileName" } ] }, "description": "Permissions: READ on cloned Cloud Route Profile and CREATE on Cloud Group (Permission Override)" }, "response": [] }, { "name": "Set active state for a cloud route profile", "id": "86dc6a64-15f0-5955-8b69-fcf6efc0aa39", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/setIsActive", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "setIsActive" ] }, "description": "Permissions: UPDATE on Cloud Profile", "body": { "mode": "raw", "raw": "{\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Manage cloud route profiles that define routing behavior." }, { "name": "Cloud Route Assignments", "item": [ { "name": "Returns a listing of assigned profiles for a cloud route destination", "id": "83629473-94d2-545c-b973-7b9f577551ce", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}/assignedProfiles", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}", "assignedProfiles" ] }, "description": "Permissions: READ on Cloud Destination" }, "response": [] }, { "name": "Creates an assigned profile for a cloud route destination", "id": "f96f09b5-5ec9-554c-94a9-d043af85f66a", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}/assignedProfiles", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}", "assignedProfiles" ] }, "description": "Permissions: UPDATE on Cloud Destination (Permissions Override)", "body": { "mode": "raw", "raw": "{\n \"allocationPercent\": 0,\n \"allocationPercentHours\": \"\",\n \"assignedDestinationId\": 0,\n \"cloudDestination\": {\n \"active\": false,\n \"address\": \"
\",\n \"authKey\": \"\",\n \"city\": \"\",\n \"cloudDestinationId\": 0,\n \"cloudRouteGroup\": {},\n \"countryCode\": {},\n \"deleted\": false,\n \"destinationDesc\": \"\",\n \"destinationName\": \"\"\n },\n \"cloudProfile\": {\n \"billingCode\": \"\",\n \"billingKey\": \"\",\n \"callConnSoapService\": {},\n \"callEndSoapService\": {},\n \"callStartSoapService\": {},\n \"cloudProfileId\": 0,\n \"cloudRouteGroup\": {},\n \"dequeueDelay\": 0,\n \"endcallMsg\": \"\",\n \"geoMaxDistance\": 0\n },\n \"countryCode\": {\n \"countryCode\": \"\",\n \"countryId\": \"\",\n \"countryName\": \"\",\n \"maxAniLength\": 0,\n \"maxUtcOffset\": 0,\n \"minAniLength\": 0,\n \"minUtcOffset\": 0\n },\n \"destinationType\": \"STANDARD\",\n \"dtmfEventsEnabled\": false,\n \"enablePrerouteHttp\": false,\n \"forceAcdQueue\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns an assigned profile for a cloud route destination", "id": "40a1a08d-6b64-556f-81dd-ccc299404a73", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}/assignedProfiles/{{cloudAssignedDestinationId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}", "assignedProfiles", "{{cloudAssignedDestinationId}}" ] }, "description": "Permissions: READ on Cloud Destination" }, "response": [] }, { "name": "Updates an assigned profile for a cloud route destination", "id": "dc190d15-41c0-5772-ad50-52d44d08fbb8", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}/assignedProfiles/{{cloudAssignedDestinationId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}", "assignedProfiles", "{{cloudAssignedDestinationId}}" ] }, "description": "Permissions: UPDATE on Cloud Destination", "body": { "mode": "raw", "raw": "{\n \"allocationPercent\": 0,\n \"allocationPercentHours\": \"\",\n \"assignedDestinationId\": 0,\n \"cloudDestination\": {\n \"active\": false,\n \"address\": \"
\",\n \"authKey\": \"\",\n \"city\": \"\",\n \"cloudDestinationId\": 0,\n \"cloudRouteGroup\": {},\n \"countryCode\": {},\n \"deleted\": false,\n \"destinationDesc\": \"\",\n \"destinationName\": \"\"\n },\n \"cloudProfile\": {\n \"billingCode\": \"\",\n \"billingKey\": \"\",\n \"callConnSoapService\": {},\n \"callEndSoapService\": {},\n \"callStartSoapService\": {},\n \"cloudProfileId\": 0,\n \"cloudRouteGroup\": {},\n \"dequeueDelay\": 0,\n \"endcallMsg\": \"\",\n \"geoMaxDistance\": 0\n },\n \"countryCode\": {\n \"countryCode\": \"\",\n \"countryId\": \"\",\n \"countryName\": \"\",\n \"maxAniLength\": 0,\n \"maxUtcOffset\": 0,\n \"minAniLength\": 0,\n \"minUtcOffset\": 0\n },\n \"destinationType\": \"STANDARD\",\n \"dtmfEventsEnabled\": false,\n \"enablePrerouteHttp\": false,\n \"forceAcdQueue\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes an assigned profile for a cloud route destination", "id": "cc46bc08-7d56-525a-8541-e1151dd10f4b", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}/assignedProfiles/{{cloudAssignedDestinationId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}", "assignedProfiles", "{{cloudAssignedDestinationId}}" ] }, "description": "Permissions: UPDATE on Cloud Destination (Permissions Override)" }, "response": [] }, { "name": "Returns a listing of assigned destinations for a cloud route profile", "id": "d6b2c46d-3564-57cf-b2ac-8f1ae38aba82", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/assignedDestinations", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "assignedDestinations" ] }, "description": "Permissions: READ on Cloud Profile" }, "response": [] }, { "name": "Creates an assigned destination for a cloud route profile", "id": "3b030cc5-34da-552b-801d-8aa1396be0ed", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/assignedDestinations", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "assignedDestinations" ] }, "description": "Permissions: CREATE on Cloud Profile", "body": { "mode": "raw", "raw": "{\n \"allocationPercent\": 0,\n \"allocationPercentHours\": \"\",\n \"assignedDestinationId\": 0,\n \"cloudDestination\": {\n \"active\": false,\n \"address\": \"
\",\n \"authKey\": \"\",\n \"city\": \"\",\n \"cloudDestinationId\": 0,\n \"cloudRouteGroup\": {},\n \"countryCode\": {},\n \"deleted\": false,\n \"destinationDesc\": \"\",\n \"destinationName\": \"\"\n },\n \"cloudProfile\": {\n \"billingCode\": \"\",\n \"billingKey\": \"\",\n \"callConnSoapService\": {},\n \"callEndSoapService\": {},\n \"callStartSoapService\": {},\n \"cloudProfileId\": 0,\n \"cloudRouteGroup\": {},\n \"dequeueDelay\": 0,\n \"endcallMsg\": \"\",\n \"geoMaxDistance\": 0\n },\n \"countryCode\": {\n \"countryCode\": \"\",\n \"countryId\": \"\",\n \"countryName\": \"\",\n \"maxAniLength\": 0,\n \"maxUtcOffset\": 0,\n \"minAniLength\": 0,\n \"minUtcOffset\": 0\n },\n \"destinationType\": \"STANDARD\",\n \"dtmfEventsEnabled\": false,\n \"enablePrerouteHttp\": false,\n \"forceAcdQueue\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Updates a list of assigned destinations for a cloud route profile", "id": "5978649c-dd08-5ccf-ae1d-33f3ae2a1e4a", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/assignedDestinations/batch", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "assignedDestinations", "batch" ] }, "description": "Permissions: UPDATE on Cloud Profile", "body": { "mode": "raw", "raw": "[\n {\n \"allocationPercent\": 0,\n \"allocationPercentHours\": \"\",\n \"assignedDestinationId\": 0,\n \"cloudDestination\": {\n \"active\": false,\n \"address\": \"
\",\n \"authKey\": \"\",\n \"city\": \"\",\n \"cloudDestinationId\": 0,\n \"cloudRouteGroup\": {},\n \"countryCode\": {},\n \"deleted\": false,\n \"destinationDesc\": \"\",\n \"destinationName\": \"\"\n },\n \"cloudProfile\": {\n \"billingCode\": \"\",\n \"billingKey\": \"\",\n \"callConnSoapService\": {},\n \"callEndSoapService\": {},\n \"callStartSoapService\": {},\n \"cloudProfileId\": 0,\n \"cloudRouteGroup\": {},\n \"dequeueDelay\": 0,\n \"endcallMsg\": \"\",\n \"geoMaxDistance\": 0\n },\n \"countryCode\": {\n \"countryCode\": \"\",\n \"countryId\": \"\",\n \"countryName\": \"\",\n \"maxAniLength\": 0,\n \"maxUtcOffset\": 0,\n \"minAniLength\": 0,\n \"minUtcOffset\": 0\n },\n \"destinationType\": \"STANDARD\",\n \"dtmfEventsEnabled\": false,\n \"enablePrerouteHttp\": false,\n \"forceAcdQueue\": false\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Exports the percent allocations for a list of assigned destinations for a cloud route profile", "id": "044ef831-4181-5e54-a0a2-bd8a7266284c", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/assignedDestinations/percentAllocationHours/export", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "assignedDestinations", "percentAllocationHours", "export" ] }, "description": "Permissions: READ on Cloud Profile (Permission Override)" }, "response": [] }, { "name": "Updates the percent allocations for a list of assigned destinations for a cloud route profile", "id": "a0a23027-6dbf-51d2-9b16-6129d505443d", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "multipart/form-data", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/assignedDestinations/percentAllocationHours/import?extension=PIPE", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "assignedDestinations", "percentAllocationHours", "import" ], "query": [ { "key": "extension", "value": "PIPE", "disabled": false, "description": "Delimiter used in the uploaded allocation-hours file." } ] }, "description": "Permissions: UPDATE on Cloud Profile (Permission Override)", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "disabled": false, "src": [] } ] } }, "response": [] }, { "name": "Returns an assigned destination for a cloud route profile", "id": "26ce8a61-b895-5c36-90cd-4e99dd02f096", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/assignedDestinations/{{cloudAssignedDestinationId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "assignedDestinations", "{{cloudAssignedDestinationId}}" ] }, "description": "Permissions: READ on Cloud Profile" }, "response": [] }, { "name": "Updates an assigned destination for a cloud route profile", "id": "ebffce7b-072d-515f-9ff4-cfa000ba5f45", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/assignedDestinations/{{cloudAssignedDestinationId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "assignedDestinations", "{{cloudAssignedDestinationId}}" ] }, "description": "Permissions: UPDATE on Cloud Profile", "body": { "mode": "raw", "raw": "{\n \"allocationPercent\": 0,\n \"allocationPercentHours\": \"\",\n \"assignedDestinationId\": 0,\n \"cloudDestination\": {\n \"active\": false,\n \"address\": \"
\",\n \"authKey\": \"\",\n \"city\": \"\",\n \"cloudDestinationId\": 0,\n \"cloudRouteGroup\": {},\n \"countryCode\": {},\n \"deleted\": false,\n \"destinationDesc\": \"\",\n \"destinationName\": \"\"\n },\n \"cloudProfile\": {\n \"billingCode\": \"\",\n \"billingKey\": \"\",\n \"callConnSoapService\": {},\n \"callEndSoapService\": {},\n \"callStartSoapService\": {},\n \"cloudProfileId\": 0,\n \"cloudRouteGroup\": {},\n \"dequeueDelay\": 0,\n \"endcallMsg\": \"\",\n \"geoMaxDistance\": 0\n },\n \"countryCode\": {\n \"countryCode\": \"\",\n \"countryId\": \"\",\n \"countryName\": \"\",\n \"maxAniLength\": 0,\n \"maxUtcOffset\": 0,\n \"minAniLength\": 0,\n \"minUtcOffset\": 0\n },\n \"destinationType\": \"STANDARD\",\n \"dtmfEventsEnabled\": false,\n \"enablePrerouteHttp\": false,\n \"forceAcdQueue\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes an assigned destination for a cloud route profile", "id": "ee45afb3-7ebe-5fe9-96c8-3bacd8cc6f38", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/assignedDestinations/{{cloudAssignedDestinationId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "assignedDestinations", "{{cloudAssignedDestinationId}}" ] }, "description": "Permissions: DELETE on Cloud Profile" }, "response": [] } ], "description": "Manage assignments between cloud route profiles and destinations." }, { "name": "Cloud Route DNIS Overrides", "item": [ { "name": "Returns a listing of dnis overrides for a cloud route destination", "id": "3fed5898-fc7c-588f-a192-caa1fc7e98ec", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}/dnisOverrides", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}", "dnisOverrides" ] }, "description": "Permissions: READ on Cloud Destination" }, "response": [] }, { "name": "Create a dnis override for a cloud route destination", "id": "337da023-0e21-52f9-ba24-4461c7c40b37", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}/dnisOverrides?cloudDestinationType=STANDARD", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}", "dnisOverrides" ], "query": [ { "key": "cloudDestinationType", "value": "STANDARD", "disabled": false, "description": "cloudDestinationType" } ] }, "description": "Permissions: UPDATE on Cloud Destination (Permission Override)", "body": { "mode": "raw", "raw": "{\n \"cloudDestination\": {\n \"active\": false,\n \"address\": \"
\",\n \"authKey\": \"\",\n \"city\": \"\",\n \"cloudDestinationId\": 0,\n \"cloudRouteGroup\": {},\n \"countryCode\": {},\n \"deleted\": false,\n \"destinationDesc\": \"\",\n \"destinationName\": \"\"\n },\n \"countryId\": \"\",\n \"destOverrideId\": 0,\n \"dnis\": \"\",\n \"routeDestination\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create a list dnis overrides for a cloud route destination", "id": "3e5bb1a7-4dfe-5755-8bb4-628972145ac4", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "multipart/form-data", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}/dnisOverrides/batch?replaceAll=false&phoneNumbersI18nEnabled=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}", "dnisOverrides", "batch" ], "query": [ { "key": "replaceAll", "value": "false", "disabled": false, "description": "replaceAll" }, { "key": "phoneNumbersI18nEnabled", "value": "false", "disabled": true, "description": "phoneNumbersI18nEnabled" } ] }, "description": "Permissions: UPDATE on Cloud Destination (Permission Override)", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "disabled": false, "src": [] } ] } }, "response": [] }, { "name": "Returns a dnis override for a cloud route destination", "id": "35066b52-0826-56da-a5f4-c9b74f7a3a6f", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}/dnisOverrides/{{cloudRouteDestinationOverrideId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}", "dnisOverrides", "{{cloudRouteDestinationOverrideId}}" ] }, "description": "Permissions: READ on Cloud Destination" }, "response": [] }, { "name": "Updates a dnis override for a cloud route destination", "id": "7365f4b1-c54b-54fc-ab25-f6b7e8897773", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}/dnisOverrides/{{cloudRouteDestinationOverrideId}}?cloudDestinationType=STANDARD", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}", "dnisOverrides", "{{cloudRouteDestinationOverrideId}}" ], "query": [ { "key": "cloudDestinationType", "value": "STANDARD", "disabled": false, "description": "cloudDestinationType" } ] }, "description": "Permissions: UPDATE on Cloud Destination", "body": { "mode": "raw", "raw": "{\n \"cloudDestination\": {\n \"active\": false,\n \"address\": \"
\",\n \"authKey\": \"\",\n \"city\": \"\",\n \"cloudDestinationId\": 0,\n \"cloudRouteGroup\": {},\n \"countryCode\": {},\n \"deleted\": false,\n \"destinationDesc\": \"\",\n \"destinationName\": \"\"\n },\n \"countryId\": \"\",\n \"destOverrideId\": 0,\n \"dnis\": \"\",\n \"routeDestination\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a dnis override for a cloud route destination", "id": "1f8ff128-5fa5-5932-b662-f8dfa8aa356e", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteDestinationGroups/{{cloudRouteGroupId}}/cloudRouteDestinations/{{cloudRouteDestinationId}}/dnisOverrides/{{cloudRouteDestinationOverrideId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteDestinationGroups", "{{cloudRouteGroupId}}", "cloudRouteDestinations", "{{cloudRouteDestinationId}}", "dnisOverrides", "{{cloudRouteDestinationOverrideId}}" ] }, "description": "Permissions: UPDATE on Cloud Destination (Permission Override)" }, "response": [] }, { "name": "Returns a listing of dnis overrides for a cloud route profile assigned destination", "id": "ceed1e52-f026-5d29-bc6d-fb73980d5293", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/assignedDestinations/{{cloudAssignedDestinationId}}/dnisOverrides", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "assignedDestinations", "{{cloudAssignedDestinationId}}", "dnisOverrides" ] }, "description": "Permissions: READ on Cloud Profile" }, "response": [] }, { "name": "Creates a dnis override for a cloud route profile assigned destination", "id": "c1eb09e9-e619-5252-a57c-78e6ea4330ef", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/assignedDestinations/{{cloudAssignedDestinationId}}/dnisOverrides?cloudDestinationType=STANDARD", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "assignedDestinations", "{{cloudAssignedDestinationId}}", "dnisOverrides" ], "query": [ { "key": "cloudDestinationType", "value": "STANDARD", "disabled": false, "description": "cloudDestinationType" } ] }, "description": "Permissions: UPDATE on Cloud Profile (Permission Override)", "body": { "mode": "raw", "raw": "{\n \"assignedDestination\": {\n \"allocationPercent\": 0,\n \"allocationPercentHours\": \"\",\n \"assignedDestinationId\": 0,\n \"cloudDestination\": {},\n \"cloudProfile\": {},\n \"countryCode\": {},\n \"destinationType\": \"STANDARD\",\n \"dtmfEventsEnabled\": false,\n \"enablePrerouteHttp\": false,\n \"forceAcdQueue\": false\n },\n \"assignedOverrideId\": 0,\n \"countryId\": \"\",\n \"dnis\": \"\",\n \"routeDestination\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create a list of dnis overrides for a cloud route profile assigned destination", "id": "69859a6a-b1ac-5758-be86-dec62799577a", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "multipart/form-data", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/assignedDestinations/{{cloudAssignedDestinationId}}/dnisOverrides/batch?replaceAll=false&phoneNumbersI18nEnabled=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "assignedDestinations", "{{cloudAssignedDestinationId}}", "dnisOverrides", "batch" ], "query": [ { "key": "replaceAll", "value": "false", "disabled": false, "description": "replaceAll" }, { "key": "phoneNumbersI18nEnabled", "value": "false", "disabled": true, "description": "phoneNumbersI18nEnabled" } ] }, "description": "Permissions: UPDATE on Cloud Profile (Permission Override) ", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "disabled": false, "src": [] } ] } }, "response": [] }, { "name": "Returns a dnis override for a cloud route profile assigned destination", "id": "a4887094-77c3-50a3-91e0-9a303e672fdc", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/assignedDestinations/{{cloudAssignedDestinationId}}/dnisOverrides/{{cloudAssignedOverrideId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "assignedDestinations", "{{cloudAssignedDestinationId}}", "dnisOverrides", "{{cloudAssignedOverrideId}}" ] }, "description": "Permissions: READ on Cloud Profile" }, "response": [] }, { "name": "Updates a dnis override for a cloud route profile assigned destination", "id": "bbb68e78-2ea2-59ba-84c3-73738ad58684", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/assignedDestinations/{{cloudAssignedDestinationId}}/dnisOverrides/{{cloudAssignedOverrideId}}?cloudDestinationType=STANDARD", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "assignedDestinations", "{{cloudAssignedDestinationId}}", "dnisOverrides", "{{cloudAssignedOverrideId}}" ], "query": [ { "key": "cloudDestinationType", "value": "STANDARD", "disabled": false, "description": "cloudDestinationType" } ] }, "description": "Permissions: UPDATE on Cloud Profile", "body": { "mode": "raw", "raw": "{\n \"assignedDestination\": {\n \"allocationPercent\": 0,\n \"allocationPercentHours\": \"\",\n \"assignedDestinationId\": 0,\n \"cloudDestination\": {},\n \"cloudProfile\": {},\n \"countryCode\": {},\n \"destinationType\": \"STANDARD\",\n \"dtmfEventsEnabled\": false,\n \"enablePrerouteHttp\": false,\n \"forceAcdQueue\": false\n },\n \"assignedOverrideId\": 0,\n \"countryId\": \"\",\n \"dnis\": \"\",\n \"routeDestination\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a dnis override for a cloud route profile assigned destination", "id": "0cde1a06-5fd8-5dce-87f8-b3d960fad5d7", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/assignedDestinations/{{cloudAssignedDestinationId}}/dnisOverrides/{{cloudAssignedOverrideId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "assignedDestinations", "{{cloudAssignedDestinationId}}", "dnisOverrides", "{{cloudAssignedOverrideId}}" ] }, "description": "Permissions: UPDATE on Cloud Profile (Permission Override)" }, "response": [] } ], "description": "Manage DNIS-specific routing overrides for cloud route destinations and assignments." }, { "name": "Cloud Route DTMF Events", "item": [ { "name": "Returns a listing of dtmf events for a cloud route profile", "id": "c2a4aef2-ac56-5eac-8085-efd0dc9eb900", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/dtmfEvents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "dtmfEvents" ] }, "description": "Permissions: READ Cloud Profile" }, "response": [] }, { "name": "Creates a dtmf event for a cloud profile", "id": "8f8c55f1-5a67-5fbd-95f3-ad33dd73d158", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/dtmfEvents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "dtmfEvents" ] }, "description": "Permissions: UPDATE on Cloud Profile (Permission Override)", "body": { "mode": "raw", "raw": "{\n \"cloudRouteDtmfId\": 0,\n \"dtmfCode\": 0,\n \"dtmfEventData\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a dtmf event for a cloud profile", "id": "3c2f4f6f-f483-5ddb-839b-9a1bff52df31", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/dtmfEvents/{{dtmfEventId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "dtmfEvents", "{{dtmfEventId}}" ] }, "description": "Permissions: READ on Cloud Profile" }, "response": [] }, { "name": "Updates a dtmf event for a cloud route profile", "id": "bfc5b13f-ff11-5b53-b25a-c4e29a566fe2", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/dtmfEvents/{{dtmfEventId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "dtmfEvents", "{{dtmfEventId}}" ] }, "description": "Permissions: UPDATE on Cloud Profile", "body": { "mode": "raw", "raw": "{\n \"cloudRouteDtmfId\": 0,\n \"dtmfCode\": 0,\n \"dtmfEventData\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a dtmf event for a cloud route profile", "id": "ff7c7452-9f3a-5311-af54-94a8bc5af7e7", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/dtmfEvents/{{dtmfEventId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "dtmfEvents", "{{dtmfEventId}}" ] }, "description": "Permissions: UPDATE on Cloud Profile (Permission Override) " }, "response": [] } ], "description": "Manage DTMF event configuration for cloud route profiles." }, { "name": "Cloud Route Sticky Destinations", "item": [ { "name": "Returns a listing of sticky destinations by ani for a cloud route profile", "id": "4fd36d45-dac9-5127-8378-0ad63f07150f", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/stickyDestinations/searchByAnis?aniParams=false&anis=[\"\"]&fullAni=false&count=false&page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "stickyDestinations", "searchByAnis" ], "query": [ { "key": "aniParams", "value": "false", "disabled": false, "description": "aniParams" }, { "key": "anis", "value": "[\"\"]", "disabled": true, "description": "anis" }, { "key": "fullAni", "value": "false", "disabled": true, "description": "fullAni" }, { "key": "count", "value": "false", "disabled": true, "description": "count" }, { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Cloud Profile" }, "response": [] }, { "name": "Deletes a sticky destination by ani for a cloud route profile", "id": "7353db4c-c6f4-5e25-97c1-03ef4f2aed37", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/cloudRouteProfileGroups/{{cloudRouteGroupId}}/cloudRouteProfiles/{{cloudRouteProfileId}}/stickyDestinations/{{ani}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "cloudRouteProfileGroups", "{{cloudRouteGroupId}}", "cloudRouteProfiles", "{{cloudRouteProfileId}}", "stickyDestinations", "{{ani}}" ] }, "description": "Permissions: UPDATE on Cloud Profile (Permission Override)" }, "response": [] } ], "description": "Manage sticky destination lookups and routing state for cloud route profiles." }, { "name": "DNIS Assignments", "item": [ { "name": "Update DNIS assignment", "id": "dd86b432-67bb-5f93-8fbc-46a19852747e", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/assignedDnis", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "assignedDnis" ] }, "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts", "body": { "mode": "raw", "raw": "[\n {\n \"cloudRouteProfile\": {\n \"accountId\": \"\",\n \"cloudGroupId\": 0,\n \"cloudProfileId\": 0,\n \"groupId\": 0,\n \"isActive\": false,\n \"isDeleted\": false,\n \"profileName\": \"\"\n },\n \"dnis\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\",\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"endPointId\": \"\",\n \"endPointType\": \"\",\n \"gate\": {\n \"accountId\": \"\",\n \"gateGroup\": {},\n \"gateGroupId\": 0,\n \"gateId\": 0,\n \"gateName\": \"\",\n \"groupId\": 0,\n \"isActive\": false\n },\n \"isActive\": false,\n \"originatingDnis\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete DNIS assignment [DELETE]", "id": "63c24975-a6fc-5708-9980-81d197e0f9d6", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/assignedDnis", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "assignedDnis" ] }, "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts", "body": { "mode": "raw", "raw": "{\n \"dnis\": \"\",\n \"dnisE164\": \"\",\n \"phoneNumbersI18nEnabled\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Assign DNIS to cloud route profile", "id": "62aa95b9-5f98-53dd-897b-b8a026ab9a9f", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/assignedDnis/cloudRouteProfiles/{{cloudRouteProfileId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "assignedDnis", "cloudRouteProfiles", "{{cloudRouteProfileId}}" ] }, "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts", "body": { "mode": "raw", "raw": "[\n {\n \"cloudRouteProfile\": {\n \"accountId\": \"\",\n \"cloudGroupId\": 0,\n \"cloudProfileId\": 0,\n \"groupId\": 0,\n \"isActive\": false,\n \"isDeleted\": false,\n \"profileName\": \"\"\n },\n \"dnis\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\",\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"endPointId\": \"\",\n \"endPointType\": \"\",\n \"gate\": {\n \"accountId\": \"\",\n \"gateGroup\": {},\n \"gateGroupId\": 0,\n \"gateId\": 0,\n \"gateName\": \"\",\n \"groupId\": 0,\n \"isActive\": false\n },\n \"isActive\": false,\n \"originatingDnis\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Assign DNIS to queue", "id": "fe8dface-df44-5b89-a0d4-2f0ff2f18f8c", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/assignedDnis/gates/{{gateId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "assignedDnis", "gates", "{{gateId}}" ] }, "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts", "body": { "mode": "raw", "raw": "[\n {\n \"cloudRouteProfile\": {\n \"accountId\": \"\",\n \"cloudGroupId\": 0,\n \"cloudProfileId\": 0,\n \"groupId\": 0,\n \"isActive\": false,\n \"isDeleted\": false,\n \"profileName\": \"\"\n },\n \"dnis\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\",\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"endPointId\": \"\",\n \"endPointType\": \"\",\n \"gate\": {\n \"accountId\": \"\",\n \"gateGroup\": {},\n \"gateGroupId\": 0,\n \"gateId\": 0,\n \"gateName\": \"\",\n \"groupId\": 0,\n \"isActive\": false\n },\n \"isActive\": false,\n \"originatingDnis\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Assign DNIS to visual IVR", "id": "3674e7f8-80fa-53bb-989f-2a827bd89c71", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/assignedDnis/visualIvrs/{{visualIvrId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "assignedDnis", "visualIvrs", "{{visualIvrId}}" ] }, "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts", "body": { "mode": "raw", "raw": "[\n {\n \"cloudRouteProfile\": {\n \"accountId\": \"\",\n \"cloudGroupId\": 0,\n \"cloudProfileId\": 0,\n \"groupId\": 0,\n \"isActive\": false,\n \"isDeleted\": false,\n \"profileName\": \"\"\n },\n \"dnis\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\",\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"endPointId\": \"\",\n \"endPointType\": \"\",\n \"gate\": {\n \"accountId\": \"\",\n \"gateGroup\": {},\n \"gateGroupId\": 0,\n \"gateId\": 0,\n \"gateName\": \"\",\n \"groupId\": 0,\n \"isActive\": false\n },\n \"isActive\": false,\n \"originatingDnis\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get DNIS assignment", "id": "e0cd05bd-1c75-5797-85dd-de2e90caf3fc", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/assignedDnis/{{dnis}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "assignedDnis", "{{dnis}}" ] }, "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts" }, "response": [] }, { "name": "Delete DNIS assignment [DELETE]", "id": "b10536de-64b2-5a1a-80de-9d9e2afd8a53", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/utilities/tnManager/assignedDnis/{{dnis}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "utilities", "tnManager", "assignedDnis", "{{dnis}}" ] }, "description": "Permissions: READ on TN_MANAGER, filter out restricted accounts" }, "response": [] } ], "description": "Manage voice DNIS assignments for queues, Visual IVRs, and cloud route profiles." }, { "name": "Tracking Numbers", "item": [ { "name": "List tracking number groups with numbers", "id": "7bda5f51-0625-58f1-84c3-d8eddecfd468", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/withChildren?includePermissions=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "withChildren" ], "query": [ { "key": "includePermissions", "value": "false", "disabled": true, "description": "includePermissions" } ] }, "description": "Permissions: READ on Account, Post Filtered Results" }, "response": [] }, { "name": "Get tracking number group", "id": "7513da35-2b0a-52b3-835f-6c288f7c75d7", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}" ] }, "description": "Permissions: READ on Trac Group" }, "response": [] }, { "name": "Update tracking number group", "id": "9e5d09ca-ef39-513c-b881-d3e9764394aa", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}" ] }, "description": "Permissions: Update on Trac Group", "body": { "mode": "raw", "raw": "{\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ],\n \"tracGroupId\": 0,\n \"tracNumbers\": [\n {\n \"accountId\": \"\",\n \"assignedDnis\": {},\n \"billingCode\": \"\",\n \"billingKey\": \"\",\n \"closeLocatorId\": 0,\n \"closeType\": \"STANDARD\",\n \"dequeueDelay\": 0,\n \"description\": \"\",\n \"endcallMsg\": \"\",\n \"friSched\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete tracking number group", "id": "80e00f15-f963-5cea-b09d-0f6ff0151258", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}" ] }, "description": "Permissions: Delete on Trac Group" }, "response": [] }, { "name": "List tracking numbers", "id": "b30edea2-74ef-5553-82da-13792bf3f4f1", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}/tracNumbers", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}", "tracNumbers" ] }, "description": "Permissions: READ on Trac Group, Post Filtered Results" }, "response": [] }, { "name": "Create tracking number", "id": "b49a3d99-c48f-538d-8c3d-27f99acd18f0", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}/tracNumbers", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}", "tracNumbers" ] }, "description": "Permissions: Create on Trac Group", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"assignedDnis\": {\n \"cloudRouteProfile\": {},\n \"dnis\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\",\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"endPointId\": \"\",\n \"endPointType\": \"\",\n \"gate\": {},\n \"isActive\": false,\n \"originatingDnis\": \"\"\n },\n \"billingCode\": \"\",\n \"billingKey\": \"\",\n \"closeLocatorId\": 0,\n \"closeType\": \"STANDARD\",\n \"dequeueDelay\": 0,\n \"description\": \"\",\n \"endcallMsg\": \"\",\n \"friSched\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get tracking number", "id": "9b11cb6a-3d35-56b0-99d0-bb65886e8713", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}/tracNumbers/{{tracId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}", "tracNumbers", "{{tracId}}" ] }, "description": "Permissions: READ on Trac Number" }, "response": [] }, { "name": "Update tracking number", "id": "896fdc9d-895a-5b82-b22b-8570a5154c38", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}/tracNumbers/{{tracId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}", "tracNumbers", "{{tracId}}" ] }, "description": "Permissions: Update on Trac Group", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"assignedDnis\": {\n \"cloudRouteProfile\": {},\n \"dnis\": \"\",\n \"dnisDescription\": \"\",\n \"dnisE164\": \"\",\n \"endDate\": \"2026-08-12T22:30:00.000+0000\",\n \"endPointId\": \"\",\n \"endPointType\": \"\",\n \"gate\": {},\n \"isActive\": false,\n \"originatingDnis\": \"\"\n },\n \"billingCode\": \"\",\n \"billingKey\": \"\",\n \"closeLocatorId\": 0,\n \"closeType\": \"STANDARD\",\n \"dequeueDelay\": 0,\n \"description\": \"\",\n \"endcallMsg\": \"\",\n \"friSched\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Manage tracking-number groups and numbers used for attribution and routing." }, { "name": "Tracking Number Routing Rules", "item": [ { "name": "List tracking number routing rules", "id": "90357263-7d00-52c6-a169-460bb5218211", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}/tracNumbers/{{tracId}}/routingRules", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}", "tracNumbers", "{{tracId}}", "routingRules" ] }, "description": "Permissions: READ on Trac Number" }, "response": [] }, { "name": "Create tracking number routing rule", "id": "85724c0c-502b-500c-a756-8371d3edcd90", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}/tracNumbers/{{tracId}}/routingRules", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}", "tracNumbers", "{{tracId}}", "routingRules" ] }, "description": "Permissions: UPDATE on Trac Number", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"destination\": \"\",\n \"openRule\": false,\n \"parallelDelay\": 0,\n \"rank\": 0,\n \"ringDuration\": 0,\n \"ruleId\": 0,\n \"ruleType\": \"STANDARD\",\n \"tracNumber\": {\n \"accountId\": \"\",\n \"assignedDnis\": {},\n \"billingCode\": \"\",\n \"billingKey\": \"\",\n \"closeLocatorId\": 0,\n \"closeType\": \"STANDARD\",\n \"dequeueDelay\": 0,\n \"description\": \"\",\n \"endcallMsg\": \"\",\n \"friSched\": \"\"\n },\n \"ttAccept\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get tracking number routing rule", "id": "a59f18d0-904a-539a-bdfd-f19154f3cbc8", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}/tracNumbers/{{tracId}}/routingRules/{{ruleId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}", "tracNumbers", "{{tracId}}", "routingRules", "{{ruleId}}" ] }, "description": "Permissions: READ on Trac Number" }, "response": [] }, { "name": "Update tracking number routing rule", "id": "a6c08112-32d5-52a5-8795-9f7229f29b1e", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}/tracNumbers/{{tracId}}/routingRules/{{ruleId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}", "tracNumbers", "{{tracId}}", "routingRules", "{{ruleId}}" ] }, "description": "Permissions: UPDATE on Trac Number", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"destination\": \"\",\n \"openRule\": false,\n \"parallelDelay\": 0,\n \"rank\": 0,\n \"ringDuration\": 0,\n \"ruleId\": 0,\n \"ruleType\": \"STANDARD\",\n \"tracNumber\": {\n \"accountId\": \"\",\n \"assignedDnis\": {},\n \"billingCode\": \"\",\n \"billingKey\": \"\",\n \"closeLocatorId\": 0,\n \"closeType\": \"STANDARD\",\n \"dequeueDelay\": 0,\n \"description\": \"\",\n \"endcallMsg\": \"\",\n \"friSched\": \"\"\n },\n \"ttAccept\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete tracking number routing rule", "id": "2311730c-4408-5bce-b6ee-359417162fb9", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}/tracNumbers/{{tracId}}/routingRules/{{ruleId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}", "tracNumbers", "{{tracId}}", "routingRules", "{{ruleId}}" ] }, "description": "Permissions: UPDATE on Trac Number" }, "response": [] } ], "description": "Manage routing rules associated with tracking numbers." }, { "name": "Tracking Number Schedules", "item": [ { "name": "List tracking number schedule overrides", "id": "feb55376-2efa-5a9e-808d-967b65b0d804", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}/tracNumbers/{{tracId}}/scheduleOverrides", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}", "tracNumbers", "{{tracId}}", "scheduleOverrides" ] }, "description": "Permissions: READ on Trac Number" }, "response": [] }, { "name": "Create tracking number schedule override", "id": "f33f765d-8aa2-5656-a007-1569a57fe605", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}/tracNumbers/{{tracId}}/scheduleOverrides", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}", "tracNumbers", "{{tracId}}", "scheduleOverrides" ] }, "description": "Permissions: UPDATE on Trac Number (Permission Override)", "body": { "mode": "raw", "raw": "{\n \"overrideClosedEvent\": \"\",\n \"overrideDate\": \"2026-08-12T22:30:00.000+0000\",\n \"overrideLabel\": \"\",\n \"overrideSched\": \"\",\n \"scheduleOverrideId\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get tracking number schedule override", "id": "5568abbd-e406-573f-ae59-34250426f360", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}/tracNumbers/{{tracId}}/scheduleOverrides/{{overrideId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}", "tracNumbers", "{{tracId}}", "scheduleOverrides", "{{overrideId}}" ] }, "description": "Permissions: READ on Trac Number" }, "response": [] }, { "name": "Update tracking number schedule override", "id": "51d61175-c1c8-5b69-a2d6-14f1fe561ec2", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}/tracNumbers/{{tracId}}/scheduleOverrides/{{overrideId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}", "tracNumbers", "{{tracId}}", "scheduleOverrides", "{{overrideId}}" ] }, "description": "Permissions: UPDATE on Trac Number", "body": { "mode": "raw", "raw": "{\n \"overrideClosedEvent\": \"\",\n \"overrideDate\": \"2026-08-12T22:30:00.000+0000\",\n \"overrideLabel\": \"\",\n \"overrideSched\": \"\",\n \"scheduleOverrideId\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete tracking number schedule override", "id": "64fd7a91-3ab1-5ab6-a8c7-a7d17f2574e4", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/tracGroups/{{tracGroupId}}/tracNumbers/{{tracId}}/scheduleOverrides/{{overrideId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "tracGroups", "{{tracGroupId}}", "tracNumbers", "{{tracId}}", "scheduleOverrides", "{{overrideId}}" ] }, "description": "Permissions: UPDATE on Trac Number (Permission Override)" }, "response": [] } ], "description": "Manage schedule overrides associated with tracking numbers." } ] }, { "name": "Dialing", "item": [ { "name": "Active Calls", "item": [ { "name": "Creates a manual agent call", "id": "dabfe525-5b48-5bcd-9d43-f5c3efd8dcef", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/activeCalls/createManualAgentCall?username=&destination=&ringDuration=0&callerId=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "activeCalls", "createManualAgentCall" ], "query": [ { "key": "username", "value": "", "disabled": false, "description": "username" }, { "key": "destination", "value": "", "disabled": false, "description": "destination" }, { "key": "ringDuration", "value": "0", "disabled": false, "description": "ringDuration" }, { "key": "callerId", "value": "", "disabled": false, "description": "callerId" } ] }, "description": "Permissions: READ on Account (Permission Override)" }, "response": [] }, { "name": "Returns a listing of current active calls for a given product OR externalId, on an account", "id": "deb6c082-f71a-555d-9f06-fabf23e66d96", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/activeCalls/list?product=ACCOUNT&productId=0&externalId=&page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "activeCalls", "list" ], "query": [ { "key": "product", "value": "ACCOUNT", "disabled": true, "description": "product" }, { "key": "productId", "value": "0", "disabled": true, "description": "productId" }, { "key": "externalId", "value": "", "disabled": true, "description": "externalId" }, { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Account" }, "response": [] }, { "name": "Check queue status", "id": "3b866312-9249-53d0-a3c0-3b4670829d41", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/activeCalls/prerouteChecks/checkQueueStatus?destination_number=&maxq=0&phoneNumbersI18nEnabled=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "activeCalls", "prerouteChecks", "checkQueueStatus" ], "query": [ { "key": "destination_number", "value": "", "disabled": false, "description": "DNIS to be used for queue lookup. Must be assigned to the queue." }, { "key": "maxq", "value": "0", "disabled": false, "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" }, { "key": "phoneNumbersI18nEnabled", "value": "false", "disabled": true, "description": "phoneNumbersI18nEnabled" } ] }, "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." }, "response": [] }, { "name": "Check queue threshold", "id": "edde7e82-c99f-5996-aabd-761d77e84883", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/activeCalls/prerouteChecks/checkQueueThreshold?destination_number=&maxCallsQueued=10&phoneNumbersI18nEnabled=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "activeCalls", "prerouteChecks", "checkQueueThreshold" ], "query": [ { "key": "destination_number", "value": "", "disabled": false, "description": "DNIS to be used for queue lookup. Must be assigned to the queue." }, { "key": "maxCallsQueued", "value": "10", "disabled": true, "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" }, { "key": "phoneNumbersI18nEnabled", "value": "false", "disabled": true, "description": "phoneNumbersI18nEnabled" } ] }, "description": "Check queue threshold API Returns true or false based on the current number of calls in queue and the passed in threshold value." }, "response": [] }, { "name": "Provides support for adding sessions to an active call", "id": "c1caa1ef-8281-596a-a143-c74a4c190006", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/activeCalls/{{uii}}/addSessionToCall?destination=&sessionType=MONITOR", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "activeCalls", "{{uii}}", "addSessionToCall" ], "query": [ { "key": "destination", "value": "", "disabled": false, "description": "destination" }, { "key": "sessionType", "value": "MONITOR", "disabled": false, "description": "sessionType" } ] }, "description": "Permissions: READ on Account (Permission Override)" }, "response": [] }, { "name": "Sets the call disposition for either INBOUND or OUTBOUND calls and releases the agent from PD state", "id": "a60cae7b-b575-5619-bfed-b9fa354ed010", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/activeCalls/{{uii}}/dispositionCall?disposition=&callback=false&callBackDTS=¬es=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "activeCalls", "{{uii}}", "dispositionCall" ], "query": [ { "key": "disposition", "value": "", "disabled": false, "description": "disposition" }, { "key": "callback", "value": "false", "disabled": false, "description": "callback" }, { "key": "callBackDTS", "value": "", "disabled": true, "description": "callBackDTS" }, { "key": "notes", "value": "", "disabled": true, "description": "notes" } ] }, "description": "Permissions: READ on Account (Permission Override)" }, "response": [] }, { "name": "Terminates an active call", "id": "8b204725-e224-58d3-b2b1-a78cdd616edf", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/activeCalls/{{uii}}/hangupCall", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "activeCalls", "{{uii}}", "hangupCall" ] }, "description": "Permissions: READ on Account (Permission Override)" }, "response": [] }, { "name": "Terminates an active session", "id": "a1a9809f-6340-50ea-9495-6553e7e63a3d", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/activeCalls/{{uii}}/hangupSession?phone=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "activeCalls", "{{uii}}", "hangupSession" ], "query": [ { "key": "phone", "value": "", "disabled": false, "description": "phone" } ] }, "description": "Permissions: READ on Account (Permission Override)" }, "response": [] }, { "name": "Provides support for toggling call recording on/off for an active call", "id": "589bab69-619b-5dec-8ebc-2f4c50224289", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/activeCalls/{{uii}}/toggleCallRecording?record=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "activeCalls", "{{uii}}", "toggleCallRecording" ], "query": [ { "key": "record", "value": "false", "disabled": false, "description": "record" } ] }, "description": "Permissions: READ on Account (Permission Override)" }, "response": [] } ], "description": "Monitor and control active RingCX calls." }, { "name": "Campaigns", "item": [ { "name": "Performs a lead action against the matching campaign leads found for the given the search criteria", "id": "d0eb2e81-0e5a-50bd-969e-f1e7bafb60b1", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/campaignLeads/actions?leadAction=RESET_LEADS", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "campaignLeads", "actions" ], "query": [ { "key": "leadAction", "value": "RESET_LEADS", "disabled": false, "description": "leadAction" } ] }, "description": "Permissions: READ on Account (Permission Override), UPDATE on Campaign\n\nRate limit: This operation is throttled per RingCX sub-account at 30 requests per 10 seconds and 120 requests per 60 seconds.", "body": { "mode": "raw", "raw": "{\n \"campaignLeadSearchCriteria\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"agentDispositions\": [\n \"\"\n ],\n \"agentId\": 0,\n \"auxData1\": \"\",\n \"auxData2\": \"\",\n \"auxData3\": \"\",\n \"auxData4\": \"\",\n \"auxData5\": \"\",\n \"callerId\": \"\"\n },\n \"leadActionParams\": {\n \"paramMap\": {}\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Allows searching of campaign leads for a single campaign", "id": "b3132574-b1b0-57e1-a1f3-0e6f7855cdc3", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "multipart/form-data", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/campaignLeads/leadSearchByPhoneList?page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "campaignLeads", "leadSearchByPhoneList" ], "query": [ { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Account (Permission Override)", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "disabled": false, "src": [] } ] } }, "response": [] }, { "name": "Returns a listing of campaigns for a dial group", "id": "9225160b-e44d-560e-9caa-762abee6764c", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/dialGroups/{{dialGroupId}}/campaigns?page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "dialGroups", "{{dialGroupId}}", "campaigns" ], "query": [ { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Dial Group, Post Filtered Results" }, "response": [] }, { "name": "Returns a campaign for a dial group [POST]", "id": "3e97ffc5-435b-5029-b249-d0cf99a841c0", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/dialGroups/{{dialGroupId}}/campaigns", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "dialGroups", "{{dialGroupId}}", "campaigns" ] }, "description": "Permissions: UPDATE on Dial Group (Permission Override)", "body": { "mode": "raw", "raw": "{\n \"abandonMsg\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {\n \"agentAuxState\": \"\",\n \"baseAgentState\": {},\n \"description\": \"\",\n \"isActive\": false,\n \"isAgentSelectable\": false,\n \"isRequired\": false,\n \"rank\": 0,\n \"stateId\": 0\n },\n \"agentConnectSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"allowLeadInserts\": \"\",\n \"allowLeadUpdates\": \"\",\n \"amdProfileId\": {\n \"accountId\": \"\",\n \"amdAfterGreetingSilence\": 0,\n \"amdBetweenWordSilence\": 0,\n \"amdGreeting\": 0,\n \"amdInitSilence\": 0,\n \"amdMaxWords\": 0,\n \"amdMinWordLength\": 0,\n \"amdProfileId\": 0,\n \"amdProfileName\": \"\",\n \"amdSilenceThreshold\": 0\n },\n \"appUrl\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a campaign for a dial group [GET]", "id": "337834cc-9fb8-5e2b-8933-f11e45a6aae9", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/dialGroups/{{dialGroupId}}/campaigns/{{campaignId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "dialGroups", "{{dialGroupId}}", "campaigns", "{{campaignId}}" ] }, "description": "Permissions: READ on Campaign" }, "response": [] }, { "name": "Updates a campaign for a dial group", "id": "1684ac43-77e3-5bc8-aa1c-6a6773524be4", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/dialGroups/{{dialGroupId}}/campaigns/{{campaignId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "dialGroups", "{{dialGroupId}}", "campaigns", "{{campaignId}}" ] }, "description": "Permissions: UPDATE on Campaign", "body": { "mode": "raw", "raw": "{\n \"abandonMsg\": \"\",\n \"afterCallBaseState\": \"\",\n \"afterCallState\": {\n \"agentAuxState\": \"\",\n \"baseAgentState\": {},\n \"description\": \"\",\n \"isActive\": false,\n \"isAgentSelectable\": false,\n \"isRequired\": false,\n \"rank\": 0,\n \"stateId\": 0\n },\n \"agentConnectSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"agentPopMessage\": \"\",\n \"agentTermSoapService\": {\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {},\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n },\n \"allowLeadInserts\": \"\",\n \"allowLeadUpdates\": \"\",\n \"amdProfileId\": {\n \"accountId\": \"\",\n \"amdAfterGreetingSilence\": 0,\n \"amdBetweenWordSilence\": 0,\n \"amdGreeting\": 0,\n \"amdInitSilence\": 0,\n \"amdMaxWords\": 0,\n \"amdMinWordLength\": 0,\n \"amdProfileId\": 0,\n \"amdProfileName\": \"\",\n \"amdSilenceThreshold\": 0\n },\n \"appUrl\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "[Deprecated] Deletes a campaign for a dial group", "id": "5fb002c7-fe7f-5928-96bb-432728770dd5", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/dialGroups/{{dialGroupId}}/campaigns/{{campaignId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "dialGroups", "{{dialGroupId}}", "campaigns", "{{campaignId}}" ] }, "description": "Deprecated operation. Permissions: DELETE on Campaign" }, "response": [] }, { "name": "Clears the cache for a campaign", "id": "ac740178-2bda-59bd-8437-053cbb669800", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/dialGroups/{{dialGroupId}}/campaigns/{{campaignId}}/clearCache", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "dialGroups", "{{dialGroupId}}", "campaigns", "{{campaignId}}", "clearCache" ] }, "description": "Permissions: READ on Campaign (Permission Override)" }, "response": [] } ], "description": "Manage outbound dialing campaigns." }, { "name": "Leads", "item": [ { "name": "Allows searching of campaign leads for a single campaign", "id": "c576f242-a39c-5a09-b9af-aec8f051810e", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/campaignLeads/leadSearch?count=false&page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "campaignLeads", "leadSearch" ], "query": [ { "key": "count", "value": "false", "disabled": true, "description": "count" }, { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Account (Permission Override)\n\nRate limit: Standard searches are throttled per RingCX sub-account at 15 requests per 10 seconds and 60 requests per 30 seconds. Requests with count=true are throttled at 90 requests per 10 seconds and 180 requests per 30 seconds.", "body": { "mode": "raw", "raw": "{\n \"address1\": \"\",\n \"address2\": \"\",\n \"agentDispositions\": [\n \"\"\n ],\n \"agentId\": 0,\n \"auxData1\": \"\",\n \"auxData2\": \"\",\n \"auxData3\": \"\",\n \"auxData4\": \"\",\n \"auxData5\": \"\",\n \"callerId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a listing of all lead states for an account", "id": "1a0b9ae2-e29b-59bb-8c78-b9ef57fa716d", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/campaignLeads/leadStates", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "campaignLeads", "leadStates" ] }, "description": "Permissions: READ on Account" }, "response": [] }, { "name": "Returns a listing of all system dispositions for an account", "id": "8c021136-0cdc-58fe-888e-ad41b9a3cfc6", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/campaignLeads/systemDispositions", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "campaignLeads", "systemDispositions" ] }, "description": "Permissions: READ on Account" }, "response": [] }, { "name": "Allows updating of a campaign lead, updating entire lead including fields not passed in", "id": "fb1726d9-6f83-5270-98d2-eaffff3b4536", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/campaignLeads/{{leadId}}?campaignId=0&listId=0&timezoneOption=NPA_NXX&duplicateHandling=RETAIN_ALL", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "campaignLeads", "{{leadId}}" ], "query": [ { "key": "campaignId", "value": "0", "disabled": false, "description": "campaignId" }, { "key": "listId", "value": "0", "disabled": true, "description": "listId" }, { "key": "timezoneOption", "value": "NPA_NXX", "disabled": true, "description": "timezoneOption" }, { "key": "duplicateHandling", "value": "RETAIN_ALL", "disabled": true, "description": "duplicateHandling" } ] }, "description": "Permissions: READ on Account (Permission Override), UPDATE on Campaign\n\nRate limit: This operation is throttled per RingCX sub-account at 12 requests per 3 seconds and 150 requests per 60 seconds.", "body": { "mode": "raw", "raw": "{\n \"address1\": \"\",\n \"address2\": \"\",\n \"auxData1\": \"\",\n \"auxData2\": \"\",\n \"auxData3\": \"\",\n \"auxData4\": \"\",\n \"auxData5\": \"\",\n \"auxExternalUrl\": \"\",\n \"auxGreeting\": \"\",\n \"auxPhone\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Allows updating of a campaign lead, only updating those fields passed in", "id": "b498d79b-73a1-50b3-9f33-82a83acb3e91", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/campaignLeads/{{leadId}}?campaignId=0&listId=0&timezoneOption=NPA_NXX&duplicateHandling=RETAIN_ALL", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "campaignLeads", "{{leadId}}" ], "query": [ { "key": "campaignId", "value": "0", "disabled": false, "description": "campaignId" }, { "key": "listId", "value": "0", "disabled": true, "description": "listId" }, { "key": "timezoneOption", "value": "NPA_NXX", "disabled": true, "description": "timezoneOption" }, { "key": "duplicateHandling", "value": "RETAIN_ALL", "disabled": true, "description": "duplicateHandling" } ] }, "description": "Permissions: READ on Account (Permission Override), UPDATE on Campaign\n\nRate limit: This operation is throttled per RingCX sub-account at 12 requests per 3 seconds and 150 requests per 60 seconds.", "body": { "mode": "raw", "raw": "{\n \"address1\": \"\",\n \"address2\": \"\",\n \"auxData1\": \"\",\n \"auxData2\": \"\",\n \"auxData3\": \"\",\n \"auxData4\": \"\",\n \"auxData5\": \"\",\n \"auxExternalUrl\": \"\",\n \"auxGreeting\": \"\",\n \"auxPhone\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Uploads a single lead or list of leads to a new or existing list", "id": "f07e8b20-e6f4-5f04-9c2b-a535cde21fd5", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/campaigns/{{campaignId}}/leadLoader/direct", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "campaigns", "{{campaignId}}", "leadLoader", "direct" ] }, "description": "Permissions: Update on Campaign (Permission Override)\n\nRate limit: This operation is throttled per RingCX sub-account at 30 requests per 10 seconds and 120 requests per 60 seconds.", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"dialPriority\": \"IMMEDIATE\",\n \"dncTags\": [\n \"\"\n ],\n \"duplicateHandling\": \"RETAIN_ALL\",\n \"extendedLeadDataMappings\": {},\n \"fileContainsHeaders\": false,\n \"fileType\": \"EXCEL\",\n \"listState\": \"ACTIVE\",\n \"pageColumnMappings\": {},\n \"pageNumber\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Manage campaign leads, lead search, and lead actions." }, { "name": "Dial Groups", "item": [ { "name": "Returns a listing of dial groups for an account", "id": "75e80e30-0e78-52ea-9b46-c3d2dda88560", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/dialGroups?page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "dialGroups" ], "query": [ { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Account, Post Filtered Results" }, "response": [] }, { "name": "Creates a dial group for an account", "id": "8dd24a7f-1420-5939-bb45-9c9a883af9d3", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/dialGroups", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "dialGroups" ] }, "description": "Permissions: CREATE on Account", "body": { "mode": "raw", "raw": "{\n \"agentDialGroupMembers\": {},\n \"agentsReady\": 0,\n \"allowLeadSearch\": \"\",\n \"allowPreviewLeadFilters\": false,\n \"billingKey\": \"\",\n \"campaigns\": {},\n \"dialGroupDesc\": \"\",\n \"dialGroupId\": 0,\n \"dialGroupName\": \"\",\n \"dialMode\": \"PREVIEW\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a listing of dial groups with associated campaigns for an account", "id": "4edbc933-71b6-53dc-ac91-ee6ce8c7a0ff", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/dialGroups/withChildren?includePermissions=false&page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "dialGroups", "withChildren" ], "query": [ { "key": "includePermissions", "value": "false", "disabled": true, "description": "includePermissions" }, { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Account, Post Filtered Results for Dial Groups and Campaigns" }, "response": [] }, { "name": "Returns a dial group for an account", "id": "05840b3f-a569-5174-b976-3bfaee9adf9b", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/dialGroups/{{dialGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "dialGroups", "{{dialGroupId}}" ] }, "description": "Permissions: READ on Dial Group" }, "response": [] }, { "name": "Updates a dial group for an account", "id": "7c9036f1-42f2-56ee-b18e-f67a80edb386", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/dialGroups/{{dialGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "dialGroups", "{{dialGroupId}}" ] }, "description": "Permissions: UPDATE on Dial Group", "body": { "mode": "raw", "raw": "{\n \"agentDialGroupMembers\": {},\n \"agentsReady\": 0,\n \"allowLeadSearch\": \"\",\n \"allowPreviewLeadFilters\": false,\n \"billingKey\": \"\",\n \"campaigns\": {},\n \"dialGroupDesc\": \"\",\n \"dialGroupId\": 0,\n \"dialGroupName\": \"\",\n \"dialMode\": \"PREVIEW\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deletes a dial group for an account", "id": "29eefd7e-23be-5eb7-af68-8b97a8af031b", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/dialGroups/{{dialGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "dialGroups", "{{dialGroupId}}" ] }, "description": "Permissions: DELETE on Account" }, "response": [] }, { "name": "Assigns a listing of agents to a dial group", "id": "bc942ad5-1b6c-52a7-b8dc-7c74c64101b2", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/dialGroups/{{dialGroupId}}/assignAgents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "dialGroups", "{{dialGroupId}}", "assignAgents" ] }, "description": "Permissions: UPDATE on Dial Group and READ on Agent", "body": { "mode": "raw", "raw": "[\n {\n \"agentId\": 0,\n \"dialGroupId\": 0,\n \"hciClicker\": false\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns a listing of all agents assigned to a dial group", "id": "28802017-7143-5544-8f17-9404d20cd497", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/dialGroups/{{dialGroupId}}/assignedAgents?page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "dialGroups", "{{dialGroupId}}", "assignedAgents" ], "query": [ { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Dial Group" }, "response": [] } ], "description": "Manage dial groups and their campaign membership." }, { "name": "Outbound", "item": [ { "name": "Upload new leads to a new or existing list [POST]", "id": "03cf6cf1-b947-514d-9f01-f87bd00c5b31", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "multipart/form-data", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/campaigns/{{campaignId}}/leadLoader/preview?fileType=EXCEL"eCharacter=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "campaigns", "{{campaignId}}", "leadLoader", "preview" ], "query": [ { "key": "fileType", "value": "EXCEL", "disabled": false, "description": "fileType" }, { "key": "quoteCharacter", "value": "", "disabled": true, "description": "quoteCharacter" } ] }, "description": "Permissions: UPDATE on Campaign (Permission Override)\n\nRate limit: This operation is throttled per RingCX sub-account at 12 requests per 30 seconds and 18 requests per 60 seconds.", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "disabled": false, "src": [] } ] } }, "response": [] }, { "name": "Upload new leads to a new or existing list [POST]", "id": "9d86d7ac-74bd-5a99-bd2a-666203b29a68", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/campaigns/{{campaignId}}/leadLoader/process", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "campaigns", "{{campaignId}}", "leadLoader", "process" ] }, "description": "Permissions: UPDATE on Campaign (Permission Override)\n\nRate limit: This operation is throttled per RingCX sub-account at 9 requests per 3 seconds and 30 requests per 30 seconds.", "body": { "mode": "raw", "raw": "{\n \"description\": \"\",\n \"dialPriority\": \"IMMEDIATE\",\n \"dncTags\": [\n \"\"\n ],\n \"duplicateHandling\": \"RETAIN_ALL\",\n \"extendedLeadDataMappings\": {},\n \"fileContainsHeaders\": false,\n \"fileType\": \"EXCEL\",\n \"listState\": \"ACTIVE\",\n \"pageColumnMappings\": {},\n \"pageNumber\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Fetches persona phone configurations", "id": "735c0be7-e3b5-5431-8fbe-1922871c19ec", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/persona-phone-config", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "persona-phone-config" ] }, "description": "Permissions: Read on Account (Permission Override), READ on Outbound" }, "response": [] }, { "name": "Creates persona phone configuration", "id": "a39c67ca-1d60-559a-89cd-b72a2b3e8930", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/persona-phone-config", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "persona-phone-config" ] }, "description": "Permissions: Read on Account (Permission Override), CREATE on Outbound", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"phoneId\": 0,\n \"phoneLabel\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Updates persona phone configuration", "id": "0f95f718-5d08-50dc-bad3-4e83fa7fe59d", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/persona-phone-config", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "persona-phone-config" ] }, "description": "Permissions: Read on Account (Permission Override), UPDATE on Outbound", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"phoneId\": 0,\n \"phoneLabel\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Fetches campaigns using a persona phone ID", "id": "30df6cd1-6caa-5de5-ad38-7bd3fd2829f2", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/persona-phone-config/active-campaigns/{{phoneId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "persona-phone-config", "active-campaigns", "{{phoneId}}" ] }, "description": "Returns campaign names that currently use the specified persona phone ID in calling preferences." }, "response": [] }, { "name": "Deletes persona phone configuration", "id": "33e8f73e-88f9-5761-a46d-7dfbf289727c", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/persona-phone-config/{{phoneId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "persona-phone-config", "{{phoneId}}" ] }, "description": "Permissions: Read on Account (Permission Override), DELETE on Outbound" }, "response": [] } ], "description": "Retrieve outbound dialing metadata and status." } ] }, { "name": "Authentication", "item": [ { "name": "API Tokens", "item": [ { "name": "List permanent API tokens", "id": "fcc0356a-035e-5f9c-b4ea-e927a3c39a83", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/token", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "token" ] }, "description": "Permissions: Authenticated User. Authenticate with a current RingCX bearer token or a legacy X-Auth-Token." }, "response": [] }, { "name": "Create a permanent API token", "id": "5542daab-43f0-5c36-90cb-436b5c740f0f", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/token", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "token" ] }, "description": "Permissions: Authenticated User. Authenticate with a current RingCX bearer token or a legacy X-Auth-Token. Each successful request creates a permanent API token." }, "response": [] }, { "name": "Delete a permanent API token", "id": "3eb35185-69b7-5e46-aad5-6d8c93653c02", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/token/{{token}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "token", "{{token}}" ] }, "description": "Permissions: Authenticated User. Authenticate with a current RingCX bearer token or a legacy X-Auth-Token. The token identified in the path is revoked." }, "response": [] } ], "description": "Create, list, and revoke permanent API tokens." } ] }, { "name": "Utilities", "item": [ { "name": "Countries", "item": [ { "name": "Returns a listing of all country codes available on the system", "id": "1322297b-99e9-5f70-af81-a2d52bf3aeb7", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/countries/available", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "countries", "available" ] }, "description": "Permissions: READ on Account" }, "response": [] } ], "description": "Retrieve country, state, and regional dialing metadata." } ] }, { "name": "Integration", "item": [ { "name": "Integration User Controller", "item": [ { "name": "Returns a listing of all users that a user has access to", "id": "82bb7165-72c2-5cd5-a191-9de0bd21c7a2", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/integration/v1/admin/users/{{rcx_main_account_id}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "integration", "v1", "admin", "users", "{{rcx_main_account_id}}" ] }, "description": "Permissions: WFO_ACCESS role" }, "response": [ { "name": "200 OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/integration/v1/admin/users/{{rcx_main_account_id}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "integration", "v1", "admin", "users", "{{rcx_main_account_id}}" ] }, "description": "Permissions: WFO_ACCESS role" }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"rcUserId\": 1009,\n \"userId\": 3289,\n \"engageUserName\": \"jane.doe+ringcx@example.com\",\n \"userName\": \"jane.doe+ringcx-voice@example.com\",\n \"email\": \"jane.doe@example.com\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"parentPath\": \"2181.2979.2983.3064\",\n \"envID\": \"production\"\n },\n {\n \"rcUserId\": 1010,\n \"userId\": 3290,\n \"engageUserName\": \"joe.doe+ringcx@example.com\",\n \"userName\": \"joe.doe+ringcx-voice@example.com\",\n \"email\": \"joe.doe@example.com\",\n \"firstName\": \"Joe\",\n \"lastName\": \"Doe\",\n \"parentPath\": \"2181.2979.2983.3064\",\n \"envID\": \"production\"\n }\n]" } ] } ], "description": "Access user resources through RingCX integration endpoints." }, { "name": "Integration Account Controller", "item": [ { "name": "Returns a listing of sub-accounts by RingCX main account identifier", "id": "79a37b1c-059a-5ed9-b8a8-f495562acb26", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/integration/v1/admin/accounts/{{rcx_main_account_id}}/subaccounts", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "integration", "v1", "admin", "accounts", "{{rcx_main_account_id}}", "subaccounts" ] }, "description": "Permissions: WFO_ACCESS role" }, "response": [] } ], "description": "Access account resources through RingCX integration endpoints." }, { "name": "Integration Agent Controller", "item": [ { "name": "Returns a list of read only agents for an agent group", "id": "094bb8da-45e4-59a6-9b18-465dbc139cb1", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/integration/v1/admin/accounts/{{rcx_sub_account_id}}/agentGroups/{{agentGroupId}}/agents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "integration", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "agentGroups", "{{agentGroupId}}", "agents" ] }, "description": "Permissions: WFO_ACCESS role" }, "response": [] } ], "description": "Access agent resources through RingCX integration endpoints." }, { "name": "Integration Agent Group Controller", "item": [ { "name": "Returns a list of agent groups for a sub-account", "id": "68f93a34-8943-5d14-9548-121740d5bfaf", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/integration/v1/admin/accounts/{{rcx_sub_account_id}}/agentGroups", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "integration", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "agentGroups" ] }, "description": "Permissions: WFO_ACCESS role" }, "response": [] } ], "description": "Access agent group resources through RingCX integration endpoints." }, { "name": "Public Integration API", "item": [ { "name": "Fetches recordings data", "id": "fc4210d2-02e5-526f-866c-fddfe28ff4c3", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/recordings/dialogs/{{dialogId}}/segments/{{segmentId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "recordings", "dialogs", "{{dialogId}}", "segments", "{{segmentId}}" ] }, "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." }, "response": [] }, { "name": "Returns Interaction Segment Metadata", "id": "ddeb1cfb-c148-5f4c-ad6a-0f1932638e37", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/interaction-metadata", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "interaction-metadata" ] }, "description": "This API is used to fetch interaction metadata for VOICE/DIGITAL for all segments under provided time duration.\n\nRate limit: This operation is throttled per RingCX sub-account at 3 requests per 60 seconds and 9 requests per 15 minutes.", "body": { "mode": "raw", "raw": "{\n \"segmentEndTime\": \"2021-02-28 08:27:15\",\n \"timeInterval\": 1800,\n \"timeZone\": \"US/Eastern\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Returns interaction metadata with current field names and voice call results", "id": "01419fe5-46ae-5c6f-8d0f-a54a50ba531b", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v2/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/interaction-metadata", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v2", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "interaction-metadata" ] }, "description": "Returns completed voice and digital interaction segment metadata for the requested account and time window. Requires WEM Access. Voice results include non-agent sessions by default, such as IVR abandons, queue timeouts, and no-agent-available outcomes. Use this v2 endpoint for new integrations; v1 remains available for integrations that depend on legacy field names.", "body": { "mode": "raw", "raw": "{\n \"segmentEndTime\": \"2026-03-02 09:00:00\",\n \"timeInterval\": 1800,\n \"timeZone\": \"US/Eastern\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v2/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/interaction-metadata", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v2", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "interaction-metadata" ] }, "description": "Returns completed voice and digital interaction segment metadata for the requested account and time window. Requires WEM Access. Voice results include non-agent sessions by default, such as IVR abandons, queue timeouts, and no-agent-available outcomes. Use this v2 endpoint for new integrations; v1 remains available for integrations that depend on legacy field names.", "body": { "mode": "raw", "raw": "{\n \"segmentEndTime\": \"2026-03-02 09:00:00\",\n \"timeInterval\": 1800,\n \"timeZone\": \"US/Eastern\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"uii\": \"202606020106368133110000000002\",\n \"dialogId\": \"s-v-23eb89e65275496496bc956876e45568-1780376796111\",\n \"segmentId\": \"p-v-23eb89e65275496496bc956876e45568-1780376796111-00e86b9fbcf05\",\n \"interactionStartTimeMs\": \"2026-06-02T05:06:36.000Z\",\n \"interactionEndTimeMs\": \"2026-06-02T05:07:21.000Z\",\n \"dialogDurationMs\": 45000,\n \"callType\": \"INBOUND\",\n \"channelType\": \"VOICE\",\n \"channelClass\": \"VOICE\",\n \"ani\": \"12025550100\",\n \"dnis\": \"12025550101\",\n \"agentId\": null,\n \"agentFullName\": null,\n \"productType\": 3,\n \"productId\": \"483\",\n \"termParty\": \"CALLER\",\n \"termReason\": \"HANGUP\",\n \"callResult\": \"Inbound Abandoned\",\n \"subAccountId\": \"99999999\",\n \"segmentStartTimeMs\": \"2026-06-02T05:06:36.000Z\",\n \"segmentEndTimeMs\": \"2026-06-02T05:07:21.000Z\",\n \"segmentDurationMs\": 45000,\n \"segmentAgentGroupId\": null,\n \"systemDisposition\": \"\",\n \"agentDisposition\": null,\n \"hasRecording\": false,\n \"hasTranscript\": false,\n \"hasScreenRecording\": false\n }\n]" } ] }, { "name": "Fetches Transcript data for both voice and digital", "id": "7b708198-b509-5808-8cea-52da462c6b6d", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/transcripts/dialogs/{{dialogId}}/segments/{{segmentId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "transcripts", "dialogs", "{{dialogId}}", "segments", "{{segmentId}}" ] }, "description": "This API returns JSON transcript data for the provided dialogId and segmentId." }, "response": [ { "name": "200 OK. The response body contains transcript data for the requested interaction segment.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/transcripts/dialogs/{{dialogId}}/segments/{{segmentId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "transcripts", "dialogs", "{{dialogId}}", "segments", "{{segmentId}}" ] }, "description": "This API returns JSON transcript data for the provided dialogId and segmentId." }, "status": "OK. The response body contains transcript data for the requested interaction segment.", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"channelClass\": \"DIGITAL\",\n \"errorCode\": null,\n \"errorMessage\": null,\n \"transcript\": [\n {\n \"message\": \"I cannot transfer number porting\",\n \"participantId\": \"d-6555aa00cd0df30007872d38-6555aa00cd0df30007872d37\",\n \"participantType\": \"contact\",\n \"rcUserId\": \"100000001\",\n \"timestamp\": \"1721651880000\"\n },\n {\n \"message\": \"Can you provide your RC account? And describe the steps you met?\",\n \"participantId\": \"d-6555b45ccd0df30007872dd2-1700115548459-18bd6d7301135\",\n \"participantType\": \"agent\",\n \"rcUserId\": \"100000001\",\n \"timestamp\": \"1721651881000\"\n }\n ]\n}" } ] }, { "name": "Returns a list of queue groups", "id": "123a2d2b-6566-5333-9115-662378e3f807", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/queue-groups", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "queue-groups" ] }, "description": "This API returns a list of all queue-groups for given sub-account" }, "response": [] }, { "name": "Returns a list of agent ids of the queue group.", "id": "326c0a8f-c734-538a-806a-a94fbced8158", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/queue-groups/{{queueGroupId}}/with-agents", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "queue-groups", "{{queueGroupId}}", "with-agents" ] }, "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." }, "response": [] }, { "name": "Builds queue statistics", "id": "321ae32e-8d85-5ef4-8bd8-6dcb9691be1e", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/agg-queue-stats", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "agg-queue-stats" ] }, "description": "This API returns statistics of all queues for given sub-account and duration.\n\nRate limit: This operation is throttled per RingCX sub-account at 3 requests per 60 seconds and 9 requests per 15 minutes.", "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2026-03-02 09:00:00\",\n \"endDate\": \"2026-03-02 12:00:00\",\n \"timeInterval\": 15,\n \"timeZone\": \"US/Eastern\",\n \"outputFormat\": \"CSV\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/agg-queue-stats", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "agg-queue-stats" ] }, "description": "This API returns statistics of all queues for given sub-account and duration.\n\nRate limit: This operation is throttled per RingCX sub-account at 3 requests per 60 seconds and 9 requests per 15 minutes.", "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2026-03-02 09:00:00\",\n \"endDate\": \"2026-03-02 12:00:00\",\n \"timeInterval\": 15,\n \"timeZone\": \"US/Eastern\",\n \"outputFormat\": \"CSV\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"abandIxnCnt\": 0,\n \"abandShortIxnCnt\": 0,\n \"abandWithinSlCnt\": 0,\n \"ansServicelevelCnt\": 0,\n \"answIxnCnt\": 3,\n \"completedContacts\": 122,\n \"dateTimeFrom\": \"03-04-2024T01:00:00\",\n \"interval\": 60,\n \"offdDirectIxnCnt\": 3,\n \"overflowInIxnCnt\": 0,\n \"overflowOutIxnCnt\": 0,\n \"queue\": 5686,\n \"queuedAbandLongestQueDur\": 0,\n \"queuedAndAbandIxnDur\": 0,\n \"queuedAndAnswIxnDur\": 9,\n \"queuedAnswLongestQueDur\": 1,\n \"queueName\": \"Queue\",\n \"segmentHoldTime\": 512000,\n \"talkingIxnDur\": 90,\n \"waitDur\": 13,\n \"wrapUpDur\": 13\n },\n {\n \"abandIxnCnt\": 0,\n \"abandShortIxnCnt\": 0,\n \"abandWithinSlCnt\": 0,\n \"ansServicelevelCnt\": 0,\n \"answIxnCnt\": 3,\n \"completedContacts\": 21,\n \"dateTimeFrom\": \"03-04-2024T02:00:00\",\n \"interval\": 60,\n \"offdDirectIxnCnt\": 3,\n \"overflowInIxnCnt\": 0,\n \"overflowOutIxnCnt\": 0,\n \"queue\": 5686,\n \"queuedAbandLongestQueDur\": 0,\n \"queuedAndAbandIxnDur\": 0,\n \"queuedAndAnswIxnDur\": 9,\n \"queuedAnswLongestQueDur\": 1,\n \"queueName\": \"Queue 2\",\n \"segmentHoldTime\": 12000,\n \"talkingIxnDur\": 90,\n \"waitDur\": 13,\n \"wrapUpDur\": 13\n }\n]" } ] }, { "name": "Builds extended agent queue statistics", "id": "02898312-e68b-5cd2-95ce-de0a91ca6244", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/agg-agent-extended-stats", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "agg-agent-extended-stats" ] }, "description": "This API returns statistics of all queues along with their agents for given Sub-Account and duration.\n\nRate limit: This operation is throttled per RingCX sub-account at 3 requests per 60 seconds and 9 requests per 15 minutes.", "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2026-03-02 09:00:00\",\n \"endDate\": \"2026-03-02 12:00:00\",\n \"timeInterval\": 15,\n \"timeZone\": \"US/Eastern\",\n \"outputFormat\": \"CSV\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/agg-agent-extended-stats", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "agg-agent-extended-stats" ] }, "description": "This API returns statistics of all queues along with their agents for given Sub-Account and duration.\n\nRate limit: This operation is throttled per RingCX sub-account at 3 requests per 60 seconds and 9 requests per 15 minutes.", "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2026-03-02 09:00:00\",\n \"endDate\": \"2026-03-02 12:00:00\",\n \"timeInterval\": 15,\n \"timeZone\": \"US/Eastern\",\n \"outputFormat\": \"CSV\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"interval\": 60,\n \"dateTimeFrom\": \"03-04-2024T05:00:00\",\n \"agentId\": 1,\n \"agentName\": \"Test Agent\",\n \"queue\": 5682,\n \"queueName\": \"Queue\",\n \"talkingIxnDur\": 56,\n \"wrapUpDur\": 0,\n \"answIxnCnt\": 1,\n \"transferOutIxnCnt\": 4\n },\n {\n \"interval\": 60,\n \"dateTimeFrom\": \"03-04-2024T06:00:00\",\n \"agentId\": 10693,\n \"agentName\": \"Sample Agent\",\n \"queue\": 5688,\n \"queueName\": \"Support Queue 2\",\n \"talkingIxnDur\": 137,\n \"wrapUpDur\": 5,\n \"answIxnCnt\": 2,\n \"transferOutIxnCnt\": 0\n }\n]" } ] }, { "name": "Builds agent statistics", "id": "a3e2606e-4167-588a-96e8-1723b2d83d06", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/agg-agent-stats", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "agg-agent-stats" ] }, "description": "This API returns statistics of all agents for given sub-account and duration.\n\nRate limit: This operation is throttled per RingCX sub-account at 3 requests per 60 seconds and 9 requests per 15 minutes.", "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2026-03-02 09:00:00\",\n \"endDate\": \"2026-03-02 12:00:00\",\n \"timeInterval\": 15,\n \"timeZone\": \"US/Eastern\",\n \"outputFormat\": \"CSV\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "200 OK", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/agg-agent-stats", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "agg-agent-stats" ] }, "description": "This API returns statistics of all agents for given sub-account and duration.\n\nRate limit: This operation is throttled per RingCX sub-account at 3 requests per 60 seconds and 9 requests per 15 minutes.", "body": { "mode": "raw", "raw": "{\n \"startDate\": \"2026-03-02 09:00:00\",\n \"endDate\": \"2026-03-02 12:00:00\",\n \"timeInterval\": 15,\n \"timeZone\": \"US/Eastern\",\n \"outputFormat\": \"CSV\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"interval\": 60,\n \"dateTimeFrom\": \"03-04-2024T08:00:00\",\n \"agentId\": 33,\n \"agentName\": \"Test Agent\",\n \"availDur\": 3376,\n \"totWorkDur\": 3376,\n \"pauseDur\": 900,\n \"waitDur\": 2476,\n \"adminDur\": 0,\n \"directOutIxnCnt\": 0,\n \"directOutIxnDur\": 0,\n \"directInIxnCnt\": 0,\n \"directInIxnDur\": 0\n },\n {\n \"interval\": 60,\n \"dateTimeFrom\": \"03-04-2024T09:00:00\",\n \"agentId\": 132598,\n \"agentName\": \"Sample Agent 2\",\n \"availDur\": 117,\n \"totWorkDur\": 117,\n \"pauseDur\": 0,\n \"waitDur\": 113,\n \"adminDur\": 0,\n \"directOutIxnCnt\": 0,\n \"directOutIxnDur\": 0,\n \"directInIxnCnt\": 1,\n \"directInIxnDur\": 5\n }\n]" } ] } ], "description": "Access public RingCX integration reporting and media endpoints." }, { "name": "Agent State Subscriptions", "item": [ { "name": "List agent state subscriptions", "id": "169ad409-4d3b-5cf7-8aa8-8a5714900219", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/agent-states/subscriptions", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "agent-states", "subscriptions" ] }, "description": "Permissions: WFO_ACCESS role" }, "response": [] }, { "name": "Create agent state subscription", "id": "d3a6ccbf-f442-5cff-8fab-f56fa4a2eda8", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/agent-states/subscriptions", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "agent-states", "subscriptions" ] }, "description": "Permissions: WFO_ACCESS role", "body": { "mode": "raw", "raw": "{\n \"subscriptionName\": \"\",\n \"notificationUrl\": \"\",\n \"description\": \"\",\n \"retryCount\": 0,\n \"authConfigId\": \"00000000-0000-4000-8000-000000000000\",\n \"active\": false,\n \"customHeaders\": {},\n \"expiresAt\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update agent state subscription", "id": "bdbea71c-8264-5bf8-8f1a-55c0a3280363", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/agent-states/subscriptions/{{subscriptionId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "agent-states", "subscriptions", "{{subscriptionId}}" ] }, "description": "Permissions: WFO_ACCESS role", "body": { "mode": "raw", "raw": "{\n \"subscriptionName\": \"\",\n \"notificationUrl\": \"\",\n \"description\": \"\",\n \"retryCount\": 0,\n \"authConfigId\": \"00000000-0000-4000-8000-000000000000\",\n \"active\": false,\n \"customHeaders\": {},\n \"expiresAt\": 0\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete agent state subscription", "id": "ab1c2a47-741a-56b5-a8ab-73f5f042336a", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/agent-states/subscriptions/{{subscriptionId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "agent-states", "subscriptions", "{{subscriptionId}}" ] }, "description": "Permissions: WFO_ACCESS role" }, "response": [] } ], "description": "Manage subscriptions that deliver RingCX agent-state notifications to external workforce management or monitoring systems." }, { "name": "Remote HTTP Service Groups", "item": [ { "name": "List remote HTTP service groups", "id": "23de5dd6-98b6-5cc4-b7ef-a94b61a3f738", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups?page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups" ], "query": [ { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Account" }, "response": [] }, { "name": "Create remote HTTP service group", "id": "dfeca651-e2e2-598c-b100-03e4960faef6", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups" ] }, "description": "Permissions: CREATE on Account", "body": { "mode": "raw", "raw": "{\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ],\n \"serviceGroupId\": 0,\n \"services\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List remote HTTP service groups with services", "id": "1395da5d-7886-5474-8241-b2b1ff7e72d2", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/withChildren?includePermissions=false", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "withChildren" ], "query": [ { "key": "includePermissions", "value": "false", "disabled": true, "description": "includePermissions" } ] }, "description": "Permissions: READ on Account" }, "response": [] }, { "name": "Get remote HTTP service group", "id": "552a81c7-4e5c-5dc0-9082-69445c36ec8d", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}" ] }, "description": "Permissions: READ on HTTP Service Group" }, "response": [] }, { "name": "Update remote HTTP service group", "id": "c20a5c00-25de-5987-97b6-4cbf5d5720bc", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}" ] }, "description": "Permissions: UPDATE on HTTP Service Group", "body": { "mode": "raw", "raw": "{\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ],\n \"serviceGroupId\": 0,\n \"services\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Manage groups that organize reusable remote HTTP service definitions for an account." }, { "name": "Remote HTTP Services", "item": [ { "name": "List remote HTTP services [GET]", "id": "c3ef3e31-3b16-5a93-a730-64b9bc9c647b", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices?page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices" ], "query": [ { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Web Service Group" }, "response": [] }, { "name": "Create remote HTTP service [POST]", "id": "db4af9f6-5057-5d1e-8e7c-6008a16e3a15", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices" ] }, "description": "Permissions: CREATE on Web Service Group", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ],\n \"serviceGroupId\": 0,\n \"services\": {}\n },\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get remote HTTP service [GET]", "id": "63eebb3e-3942-5775-b04d-07ba3e288fdf", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices/{{serviceId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices", "{{serviceId}}" ] }, "description": "Permissions: READ on Web Service" }, "response": [] }, { "name": "Update remote HTTP service [PUT]", "id": "89f0345b-2e14-567f-9246-bb6b980021c0", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices/{{serviceId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices", "{{serviceId}}" ] }, "description": "Permissions: UPDATE on Web Service", "body": { "mode": "raw", "raw": "{\n \"accountId\": \"\",\n \"enableMappings\": false,\n \"httpPassword\": \"\",\n \"httpServiceConfig\": \"\",\n \"httpServiceGroup\": {\n \"groupName\": \"\",\n \"isDefault\": false,\n \"permissions\": [\n \"CREATE\"\n ],\n \"serviceGroupId\": 0,\n \"services\": {}\n },\n \"httpServiceInputs\": {},\n \"httpUsername\": \"\",\n \"isDebug\": false,\n \"isEnabled\": false,\n \"permissions\": [\n \"CREATE\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Clone remote HTTP service", "id": "24abbd06-779c-575c-9a0c-863072f96a0f", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices/{{serviceId}}/clone?newName=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices", "{{serviceId}}", "clone" ], "query": [ { "key": "newName", "value": "", "disabled": false, "description": "newName" } ] }, "description": "Permissions: READ on Web Service (Permission Override), CREATE on Web Service Group" }, "response": [] }, { "name": "Set remote HTTP service active state", "id": "03d1b938-9dd8-5716-b165-74f13742f1da", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices/{{serviceId}}/setIsActive", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices", "{{serviceId}}", "setIsActive" ] }, "description": "Permissions: UPDATE on Web Service", "body": { "mode": "raw", "raw": "{\n \"isActive\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List remote HTTP services [GET]", "id": "18b83328-b5c8-5de2-a2fd-a8877d1b3f8c", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v2/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices?page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v2", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices" ], "query": [ { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "Permissions: READ on Web Service Group" }, "response": [] }, { "name": "Create remote HTTP service [POST]", "id": "024cbbf3-9932-58f6-b988-1dd3bedc9323", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v2/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v2", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices" ] }, "description": "Create remote HTTP service", "body": { "mode": "raw", "raw": "{\n \"accountId\": 0,\n \"action\": \"\",\n \"authConfigId\": \"\",\n \"enableMappings\": false,\n \"endpoint\": \"\",\n \"httpServiceConfig\": {\n \"content_type\": \"\",\n \"form_data\": [\n {}\n ],\n \"headers\": [\n {}\n ],\n \"json_data\": \"\",\n \"method\": \"GET\",\n \"query_params\": [\n {}\n ],\n \"soap_inputs\": [\n {}\n ],\n \"text_data\": \"\",\n \"type\": \"HTTP\",\n \"xml_data\": \"\"\n },\n \"isDebug\": false,\n \"isEnabled\": false,\n \"operationName\": \"\",\n \"permissions\": [\n \"CREATE\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get remote HTTP service [GET]", "id": "4be254d3-6dce-57c6-9e6b-1c18ee09de23", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v2/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices/{{serviceId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v2", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices", "{{serviceId}}" ] }, "description": "Permissions: READ on Web Service" }, "response": [] }, { "name": "Update remote HTTP service [PUT]", "id": "46ffab19-314e-5e13-bd88-90e02d9764f1", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v2/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices/{{serviceId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v2", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices", "{{serviceId}}" ] }, "description": "Update remote HTTP service", "body": { "mode": "raw", "raw": "{\n \"accountId\": 0,\n \"action\": \"\",\n \"authConfigId\": \"\",\n \"enableMappings\": false,\n \"endpoint\": \"\",\n \"httpServiceConfig\": {\n \"content_type\": \"\",\n \"form_data\": [\n {}\n ],\n \"headers\": [\n {}\n ],\n \"json_data\": \"\",\n \"method\": \"GET\",\n \"query_params\": [\n {}\n ],\n \"soap_inputs\": [\n {}\n ],\n \"text_data\": \"\",\n \"type\": \"HTTP\",\n \"xml_data\": \"\"\n },\n \"isDebug\": false,\n \"isEnabled\": false,\n \"operationName\": \"\",\n \"permissions\": [\n \"CREATE\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete remote HTTP service", "id": "626871f6-9317-5cae-b9aa-03f284b84d7c", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v2/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices/{{serviceId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v2", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices", "{{serviceId}}" ] }, "description": "Delete remote HTTP service" }, "response": [] } ], "description": "Manage reusable external HTTP and SOAP service definitions used by RingCX workflows." }, { "name": "Remote HTTP Service Inputs", "item": [ { "name": "List remote HTTP service inputs", "id": "0361b063-9212-5e48-8d33-e7d8e4090cbd", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices/{{serviceId}}/inputs", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices", "{{serviceId}}", "inputs" ] }, "description": "Permissions: READ on HTTP Service" }, "response": [] }, { "name": "Create remote HTTP service input", "id": "dcae4aa9-2f07-5de2-895a-f5782d958f9a", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices/{{serviceId}}/inputs", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices", "{{serviceId}}", "inputs" ] }, "description": "Permissions: UPDATE on HTTP Service", "body": { "mode": "raw", "raw": "[\n {\n \"inputId\": 0,\n \"name\": \"\",\n \"rank\": \"\",\n \"simpleDataType\": \"\",\n \"type\": \"\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get remote HTTP service input", "id": "3a1af3aa-f2af-54b6-b14b-d33dbb6fb38c", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices/{{serviceId}}/inputs/{{inputId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices", "{{serviceId}}", "inputs", "{{inputId}}" ] }, "description": "Permissions: READ on HTTP Service" }, "response": [] }, { "name": "Delete remote HTTP service input", "id": "da432c24-6d8b-5883-8601-b5ddf64dc603", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/httpServiceGroups/{{serviceGroupId}}/httpServices/{{serviceId}}/inputs/{{inputId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "httpServiceGroups", "{{serviceGroupId}}", "httpServices", "{{serviceId}}", "inputs", "{{inputId}}" ] }, "description": "Permissions: UPDATE on HTTP Service" }, "response": [] } ], "description": "Manage input mappings that pass RingCX runtime values into remote HTTP services." }, { "name": "External Auth Configurations", "item": [ { "name": "List external auth configurations", "id": "40b7f87b-9c91-5472-83e7-91d9b2b931d3", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/external/authConfigs?page=0&maxRows=0", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "external", "authConfigs" ], "query": [ { "key": "page", "value": "0", "disabled": true, "description": "page" }, { "key": "maxRows", "value": "0", "disabled": true, "description": "maxRows" } ] }, "description": "List external auth configurations" }, "response": [] }, { "name": "Get external auth OAuth metadata", "id": "5f3082d9-609e-5b17-93ba-000a9efe8767", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/external/authConfigs/oauth/info?oauthProvider=", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "external", "authConfigs", "oauth", "info" ], "query": [ { "key": "oauthProvider", "value": "", "disabled": false, "description": "oauthProvider" } ] }, "description": "Get external auth OAuth metadata" }, "response": [] }, { "name": "Get external auth configuration", "id": "d3c84479-b403-5d12-840c-d6f677738626", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/external/authConfigs/{{authConfigId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "external", "authConfigs", "{{authConfigId}}" ] }, "description": "Get external auth configuration" }, "response": [] }, { "name": "Delete external auth configuration", "id": "3e91470b-2495-53f5-9482-a1036f02a3a9", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/external/authConfigs/{{authConfigId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "external", "authConfigs", "{{authConfigId}}" ] }, "description": "Delete external auth configuration" }, "response": [] }, { "name": "Create API key external auth configuration", "id": "2495def5-94de-5308-acf2-377b55151221", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/external/authConfigs/{{authConfigId}}/apiKey", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "external", "authConfigs", "{{authConfigId}}", "apiKey" ] }, "description": "Create API key external auth configuration", "body": { "mode": "raw", "raw": "{\n \"apiKey\": \"\",\n \"providerName\": \"\",\n \"authConfigId\": \"00000000-0000-4000-8000-000000000000\",\n \"authType\": \"APIKEY\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"updatedTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update API key external auth configuration", "id": "a44408eb-7342-527b-b127-6728b9d48f63", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/external/authConfigs/{{authConfigId}}/apiKey", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "external", "authConfigs", "{{authConfigId}}", "apiKey" ] }, "description": "Update API key external auth configuration", "body": { "mode": "raw", "raw": "{\n \"apiKey\": \"\",\n \"providerName\": \"\",\n \"authConfigId\": \"00000000-0000-4000-8000-000000000000\",\n \"authType\": \"APIKEY\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"updatedTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create basic external auth configuration", "id": "a7a2216c-ebff-586a-a71b-17d4d6108f76", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/external/authConfigs/{{authConfigId}}/basic", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "external", "authConfigs", "{{authConfigId}}", "basic" ] }, "description": "Create basic external auth configuration", "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"providerName\": \"\",\n \"username\": \"\",\n \"authConfigId\": \"00000000-0000-4000-8000-000000000000\",\n \"authType\": \"APIKEY\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"updatedTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update basic external auth configuration", "id": "c4b46ef8-9fd6-5fab-93ea-2e3da7bf5a84", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/external/authConfigs/{{authConfigId}}/basic", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "external", "authConfigs", "{{authConfigId}}", "basic" ] }, "description": "Update basic external auth configuration", "body": { "mode": "raw", "raw": "{\n \"password\": \"\",\n \"providerName\": \"\",\n \"username\": \"\",\n \"authConfigId\": \"00000000-0000-4000-8000-000000000000\",\n \"authType\": \"APIKEY\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"updatedTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create custom external auth configuration", "id": "abbc5bd8-9d3f-517c-b9d6-d86ed8f27599", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/external/authConfigs/{{authConfigId}}/customAuth", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "external", "authConfigs", "{{authConfigId}}", "customAuth" ] }, "description": "Create custom external auth configuration", "body": { "mode": "raw", "raw": "{\n \"allowedBaseUrl\": \"\",\n \"authConfigId\": \"00000000-0000-4000-8000-000000000000\",\n \"authType\": \"APIKEY\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"inputParams\": [\n {}\n ],\n \"providerName\": \"\",\n \"updatedTime\": \"\",\n \"wcgFunctionId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update custom external auth configuration", "id": "2ca01399-36d9-5d05-97b6-7e43a57fadc8", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/external/authConfigs/{{authConfigId}}/customAuth", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "external", "authConfigs", "{{authConfigId}}", "customAuth" ] }, "description": "Update custom external auth configuration", "body": { "mode": "raw", "raw": "{\n \"allowedBaseUrl\": \"\",\n \"authConfigId\": \"00000000-0000-4000-8000-000000000000\",\n \"authType\": \"APIKEY\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"inputParams\": [\n {}\n ],\n \"providerName\": \"\",\n \"updatedTime\": \"\",\n \"wcgFunctionId\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create JWT external auth configuration", "id": "513bb7e1-cead-5c75-ac9a-56e902ac8ffa", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/external/authConfigs/{{authConfigId}}/jwt", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "external", "authConfigs", "{{authConfigId}}", "jwt" ] }, "description": "Create JWT external auth configuration", "body": { "mode": "raw", "raw": "{\n \"addTokenTo\": \"REQUEST_HEADER\",\n \"algorithm\": \"\",\n \"payload\": \"\",\n \"providerName\": \"\",\n \"authConfigId\": \"00000000-0000-4000-8000-000000000000\",\n \"authType\": \"APIKEY\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"expirationTime\": 0,\n \"headerPrefix\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update JWT external auth configuration", "id": "10f42647-2acd-51ae-8e88-12a2c4466b97", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/external/authConfigs/{{authConfigId}}/jwt", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "external", "authConfigs", "{{authConfigId}}", "jwt" ] }, "description": "Update JWT external auth configuration", "body": { "mode": "raw", "raw": "{\n \"addTokenTo\": \"REQUEST_HEADER\",\n \"algorithm\": \"\",\n \"payload\": \"\",\n \"providerName\": \"\",\n \"authConfigId\": \"00000000-0000-4000-8000-000000000000\",\n \"authType\": \"APIKEY\",\n \"createdTime\": \"\",\n \"description\": \"\",\n \"expirationTime\": 0,\n \"headerPrefix\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Create OAuth external auth configuration", "id": "c2a6d471-c388-563b-9ee6-0518536fe3ac", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/external/authConfigs/{{authConfigId}}/oauth", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "external", "authConfigs", "{{authConfigId}}", "oauth" ] }, "description": "Create OAuth external auth configuration", "body": { "mode": "raw", "raw": "{\n \"clientId\": \"\",\n \"grantType\": \"CLIENT_CREDENTIALS\",\n \"providerName\": \"\",\n \"secret\": \"\",\n \"tokenUrl\": \"\",\n \"assertion\": \"\",\n \"authConfigId\": \"00000000-0000-4000-8000-000000000000\",\n \"authType\": \"APIKEY\",\n \"clientCredentialsSupplyIn\": \"BODY\",\n \"createdTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update OAuth external auth configuration", "id": "4cee597d-7a6d-5de1-9d87-bf79d509ba0b", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/v1/admin/accounts/{{rcx_sub_account_id}}/external/authConfigs/{{authConfigId}}/oauth", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "v1", "admin", "accounts", "{{rcx_sub_account_id}}", "external", "authConfigs", "{{authConfigId}}", "oauth" ] }, "description": "Update OAuth external auth configuration", "body": { "mode": "raw", "raw": "{\n \"clientId\": \"\",\n \"grantType\": \"CLIENT_CREDENTIALS\",\n \"providerName\": \"\",\n \"secret\": \"\",\n \"tokenUrl\": \"\",\n \"assertion\": \"\",\n \"authConfigId\": \"00000000-0000-4000-8000-000000000000\",\n \"authType\": \"APIKEY\",\n \"clientCredentialsSupplyIn\": \"BODY\",\n \"createdTime\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ], "description": "Manage reusable authentication configurations for outbound remote HTTP service calls." } ] }, { "name": "Workforce", "item": [ { "name": "Media Control", "item": [ { "name": "Start segment media stream", "id": "22d90f95-77b6-50e8-8f8e-9380ea0172da", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/dialogs/{{dialogId}}/segments/{{segmentId}}/streams", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "dialogs", "{{dialogId}}", "segments", "{{segmentId}}", "streams" ] }, "description": "Start segment media stream", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"encoding\": \"\",\n \"ptime\": 0,\n \"rate\": 0\n },\n \"streamId\": \"\",\n \"token\": \"\",\n \"url\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Stop segment media stream", "id": "b17ad1aa-0f29-546b-aed7-c60454d7f929", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/dialogs/{{dialogId}}/segments/{{segmentId}}/streams/{{streamId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "dialogs", "{{dialogId}}", "segments", "{{segmentId}}", "streams", "{{streamId}}" ] }, "description": "Stop segment media stream" }, "response": [] }, { "name": "Start dialog media stream", "id": "28754482-dbdf-5e02-b2e9-e41219656f1e", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" }, { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/dialogs/{{dialogId}}/streams", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "dialogs", "{{dialogId}}", "streams" ] }, "description": "Start dialog media stream", "body": { "mode": "raw", "raw": "{\n \"properties\": {\n \"encoding\": \"\",\n \"ptime\": 0,\n \"rate\": 0\n },\n \"streamId\": \"\",\n \"token\": \"\",\n \"url\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Stop dialog media stream", "id": "b46e7df5-9e5e-5e75-851d-342cab7a37e4", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{ringcx_base_url}}/voice/api/cx/integration/v1/accounts/{{rc_account_uid}}/sub-accounts/{{rcx_sub_account_id}}/dialogs/{{dialogId}}/streams/{{streamId}}", "host": [ "{{ringcx_base_url}}" ], "path": [ "voice", "api", "cx", "integration", "v1", "accounts", "{{rc_account_uid}}", "sub-accounts", "{{rcx_sub_account_id}}", "dialogs", "{{dialogId}}", "streams", "{{streamId}}" ] }, "description": "Stop dialog media stream" }, "response": [] } ], "description": "Start and stop live audio streams for RingCX dialogs and dialog segments." } ] } ] }