diff --git a/specs/engage-voice_openapi3.json b/specs/engage-voice_openapi3.json index c5c6101..271fee2 100644 --- a/specs/engage-voice_openapi3.json +++ b/specs/engage-voice_openapi3.json @@ -309,7 +309,9 @@ "type": "boolean" }, "endDate": { - "$ref": "#/components/schemas/DateTime" + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, "ftpHost": { "type": "string" @@ -425,7 +427,9 @@ "type": "string" }, "startDate": { - "$ref": "#/components/schemas/DateTime" + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, "tcpaSafeMode": { "type": "boolean" @@ -483,159 +487,6 @@ }, "type": "object" }, - "AccountCallerId": { - "properties": { - "accountId": { - "type": "string" - }, - "callerId": { - "type": "string" - }, - "callerIdId": { - "format": "int32", - "type": "integer" - }, - "description": { - "type": "string" - } - }, - "type": "object" - }, - "AccountCreationRequest": { - "properties": { - "accountName": { - "type": "string" - }, - "databaseShardId": { - "type": "string" - }, - "defaultIntellidialServerId": { - "format": "int32", - "type": "integer" - }, - "defaultOutdialServerGroupId": { - "format": "int32", - "type": "integer" - }, - "mainAccountId": { - "type": "string" - }, - "pciCompliance": { - "type": "boolean" - }, - "tcpaSafeMode": { - "type": "boolean" - } - }, - "required": [ - "accountName", - "databaseShardId", - "defaultIntellidialServerId", - "defaultOutdialServerGroupId", - "mainAccountId", - "pciCompliance", - "tcpaSafeMode" - ], - "type": "object" - }, - "AccountIntegrationBase": { - "properties": { - "_type": { - "type": "string" - }, - "accountId": { - "type": "string" - }, - "description": { - "type": "string" - }, - "integrationType": { - "type": "string" - }, - "isActive": { - "type": "boolean" - } - }, - "type": "object" - }, - "AccountPrepayProfile": { - "properties": { - "account": { - "$ref": "#/components/schemas/Account" - }, - "accountId": { - "type": "string" - }, - "agent": { - "format": "double", - "type": "number" - }, - "agentVoip": { - "format": "double", - "type": "number" - }, - "inbound": { - "format": "double", - "type": "number" - }, - "inboundTf": { - "format": "double", - "type": "number" - }, - "machineMsgs": { - "format": "double", - "type": "number" - }, - "monitoring": { - "format": "double", - "type": "number" - }, - "offHook": { - "format": "double", - "type": "number" - }, - "offHookVoip": { - "format": "double", - "type": "number" - }, - "outbound": { - "format": "double", - "type": "number" - }, - "transfer": { - "format": "double", - "type": "number" - } - }, - "type": "object" - }, - "AccountSkillStats": { - "properties": { - "accountId": { - "format": "int32", - "type": "integer" - }, - "accountName": { - "type": "string" - }, - "availableCount": { - "format": "int32", - "type": "integer" - }, - "onlineCount": { - "format": "int32", - "type": "integer" - }, - "skillName": { - "type": "string" - }, - "staffedCount": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, "AccountView": { "properties": { "accountId": { @@ -747,996 +598,920 @@ }, "type": "object" }, - "AcdStats": { + "ActiveCallListResponse": { "properties": { - "abandoned": { - "format": "int32", - "type": "integer" - }, - "accepted": { - "format": "int32", - "type": "integer" - }, "accountId": { "type": "string" }, - "active": { - "format": "int32", - "type": "integer" - }, - "available": { - "format": "int32", - "type": "integer" + "agentFirstName": { + "type": "string" }, - "deflected": { - "format": "int32", - "type": "integer" + "agentLastName": { + "type": "string" }, - "gateGroupId": { - "format": "int32", - "type": "integer" + "ani": { + "type": "string" }, - "gateId": { - "format": "int32", - "type": "integer" + "archive": { + "type": "boolean" }, - "gateName": { + "callState": { "type": "string" }, - "groupName": { + "cnam": { "type": "string" }, - "inQueue": { - "format": "int32", - "type": "integer" - }, - "lastUpdate": { - "$ref": "#/components/schemas/DateTime" - }, - "longCall": { - "format": "int32", - "type": "integer" + "dequeueTime": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "longestInQueue": { - "format": "int32", - "type": "integer" + "destinationName": { + "type": "string" }, - "presented": { - "format": "int32", - "type": "integer" + "dnis": { + "type": "string" }, - "routing": { - "format": "int32", - "type": "integer" + "dnisE164": { + "type": "string" }, - "schedule": { + "enqueueTime": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "scheduleOverride": { + "externalId": { "type": "string" }, - "selectable": { + "uii": { + "type": "string" + } + }, + "type": "object" + }, + "ActiveState_boolean_": { + "properties": { + "isActive": { "type": "boolean" - }, - "shortAbandon": { - "format": "int32", - "type": "integer" - }, - "shortCall": { - "format": "int32", - "type": "integer" - }, - "slaFail": { - "format": "int32", - "type": "integer" - }, - "slaPass": { - "format": "int32", - "type": "integer" - }, - "staffed": { - "format": "int32", - "type": "integer" - }, - "successDispositions": { - "format": "int32", - "type": "integer" - }, - "totalAbandonTime": { - "format": "int64", - "type": "integer" - }, - "totalAnswerTime": { - "format": "int64", - "type": "integer" - }, - "totalQueueTime": { - "format": "int64", - "type": "integer" - }, - "totalTalkTime": { - "format": "int64", - "type": "integer" } }, "type": "object" }, - "ActiveCall": { + "AdminUserRequest": { "properties": { - "accountId": { - "type": "string" - }, - "activeCallSessions": { + "children": { "items": { - "$ref": "#/components/schemas/ActiveCallSession" + "$ref": "#/components/schemas/User" }, "type": "array" }, - "agentDisposition": { - "type": "string" - }, - "ani": { + "creationDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "archive": { + "enabled": { "type": "boolean" }, - "auxPhone": { + "firstName": { "type": "string" }, - "billingKey": { + "fullName": { "type": "string" }, - "callFinalResult": { - "format": "int32", - "type": "integer" + "lastName": { + "type": "string" }, - "callState": { + "parentPath": { "type": "string" }, - "callType": { + "phoneNumber": { "type": "string" }, - "campaign": { - "$ref": "#/components/schemas/Campaign" + "phoneNumberE164": { + "type": "string" }, - "campaignLead": { - "$ref": "#/components/schemas/CampaignLead" + "phoneNumbersI18nEnabled": { + "type": "boolean" }, - "cloudProfileId": { - "format": "int32", - "type": "integer" + "rcAccountId": { + "type": "string" }, - "currDequeueEventId": { - "format": "int32", + "rcUserId": { + "format": "int64", "type": "integer" }, - "dequeueAgentSession": { - "$ref": "#/components/schemas/ActiveCallSession" + "regionalSettings": { + "$ref": "#/components/schemas/RegionalSettingRequestResponse" }, - "dequeueAttempts": { - "format": "int32", - "type": "integer" + "roles": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Role" + } }, - "dequeueTime": { - "$ref": "#/components/schemas/DateTime" + "rootUser": { + "type": "boolean" }, - "dialType": { + "userId": { "format": "int32", "type": "integer" }, - "dialerSourceKey": { - "type": "string" + "userManagedByRC": { + "type": "boolean" }, - "dnis": { + "userName": { "type": "string" + } + }, + "type": "object" + }, + "Agent": { + "properties": { + "accountAccess": { + "$ref": "#/components/schemas/CollectionAgentAccountAccess" }, - "dnisE164": { - "type": "string" + "active": { + "type": "boolean" }, - "enqueueTime": { - "$ref": "#/components/schemas/DateTime" + "agentAccountAccess": { + "items": { + "$ref": "#/components/schemas/AgentAccountAccess" + }, + "type": "array" }, - "extraUrlData": { - "type": "string" + "agentChatGroupAccess": { + "items": { + "$ref": "#/components/schemas/AgentChatGroupAccess" + }, + "type": "array" }, - "gate": { - "$ref": "#/components/schemas/Gate" + "agentChatQueueAccesses": { + "$ref": "#/components/schemas/CollectionAgentChatQueueAccess" }, - "iqServerId": { - "type": "string" + "agentDialGroupMembers": { + "$ref": "#/components/schemas/CollectionAgentDialGroupMember" }, - "isLongCall": { - "type": "boolean" + "agentGateAccess": { + "$ref": "#/components/schemas/CollectionAgentGateAccess" }, - "isShortAbandon": { - "type": "boolean" + "agentGateGroupAccess": { + "items": { + "$ref": "#/components/schemas/AgentGateGroupAccess" + }, + "type": "array" }, - "isShortCall": { - "type": "boolean" + "agentGroup": { + "$ref": "#/components/schemas/AgentGroup" }, - "nextDequeueTime": { - "$ref": "#/components/schemas/Timestamp" + "agentId": { + "format": "int32", + "type": "integer" + }, + "agentLoadBalance": { + "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember" + }, + "agentLoadBalanceMembers": { + "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember" }, - "nextSessionId": { + "agentRank": { "format": "int32", "type": "integer" }, - "optOut": { - "type": "boolean" + "agentSkillProfiles": { + "$ref": "#/components/schemas/CollectionAgentSkillProfile" }, - "originatingDnis": { + "agentType": { + "enum": [ + "AGENT", + "SUPERVISOR", + "MULTI_USER", + "MULTI_SUPERVISOR" + ], "type": "string" }, - "outboundDisposition": { - "type": "string" + "allowAgentReports": { + "type": "boolean" }, - "outboundExternid": { - "type": "string" + "allowAgentStats": { + "type": "boolean" }, - "primarySession": { - "$ref": "#/components/schemas/ActiveCallSession" + "allowAutoAnswer": { + "type": "boolean" }, - "priorityQueueEvent": { - "type": "string" + "allowBlended": { + "type": "boolean" }, - "recordingDeleted": { - "format": "int32", - "type": "integer" + "allowCallControl": { + "type": "boolean" }, - "recordingUrl": { - "type": "string" + "allowCampStats": { + "type": "boolean" }, - "safeArchiveDate": { - "$ref": "#/components/schemas/DateTime" + "allowChat": { + "type": "boolean" }, - "skillOverride": { - "type": "string" + "allowChatStats": { + "type": "boolean" }, - "slaPassed": { + "allowChatVoiceConcurrent": { "type": "boolean" }, - "slaQualified": { + "allowCrossGateRequeue": { "type": "boolean" }, - "sourceAppId": { + "allowDirectAgentTransfer": { + "enum": [ + "DIRECT_TRANSFER_DISABLED", + "ALLOW_DIRECT_TRANSFER_TO_SAME_GROUP", + "ALLOW_DIRECT_TRANSFER_TO_ANY_GROUP" + ], "type": "string" }, - "tracId": { - "format": "int32", - "type": "integer" + "allowEndcallforeveryone": { + "type": "boolean" }, - "uii": { + "allowExternalChat": { + "type": "boolean" + }, + "allowFromIpAddresses": { "type": "string" }, - "visualIvrId": { - "format": "int32", - "type": "integer" + "allowGateStats": { + "type": "boolean" }, - "vruSourceKey": { - "type": "string" - } - }, - "type": "object" - }, - "ActiveCallEventHistory": { - "properties": { - "ani": { - "type": "string" + "allowHangup": { + "type": "boolean" }, - "callEventDts": { - "$ref": "#/components/schemas/DateTime" + "allowHistoricalDialing": { + "type": "boolean" }, - "callEventId": { - "format": "int32", - "type": "integer" + "allowHold": { + "type": "boolean" }, - "callEventType": { - "type": "string" + "allowInbound": { + "type": "boolean" }, - "destDnis": { - "type": "string" + "allowInboundIntlTransfer": { + "type": "boolean" }, - "destDnisE164": { - "type": "string" + "allowLeadInserts": { + "type": "boolean" }, - "destId": { - "format": "int32", - "type": "integer" + "allowLoginControl": { + "type": "boolean" }, - "destName": { - "type": "string" + "allowLoginUpdates": { + "type": "boolean" }, - "destType": { - "enum": [ - "CLOUD-PROFILE", - "CLOUD-DESTINATION", - "GATE", - "TRAC", - "CAMPAIGN", - "AGENT", - "IVR", - "VIVR" - ], - "type": "string" + "allowManualCalls": { + "type": "boolean" }, - "destUii": { - "type": "string" + "allowManualIntlCalls": { + "type": "boolean" }, - "dtmfTrap": { - "type": "string" + "allowManualIntlTransfer": { + "type": "boolean" }, - "eventLog": { - "type": "string" + "allowManualOutboundGates": { + "type": "boolean" }, - "origDnis": { - "type": "string" + "allowManualPass": { + "type": "boolean" }, - "origDnisE164": { - "type": "string" + "allowOffHook": { + "type": "boolean" }, - "origId": { - "format": "int32", - "type": "integer" + "allowOutbound": { + "type": "boolean" }, - "origName": { - "type": "string" + "allowRequeue": { + "type": "boolean" }, - "origType": { - "enum": [ - "CLOUD-PROFILE", - "CLOUD-DESTINATION", - "GATE", - "TRAC", - "CAMPAIGN", - "AGENT", - "IVR", - "VIVR" - ], - "type": "string" + "allowSelfAgentStats": { + "type": "boolean" }, - "origUii": { - "type": "string" - } - }, - "type": "object" - }, - "ActiveCallHistory": { - "properties": { - "accountId": { + "allowTransfer": { + "type": "boolean" + }, + "altDefaultLoginDest": { "type": "string" }, - "activeCallEventHistories": { + "chatQueueAssignments": { "items": { - "$ref": "#/components/schemas/ActiveCallEventHistory" + "format": "int32", + "type": "integer" }, "type": "array" }, - "activeCallSessionHistories": { + "createdOn": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" + }, + "defaultAutoAnswerOn": { + "type": "boolean" + }, + "defaultLoginDest": { + "type": "string" + }, + "dialGroupAssignments": { "items": { - "$ref": "#/components/schemas/ActiveCallSessionHistory" + "format": "int32", + "type": "integer" }, "type": "array" }, - "agentDisposition": { + "directAgentExtension": { "type": "string" }, - "agentNameAndType": { - "$ref": "#/components/schemas/AgentNameAndType" + "disableSupervisorMonitoring": { + "type": "boolean" }, - "ani": { + "email": { "type": "string" }, - "archive": { - "format": "int32", - "type": "integer" + "enableSoftphone": { + "type": "boolean" }, - "auxPhone": { + "externalAgentId": { "type": "string" }, - "billingKey": { + "firstName": { "type": "string" }, - "callFinalResult": { - "format": "int32", - "type": "integer" - }, - "callState": { - "type": "string" + "gateAssignments": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" }, - "callType": { - "type": "string" + "gatesControlAgentVisibility": { + "type": "boolean" }, - "currDequeueEventId": { - "format": "int32", - "type": "integer" + "ghostRnaAction": { + "type": "string" }, - "dequeueAttempts": { + "groupId": { "format": "int32", "type": "integer" }, - "dequeueTime": { - "$ref": "#/components/schemas/DateTime" + "initLoginBaseState": { + "type": "string" }, - "dialType": { + "initLoginBaseStateId": { "format": "int32", "type": "integer" }, - "dialTypeString": { - "type": "string" - }, - "dialerSourceKey": { - "type": "string" + "isActive": { + "type": "boolean" }, - "dnis": { + "lastLoginDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "dnisE164": { + "lastName": { "type": "string" }, - "enqueueTime": { - "$ref": "#/components/schemas/DateTime" + "loadBalanceEnabled": { + "type": "boolean" }, - "extraUrlData": { + "location": { "type": "string" }, - "historySource": { - "$ref": "#/components/schemas/HistorySource" + "manualOutboundDefaultCallerId": { + "type": "string" }, - "iqServerId": { + "manualOutboundDefaultCallerIdE164": { "type": "string" }, - "isLongCall": { - "type": "boolean" + "manualOutboundDefaultGate": { + "$ref": "#/components/schemas/Gate" }, - "isShortAbandon": { - "type": "boolean" + "maxChats": { + "format": "int32", + "type": "integer" }, - "isShortCall": { + "multiAccountAgent": { "type": "boolean" }, - "leadId": { + "parentAgentId": { "format": "int32", "type": "integer" }, - "nextDequeueTime": { - "$ref": "#/components/schemas/Timestamp" + "password": { + "type": "string" }, - "nextSessionId": { - "format": "int32", - "type": "integer" + "permissions": { + "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" + }, + "type": "array" }, - "optOut": { - "type": "boolean" + "phoneLoginDialGroup": { + "$ref": "#/components/schemas/DialGroup" }, - "originatingDnis": { + "phoneLoginPin": { "type": "string" }, - "outboundDisposition": { - "type": "string" + "rcUserId": { + "format": "int64", + "type": "integer" + }, + "regionalSettings": { + "$ref": "#/components/schemas/RegionalSettingRequestResponse" }, - "outboundExternid": { + "showLeadHistory": { + "type": "boolean" + }, + "sipPassword": { "type": "string" }, - "priorityQueueEvent": { + "sipSafeUsername": { "type": "string" }, - "recordingDeleted": { + "softphoneId": { "format": "int32", "type": "integer" }, - "recordingUrl": { + "team": { "type": "string" }, - "safeArchiveDate": { - "$ref": "#/components/schemas/DateTime" + "transientAgent": { + "type": "boolean" }, - "scriptResult": { - "type": "string" + "transientDelete": { + "type": "boolean" }, - "skillOverride": { + "transientDeleteDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "slaPassed": { - "type": "boolean" - }, - "slaQualified": { + "userManagedByRC": { "type": "boolean" }, - "sourceAppId": { + "username": { "type": "string" }, - "uii": { - "type": "string" + "whereSupervisee": { + "items": { + "$ref": "#/components/schemas/AgentSupervisor" + }, + "type": "array" }, - "vruSourceKey": { - "type": "string" + "whereSupervisor": { + "$ref": "#/components/schemas/CollectionAgentSupervisor" } }, "type": "object" }, - "ActiveCallListResponse": { + "ActiveStateBoolean": { "properties": { - "accountId": { - "type": "string" - }, - "agentFirstName": { - "type": "string" - }, - "agentLastName": { - "type": "string" - }, - "ani": { - "type": "string" - }, - "archive": { + "isActive": { "type": "boolean" - }, - "callState": { - "type": "string" - }, - "cnam": { - "type": "string" - }, - "dequeueTime": { - "$ref": "#/components/schemas/DateTime" - }, - "destinationName": { - "type": "string" - }, - "dnis": { - "type": "string" - }, - "dnisE164": { - "type": "string" - }, - "enqueueTime": { - "$ref": "#/components/schemas/DateTime" - }, - "externalId": { - "type": "string" - }, - "uii": { - "type": "string" } }, "type": "object" }, - "ActiveCallSession": { + "AgentAccountAccess": { "properties": { - "agentDisposition": { - "type": "string" - }, - "agentLogin": { - "$ref": "#/components/schemas/AgentLogin" - }, - "agentNotes": { - "type": "string" + "account": { + "$ref": "#/components/schemas/Account" }, - "archive": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", + "accountId": { "type": "string" }, - "callDts": { - "$ref": "#/components/schemas/DateTime" - }, - "callerName": { + "accountName": { "type": "string" }, - "carrier": { - "type": "string" + "agent": { + "$ref": "#/components/schemas/Agent" }, - "cloudDestinationId": { + "agentId": { "format": "int32", "type": "integer" }, - "dialDisposition": { + "name": { "type": "string" - }, - "dialDts": { - "$ref": "#/components/schemas/DateTime" - }, - "dialDuration": { + } + }, + "type": "object" + }, + "AgentChatGroupAccess": { + "properties": { + "agentId": { "format": "int32", "type": "integer" }, - "duration": { + "chatGroupId": { "format": "int32", "type": "integer" - }, - "iqServerId": { - "type": "string" - }, - "isDequeueAgent": { + } + }, + "type": "object" + }, + "AgentDialGroupMember": { + "properties": { + "agentId": { "format": "int32", "type": "integer" }, - "isMonitoring": { + "dialGroupId": { "format": "int32", "type": "integer" }, - "onHold": { + "hciClicker": { + "type": "boolean" + } + }, + "type": "object" + }, + "AgentGateAccess": { + "properties": { + "agentId": { "format": "int32", "type": "integer" }, - "phone": { - "type": "string" - }, - "pk": { - "$ref": "#/components/schemas/ActiveCallSessionPK" - }, - "recordingUrl": { - "type": "string" - }, - "safeArchiveDate": { - "$ref": "#/components/schemas/DateTime" - }, - "sessionId": { - "type": "string" - }, - "sessionType": { - "type": "string" - }, - "skillProfileId": { + "agentRank": { "format": "int32", "type": "integer" }, - "termParty": { - "type": "string" - }, - "termReason": { + "defaultDestOverride": { "type": "string" }, - "transferFlag": { - "format": "int32", - "type": "integer" - }, - "wrapTime": { + "gateId": { "format": "int32", "type": "integer" } }, "type": "object" }, - "ActiveCallSessionHistory": { + "AgentGateGroupAccess": { "properties": { - "agentLoginId": { + "agentId": { "format": "int32", "type": "integer" }, - "agentNotes": { - "type": "string" - }, - "archive": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" - }, - "callDts": { - "$ref": "#/components/schemas/DateTime" - }, - "callerName": { - "type": "string" - }, - "carrier": { - "type": "string" - }, - "cloudDestinationId": { + "gateGroupId": { "format": "int32", "type": "integer" + } + }, + "type": "object" + }, + "AgentGroup": { + "properties": { + "account": { + "$ref": "#/components/schemas/Account" }, - "dialDisposition": { - "type": "string" - }, - "dialDts": { - "$ref": "#/components/schemas/DateTime" - }, - "dialDuration": { + "agentGroupId": { "format": "int32", "type": "integer" }, - "duration": { - "format": "int32", - "type": "integer" + "agents": { + "$ref": "#/components/schemas/CollectionAgent" }, - "iqServerId": { + "groupName": { "type": "string" }, - "isDequeueAgent": { - "format": "int32", - "type": "integer" + "isDefault": { + "type": "boolean" }, - "isMonitoring": { - "format": "int32", - "type": "integer" + "permissions": { + "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AgentRequest": { + "properties": { + "accountAccess": { + "items": { + "$ref": "#/components/schemas/AgentAccountAccess" + }, + "type": "array" }, - "onHold": { - "format": "int32", - "type": "integer" + "active": { + "type": "boolean" }, - "phone": { - "type": "string" + "agentAccountAccess": { + "items": { + "$ref": "#/components/schemas/AgentAccountAccess" + }, + "type": "array" }, - "pk": { - "$ref": "#/components/schemas/ActiveCallSessionPK" + "agentChatGroupAccess": { + "items": { + "$ref": "#/components/schemas/AgentChatGroupAccess" + }, + "type": "array" }, - "recordingUrl": { - "type": "string" + "agentChatQueueAccesses": { + "$ref": "#/components/schemas/CollectionAgentChatQueueAccess" }, - "safeArchiveDate": { - "$ref": "#/components/schemas/DateTime" + "agentDialGroupMembers": { + "$ref": "#/components/schemas/CollectionAgentDialGroupMember" }, - "sessionId": { - "type": "string" + "agentGateAccess": { + "items": { + "$ref": "#/components/schemas/AgentGateAccess" + }, + "type": "array" }, - "sessionType": { - "type": "string" + "agentGateGroupAccess": { + "items": { + "$ref": "#/components/schemas/AgentGateGroupAccess" + }, + "type": "array" + }, + "agentGroup": { + "$ref": "#/components/schemas/AgentGroup" }, - "skillProfileId": { + "agentId": { "format": "int32", "type": "integer" }, - "termParty": { - "type": "string" - }, - "termReason": { - "type": "string" + "agentLoadBalance": { + "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember" }, - "transferFlag": { - "format": "int32", - "type": "integer" + "agentLoadBalanceMembers": { + "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember" }, - "wrapTime": { + "agentRank": { "format": "int32", "type": "integer" - } - }, - "type": "object" - }, - "ActiveCallSessionPK": { - "properties": { - "sessionId": { - "type": "string" }, - "uii": { - "type": "string" - } - }, - "type": "object" - }, - "ActiveCallUniqueId": { - "properties": { - "ani": { - "type": "string" + "agentSkillProfiles": { + "items": { + "$ref": "#/components/schemas/AgentSkillProfile" + }, + "type": "array" }, - "dnis": { + "agentType": { + "enum": [ + "AGENT", + "SUPERVISOR", + "MULTI_USER", + "MULTI_SUPERVISOR" + ], "type": "string" }, - "dnisE164": { - "type": "string" + "allowAgentReports": { + "type": "boolean" }, - "originatingDnis": { - "type": "string" - } - }, - "type": "object" - }, - "ActiveChat": { - "properties": { - "accountId": { - "type": "string" + "allowAgentStats": { + "type": "boolean" }, - "activeChatSessions": { - "items": { - "$ref": "#/components/schemas/ActiveChatSession" - }, - "type": "array" + "allowAutoAnswer": { + "type": "boolean" }, - "agentDisposition": { - "type": "string" + "allowBlended": { + "type": "boolean" }, - "ani": { - "type": "string" + "allowCallControl": { + "type": "boolean" }, - "archive": { - "format": "int32", - "type": "integer" + "allowCampStats": { + "type": "boolean" }, - "billingKey": { - "type": "string" + "allowChat": { + "type": "boolean" }, - "browserInfo": { - "type": "string" + "allowChatStats": { + "type": "boolean" }, - "channelType": { - "type": "string" + "allowChatVoiceConcurrent": { + "type": "boolean" }, - "chatQueueId": { - "format": "int32", - "type": "integer" + "allowCrossGateRequeue": { + "type": "boolean" }, - "chatState": { + "allowDirectAgentTransfer": { "enum": [ - "CHAT_PREQUEUED", - "CHAT_QUEUED", - "CHAT_DEQUEUE_1", - "CHAT_DEQUEUE_2", - "CHAT_ACTIVE", - "CHAT_COMPLETED", - "CHAT_PQUEUED", - "CHAT_END", - "CHAT_IP_BLOCKED", - "CHAT_QUEUE_CLOSED", - "CHAT_NO_AGENTS", - "CHAT_MAX_QUEUE", - "CHAT_THROTTLE", - "CHAT_DISCONNECT" + "DIRECT_TRANSFER_DISABLED", + "ALLOW_DIRECT_TRANSFER_TO_SAME_GROUP", + "ALLOW_DIRECT_TRANSFER_TO_ANY_GROUP" ], "type": "string" }, - "currDequeueEventId": { - "format": "int32", - "type": "integer" + "allowEndcallforeveryone": { + "type": "boolean" }, - "dequeueAgentSession": { - "$ref": "#/components/schemas/ActiveChatSession" + "allowExternalChat": { + "type": "boolean" }, - "dequeueAttempts": { - "format": "int32", - "type": "integer" + "allowFromIpAddresses": { + "type": "string" }, - "dequeueTime": { - "$ref": "#/components/schemas/DateTime" + "allowGateStats": { + "type": "boolean" }, - "dnis": { - "type": "string" + "allowHangup": { + "type": "boolean" }, - "dnisE164": { - "type": "string" + "allowHistoricalDialing": { + "type": "boolean" }, - "enqueueTime": { - "$ref": "#/components/schemas/DateTime" + "allowHold": { + "type": "boolean" }, - "jsonBaggage": { - "type": "string" + "allowInbound": { + "type": "boolean" }, - "nextDequeueTime": { - "$ref": "#/components/schemas/DateTime" + "allowInboundIntlTransfer": { + "type": "boolean" }, - "safeArchiveDate": { - "$ref": "#/components/schemas/DateTime" + "allowLeadInserts": { + "type": "boolean" }, - "skillOverride": { - "type": "string" + "allowLoginControl": { + "type": "boolean" }, - "sourceIp": { - "type": "string" + "allowLoginUpdates": { + "type": "boolean" }, - "uii": { - "type": "string" - } - }, - "type": "object" - }, - "ActiveChatSession": { - "properties": { - "agentDisposition": { - "type": "string" + "allowManualCalls": { + "type": "boolean" }, - "agentLogin": { - "$ref": "#/components/schemas/AgentLogin" + "allowManualIntlCalls": { + "type": "boolean" }, - "agentNotes": { - "type": "string" + "allowManualIntlTransfer": { + "type": "boolean" }, - "archive": { + "allowManualOutboundGates": { "type": "boolean" }, - "dequeueAgent": { + "allowManualPass": { "type": "boolean" }, - "iqServerId": { - "type": "string" + "allowOffHook": { + "type": "boolean" }, - "isDequeueAgent": { + "allowOutbound": { "type": "boolean" }, - "safeArchiveDate": { - "$ref": "#/components/schemas/DateTime" + "allowRequeue": { + "type": "boolean" }, - "sessionEnd": { - "$ref": "#/components/schemas/DateTime" + "allowSelfAgentStats": { + "type": "boolean" }, - "sessionId": { - "format": "int32", - "type": "integer" + "allowTransfer": { + "type": "boolean" + }, + "altDefaultLoginDest": { + "type": "string" }, - "sessionStart": { - "$ref": "#/components/schemas/DateTime" + "chatQueueAssignments": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" }, - "sessionType": { + "createdOn": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "skillProfileId": { - "format": "int32", - "type": "integer" + "defaultAutoAnswerOn": { + "type": "boolean" }, - "termParty": { + "defaultLoginDest": { "type": "string" }, - "termReason": { + "dialGroupAssignments": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" + }, + "directAgentExtension": { "type": "string" }, - "uii": { + "disableSupervisorMonitoring": { + "type": "boolean" + }, + "email": { "type": "string" - } - }, - "type": "object" - }, - "ActiveState_boolean_": { - "properties": { - "isActive": { - "type": "boolean" - } - }, - "type": "object" - }, - "ActiveStateboolean": { - "properties": { - "isActive": { + }, + "enableSoftphone": { "type": "boolean" - } - }, - "type": "object" - }, - "ActiveStateint": { - "properties": { - "isActive": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "AdminUserRequest": { - "properties": { - "children": { + }, + "externalAgentId": { + "type": "string" + }, + "firstName": { + "type": "string" + }, + "gateAssignments": { "items": { - "$ref": "#/components/schemas/User" + "format": "int32", + "type": "integer" }, "type": "array" }, - "creationDate": { - "$ref": "#/components/schemas/DateTime" - }, - "enabled": { + "gatesControlAgentVisibility": { "type": "boolean" }, - "firstName": { + "ghostRnaAction": { "type": "string" }, - "fullName": { + "groupId": { + "format": "int32", + "type": "integer" + }, + "initLoginBaseState": { + "type": "string" + }, + "initLoginBaseStateId": { + "format": "int32", + "type": "integer" + }, + "isActive": { + "type": "boolean" + }, + "lastLoginDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, "lastName": { "type": "string" }, - "parentPath": { + "loadBalanceEnabled": { + "type": "boolean" + }, + "location": { "type": "string" }, - "phoneNumber": { + "manualOutboundDefaultCallerId": { "type": "string" }, - "phoneNumberE164": { + "manualOutboundDefaultCallerIdE164": { "type": "string" }, - "phoneNumbersI18nEnabled": { + "manualOutboundDefaultGate": { + "$ref": "#/components/schemas/Gate" + }, + "maxChats": { + "format": "int32", + "type": "integer" + }, + "multiAccountAgent": { "type": "boolean" }, - "rcAccountId": { + "parentAgentId": { + "format": "int32", + "type": "integer" + }, + "password": { + "type": "string" + }, + "permissions": { + "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" + }, + "type": "array" + }, + "phoneLoginDialGroup": { + "$ref": "#/components/schemas/DialGroup" + }, + "phoneLoginPin": { "type": "string" }, + "phoneNumbersI18nEnabled": { + "type": "boolean" + }, "rcUserId": { "format": "int64", "type": "integer" @@ -1744,9237 +1519,3221 @@ "regionalSettings": { "$ref": "#/components/schemas/RegionalSettingRequestResponse" }, - "roles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Role" - } - }, - "rootUser": { + "showLeadHistory": { "type": "boolean" }, - "userId": { + "sipPassword": { + "type": "string" + }, + "sipSafeUsername": { + "type": "string" + }, + "softphoneId": { "format": "int32", "type": "integer" }, + "team": { + "type": "string" + }, + "transientAgent": { + "type": "boolean" + }, + "transientDelete": { + "type": "boolean" + }, + "transientDeleteDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" + }, "userManagedByRC": { "type": "boolean" }, - "userName": { + "username": { "type": "string" + }, + "whereSupervisee": { + "items": { + "$ref": "#/components/schemas/AgentSupervisor" + }, + "type": "array" + }, + "whereSupervisor": { + "$ref": "#/components/schemas/CollectionAgentSupervisor" } }, "type": "object" }, - "Agent": { + "AgentSkillProfile": { "properties": { - "accountAccess": { - "$ref": "#/components/schemas/CollectionAgentAccountAccess" + "chatGroupSkills": { + "items": { + "$ref": "#/components/schemas/ChatGroupSkill" + }, + "type": "array" }, - "active": { + "createdOn": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" + }, + "default": { "type": "boolean" }, - "agentAccountAccess": { + "gateGroupSkills": { "items": { - "$ref": "#/components/schemas/AgentAccountAccess" + "$ref": "#/components/schemas/GateGroupSkill" }, "type": "array" }, - "agentChatGroupAccess": { + "groupSkills": { "items": { - "$ref": "#/components/schemas/AgentChatGroupAccess" + "$ref": "#/components/schemas/GateGroupSkill" }, "type": "array" }, - "agentChatQueueAccesses": { - "$ref": "#/components/schemas/CollectionAgentChatQueueAccess" - }, - "agentDialGroupMembers": { - "$ref": "#/components/schemas/CollectionAgentDialGroupMember" - }, - "agentGateAccess": { - "$ref": "#/components/schemas/CollectionAgentGateAccess" + "isDefault": { + "type": "boolean" }, - "agentGateGroupAccess": { - "items": { - "$ref": "#/components/schemas/AgentGateGroupAccess" - }, - "type": "array" + "profileDesc": { + "type": "string" }, - "agentGroup": { - "$ref": "#/components/schemas/AgentGroup" + "profileId": { + "format": "int32", + "type": "integer" }, + "profileName": { + "type": "string" + } + }, + "type": "object" + }, + "AgentSupervisor": { + "properties": { "agentId": { "format": "int32", "type": "integer" }, - "agentLoadBalance": { - "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember" + "supervisorId": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "AgentV2": { + "properties": { + "accountId": { + "type": "string" }, - "agentLoadBalanceMembers": { - "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember" + "accountName": { + "type": "string" }, - "agentRank": { + "agentGroupId": { "format": "int32", "type": "integer" }, - "agentSkillProfiles": { - "$ref": "#/components/schemas/CollectionAgentSkillProfile" + "agentId": { + "format": "int32", + "type": "integer" + }, + "agentRank": { + "format": "int32", + "type": "integer" }, "agentType": { - "enum": [ - "AGENT", - "SUPERVISOR", - "MULTI_USER", - "MULTI_SUPERVISOR" - ], "type": "string" }, - "allowAgentReports": { + "allowLoginControl": { "type": "boolean" }, - "allowAgentStats": { + "allowLoginUpdates": { "type": "boolean" }, - "allowAutoAnswer": { - "type": "boolean" + "altDefaultLoginDest": { + "type": "string" }, - "allowBlended": { - "type": "boolean" + "directAgentExtension": { + "type": "string" }, - "allowCallControl": { - "type": "boolean" + "email": { + "type": "string" }, - "allowCampStats": { + "enableSoftphone": { "type": "boolean" }, - "allowChat": { - "type": "boolean" + "externalAgentId": { + "type": "string" }, - "allowChatStats": { - "type": "boolean" - }, - "allowChatVoiceConcurrent": { - "type": "boolean" + "firstName": { + "type": "string" }, - "allowCrossGateRequeue": { - "type": "boolean" + "ghostRnaAction": { + "type": "string" }, - "allowDirectAgentTransfer": { - "enum": [ - "DIRECT_TRANSFER_DISABLED", - "ALLOW_DIRECT_TRANSFER_TO_SAME_GROUP", - "ALLOW_DIRECT_TRANSFER_TO_ANY_GROUP" - ], + "initLoginBaseState": { "type": "string" }, - "allowEndcallforeveryone": { - "type": "boolean" + "lastName": { + "type": "string" }, - "allowExternalChat": { - "type": "boolean" + "location": { + "type": "string" }, - "allowFromIpAddresses": { + "manualOutboundDefaultCallerId": { "type": "string" }, - "allowGateStats": { - "type": "boolean" + "maxChats": { + "format": "int32", + "type": "integer" }, - "allowHangup": { - "type": "boolean" + "password": { + "type": "string" }, - "allowHistoricalDialing": { - "type": "boolean" + "phoneLoginPin": { + "type": "string" }, - "allowHold": { - "type": "boolean" + "rcUserId": { + "format": "int64", + "type": "integer" }, - "allowInbound": { - "type": "boolean" + "team": { + "type": "string" }, - "allowInboundIntlTransfer": { - "type": "boolean" + "username": { + "type": "string" + } + }, + "title": "AgentV2", + "type": "object" + }, + "AmdProfile": { + "properties": { + "accountId": { + "type": "string" }, - "allowLeadInserts": { - "type": "boolean" + "amdAfterGreetingSilence": { + "format": "int32", + "type": "integer" }, - "allowLoginControl": { - "type": "boolean" + "amdBetweenWordSilence": { + "format": "int32", + "type": "integer" }, - "allowLoginUpdates": { - "type": "boolean" + "amdGreeting": { + "format": "int32", + "type": "integer" }, - "allowManualCalls": { - "type": "boolean" + "amdInitSilence": { + "format": "int32", + "type": "integer" }, - "allowManualIntlCalls": { - "type": "boolean" + "amdMaxWords": { + "format": "int32", + "type": "integer" }, - "allowManualIntlTransfer": { - "type": "boolean" + "amdMinWordLength": { + "format": "int32", + "type": "integer" }, - "allowManualOutboundGates": { - "type": "boolean" + "amdProfileId": { + "format": "int32", + "type": "integer" }, - "allowManualPass": { - "type": "boolean" + "amdProfileName": { + "type": "string" }, - "allowOffHook": { - "type": "boolean" + "amdSilenceThreshold": { + "format": "int32", + "type": "integer" }, - "allowOutbound": { - "type": "boolean" + "amdTotalTime": { + "format": "int32", + "type": "integer" }, - "allowRequeue": { - "type": "boolean" + "countOfCampaigns": { + "format": "int32", + "type": "integer" }, - "allowSelfAgentStats": { + "systemDefault": { "type": "boolean" }, - "allowTransfer": { + "systemProfile": { "type": "boolean" + } + }, + "type": "object" + }, + "AssignedDnis": { + "properties": { + "cloudRouteProfile": { + "$ref": "#/components/schemas/CloudRouteProfileSkinny" }, - "altDefaultLoginDest": { + "dnis": { "type": "string" }, - "chatQueueAssignments": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "createdOn": { - "$ref": "#/components/schemas/DateTime" + "dnisDescription": { + "type": "string" }, - "defaultAutoAnswerOn": { - "type": "boolean" + "dnisE164": { + "type": "string" }, - "defaultLoginDest": { + "endDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "dialGroupAssignments": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" + "endPointId": { + "type": "string" }, - "directAgentExtension": { + "endPointType": { "type": "string" }, - "disableSupervisorMonitoring": { + "gate": { + "$ref": "#/components/schemas/GateSkinnyAssignable" + }, + "isActive": { "type": "boolean" }, - "email": { + "originatingDnis": { "type": "string" }, - "enableSoftphone": { + "phoneNumbersI18nEnabled": { "type": "boolean" }, - "externalAgentId": { - "type": "string" - }, - "firstName": { + "startDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "gateAssignments": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" + "tracNumber": { + "$ref": "#/components/schemas/TracNumberSkinny" }, - "gatesControlAgentVisibility": { - "type": "boolean" + "visualIvr": { + "$ref": "#/components/schemas/VisualIvrSkinny" + } + }, + "type": "object" + }, + "AssignedSmsDnis": { + "properties": { + "chatQueue": { + "$ref": "#/components/schemas/ChatQueueSkinny" }, - "ghostRnaAction": { + "dnis": { "type": "string" }, - "groupId": { - "format": "int32", - "type": "integer" + "dnisDescription": { + "type": "string" }, - "initLoginBaseState": { + "dnisE164": { "type": "string" }, - "initLoginBaseStateId": { - "format": "int32", - "type": "integer" + "dnisPool": { + "$ref": "#/components/schemas/DnisPoolV2" + }, + "endDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, "isActive": { "type": "boolean" }, - "lastLoginDate": { - "$ref": "#/components/schemas/DateTime" - }, - "lastName": { + "originatingDnis": { "type": "string" }, - "loadBalanceEnabled": { + "phoneNumbersI18nEnabled": { "type": "boolean" }, - "location": { + "startDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" + } + }, + "type": "object" + }, + "AuditLog": { + "properties": { + "accountId": { "type": "string" }, - "manualOutboundDefaultCallerId": { + "actionType": { + "enum": [ + "DELETE", + "CREATE", + "UPDATE" + ], "type": "string" }, - "manualOutboundDefaultCallerIdE164": { + "affectedEntityJson": { "type": "string" }, - "manualOutboundDefaultGate": { - "$ref": "#/components/schemas/Gate" + "auditLogResultList": { + "items": { + "$ref": "#/components/schemas/AuditLogResult" + }, + "type": "array" }, - "maxChats": { - "format": "int32", - "type": "integer" + "auditedEntityDescription": { + "type": "object" }, - "multiAccountAgent": { - "type": "boolean" + "auditedEntityId": { + "type": "object" }, - "parentAgentId": { - "format": "int32", + "authUser": { + "$ref": "#/components/schemas/AuditLogAuthenticatedUser" + }, + "createTime": { + "format": "int64", "type": "integer" }, - "password": { + "createTimeAsDateTime": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - }, - "phoneLoginDialGroup": { - "$ref": "#/components/schemas/DialGroup" - }, - "phoneLoginPin": { + "description": { "type": "string" }, - "rcUserId": { - "format": "int64", - "type": "integer" - }, - "regionalSettings": { - "$ref": "#/components/schemas/RegionalSettingRequestResponse" - }, - "showLeadHistory": { - "type": "boolean" - }, - "sipPassword": { + "id": { "type": "string" - }, - "sipSafeUsername": { + } + }, + "type": "object" + }, + "AuditLogAuthenticatedUser": { + "properties": { + "firstName": { "type": "string" }, - "softphoneId": { - "format": "int32", - "type": "integer" - }, - "team": { + "fullJson": { "type": "string" }, - "transientAgent": { - "type": "boolean" - }, - "transientDelete": { - "type": "boolean" - }, - "transientDeleteDate": { - "$ref": "#/components/schemas/DateTime" - }, - "userManagedByRC": { - "type": "boolean" + "lastName": { + "type": "string" }, - "username": { + "sourceId": { "type": "string" }, - "whereSupervisee": { - "items": { - "$ref": "#/components/schemas/AgentSupervisor" - }, - "type": "array" + "userId": { + "type": "string" }, - "whereSupervisor": { - "$ref": "#/components/schemas/CollectionAgentSupervisor" - } - }, - "type": "object" - }, - "ActiveStateBoolean": { - "properties": { - "isActive": { - "type": "boolean" + "userName": { + "type": "string" } }, "type": "object" }, - "AgentAccountAccess": { + "AuditLogResult": { "properties": { - "account": { - "$ref": "#/components/schemas/Account" - }, - "accountId": { + "attributeName": { "type": "string" }, - "accountName": { + "classType": { "type": "string" }, - "agent": { - "$ref": "#/components/schemas/Agent" - }, - "agentId": { - "format": "int32", - "type": "integer" + "newValue": { + "type": "object" }, - "name": { - "type": "string" + "originalValue": { + "type": "object" } }, "type": "object" }, - "AgentBlockMonitor": { + "AuditLogSearchCriteria": { "properties": { - "blockMonitorId": { + "accountId": { "type": "string" }, - "duration": { - "format": "int32", - "type": "integer" + "ascOrDesc": { + "enum": [ + "ASCENDING", + "DESCENDING" + ], + "type": "string" }, - "endTime": { - "$ref": "#/components/schemas/DateTime" + "auditActions": { + "items": { + "enum": [ + "DELETE", + "CREATE", + "UPDATE" + ], + "type": "string" + }, + "type": "array" }, - "reason": { + "auditedEntityId": { "type": "string" }, - "recordingUrl": { + "createUserId": { "type": "string" }, - "requestedBy": { + "endDateTime": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "result": { + "endDateTimeAsUnix": { + "format": "int64", + "type": "integer" + }, + "orderBy": { "type": "string" }, - "startTime": { - "$ref": "#/components/schemas/DateTime" + "searchEntities": { + "items": { + "type": "string" + }, + "type": "array" }, - "uii": { + "startDateTime": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" + }, + "startDateTimeAsUnix": { + "format": "int64", + "type": "integer" } }, "type": "object" }, - "AgentChatGroupAccess": { + "Auditable": { "properties": { - "agentId": { - "format": "int32", - "type": "integer" + "fullPath": { + "type": "string" }, - "chatGroupId": { - "format": "int32", - "type": "integer" + "name": { + "type": "string" } }, "type": "object" }, - "AgentChatQueueAccess": { + "AuthConfig": { "properties": { - "agentId": { - "format": "int32", - "type": "integer" - }, - "chatQueue": { - "$ref": "#/components/schemas/ChatQueue" + "authType": { + "enum": [ + "APIKEY", + "JWT", + "BASIC", + "OAUTH", + "CUSTOM_AUTH" + ], + "type": "string" }, - "chatQueueId": { - "format": "int32", - "type": "integer" + "apiKey": { + "type": "string" } }, "type": "object" }, - "AgentDetailsResult": { + "AuthenticatedUser": { "properties": { - "accountId": { + "authToken": { "type": "string" }, - "accountName": { + "description": { "type": "string" }, - "agentGroupId": { - "format": "int32", - "type": "integer" + "id": { + "type": "string" }, - "agentId": { - "format": "int32", - "type": "integer" + "isApiToken": { + "type": "boolean" }, - "agentType": { - "enum": [ - "AGENT", - "SUPERVISOR", - "MULTI_USER", - "MULTI_SUPERVISOR" - ], - "type": "string" + "masterRightsDocs": { + "additionalProperties": { + "$ref": "#/components/schemas/RightsDocument" + }, + "type": "object" }, - "email": { - "type": "string" + "masterRightsDocsValues": { + "$ref": "#/components/schemas/CollectionRightsDocument" }, - "firstName": { + "name": { "type": "string" }, - "lastName": { - "type": "string" + "rightsDocs": { + "additionalProperties": { + "$ref": "#/components/schemas/RightsDocument" + }, + "type": "object" }, - "location": { + "sourceIp": { "type": "string" }, - "rcUserId": { - "format": "int64", - "type": "integer" + "stayLoggedIn": { + "type": "boolean" }, - "team": { - "type": "string" + "superUser": { + "type": "boolean" }, - "username": { - "type": "string" + "user": { + "$ref": "#/components/schemas/User" } }, "type": "object" }, - "AgentDialGroupMember": { + "BaseAgentState": { "properties": { - "agentId": { - "format": "int32", - "type": "integer" + "colKey": { + "type": "string" }, - "dialGroupId": { + "colLabel": { + "type": "string" + }, + "id": { "format": "int32", "type": "integer" }, - "hciClicker": { + "isCore": { + "type": "boolean" + }, + "isRequired": { "type": "boolean" + }, + "name": { + "type": "string" } }, "type": "object" }, - "AgentGateAccess": { + "BaseCsvDto": { + "type": "object" + }, + "Blob": { "properties": { - "agentId": { - "format": "int32", - "type": "integer" - }, - "agentRank": { - "format": "int32", - "type": "integer" - }, - "defaultDestOverride": { - "type": "string" - }, - "gateId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "AgentGateGroupAccess": { - "properties": { - "agentId": { - "format": "int32", - "type": "integer" - }, - "gateGroupId": { - "format": "int32", - "type": "integer" + "binaryStream": { + "$ref": "#/components/schemas/InputStream" } }, "type": "object" }, - "AgentGateLoginRequest": { + "CallerIdBucket": { "properties": { - "action": { - "enum": [ - "ADD", - "REMOVE" - ], + "accountId": { "type": "string" }, - "agentGroupId": { - "format": "int32", - "type": "integer" - }, - "agentId": { - "format": "int32", - "type": "integer" - }, - "gateIds": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - } - }, - "type": "object" - }, - "AgentGroup": { - "properties": { - "account": { - "$ref": "#/components/schemas/Account" + "active": { + "type": "boolean" }, - "agentGroupId": { + "bucketId": { "format": "int32", "type": "integer" }, - "agents": { - "$ref": "#/components/schemas/CollectionAgent" - }, - "groupName": { + "bucketName": { "type": "string" }, - "isDefault": { - "type": "boolean" + "bwOrderId": { + "type": "string" }, - "permissions": { + "callerIdBucketNumbers": { "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" + "$ref": "#/components/schemas/CallerIdBucketNumber" }, "type": "array" - } - }, - "type": "object" - }, - "AgentImportRequest": { - "properties": { - "active": { - "type": "boolean" }, - "agentType": { + "callerIdName": { "type": "string" }, - "allowChat": { - "type": "boolean" - }, - "allowInbound": { - "type": "boolean" - }, - "allowOutbound": { - "type": "boolean" + "createDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "chatQueueAssignmentIds": { + "excludedStates": { "items": { - "format": "int32", - "type": "integer" + "type": "string" }, "type": "array" }, - "dialGroupAssignmentIds": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" + "forwardingDid": { + "type": "string" + }, + "forwardingDidE164": { + "type": "string" }, "isActive": { "type": "boolean" }, - "queueAssignmentIds": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "rcAccountId": { + "orderStatus": { + "enum": [ + "PENDING", + "COMPLETE", + "FAILED", + "DISCONNECT" + ], "type": "string" }, - "rcOfficeUsers": { - "items": { - "$ref": "#/components/schemas/RcOfficeUser" - }, - "type": "array" + "phoneNumbersI18nEnabled": { + "type": "boolean" } }, "type": "object" }, - "AgentLoadBalanceMember": { + "CallerIdBucketNumber": { "properties": { - "masterAgentId": { + "city": { + "type": "string" + }, + "lat": { + "format": "double", + "type": "number" + }, + "lon": { + "format": "double", + "type": "number" + }, + "numberId": { "format": "int32", "type": "integer" }, - "name": { + "state": { "type": "string" }, - "slaveAccountId": { + "tnNumber": { "type": "string" - }, - "slaveAgentId": { - "format": "int32", - "type": "integer" } }, "type": "object" }, - "AgentLoadBalanceMemberPK": { + "Campaign": { "properties": { - "masterAgentId": { - "format": "int32", - "type": "integer" + "abandonMsg": { + "type": "string" }, - "slaveAgentId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "AgentLogin": { - "properties": { - "agent": { - "$ref": "#/components/schemas/Agent" + "afterCallBaseState": { + "type": "string" }, - "agentAuxState": { + "afterCallState": { + "$ref": "#/components/schemas/AccountAuxState" + }, + "agentConnectSoapService": { + "$ref": "#/components/schemas/RemoteHttpService" + }, + "agentPopMessage": { "type": "string" }, - "agentBlockMonitor": { - "$ref": "#/components/schemas/CollectionAgentBlockMonitor" + "agentTermSoapService": { + "$ref": "#/components/schemas/RemoteHttpService" }, - "agentChatState": { + "allowLeadInserts": { + "format": "byte", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type": "string" }, - "agentLoginChatQueues": { - "$ref": "#/components/schemas/CollectionAgentLoginChatQueues" + "allowLeadUpdates": { + "format": "byte", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", + "type": "string" }, - "agentLoginGates": { - "$ref": "#/components/schemas/CollectionAgentLoginGate" + "amdProfileId": { + "$ref": "#/components/schemas/AmdProfile" }, - "agentLoginId": { - "format": "int32", - "type": "integer" + "appUrl": { + "type": "string" }, - "agentLoginType": { + "aux1Label": { "type": "string" }, - "agentOffhookSessions": { - "items": { - "$ref": "#/components/schemas/AgentOffhookSession" - }, - "type": "array" + "aux2Label": { + "type": "string" }, - "agentPhone": { + "aux3Label": { "type": "string" }, - "agentRank": { - "format": "int32", - "type": "integer" + "aux4Label": { + "type": "string" }, - "agentSkillProfile": { - "$ref": "#/components/schemas/AgentSkillProfile" + "aux5Label": { + "type": "string" }, - "agentState": { + "billingCode": { "type": "string" }, - "availableTime": { - "format": "int32", - "type": "integer" + "callerId": { + "type": "string" }, - "awayTime": { - "format": "int32", - "type": "integer" + "callerIdBucket": { + "$ref": "#/components/schemas/CallerIdBucket" }, - "breakTime": { - "format": "int32", - "type": "integer" + "campaignDesc": { + "type": "string" }, - "callsHandled": { - "format": "int32", - "type": "integer" + "campaignDispositions": { + "$ref": "#/components/schemas/CollectionCampaignDisposition" }, - "chatAvailableTime": { - "format": "int32", - "type": "integer" + "campaignFilterStates": { + "$ref": "#/components/schemas/CollectionCampaignFilterStates" }, - "chatEngagedTime": { - "format": "int32", - "type": "integer" + "campaignFilterTimezones": { + "$ref": "#/components/schemas/CollectionCampaignFilterTimezones" }, - "chatPresentedTime": { + "campaignId": { "format": "int32", "type": "integer" }, - "chatRnaTime": { - "format": "int32", - "type": "integer" + "campaignName": { + "type": "string" }, - "chatsHandled": { + "campaignPriority": { "format": "int32", "type": "integer" }, - "currentChatCount": { - "format": "int32", - "type": "integer" + "campaignRequeueShortcuts": { + "$ref": "#/components/schemas/CollectionRequeueShortcut" + }, + "campaignResultDest": { + "$ref": "#/components/schemas/ResultFileDestination" + }, + "campaignUnlimitedFieldGroup": { + "$ref": "#/components/schemas/CampaignUnlimitedFieldGroup" + }, + "campaignWhitelistTagMembers": { + "$ref": "#/components/schemas/CollectionWhitelistTagMembers" + }, + "countryId": { + "type": "string" + }, + "customDialZoneGroup": { + "$ref": "#/components/schemas/CustomDialZoneGroups" }, "dialGroup": { "$ref": "#/components/schemas/DialGroup" }, - "engagedTime": { + "dialLoadedOrder": { "format": "int32", "type": "integer" }, - "exportFlag": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" - }, - "holdTime": { + "dispositionTimeout": { "format": "int32", "type": "integer" }, - "id": { - "format": "int32", - "type": "integer" + "dncScrubOption": { + "enum": [ + "DO_NOT_SCRUB", + "INTERNAL_AND_NATIONAL", + "INTERNAL_ONLY", + "CELLULAR_AND_INTERNAL", + "CELLULAR_ONLY" + ], + "type": "string" + }, + "enableGlobalPhoneBook": { + "type": "boolean" }, - "ipMapKey": { + "endCallMsg": { "type": "string" }, - "iqServerId": { + "endDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "isGhostLogin": { + "exportFlag": { + "type": "boolean" + }, + "filterEnabled": { "format": "byte", "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type": "string" }, - "lastArchiveStateDts": { - "$ref": "#/components/schemas/DateTime" - }, - "lastCallDts": { - "$ref": "#/components/schemas/DateTime" - }, - "loginDialGroupId": { - "format": "int32", - "type": "integer" - }, - "loginDts": { - "$ref": "#/components/schemas/DateTime" + "filterType": { + "type": "string" }, - "loginHashcode": { + "friSched": { "type": "string" }, - "logoutDts": { - "$ref": "#/components/schemas/DateTime" + "genericKeyValuePairs": { + "type": "string" }, - "lunchTime": { + "groupId": { "format": "int32", "type": "integer" }, - "manualDials": { + "hangupOnDisposition": { "format": "int32", "type": "integer" }, - "monitorAgentId": { + "isActive": { "format": "int32", "type": "integer" }, - "name": { - "type": "string" - }, - "nextCallTime": { - "$ref": "#/components/schemas/DateTime" + "lastPassDts": { + "$ref": "#/components/schemas/Timestamp" }, - "parentAgentId": { - "format": "int32", - "type": "integer" + "liveAnswerMsg": { + "type": "string" }, - "pendingDispTime": { - "format": "int32", - "type": "integer" + "machAnswerMsg": { + "type": "string" }, - "pendingDisposition": { + "machineDetect": { "type": "boolean" }, - "previewDials": { + "maxDailyPasses": { "format": "int32", "type": "integer" }, - "reservedDts": { - "$ref": "#/components/schemas/DateTime" - }, - "reservedUii": { + "maxDailyPassesInclude": { "type": "string" }, - "ringTime": { + "maxDialLimit": { "format": "int32", "type": "integer" }, - "rnaCount": { + "maxPasses": { "format": "int32", "type": "integer" }, - "rnaTime": { + "maxPassesExclude": { + "type": "string" + }, + "maxRingTime": { "format": "int32", "type": "integer" }, - "stateDts": { - "$ref": "#/components/schemas/DateTime" - }, - "trainTime": { + "maxRingTimeTransfer": { "format": "int32", "type": "integer" }, - "workTime": { + "minPredictiveCallsHistory": { "format": "int32", "type": "integer" - } - }, - "type": "object" - }, - "AgentLoginAuthVerifyResult": { - "properties": { - "accountId": { + }, + "monSched": { "type": "string" }, - "agentId": { + "onHoldMsg": { + "type": "string" + }, + "passDelayMin": { "format": "int32", "type": "integer" }, - "agentLoginId": { + "pauseRecordingSec": { "format": "int32", "type": "integer" }, - "authTokens": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "integrations": { + "permissions": { "items": { - "$ref": "#/components/schemas/AccountIntegrationBase" + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" }, "type": "array" - } - }, - "type": "object" - }, - "AgentLoginChatQueues": { - "properties": { - "agentLoginChatQueueId": { - "format": "int64", - "type": "integer" }, - "chatQueue": { - "$ref": "#/components/schemas/ChatQueue" - } - }, - "type": "object" - }, - "AgentLoginGate": { - "properties": { - "agentLoginGateId": { - "format": "int64", - "type": "integer" + "perspectiveRecordingMode": { + "enum": [ + "DISABLED", + "ALL_AGENT_LEGS" + ], + "type": "string" }, - "agentRank": { - "format": "int32", - "type": "integer" + "postCallSoapService": { + "$ref": "#/components/schemas/RemoteHttpService" }, - "destOverride": { + "postDispSoapService": { + "$ref": "#/components/schemas/RemoteHttpService" + }, + "quotaGroup": { + "$ref": "#/components/schemas/QuotaGroup" + }, + "realtimeDncUrl": { "type": "string" }, - "gate": { - "$ref": "#/components/schemas/Gate" - } - }, - "type": "object" - }, - "AgentLoginProductView": { - "properties": { - "agentGroupId": { + "recordCall": { "format": "int32", "type": "integer" }, - "agentId": { - "format": "int32", - "type": "integer" + "recordingInConference": { + "type": "boolean" + }, + "recordingSettings": { + "enum": [ + "RECORD_FULL_CALL", + "AGENT_FULL_CONTROL_DEFAULT_ON", + "AGENT_FULL_CONTROL_DEFAULT_OFF", + "AGENT_PAUSE" + ], + "type": "string" + }, + "requeueType": { + "enum": [ + "ADVANCED", + "RESTRICTED" + ], + "type": "string" }, - "agentLoginId": { + "rescrubInterval": { "format": "int32", "type": "integer" }, - "agentLoginType": { + "satSched": { "type": "string" }, - "agentPhone": { + "script": { + "$ref": "#/components/schemas/Script" + }, + "scrubDisconnectNoanswer": { + "format": "byte", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type": "string" }, - "agentRank": { + "seedAbandonRate": { + "format": "double", + "type": "number" + }, + "seedSuccessRate": { + "format": "double", + "type": "number" + }, + "showLeadInfo": { "format": "int32", "type": "integer" }, - "agentState": { - "type": "string" + "showLeadPasses": { + "type": "boolean" }, - "agentType": { + "showListName": { + "type": "boolean" + }, + "singleChannelEnabled": { + "type": "boolean" + }, + "startDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "email": { + "stopRecordingOnTransfer": { + "type": "boolean" + }, + "sunSched": { "type": "string" }, - "firstName": { + "survey": { + "$ref": "#/components/schemas/Survey" + }, + "surveyPopType": { "type": "string" }, - "isGhostLogin": { - "type": "boolean" + "targetAbandonRate": { + "format": "double", + "type": "number" }, - "isOffhook": { - "type": "boolean" + "thuSched": { + "type": "string" }, - "lastName": { + "trackSpeedToLead": { + "format": "byte", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", + "type": "string" + }, + "transferCallerId": { "type": "string" }, - "loginDts": { - "$ref": "#/components/schemas/DateTime" + "transferTermSoapService": { + "$ref": "#/components/schemas/RemoteHttpService" + }, + "tueSched": { + "type": "string" }, - "pendingDisposition": { + "useGlobalWhitelist": { "type": "boolean" }, - "stateDts": { - "$ref": "#/components/schemas/DateTime" + "wedSched": { + "type": "string" }, - "username": { + "whisperMsg": { "type": "string" - } - }, - "type": "object" - }, - "AgentLoginRequest": { - "properties": { - "defaultDialDest": { + }, + "callingConfiguration": { + "description": "Calling preference mode for the campaign. Use SIMPLE for standard lead-phone dialing or STRATEGIC for persona-based phone selection. This setting is selected when the campaign is created and cannot be changed later.", + "enum": [ + "SIMPLE", + "STRATEGIC" + ], "type": "string" }, - "gateIds": { + "personaCallSchedules": { + "description": "Persona-based calling windows and phone-priority rules for STRATEGIC campaigns.", "items": { - "format": "int32", - "type": "integer" + "$ref": "#/components/schemas/PersonaCallSchedule" }, "type": "array" } }, "type": "object" }, - "AgentNameAndType": { + "CampaignLead": { "properties": { - "agentId": { - "format": "int32", - "type": "integer" - }, - "agentName": { + "address1": { "type": "string" }, - "agentType": { - "type": "string" - } - }, - "type": "object" - }, - "AgentOffhookSession": { - "properties": { - "accountId": { + "address2": { "type": "string" }, - "ani": { + "auxData1": { "type": "string" }, - "archive": { - "format": "int32", - "type": "integer" - }, - "carrier": { + "auxData2": { "type": "string" }, - "dnis": { + "auxData3": { "type": "string" }, - "dnisE164": { + "auxData4": { "type": "string" }, - "endDts": { - "$ref": "#/components/schemas/DateTime" - }, - "iqServerId": { - "format": "int32", - "type": "integer" - }, - "monitoring": { - "format": "int32", - "type": "integer" - }, - "offhookUii": { + "auxData5": { "type": "string" }, - "safeArchiveDate": { - "$ref": "#/components/schemas/DateTime" + "auxExternalUrl": { + "type": "string" }, - "startDts": { - "$ref": "#/components/schemas/DateTime" + "auxGreeting": { + "type": "string" }, - "vruSourceKey": { + "auxPhone": { "type": "string" - } - }, - "type": "object" - }, - "AgentRequest": { - "properties": { - "accountAccess": { - "items": { - "$ref": "#/components/schemas/AgentAccountAccess" - }, - "type": "array" }, - "active": { - "type": "boolean" + "callerId": { + "type": "string" }, - "agentAccountAccess": { - "items": { - "$ref": "#/components/schemas/AgentAccountAccess" - }, - "type": "array" + "campaign": { + "$ref": "#/components/schemas/Campaign" }, - "agentChatGroupAccess": { + "campaignRedials": { "items": { - "$ref": "#/components/schemas/AgentChatGroupAccess" + "$ref": "#/components/schemas/CampaignRedial" }, "type": "array" }, - "agentChatQueueAccesses": { - "$ref": "#/components/schemas/CollectionAgentChatQueueAccess" + "city": { + "type": "string" }, - "agentDialGroupMembers": { - "$ref": "#/components/schemas/CollectionAgentDialGroupMember" + "dupeKeyOverride": { + "format": "int64", + "type": "integer" }, - "agentGateAccess": { - "items": { - "$ref": "#/components/schemas/AgentGateAccess" - }, - "type": "array" + "email": { + "type": "string" }, - "agentGateGroupAccess": { - "items": { - "$ref": "#/components/schemas/AgentGateGroupAccess" + "extendedLeadData": { + "additionalProperties": { + "type": "string" }, - "type": "array" - }, - "agentGroup": { - "$ref": "#/components/schemas/AgentGroup" + "type": "object" }, - "agentId": { - "format": "int32", - "type": "integer" + "externId": { + "type": "string" }, - "agentLoadBalance": { - "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember" + "firstName": { + "type": "string" }, - "agentLoadBalanceMembers": { - "$ref": "#/components/schemas/CollectionAgentLoadBalanceMember" + "gateKeeper": { + "type": "string" }, - "agentRank": { + "id": { "format": "int32", "type": "integer" }, - "agentSkillProfiles": { - "items": { - "$ref": "#/components/schemas/AgentSkillProfile" - }, - "type": "array" + "lastName": { + "type": "string" }, - "agentType": { + "lastPassDisposition": { "enum": [ - "AGENT", - "SUPERVISOR", - "MULTI_USER", - "MULTI_SUPERVISOR" + "ANSWER", + "NOANSWER", + "BUSY", + "MACHINE", + "INTERCEPT", + "DISCONNECT", + "ABANDON", + "CONGESTION", + "MANUAL_PASS", + "INBOUND_CALLBACK", + "APP_DNC", + "APP_REQUEUE", + "APP_REQUEUE_COMPLETE", + "APP_REQUEUE_ABANDON", + "INBOUND_ABANDON", + "API_BLOCKED", + "API_ERROR" ], "type": "string" }, - "allowAgentReports": { - "type": "boolean" - }, - "allowAgentStats": { - "type": "boolean" - }, - "allowAutoAnswer": { - "type": "boolean" - }, - "allowBlended": { - "type": "boolean" - }, - "allowCallControl": { - "type": "boolean" + "lastPassDts": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "allowCampStats": { - "type": "boolean" + "leadId": { + "format": "int32", + "type": "integer" }, - "allowChat": { - "type": "boolean" + "leadPasses": { + "format": "int32", + "type": "integer" }, - "allowChatStats": { - "type": "boolean" + "leadPhone": { + "description": "Primary lead phone number. For accounts enabled for E.164 or international phone-number handling, provide the primary phone in leadPhoneE164.", + "type": "string" }, - "allowChatVoiceConcurrent": { - "type": "boolean" + "leadPhoneE164": { + "description": "Primary lead phone number in E.164 format. Required for direct lead loading when the account uses E.164 or international phone-number handling.", + "type": "string" }, - "allowCrossGateRequeue": { - "type": "boolean" + "leadPriority": { + "format": "int32", + "type": "integer" }, - "allowDirectAgentTransfer": { + "leadState": { "enum": [ - "DIRECT_TRANSFER_DISABLED", - "ALLOW_DIRECT_TRANSFER_TO_SAME_GROUP", - "ALLOW_DIRECT_TRANSFER_TO_ANY_GROUP" + "ACTIVE", + "AGENT-CALLBACK", + "CALLBACK-CANCELLED", + "CALLBACK", + "CANCELLED", + "COMPLETE", + "DISCONNECTED", + "DO-NOT-CALL", + "INTERCEPT", + "MAX-DIAL-LIMIT", + "PAUSED", + "PENDING-CALLBACK", + "PENDING-ERR", + "PENDING-HCI", + "PENDING", + "READY", + "TRANSITIONED", + "WHITELIST" ], "type": "string" }, - "allowEndcallforeveryone": { - "type": "boolean" + "leadTimezone": { + "type": "string" }, - "allowExternalChat": { - "type": "boolean" + "liveAnswerMessage": { + "type": "string" }, - "allowFromIpAddresses": { + "loadedDts": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "allowGateStats": { - "type": "boolean" + "machAnswerMessage": { + "type": "string" }, - "allowHangup": { - "type": "boolean" + "maxPasses": { + "format": "int32", + "type": "integer" }, - "allowHistoricalDialing": { - "type": "boolean" + "midName": { + "type": "string" }, - "allowHold": { - "type": "boolean" + "name": { + "type": "string" }, - "allowInbound": { - "type": "boolean" + "nextDialTime": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "allowInboundIntlTransfer": { - "type": "boolean" + "quotaTargetIds": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" }, - "allowLeadInserts": { - "type": "boolean" + "quotaTargets": { + "$ref": "#/components/schemas/CollectionQuotaTarget" }, - "allowLoginControl": { - "type": "boolean" + "reserveAgent": { + "description": "Agent ID to reserve this lead for during direct lead loading. If the value is blank, null, omitted, invalid, or refers to an agent without access to the account, the lead is still accepted. Invalid or inaccessible assignments are counted in failedAgentAssignment.", + "example": "980", + "nullable": true, + "type": "string", + "writeOnly": true }, - "allowLoginUpdates": { - "type": "boolean" + "sortCol": { + "type": "string" }, - "allowManualCalls": { - "type": "boolean" + "state": { + "type": "string" }, - "allowManualIntlCalls": { - "type": "boolean" + "stateDts": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "allowManualIntlTransfer": { - "type": "boolean" + "suffix": { + "type": "string" }, - "allowManualOutboundGates": { + "suppressed": { "type": "boolean" }, - "allowManualPass": { - "type": "boolean" - }, - "allowOffHook": { - "type": "boolean" - }, - "allowOutbound": { - "type": "boolean" + "title": { + "type": "string" }, - "allowRequeue": { - "type": "boolean" + "zip": { + "type": "string" }, - "allowSelfAgentStats": { - "type": "boolean" + "personaMapping": { + "description": "Stored mapping of lead phone values to persona phone IDs.", + "readOnly": true, + "type": "string" }, - "allowTransfer": { - "type": "boolean" + "personaPhoneConfig": { + "additionalProperties": { + "type": "string" + }, + "description": "Additional phone numbers for direct lead loading. Keys must exactly match configured persona phone labels, and values are phone numbers for that lead.", + "type": "object" + } + }, + "type": "object" + }, + "CampaignLeadSearchCriteria": { + "properties": { + "address1": { + "type": "string" }, - "altDefaultLoginDest": { + "address2": { "type": "string" }, - "chatQueueAssignments": { + "agentDispositions": { "items": { - "format": "int32", - "type": "integer" + "type": "string" }, "type": "array" }, - "createdOn": { - "$ref": "#/components/schemas/DateTime" + "agentId": { + "format": "int32", + "type": "integer" }, - "defaultAutoAnswerOn": { - "type": "boolean" + "auxData1": { + "type": "string" }, - "defaultLoginDest": { + "auxData2": { "type": "string" }, - "dialGroupAssignments": { + "auxData3": { + "type": "string" + }, + "auxData4": { + "type": "string" + }, + "auxData5": { + "type": "string" + }, + "callerId": { + "type": "string" + }, + "campaignIds": { "items": { "format": "int32", "type": "integer" }, "type": "array" }, - "directAgentExtension": { + "city": { "type": "string" }, - "disableSupervisorMonitoring": { - "type": "boolean" - }, - "email": { + "emailAddress": { "type": "string" }, - "enableSoftphone": { - "type": "boolean" + "externIds": { + "items": { + "type": "string" + }, + "type": "array" }, - "externalAgentId": { + "firstName": { "type": "string" }, - "firstName": { + "lastName": { "type": "string" }, - "gateAssignments": { + "lastPassTimeCriteria": { + "$ref": "#/components/schemas/DateTimeComparableSearchField" + }, + "leadIds": { "items": { "format": "int32", "type": "integer" }, "type": "array" }, - "gatesControlAgentVisibility": { - "type": "boolean" - }, - "ghostRnaAction": { - "type": "string" - }, - "groupId": { - "format": "int32", - "type": "integer" + "leadPassesCriteria": { + "$ref": "#/components/schemas/ComparableSearchField" }, - "initLoginBaseState": { + "leadPhoneNum": { "type": "string" }, - "initLoginBaseStateId": { - "format": "int32", - "type": "integer" - }, - "isActive": { - "type": "boolean" - }, - "lastLoginDate": { - "$ref": "#/components/schemas/DateTime" + "leadPhoneNumbers": { + "items": { + "type": "string" + }, + "type": "array" }, - "lastName": { - "type": "string" + "leadStates": { + "items": { + "enum": [ + "ACTIVE", + "AGENT-CALLBACK", + "CALLBACK-CANCELLED", + "CALLBACK", + "CANCELLED", + "COMPLETE", + "DISCONNECTED", + "DO-NOT-CALL", + "INTERCEPT", + "MAX-DIAL-LIMIT", + "PAUSED", + "PENDING-CALLBACK", + "PENDING-ERR", + "PENDING-HCI", + "PENDING", + "READY", + "TRANSITIONED", + "WHITELIST" + ], + "type": "string" + }, + "type": "array" }, - "loadBalanceEnabled": { - "type": "boolean" + "leadTimezones": { + "items": { + "$ref": "#/components/schemas/Timezone" + }, + "type": "array" }, - "location": { - "type": "string" + "listIds": { + "items": { + "format": "int32", + "type": "integer" + }, + "type": "array" }, - "manualOutboundDefaultCallerId": { + "loadedDtsEnd": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "manualOutboundDefaultCallerIdE164": { + "loadedDtsStart": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "manualOutboundDefaultGate": { - "$ref": "#/components/schemas/Gate" - }, - "maxChats": { - "format": "int32", - "type": "integer" + "nextDialTimeCriteria": { + "$ref": "#/components/schemas/DateTimeComparableSearchField" }, - "multiAccountAgent": { + "orphanedLeadsOnly": { "type": "boolean" }, - "parentAgentId": { + "pendingAgentId": { "format": "int32", "type": "integer" }, - "password": { + "physicalStates": { + "items": { + "type": "string" + }, + "type": "array" + }, + "suppressed": { + "enum": [ + "ONLY_SUPPRESSED", + "ONLY_UNSUPPRESSED", + "ALL" + ], "type": "string" }, - "permissions": { + "systemDispositions": { "items": { "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" + "ANSWER", + "NOANSWER", + "BUSY", + "MACHINE", + "INTERCEPT", + "DISCONNECT", + "ABANDON", + "CONGESTION", + "MANUAL_PASS", + "INBOUND_CALLBACK", + "APP_DNC", + "APP_REQUEUE", + "APP_REQUEUE_COMPLETE", + "APP_REQUEUE_ABANDON", + "INBOUND_ABANDON", + "API_BLOCKED", + "API_ERROR" ], "type": "string" }, "type": "array" }, - "phoneLoginDialGroup": { - "$ref": "#/components/schemas/DialGroup" + "zip": { + "type": "string" + } + }, + "type": "object" + }, + "CampaignLeadSearchResultsView": { + "properties": { + "address1": { + "type": "string" }, - "phoneLoginPin": { + "address2": { "type": "string" }, - "phoneNumbersI18nEnabled": { - "type": "boolean" + "agentDispostion": { + "type": "string" }, - "rcUserId": { - "format": "int64", - "type": "integer" + "auxData1": { + "type": "string" }, - "regionalSettings": { - "$ref": "#/components/schemas/RegionalSettingRequestResponse" + "auxData2": { + "type": "string" }, - "showLeadHistory": { - "type": "boolean" + "auxData3": { + "type": "string" }, - "sipPassword": { + "auxData4": { "type": "string" }, - "sipSafeUsername": { + "auxData5": { "type": "string" }, - "softphoneId": { - "format": "int32", - "type": "integer" + "auxExternalUrl": { + "type": "string" }, - "team": { + "auxGreeting": { "type": "string" }, - "transientAgent": { - "type": "boolean" + "auxPhone": { + "type": "string" }, - "transientDelete": { - "type": "boolean" + "callerId": { + "type": "string" }, - "transientDeleteDate": { - "$ref": "#/components/schemas/DateTime" + "campaignId": { + "format": "int32", + "type": "integer" }, - "userManagedByRC": { - "type": "boolean" + "campaignLead": { + "$ref": "#/components/schemas/CampaignLead" }, - "username": { + "campaignName": { "type": "string" }, - "whereSupervisee": { - "items": { - "$ref": "#/components/schemas/AgentSupervisor" - }, - "type": "array" - }, - "whereSupervisor": { - "$ref": "#/components/schemas/CollectionAgentSupervisor" - } - }, - "type": "object" - }, - "AgentSkillProfile": { - "properties": { - "chatGroupSkills": { - "items": { - "$ref": "#/components/schemas/ChatGroupSkill" - }, - "type": "array" + "city": { + "type": "string" }, - "createdOn": { - "$ref": "#/components/schemas/DateTime" + "dialGroupId": { + "format": "int32", + "type": "integer" }, - "default": { - "type": "boolean" + "dupeKeyOverride": { + "format": "int64", + "type": "integer" }, - "gateGroupSkills": { - "items": { - "$ref": "#/components/schemas/GateGroupSkill" - }, - "type": "array" + "email": { + "type": "string" }, - "groupSkills": { - "items": { - "$ref": "#/components/schemas/GateGroupSkill" - }, - "type": "array" + "externId": { + "type": "string" }, - "isDefault": { - "type": "boolean" + "extraData": { + "type": "string" }, - "profileDesc": { + "firstName": { "type": "string" }, - "profileId": { - "format": "int32", - "type": "integer" + "gateKeeper": { + "type": "string" }, - "profileName": { + "lastName": { "type": "string" - } - }, - "type": "object" - }, - "AgentStats": { - "properties": { - "accountId": { + }, + "lastPassAgentName": { "type": "string" }, - "accountName": { + "lastPassDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "agentChatState": { + "lastPassDispo": { "type": "string" }, - "agentGroupId": { - "format": "int32", - "type": "integer" + "lastPassDisposition": { + "type": "string" }, - "agentGroupName": { + "lastPassDts": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "agentId": { + "leadId": { "format": "int32", "type": "integer" }, - "agentLoginId": { + "leadPasses": { "format": "int32", "type": "integer" }, - "agentLoginType": { + "leadPhone": { "type": "string" }, - "agentPhone": { + "leadState": { "type": "string" }, - "agentState": { + "leadTimezone": { "type": "string" }, - "agentType": { + "listDesc": { "type": "string" }, - "callAni": { + "listId": { + "format": "int32", + "type": "integer" + }, + "liveAnswerMessage": { "type": "string" }, - "callDnis": { + "loadedDts": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "callSource": { + "machAnswerMessage": { "type": "string" }, - "callSourceDesc": { + "maxPasses": { + "format": "int32", + "type": "integer" + }, + "midName": { "type": "string" }, - "callUii": { + "nextDialTime": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "callsHandled": { - "format": "int32", - "type": "integer" + "pendingAgentName": { + "type": "string" }, - "campaignId": { - "format": "int32", - "type": "integer" + "sortCol": { + "type": "string" }, - "chatsHandled": { + "speedToLeadAgentConn": { "format": "int32", "type": "integer" }, - "currentChatCount": { + "speedToLeadFirstPass": { "format": "int32", "type": "integer" }, - "email": { + "state": { "type": "string" }, - "firstName": { + "stateDts": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "gateId": { - "format": "int32", - "type": "integer" + "suffix": { + "type": "string" }, - "isDequeueAgent": { - "format": "int32", - "type": "integer" + "suppressed": { + "type": "boolean" }, - "isGhostLogin": { - "format": "int32", - "type": "integer" + "title": { + "type": "string" }, - "isOffhook": { - "format": "int32", - "type": "integer" + "uploadDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "lastName": { + "uploadedBy": { "type": "string" }, - "lastUpdate": { - "$ref": "#/components/schemas/DateTime" + "zip": { + "type": "string" + } + }, + "type": "object" + }, + "CampaignPass": { + "properties": { + "agent": { + "$ref": "#/components/schemas/Agent" }, - "loginDialGroupId": { - "format": "int32", - "type": "integer" + "agentDisposition": { + "type": "string" }, - "loginTime": { - "format": "int32", - "type": "integer" + "agentNotes": { + "type": "string" }, - "onHoldDts": { - "$ref": "#/components/schemas/DateTime" + "callStart": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "pendingDisposition": { - "format": "int32", - "type": "integer" + "campaignRedials": { + "items": { + "$ref": "#/components/schemas/CampaignRedial" + }, + "type": "array" }, - "pendingDispositionTime": { + "dialDuration": { "format": "int32", "type": "integer" }, - "profileName": { - "type": "string" + "dialType": { + "type": "boolean" }, - "rna": { + "duration": { "format": "int32", "type": "integer" }, - "selectable": { + "export": { + "type": "boolean" + }, + "exportFlag": { "type": "boolean" }, - "stateTime": { - "format": "int32", - "type": "integer" + "leadPhone": { + "type": "string" }, - "successDispositions": { - "format": "int32", - "type": "integer" + "passDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "totalChatTime": { - "format": "int32", - "type": "integer" + "passDisposition": { + "enum": [ + "ANSWER", + "NOANSWER", + "BUSY", + "MACHINE", + "INTERCEPT", + "DISCONNECT", + "ABANDON", + "CONGESTION", + "MANUAL_PASS", + "INBOUND_CALLBACK", + "APP_DNC", + "APP_REQUEUE", + "APP_REQUEUE_COMPLETE", + "APP_REQUEUE_ABANDON", + "INBOUND_ABANDON", + "API_BLOCKED", + "API_ERROR" + ], + "type": "string" }, - "totalTalkTime": { + "passNumber": { "format": "int32", "type": "integer" }, - "username": { + "passUii": { "type": "string" } }, "type": "object" }, - "AgentSupervisor": { + "CampaignRedial": { "properties": { "agentId": { "format": "int32", "type": "integer" }, - "supervisorId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "AgentSupervisorPK": { - "properties": { - "agentId": { + "callBackDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" + }, + "callBackPhone": { + "type": "string" + }, + "campaignLead": { + "$ref": "#/components/schemas/CampaignLead" + }, + "campaignPass": { + "$ref": "#/components/schemas/CampaignPass" + }, + "id": { "format": "int32", "type": "integer" }, - "supervisorId": { + "name": { + "type": "string" + }, + "redialId": { "format": "int32", "type": "integer" } }, "type": "object" }, - "AgentV2": { + "CampaignUnlimitedFieldGroup": { "properties": { - "accountId": { + "campaigns": { + "items": { + "$ref": "#/components/schemas/Campaign" + }, + "type": "array" + }, + "extraDataMappings": { "type": "string" }, - "accountName": { + "groupName": { "type": "string" }, - "agentGroupId": { - "format": "int32", - "type": "integer" - }, - "agentId": { + "unlimitedFieldGroupId": { "format": "int32", "type": "integer" + } + }, + "type": "object" + }, + "ChatGroup": { + "properties": { + "billingKey": { + "type": "string" }, - "agentRank": { + "chatGroupId": { "format": "int32", "type": "integer" }, - "agentType": { - "type": "string" - }, - "allowLoginControl": { - "type": "boolean" + "chatGroupSkills": { + "items": { + "$ref": "#/components/schemas/ChatGroupSkill" + }, + "type": "array" }, - "allowLoginUpdates": { - "type": "boolean" + "chatGroups": { + "items": { + "$ref": "#/components/schemas/ChatQueue" + }, + "type": "array" }, - "altDefaultLoginDest": { - "type": "string" + "chatQueues": { + "items": { + "$ref": "#/components/schemas/ChatQueue" + }, + "type": "array" }, - "directAgentExtension": { + "createdOn": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "email": { + "groupName": { "type": "string" }, - "enableSoftphone": { + "permissions": { + "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ChatGroupSkill": { + "properties": { + "active": { "type": "boolean" }, - "externalAgentId": { - "type": "string" - }, - "firstName": { - "type": "string" - }, - "ghostRnaAction": { - "type": "string" + "agentSkillProfiles": { + "$ref": "#/components/schemas/CollectionAgentSkillProfile" }, - "initLoginBaseState": { - "type": "string" + "chatRequeueShortcuts": { + "items": { + "$ref": "#/components/schemas/ChatRequeueShortcut" + }, + "type": "array" }, - "lastName": { + "createdOn": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "location": { - "type": "string" + "permissions": { + "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" + }, + "type": "array" }, - "manualOutboundDefaultCallerId": { + "skillDesc": { "type": "string" }, - "maxChats": { + "skillId": { "format": "int32", "type": "integer" }, - "password": { - "type": "string" - }, - "phoneLoginPin": { + "skillName": { "type": "string" - }, - "rcUserId": { - "format": "int64", + } + }, + "type": "object" + }, + "ChatPriorityGroup": { + "properties": { + "chatPriorityGroupId": { + "format": "int32", "type": "integer" }, - "team": { - "type": "string" + "chatQueues": { + "items": { + "$ref": "#/components/schemas/ChatQueue" + }, + "type": "array" }, - "username": { + "priorityGroupName": { "type": "string" } }, - "title": "AgentV2", "type": "object" }, - "AgentsLoggedInGatesView": { + "ChatQueue": { "properties": { - "gateGroupId": { - "format": "int32", - "type": "integer" + "account": { + "$ref": "#/components/schemas/Account" }, - "gateId": { - "format": "int32", - "type": "integer" + "accountId": { + "type": "string" }, - "gateName": { + "active": { + "type": "boolean" + }, + "agentConnectHttpService": { + "$ref": "#/components/schemas/RemoteHttpService" + }, + "agentConnectMsg": { "type": "string" }, - "groupName": { + "agentFrom": { "type": "string" }, - "id": { + "agentMaxAcceptTime": { "format": "int32", "type": "integer" }, - "name": { - "type": "string" - } - }, - "type": "object" - }, - "Alert": { - "properties": { - "alertId": { + "agentTermHttpService": { + "$ref": "#/components/schemas/RemoteHttpService" + }, + "agentWrapTime": { "format": "int32", "type": "integer" }, - "alertMessageBody": { + "appUrl": { "type": "string" }, - "alertMessageSubject": { - "type": "string" + "callbackCampaign": { + "$ref": "#/components/schemas/Campaign" }, - "alertName": { - "type": "string" + "chatGroup": { + "$ref": "#/components/schemas/ChatGroup" + }, + "chatPriorityGroup": { + "$ref": "#/components/schemas/ChatPriorityGroup" }, - "alertScript": { + "chatQueueDescription": { "type": "string" }, - "intervalMin": { + "chatQueueId": { "format": "int32", "type": "integer" }, - "itemIds": { + "chatQueueName": { "type": "string" }, - "jsonBlob": { + "chatQueueOpen": { + "type": "boolean" + }, + "clientFrom": { "type": "string" }, - "nextRunTime": { - "$ref": "#/components/schemas/DateTime" + "companyLogo": { + "$ref": "#/components/schemas/Blob" }, - "productType": { - "enum": [ - "ACCOUNT", - "ACD", - "AGENT", - "CHAT_QUEUE", - "OUTBOUND", - "VISUAL_IVR", - "CLOUD_PROFILE", - "CLOUD_DESTINATION", - "TRAC_NUMBER", - "HTTP_SERVICES", - "SCRIPTING", - "TN_MANAGER", - "SURVEY", - "DNIS", - "TEAMS", - "KNOWLEDGE_BASE", - "UTILITIES" - ], - "type": "string" - } - }, - "type": "object" - }, - "AmdProfile": { - "properties": { - "accountId": { + "createdOn": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "amdAfterGreetingSilence": { - "format": "int32", - "type": "integer" + "dequeueHttpService": { + "$ref": "#/components/schemas/RemoteHttpService" }, - "amdBetweenWordSilence": { + "dispTimeout": { "format": "int32", "type": "integer" }, - "amdGreeting": { - "format": "int32", - "type": "integer" + "friSched": { + "type": "string" }, - "amdInitSilence": { - "format": "int32", - "type": "integer" + "gateQueueAnips": { + "items": { + "$ref": "#/components/schemas/ChatQueueAnip" + }, + "type": "array" }, - "amdMaxWords": { + "groupId": { "format": "int32", "type": "integer" }, - "amdMinWordLength": { + "idleTimeout": { "format": "int32", "type": "integer" }, - "amdProfileId": { + "isActive": { + "type": "boolean" + }, + "longChatTime": { "format": "int32", "type": "integer" }, - "amdProfileName": { + "maxQueueEvent": { "type": "string" }, - "amdSilenceThreshold": { + "maxQueueLimit": { "format": "int32", "type": "integer" }, - "amdTotalTime": { - "format": "int32", - "type": "integer" + "monSched": { + "type": "string" }, - "countOfCampaigns": { - "format": "int32", - "type": "integer" + "newChatHttpService": { + "$ref": "#/components/schemas/RemoteHttpService" }, - "systemDefault": { - "type": "boolean" + "noAgentEvent": { + "type": "string" }, - "systemProfile": { + "observeDst": { "type": "boolean" - } - }, - "type": "object" - }, - "ApplicationContext": { - "properties": { - "applicationName": { - "type": "string" }, - "autowireCapableBeanFactory": { - "$ref": "#/components/schemas/AutowireCapableBeanFactory" + "permissions": { + "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" + }, + "type": "array" + }, + "postChatHttpService": { + "$ref": "#/components/schemas/RemoteHttpService" + }, + "postDispHttpService": { + "$ref": "#/components/schemas/RemoteHttpService" + }, + "queueClosedEvent": { + "type": "string" }, - "beanDefinitionCount": { + "queuePriority": { "format": "int32", "type": "integer" }, - "beanDefinitionNames": { + "requeueShortcutAccess": { "items": { - "type": "string" + "$ref": "#/components/schemas/ChatRequeueShortcutGroupChatQueueAccess" }, "type": "array" }, - "classLoader": { - "$ref": "#/components/schemas/ClassLoader" - }, - "displayName": { + "requeueType": { "type": "string" }, - "environment": { - "$ref": "#/components/schemas/Environment" + "requireCaptcha": { + "type": "boolean" }, - "id": { + "satSched": { "type": "string" }, - "parent": { - "$ref": "#/components/schemas/ApplicationContext" - }, - "parentBeanFactory": { - "$ref": "#/components/schemas/BeanFactory" + "script": { + "$ref": "#/components/schemas/Script" }, - "startupDate": { - "format": "int64", + "shortChatTime": { + "format": "int32", "type": "integer" - } - }, - "title": "ApplicationContext", - "type": "object" - }, - "AssignedDnis": { - "properties": { - "cloudRouteProfile": { - "$ref": "#/components/schemas/CloudRouteProfileSkinny" }, - "dnis": { - "type": "string" + "slaTime": { + "format": "int32", + "type": "integer" }, - "dnisDescription": { + "specialIpEvent": { "type": "string" }, - "dnisE164": { + "sunSched": { "type": "string" }, - "endDate": { - "$ref": "#/components/schemas/DateTime" - }, - "endPointId": { - "type": "string" + "surveyId": { + "format": "int32", + "type": "integer" }, - "endPointType": { + "surveyPopType": { "type": "string" }, - "gate": { - "$ref": "#/components/schemas/GateSkinnyAssignable" + "throttleCalls": { + "format": "int32", + "type": "integer" }, - "isActive": { - "type": "boolean" + "throttleDays": { + "format": "int32", + "type": "integer" }, - "originatingDnis": { + "throttleIpEvent": { "type": "string" }, - "phoneNumbersI18nEnabled": { - "type": "boolean" - }, - "startDate": { - "$ref": "#/components/schemas/DateTime" + "thuSched": { + "type": "string" }, - "tracNumber": { - "$ref": "#/components/schemas/TracNumberSkinny" + "tueSched": { + "type": "string" }, - "visualIvr": { - "$ref": "#/components/schemas/VisualIvrSkinny" + "wedSched": { + "type": "string" } }, "type": "object" }, - "AssignedSmsDnis": { + "ChatQueueAnip": { "properties": { - "chatQueue": { - "$ref": "#/components/schemas/ChatQueueSkinny" - }, - "dnis": { + "anip": { "type": "string" }, - "dnisDescription": { - "type": "string" + "chatQueueId": { + "format": "int32", + "type": "integer" }, - "dnisE164": { + "dateAdded": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "dnisPool": { - "$ref": "#/components/schemas/DnisPoolV2" - }, - "endDate": { - "$ref": "#/components/schemas/DateTime" - }, - "isActive": { - "type": "boolean" - }, - "originatingDnis": { + "recordType": { "type": "string" }, - "phoneNumbersI18nEnabled": { - "type": "boolean" - }, - "startDate": { - "$ref": "#/components/schemas/DateTime" + "type": { + "type": "string" } }, "type": "object" }, - "AudioFileView": { + "ChatQueueSkinny": { "properties": { - "fileName": { + "accountId": { "type": "string" }, - "fileSize": { - "format": "int64", + "chatGroupId": { + "format": "int32", "type": "integer" }, - "lastModified": { - "format": "date-time", + "chatQueueId": { + "format": "int32", + "type": "integer" + }, + "chatQueueName": { "type": "string" + }, + "isActive": { + "type": "boolean" } }, "type": "object" }, - "AuditLog": { + "ChatRequeueShortcut": { "properties": { - "accountId": { - "type": "string" + "chatGroupSkill": { + "$ref": "#/components/schemas/ChatGroupSkill" }, - "actionType": { - "enum": [ - "DELETE", - "CREATE", - "UPDATE" - ], - "type": "string" + "chatRequeueShortcutId": { + "format": "int32", + "type": "integer" }, - "affectedEntityJson": { + "name": { "type": "string" }, - "auditLogResultList": { - "items": { - "$ref": "#/components/schemas/AuditLogResult" - }, - "type": "array" - }, - "auditedEntityDescription": { - "type": "object" - }, - "auditedEntityId": { - "type": "object" - }, - "authUser": { - "$ref": "#/components/schemas/AuditLogAuthenticatedUser" - }, - "createTime": { - "format": "int64", + "rank": { + "format": "int32", "type": "integer" }, - "createTimeAsDateTime": { - "$ref": "#/components/schemas/DateTime" - }, - "description": { - "type": "string" + "requeueGroup": { + "$ref": "#/components/schemas/ChatGroup" }, - "id": { - "type": "string" + "requeueQueue": { + "$ref": "#/components/schemas/ChatQueue" } }, "type": "object" }, - "AuditLogAuthenticatedUser": { + "ChatRequeueShortcutGroup": { "properties": { - "firstName": { - "type": "string" - }, - "fullJson": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "sourceId": { - "type": "string" - }, - "userId": { - "type": "string" + "chatRequeueShortcutGroupId": { + "format": "int32", + "type": "integer" }, - "userName": { + "name": { "type": "string" } }, "type": "object" }, - "AuditLogResult": { + "ChatRequeueShortcutGroupChatQueueAccess": { "properties": { - "attributeName": { - "type": "string" + "chatQueue": { + "$ref": "#/components/schemas/ChatQueue" }, - "classType": { - "type": "string" + "chatQueueId": { + "format": "int32", + "type": "integer" }, - "newValue": { - "type": "object" + "chatRequeueShortcutGroup": { + "$ref": "#/components/schemas/ChatRequeueShortcutGroup" }, - "originalValue": { - "type": "object" + "chatRequeueShortcutGroupId": { + "format": "int32", + "type": "integer" } }, "type": "object" }, - "AuditLogSearchCriteria": { + "CloudRouteAssignedDestination": { "properties": { - "accountId": { - "type": "string" + "allocationPercent": { + "format": "int32", + "type": "integer" }, - "ascOrDesc": { - "enum": [ - "ASCENDING", - "DESCENDING" - ], + "allocationPercentHours": { "type": "string" }, - "auditActions": { - "items": { - "enum": [ - "DELETE", - "CREATE", - "UPDATE" - ], - "type": "string" - }, - "type": "array" - }, - "auditedEntityId": { - "type": "string" + "assignedDestinationId": { + "format": "int32", + "type": "integer" }, - "createUserId": { + "cloudDestination": { + "$ref": "#/components/schemas/CloudRouteDestination" + }, + "cloudProfile": { + "$ref": "#/components/schemas/CloudRouteProfile" + }, + "countryCode": { + "$ref": "#/components/schemas/CountryCode" + }, + "destinationType": { + "enum": [ + "STANDARD", + "DID", + "SIP", + "IN_NETWORK_DID", + "ACD", + "IVR", + "IVR_STUDIO" + ], "type": "string" }, - "endDateTime": { - "$ref": "#/components/schemas/DateTime" + "dtmfEventsEnabled": { + "type": "boolean" }, - "endDateTimeAsUnix": { - "format": "int64", - "type": "integer" + "enablePrerouteHttp": { + "type": "boolean" }, - "orderBy": { + "forceAcdQueue": { + "type": "boolean" + }, + "outboundCallerId": { "type": "string" }, - "searchEntities": { + "overrideFlag": { + "type": "boolean" + }, + "permissions": { "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], "type": "string" }, "type": "array" }, - "startDateTime": { - "$ref": "#/components/schemas/DateTime" + "rank": { + "format": "int32", + "type": "integer" }, - "startDateTimeAsUnix": { - "format": "int64", + "repeatIndexStart": { + "format": "int32", "type": "integer" - } - }, - "type": "object" - }, - "Auditable": { - "properties": { - "fullPath": { + }, + "ringDuration": { + "format": "int32", + "type": "integer" + }, + "routeDestination": { "type": "string" }, - "name": { + "takeBackDtmf": { "type": "string" + }, + "ttAccept": { + "type": "boolean" + }, + "ttAcceptTime": { + "format": "int32", + "type": "integer" } }, "type": "object" }, - "AuthConfig": { + "CloudRouteAssignedOverride": { "properties": { - "authType": { - "enum": [ - "APIKEY", - "JWT", - "BASIC", - "OAUTH", - "CUSTOM_AUTH" - ], + "assignedDestination": { + "$ref": "#/components/schemas/CloudRouteAssignedDestination" + }, + "assignedOverrideId": { + "format": "int32", + "type": "integer" + }, + "countryId": { "type": "string" }, - "apiKey": { + "dnis": { + "type": "string" + }, + "routeDestination": { "type": "string" } }, "type": "object" }, - "AuthenticatedUser": { + "CloudRouteDestination": { "properties": { - "authToken": { + "active": { + "type": "boolean" + }, + "address": { "type": "string" }, - "description": { + "authKey": { "type": "string" }, - "id": { + "city": { "type": "string" }, - "isApiToken": { + "cloudDestinationId": { + "format": "int32", + "type": "integer" + }, + "cloudRouteGroup": { + "$ref": "#/components/schemas/CloudRouteGroup" + }, + "countryCode": { + "$ref": "#/components/schemas/CountryCode" + }, + "deleted": { "type": "boolean" }, - "masterRightsDocs": { - "additionalProperties": { - "$ref": "#/components/schemas/RightsDocument" - }, - "type": "object" + "destinationDesc": { + "type": "string" }, - "masterRightsDocsValues": { - "$ref": "#/components/schemas/CollectionRightsDocument" + "destinationName": { + "type": "string" }, - "name": { + "destinationType": { + "enum": [ + "STANDARD", + "DID", + "SIP", + "IN_NETWORK_DID", + "ACD", + "IVR", + "IVR_STUDIO" + ], "type": "string" }, - "rightsDocs": { - "additionalProperties": { - "$ref": "#/components/schemas/RightsDocument" - }, - "type": "object" + "endDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "sourceIp": { + "forceAcdQueue": { + "type": "boolean" + }, + "friSched": { "type": "string" }, - "stayLoggedIn": { + "isActive": { "type": "boolean" }, - "superUser": { + "isDeleted": { "type": "boolean" }, - "user": { - "$ref": "#/components/schemas/User" - } - }, - "type": "object" - }, - "AutowireCapableBeanFactory": { - "title": "AutowireCapableBeanFactory", - "type": "object" - }, - "BaseAgentState": { - "properties": { - "colKey": { - "type": "string" + "lat": { + "format": "double", + "type": "number" }, - "colLabel": { - "type": "string" + "lon": { + "format": "double", + "type": "number" }, - "id": { + "maxConcurrent": { "format": "int32", "type": "integer" }, - "isCore": { - "type": "boolean" + "maxConcurrentHours": { + "type": "string" }, - "isRequired": { - "type": "boolean" + "maxConcurrentType": { + "type": "string" }, - "name": { + "monSched": { "type": "string" - } - }, - "type": "object" - }, - "BaseCsvDto": { - "type": "object" - }, - "BatchOperationResult": { - "properties": { - "result": { + }, + "permissions": { "items": { - "$ref": "#/components/schemas/ProductOperationResult" + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" }, "type": "array" - } - }, - "type": "object" - }, - "BeanFactory": { - "title": "BeanFactory", - "type": "object" - }, - "Blob": { - "properties": { - "binaryStream": { - "$ref": "#/components/schemas/InputStream" - } - }, - "type": "object" - }, - "BlockedANI": { - "properties": { - "accountId": { - "type": "string" }, - "ani": { + "prerouteHttpUrl": { "type": "string" }, - "aniE164": { + "ringDuration": { + "format": "int32", + "type": "integer" + }, + "routeDestination": { "type": "string" }, - "dateCreated": { - "$ref": "#/components/schemas/DateTime" + "satSched": { + "type": "string" }, - "notes": { + "startDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "phoneNumbersI18nEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "BlockedANIDeleteRequest": { - "properties": { - "ani": { + "state": { "type": "string" }, - "aniE164": { + "sunSched": { "type": "string" }, - "effectiveAni": { + "thuSched": { "type": "string" }, - "phoneNumbersI18nEnabled": { + "ttAccept": { "type": "boolean" - } - }, - "type": "object" - }, - "BlockedIP": { - "properties": { - "accountId": { - "type": "string" }, - "dateCreated": { - "$ref": "#/components/schemas/DateTime" + "ttAcceptTime": { + "format": "int32", + "type": "integer" }, - "ipAddress": { + "tueSched": { "type": "string" }, - "mask": { + "wedSched": { "type": "string" }, - "notes": { + "zip": { "type": "string" } }, "type": "object" }, - "CallerIdBucket": { + "CloudRouteDestinationOverride": { "properties": { - "accountId": { - "type": "string" + "cloudDestination": { + "$ref": "#/components/schemas/CloudRouteDestination" }, - "active": { - "type": "boolean" + "countryId": { + "type": "string" }, - "bucketId": { + "destOverrideId": { "format": "int32", "type": "integer" }, - "bucketName": { - "type": "string" - }, - "bwOrderId": { - "type": "string" - }, - "callerIdBucketNumbers": { - "items": { - "$ref": "#/components/schemas/CallerIdBucketNumber" - }, - "type": "array" - }, - "callerIdName": { - "type": "string" - }, - "createDate": { - "$ref": "#/components/schemas/DateTime" - }, - "excludedStates": { - "items": { - "type": "string" - }, - "type": "array" - }, - "forwardingDid": { + "dnis": { "type": "string" }, - "forwardingDidE164": { + "routeDestination": { "type": "string" + } + }, + "type": "object" + }, + "CloudRouteDtmfEvent": { + "properties": { + "cloudRouteDtmfId": { + "format": "int32", + "type": "integer" }, - "isActive": { - "type": "boolean" + "dtmfCode": { + "format": "int32", + "type": "integer" }, - "orderStatus": { - "enum": [ - "PENDING", - "COMPLETE", - "FAILED", - "DISCONNECT" - ], + "dtmfEventData": { "type": "string" - }, - "phoneNumbersI18nEnabled": { - "type": "boolean" } }, "type": "object" }, - "CallerIdBucketNumber": { + "CloudRouteGroup": { "properties": { - "city": { - "type": "string" - }, - "lat": { - "format": "double", - "type": "number" - }, - "lon": { - "format": "double", - "type": "number" - }, - "numberId": { + "cloudGroupId": { "format": "int32", "type": "integer" }, - "state": { - "type": "string" + "cloudRouteDestinations": { + "$ref": "#/components/schemas/CollectionCloudRouteDestination" }, - "tnNumber": { + "cloudRouteProfiles": { + "$ref": "#/components/schemas/CollectionCloudRouteProfile" + }, + "groupName": { "type": "string" + }, + "isDefault": { + "type": "boolean" + }, + "permissions": { + "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" + }, + "type": "array" } }, "type": "object" }, - "Campaign": { + "CloudRouteProfile": { "properties": { - "abandonMsg": { + "billingCode": { "type": "string" }, - "afterCallBaseState": { + "billingKey": { "type": "string" }, - "afterCallState": { - "$ref": "#/components/schemas/AccountAuxState" - }, - "agentConnectSoapService": { + "callConnSoapService": { "$ref": "#/components/schemas/RemoteHttpService" }, - "agentPopMessage": { - "type": "string" + "callEndSoapService": { + "$ref": "#/components/schemas/RemoteHttpService" }, - "agentTermSoapService": { + "callStartSoapService": { "$ref": "#/components/schemas/RemoteHttpService" }, - "allowLeadInserts": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" + "cloudProfileId": { + "format": "int32", + "type": "integer" }, - "allowLeadUpdates": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" + "cloudRouteGroup": { + "$ref": "#/components/schemas/CloudRouteGroup" }, - "amdProfileId": { - "$ref": "#/components/schemas/AmdProfile" + "dequeueDelay": { + "format": "int32", + "type": "integer" }, - "appUrl": { + "endcallMsg": { "type": "string" }, - "aux1Label": { - "type": "string" + "geoMaxDistance": { + "format": "int32", + "type": "integer" }, - "aux2Label": { + "introMsg": { "type": "string" }, - "aux3Label": { - "type": "string" + "isActive": { + "type": "boolean" }, - "aux4Label": { - "type": "string" + "isDeleted": { + "type": "boolean" }, - "aux5Label": { - "type": "string" + "longCall": { + "format": "int32", + "type": "integer" }, - "billingCode": { + "outboundCallerId": { "type": "string" }, - "callerId": { + "percentAllocType": { "type": "string" }, - "callerIdBucket": { - "$ref": "#/components/schemas/CallerIdBucket" + "permissions": { + "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" + }, + "type": "array" }, - "campaignDesc": { + "profileDesc": { "type": "string" }, - "campaignDispositions": { - "$ref": "#/components/schemas/CollectionCampaignDisposition" + "profileName": { + "type": "string" }, - "campaignFilterStates": { - "$ref": "#/components/schemas/CollectionCampaignFilterStates" + "recordCall": { + "type": "boolean" }, - "campaignFilterTimezones": { - "$ref": "#/components/schemas/CollectionCampaignFilterTimezones" + "repeatCount": { + "format": "int32", + "type": "integer" }, - "campaignId": { + "repeatDelay": { "format": "int32", "type": "integer" }, - "campaignName": { + "revMatch": { + "type": "boolean" + }, + "routeExhaustedAction": { "type": "string" }, - "campaignPriority": { + "routingType": { + "type": "string" + }, + "shortCall": { "format": "int32", "type": "integer" }, - "campaignRequeueShortcuts": { - "$ref": "#/components/schemas/CollectionRequeueShortcut" - }, - "campaignResultDest": { - "$ref": "#/components/schemas/ResultFileDestination" - }, - "campaignUnlimitedFieldGroup": { - "$ref": "#/components/schemas/CampaignUnlimitedFieldGroup" + "stickyDestinationType": { + "type": "string" }, - "campaignWhitelistTagMembers": { - "$ref": "#/components/schemas/CollectionWhitelistTagMembers" + "takeBackMsg": { + "type": "string" }, - "countryId": { + "voicemailEmail": { "type": "string" }, - "customDialZoneGroup": { - "$ref": "#/components/schemas/CustomDialZoneGroups" + "whisperMsg": { + "type": "string" + } + }, + "type": "object" + }, + "CloudRouteProfileSkinny": { + "properties": { + "accountId": { + "type": "string" }, - "dialGroup": { - "$ref": "#/components/schemas/DialGroup" + "cloudGroupId": { + "format": "int32", + "type": "integer" }, - "dialLoadedOrder": { + "cloudProfileId": { "format": "int32", "type": "integer" }, - "dispositionTimeout": { + "groupId": { "format": "int32", "type": "integer" }, - "dncScrubOption": { - "enum": [ - "DO_NOT_SCRUB", - "INTERNAL_AND_NATIONAL", - "INTERNAL_ONLY", - "CELLULAR_AND_INTERNAL", - "CELLULAR_ONLY" - ], - "type": "string" - }, - "enableGlobalPhoneBook": { - "type": "boolean" - }, - "endCallMsg": { - "type": "string" - }, - "endDate": { - "$ref": "#/components/schemas/DateTime" - }, - "exportFlag": { - "type": "boolean" - }, - "filterEnabled": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" - }, - "filterType": { - "type": "string" - }, - "friSched": { - "type": "string" - }, - "genericKeyValuePairs": { - "type": "string" - }, - "groupId": { - "format": "int32", - "type": "integer" - }, - "hangupOnDisposition": { - "format": "int32", - "type": "integer" - }, - "isActive": { - "format": "int32", - "type": "integer" - }, - "lastPassDts": { - "$ref": "#/components/schemas/Timestamp" - }, - "liveAnswerMsg": { - "type": "string" - }, - "machAnswerMsg": { - "type": "string" - }, - "machineDetect": { - "type": "boolean" - }, - "maxDailyPasses": { - "format": "int32", - "type": "integer" - }, - "maxDailyPassesInclude": { - "type": "string" - }, - "maxDialLimit": { - "format": "int32", - "type": "integer" - }, - "maxPasses": { - "format": "int32", - "type": "integer" - }, - "maxPassesExclude": { - "type": "string" - }, - "maxRingTime": { - "format": "int32", - "type": "integer" - }, - "maxRingTimeTransfer": { - "format": "int32", - "type": "integer" - }, - "minPredictiveCallsHistory": { - "format": "int32", - "type": "integer" - }, - "monSched": { - "type": "string" - }, - "onHoldMsg": { - "type": "string" - }, - "passDelayMin": { - "format": "int32", - "type": "integer" - }, - "pauseRecordingSec": { - "format": "int32", - "type": "integer" - }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - }, - "perspectiveRecordingMode": { - "enum": [ - "DISABLED", - "ALL_AGENT_LEGS" - ], - "type": "string" - }, - "postCallSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "postDispSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "quotaGroup": { - "$ref": "#/components/schemas/QuotaGroup" - }, - "realtimeDncUrl": { - "type": "string" - }, - "recordCall": { - "format": "int32", - "type": "integer" - }, - "recordingInConference": { - "type": "boolean" - }, - "recordingSettings": { - "enum": [ - "RECORD_FULL_CALL", - "AGENT_FULL_CONTROL_DEFAULT_ON", - "AGENT_FULL_CONTROL_DEFAULT_OFF", - "AGENT_PAUSE" - ], - "type": "string" - }, - "requeueType": { - "enum": [ - "ADVANCED", - "RESTRICTED" - ], - "type": "string" - }, - "rescrubInterval": { - "format": "int32", - "type": "integer" - }, - "satSched": { - "type": "string" - }, - "script": { - "$ref": "#/components/schemas/Script" - }, - "scrubDisconnectNoanswer": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" - }, - "seedAbandonRate": { - "format": "double", - "type": "number" - }, - "seedSuccessRate": { - "format": "double", - "type": "number" - }, - "showLeadInfo": { - "format": "int32", - "type": "integer" - }, - "showLeadPasses": { - "type": "boolean" - }, - "showListName": { - "type": "boolean" - }, - "singleChannelEnabled": { - "type": "boolean" - }, - "startDate": { - "$ref": "#/components/schemas/DateTime" - }, - "stopRecordingOnTransfer": { - "type": "boolean" - }, - "sunSched": { - "type": "string" - }, - "survey": { - "$ref": "#/components/schemas/Survey" - }, - "surveyPopType": { - "type": "string" - }, - "targetAbandonRate": { - "format": "double", - "type": "number" - }, - "thuSched": { - "type": "string" - }, - "trackSpeedToLead": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" - }, - "transferCallerId": { - "type": "string" - }, - "transferTermSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "tueSched": { - "type": "string" - }, - "useGlobalWhitelist": { - "type": "boolean" - }, - "wedSched": { - "type": "string" - }, - "whisperMsg": { - "type": "string" - }, - "callingConfiguration": { - "description": "Calling preference mode for the campaign. Use SIMPLE for standard lead-phone dialing or STRATEGIC for persona-based phone selection. This setting is selected when the campaign is created and cannot be changed later.", - "enum": [ - "SIMPLE", - "STRATEGIC" - ], - "type": "string" - }, - "personaCallSchedules": { - "description": "Persona-based calling windows and phone-priority rules for STRATEGIC campaigns.", - "items": { - "$ref": "#/components/schemas/PersonaCallSchedule" - }, - "type": "array" - } - }, - "type": "object" - }, - "CampaignCriteriaGroupAccess": { - "properties": { - "campaignId": { - "format": "int32", - "type": "integer" - }, - "groupId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "CampaignDisposition": { - "properties": { - "campaign": { - "$ref": "#/components/schemas/Campaign" - }, - "contactForwarding": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" - }, - "createCopy": { - "type": "boolean" - }, - "destCampaign": { - "$ref": "#/components/schemas/Campaign" - }, - "dispSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "disposition": { - "type": "string" - }, - "dispositionId": { - "format": "int32", - "type": "integer" - }, - "dncTagLabel": { - "type": "string" - }, - "doNotCall": { - "type": "boolean" - }, - "dtmfMapping": { - "type": "string" - }, - "emailDestinations": { - "type": "string" - }, - "emailTemplate": { - "$ref": "#/components/schemas/EmailTemplate" - }, - "excludeAbandon": { - "type": "boolean" - }, - "isComplete": { - "type": "boolean" - }, - "isContact": { - "type": "boolean" - }, - "isDefault": { - "type": "boolean" - }, - "isDisabled": { - "type": "boolean" - }, - "isRequeued": { - "format": "int32", - "type": "integer" - }, - "isSuccess": { - "type": "boolean" - }, - "mergeOriginal": { - "type": "boolean" - }, - "rank": { - "format": "int32", - "type": "integer" - }, - "requeueDelay": { - "format": "int32", - "type": "integer" - }, - "requireNote": { - "type": "boolean" - }, - "saveSurvey": { - "type": "boolean" - }, - "setAgentFlag": { - "type": "boolean" - }, - "termMessage": { - "type": "string" - }, - "timeout": { - "format": "int32", - "type": "integer" - }, - "xfer": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" - }, - "xferDest": { - "type": "string" - } - }, - "type": "object" - }, - "CampaignFilterStates": { - "properties": { - "campaign": { - "$ref": "#/components/schemas/Campaign" - }, - "campaignId": { - "format": "int32", - "type": "integer" - }, - "name": { - "type": "string" - }, - "state": { - "type": "string" - } - }, - "type": "object" - }, - "CampaignFilterTimezones": { - "properties": { - "campaign": { - "$ref": "#/components/schemas/Campaign" - }, - "campaignId": { - "format": "int32", - "type": "integer" - }, - "timezone": { - "type": "string" - } - }, - "type": "object" - }, - "CampaignLead": { - "properties": { - "address1": { - "type": "string" - }, - "address2": { - "type": "string" - }, - "auxData1": { - "type": "string" - }, - "auxData2": { - "type": "string" - }, - "auxData3": { - "type": "string" - }, - "auxData4": { - "type": "string" - }, - "auxData5": { - "type": "string" - }, - "auxExternalUrl": { - "type": "string" - }, - "auxGreeting": { - "type": "string" - }, - "auxPhone": { - "type": "string" - }, - "callerId": { - "type": "string" - }, - "campaign": { - "$ref": "#/components/schemas/Campaign" - }, - "campaignRedials": { - "items": { - "$ref": "#/components/schemas/CampaignRedial" - }, - "type": "array" - }, - "city": { - "type": "string" - }, - "dupeKeyOverride": { - "format": "int64", - "type": "integer" - }, - "email": { - "type": "string" - }, - "extendedLeadData": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "externId": { - "type": "string" - }, - "firstName": { - "type": "string" - }, - "gateKeeper": { - "type": "string" - }, - "id": { - "format": "int32", - "type": "integer" - }, - "lastName": { - "type": "string" - }, - "lastPassDisposition": { - "enum": [ - "ANSWER", - "NOANSWER", - "BUSY", - "MACHINE", - "INTERCEPT", - "DISCONNECT", - "ABANDON", - "CONGESTION", - "MANUAL_PASS", - "INBOUND_CALLBACK", - "APP_DNC", - "APP_REQUEUE", - "APP_REQUEUE_COMPLETE", - "APP_REQUEUE_ABANDON", - "INBOUND_ABANDON", - "API_BLOCKED", - "API_ERROR" - ], - "type": "string" - }, - "lastPassDts": { - "$ref": "#/components/schemas/DateTime" - }, - "leadId": { - "format": "int32", - "type": "integer" - }, - "leadPasses": { - "format": "int32", - "type": "integer" - }, - "leadPhone": { - "description": "Primary lead phone number. For accounts enabled for E.164 or international phone-number handling, provide the primary phone in leadPhoneE164.", - "type": "string" - }, - "leadPhoneE164": { - "description": "Primary lead phone number in E.164 format. Required for direct lead loading when the account uses E.164 or international phone-number handling.", - "type": "string" - }, - "leadPriority": { - "format": "int32", - "type": "integer" - }, - "leadState": { - "enum": [ - "ACTIVE", - "AGENT-CALLBACK", - "CALLBACK-CANCELLED", - "CALLBACK", - "CANCELLED", - "COMPLETE", - "DISCONNECTED", - "DO-NOT-CALL", - "INTERCEPT", - "MAX-DIAL-LIMIT", - "PAUSED", - "PENDING-CALLBACK", - "PENDING-ERR", - "PENDING-HCI", - "PENDING", - "READY", - "TRANSITIONED", - "WHITELIST" - ], - "type": "string" - }, - "leadTimezone": { - "type": "string" - }, - "liveAnswerMessage": { - "type": "string" - }, - "loadedDts": { - "$ref": "#/components/schemas/DateTime" - }, - "machAnswerMessage": { - "type": "string" - }, - "maxPasses": { - "format": "int32", - "type": "integer" - }, - "midName": { - "type": "string" - }, - "name": { - "type": "string" - }, - "nextDialTime": { - "$ref": "#/components/schemas/DateTime" - }, - "quotaTargetIds": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "quotaTargets": { - "$ref": "#/components/schemas/CollectionQuotaTarget" - }, - "reserveAgent": { - "description": "Agent ID to reserve this lead for during direct lead loading. If the value is blank, null, omitted, invalid, or refers to an agent without access to the account, the lead is still accepted. Invalid or inaccessible assignments are counted in failedAgentAssignment.", - "example": "980", - "nullable": true, - "type": "string", - "writeOnly": true - }, - "sortCol": { - "type": "string" - }, - "state": { - "type": "string" - }, - "stateDts": { - "$ref": "#/components/schemas/DateTime" - }, - "suffix": { - "type": "string" - }, - "suppressed": { - "type": "boolean" - }, - "title": { - "type": "string" - }, - "zip": { - "type": "string" - }, - "personaMapping": { - "description": "Stored mapping of lead phone values to persona phone IDs.", - "readOnly": true, - "type": "string" - }, - "personaPhoneConfig": { - "additionalProperties": { - "type": "string" - }, - "description": "Additional phone numbers for direct lead loading. Keys must exactly match configured persona phone labels, and values are phone numbers for that lead.", - "type": "object" - } - }, - "type": "object" - }, - "CampaignLeadList": { - "properties": { - "deleteLeads": { - "type": "boolean" - }, - "deletedDts": { - "$ref": "#/components/schemas/DateTime" - }, - "dncTagList": { - "type": "string" - }, - "exportFlag": { - "type": "boolean" - }, - "lastDncScrubDate": { - "$ref": "#/components/schemas/DateTime" - }, - "leadsAccepted": { - "format": "int32", - "type": "integer" - }, - "leadsConverted": { - "format": "int32", - "type": "integer" - }, - "leadsDoNotCall": { - "format": "int32", - "type": "integer" - }, - "leadsSupplied": { - "format": "int32", - "type": "integer" - }, - "leadsWhitelist": { - "format": "int32", - "type": "integer" - }, - "listDesc": { - "type": "string" - }, - "listId": { - "format": "int32", - "type": "integer" - }, - "listPriority": { - "format": "int32", - "type": "integer" - }, - "listState": { - "enum": [ - "ACTIVE", - "PAUSED", - "PENDING_DNC", - "LOADING", - "DELETED", - "READY", - "CALLBACKS", - "CALLBACKS_AGENT", - "DUPLICATES_NOT_MERGED", - "DUPLICATES_NOT_MOVED" - ], - "type": "string" - }, - "message": { - "type": "string" - }, - "originalFormat": { - "type": "string" - }, - "result": { - "type": "string" - }, - "unloadFilename": { - "type": "string" - }, - "uploadDate": { - "$ref": "#/components/schemas/DateTime" - }, - "uploadedBy": { - "type": "string" - } - }, - "type": "object" - }, - "CampaignLeadSearchCriteria": { - "properties": { - "address1": { - "type": "string" - }, - "address2": { - "type": "string" - }, - "agentDispositions": { - "items": { - "type": "string" - }, - "type": "array" - }, - "agentId": { - "format": "int32", - "type": "integer" - }, - "auxData1": { - "type": "string" - }, - "auxData2": { - "type": "string" - }, - "auxData3": { - "type": "string" - }, - "auxData4": { - "type": "string" - }, - "auxData5": { - "type": "string" - }, - "callerId": { - "type": "string" - }, - "campaignIds": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "city": { - "type": "string" - }, - "emailAddress": { - "type": "string" - }, - "externIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "firstName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "lastPassTimeCriteria": { - "$ref": "#/components/schemas/DateTimeComparableSearchField" - }, - "leadIds": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "leadPassesCriteria": { - "$ref": "#/components/schemas/ComparableSearchField" - }, - "leadPhoneNum": { - "type": "string" - }, - "leadPhoneNumbers": { - "items": { - "type": "string" - }, - "type": "array" - }, - "leadStates": { - "items": { - "enum": [ - "ACTIVE", - "AGENT-CALLBACK", - "CALLBACK-CANCELLED", - "CALLBACK", - "CANCELLED", - "COMPLETE", - "DISCONNECTED", - "DO-NOT-CALL", - "INTERCEPT", - "MAX-DIAL-LIMIT", - "PAUSED", - "PENDING-CALLBACK", - "PENDING-ERR", - "PENDING-HCI", - "PENDING", - "READY", - "TRANSITIONED", - "WHITELIST" - ], - "type": "string" - }, - "type": "array" - }, - "leadTimezones": { - "items": { - "$ref": "#/components/schemas/Timezone" - }, - "type": "array" - }, - "listIds": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "loadedDtsEnd": { - "$ref": "#/components/schemas/DateTime" - }, - "loadedDtsStart": { - "$ref": "#/components/schemas/DateTime" - }, - "nextDialTimeCriteria": { - "$ref": "#/components/schemas/DateTimeComparableSearchField" - }, - "orphanedLeadsOnly": { - "type": "boolean" - }, - "pendingAgentId": { - "format": "int32", - "type": "integer" - }, - "physicalStates": { - "items": { - "type": "string" - }, - "type": "array" - }, - "suppressed": { - "enum": [ - "ONLY_SUPPRESSED", - "ONLY_UNSUPPRESSED", - "ALL" - ], - "type": "string" - }, - "systemDispositions": { - "items": { - "enum": [ - "ANSWER", - "NOANSWER", - "BUSY", - "MACHINE", - "INTERCEPT", - "DISCONNECT", - "ABANDON", - "CONGESTION", - "MANUAL_PASS", - "INBOUND_CALLBACK", - "APP_DNC", - "APP_REQUEUE", - "APP_REQUEUE_COMPLETE", - "APP_REQUEUE_ABANDON", - "INBOUND_ABANDON", - "API_BLOCKED", - "API_ERROR" - ], - "type": "string" - }, - "type": "array" - }, - "zip": { - "type": "string" - } - }, - "type": "object" - }, - "CampaignLeadSearchResultsView": { - "properties": { - "address1": { - "type": "string" - }, - "address2": { - "type": "string" - }, - "agentDispostion": { - "type": "string" - }, - "auxData1": { - "type": "string" - }, - "auxData2": { - "type": "string" - }, - "auxData3": { - "type": "string" - }, - "auxData4": { - "type": "string" - }, - "auxData5": { - "type": "string" - }, - "auxExternalUrl": { - "type": "string" - }, - "auxGreeting": { - "type": "string" - }, - "auxPhone": { - "type": "string" - }, - "callerId": { - "type": "string" - }, - "campaignId": { - "format": "int32", - "type": "integer" - }, - "campaignLead": { - "$ref": "#/components/schemas/CampaignLead" - }, - "campaignName": { - "type": "string" - }, - "city": { - "type": "string" - }, - "dialGroupId": { - "format": "int32", - "type": "integer" - }, - "dupeKeyOverride": { - "format": "int64", - "type": "integer" - }, - "email": { - "type": "string" - }, - "externId": { - "type": "string" - }, - "extraData": { - "type": "string" - }, - "firstName": { - "type": "string" - }, - "gateKeeper": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "lastPassAgentName": { - "type": "string" - }, - "lastPassDate": { - "$ref": "#/components/schemas/DateTime" - }, - "lastPassDispo": { - "type": "string" - }, - "lastPassDisposition": { - "type": "string" - }, - "lastPassDts": { - "$ref": "#/components/schemas/DateTime" - }, - "leadId": { - "format": "int32", - "type": "integer" - }, - "leadPasses": { - "format": "int32", - "type": "integer" - }, - "leadPhone": { - "type": "string" - }, - "leadState": { - "type": "string" - }, - "leadTimezone": { - "type": "string" - }, - "listDesc": { - "type": "string" - }, - "listId": { - "format": "int32", - "type": "integer" - }, - "liveAnswerMessage": { - "type": "string" - }, - "loadedDts": { - "$ref": "#/components/schemas/DateTime" - }, - "machAnswerMessage": { - "type": "string" - }, - "maxPasses": { - "format": "int32", - "type": "integer" - }, - "midName": { - "type": "string" - }, - "nextDialTime": { - "$ref": "#/components/schemas/DateTime" - }, - "pendingAgentName": { - "type": "string" - }, - "sortCol": { - "type": "string" - }, - "speedToLeadAgentConn": { - "format": "int32", - "type": "integer" - }, - "speedToLeadFirstPass": { - "format": "int32", - "type": "integer" - }, - "state": { - "type": "string" - }, - "stateDts": { - "$ref": "#/components/schemas/DateTime" - }, - "suffix": { - "type": "string" - }, - "suppressed": { - "type": "boolean" - }, - "title": { - "type": "string" - }, - "uploadDate": { - "$ref": "#/components/schemas/DateTime" - }, - "uploadedBy": { - "type": "string" - }, - "zip": { - "type": "string" - } - }, - "type": "object" - }, - "CampaignPass": { - "properties": { - "agent": { - "$ref": "#/components/schemas/Agent" - }, - "agentDisposition": { - "type": "string" - }, - "agentNotes": { - "type": "string" - }, - "callStart": { - "$ref": "#/components/schemas/DateTime" - }, - "campaignRedials": { - "items": { - "$ref": "#/components/schemas/CampaignRedial" - }, - "type": "array" - }, - "dialDuration": { - "format": "int32", - "type": "integer" - }, - "dialType": { - "type": "boolean" - }, - "duration": { - "format": "int32", - "type": "integer" - }, - "export": { - "type": "boolean" - }, - "exportFlag": { - "type": "boolean" - }, - "leadPhone": { - "type": "string" - }, - "passDate": { - "$ref": "#/components/schemas/DateTime" - }, - "passDisposition": { - "enum": [ - "ANSWER", - "NOANSWER", - "BUSY", - "MACHINE", - "INTERCEPT", - "DISCONNECT", - "ABANDON", - "CONGESTION", - "MANUAL_PASS", - "INBOUND_CALLBACK", - "APP_DNC", - "APP_REQUEUE", - "APP_REQUEUE_COMPLETE", - "APP_REQUEUE_ABANDON", - "INBOUND_ABANDON", - "API_BLOCKED", - "API_ERROR" - ], - "type": "string" - }, - "passNumber": { - "format": "int32", - "type": "integer" - }, - "passUii": { - "type": "string" - } - }, - "type": "object" - }, - "CampaignPassDisposition": { - "properties": { - "createCopy": { - "type": "boolean" - }, - "destCampaign": { - "$ref": "#/components/schemas/Campaign" - }, - "isComplete": { - "type": "boolean" - }, - "machineDetect": { - "format": "int32", - "type": "integer" - }, - "mergeOriginal": { - "type": "boolean" - }, - "pass": { - "format": "int32", - "type": "integer" - }, - "passDispositionId": { - "format": "int32", - "type": "integer" - }, - "passEnd": { - "format": "int32", - "type": "integer" - }, - "requeueDelay": { - "format": "int32", - "type": "integer" - }, - "requeueType": { - "enum": [ - "DEFAULT", - "NONE", - "STANDARD", - "PRIORITY" - ], - "type": "string" - } - }, - "type": "object" - }, - "CampaignRedial": { - "properties": { - "agentId": { - "format": "int32", - "type": "integer" - }, - "callBackDate": { - "$ref": "#/components/schemas/DateTime" - }, - "callBackPhone": { - "type": "string" - }, - "campaignLead": { - "$ref": "#/components/schemas/CampaignLead" - }, - "campaignPass": { - "$ref": "#/components/schemas/CampaignPass" - }, - "id": { - "format": "int32", - "type": "integer" - }, - "name": { - "type": "string" - }, - "redialId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "CampaignStats": { - "properties": { - "campaignId": { - "format": "int32", - "type": "integer" - }, - "campaignName": { - "type": "string" - }, - "complete": { - "format": "int32", - "type": "integer" - }, - "doNotCall": { - "format": "int32", - "type": "integer" - }, - "endDate": { - "$ref": "#/components/schemas/DateTime" - }, - "maxPasses": { - "format": "int32", - "type": "integer" - }, - "other": { - "format": "int32", - "type": "integer" - }, - "paused": { - "format": "int32", - "type": "integer" - }, - "readyFuture": { - "format": "int32", - "type": "integer" - }, - "readyNow": { - "format": "int32", - "type": "integer" - }, - "startDate": { - "$ref": "#/components/schemas/DateTime" - }, - "suppressed": { - "format": "int32", - "type": "integer" - }, - "targetId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "CampaignTimeZoneDialCount": { - "properties": { - "dialFuture": { - "format": "int32", - "type": "integer" - }, - "dialNow": { - "format": "int32", - "type": "integer" - }, - "suppressed": { - "format": "int32", - "type": "integer" - }, - "timezone": { - "type": "string" - } - }, - "type": "object" - }, - "CampaignTimeZoneDialCountWrapper": { - "properties": { - "campaignId": { - "format": "int32", - "type": "integer" - }, - "campaignName": { - "type": "string" - }, - "dialGroupId": { - "format": "int32", - "type": "integer" - }, - "dialGroupName": { - "type": "string" - }, - "dialMode": { - "enum": [ - "PREVIEW", - "CLICK_TO_TALK", - "PREDICTIVE", - "POWER", - "TCPA_SAFE_MODE" - ], - "type": "string" - }, - "endDate": { - "$ref": "#/components/schemas/DateTime" - }, - "leadData": { - "items": { - "$ref": "#/components/schemas/CampaignTimeZoneDialCount" - }, - "type": "array" - }, - "maxPasses": { - "format": "int32", - "type": "integer" - }, - "passDelayMin": { - "format": "int32", - "type": "integer" - }, - "startDate": { - "$ref": "#/components/schemas/DateTime" - } - }, - "type": "object" - }, - "CampaignUnlimitedFieldGroup": { - "properties": { - "campaigns": { - "items": { - "$ref": "#/components/schemas/Campaign" - }, - "type": "array" - }, - "extraDataMappings": { - "type": "string" - }, - "groupName": { - "type": "string" - }, - "unlimitedFieldGroupId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "ChatGroup": { - "properties": { - "billingKey": { - "type": "string" - }, - "chatGroupId": { - "format": "int32", - "type": "integer" - }, - "chatGroupSkills": { - "items": { - "$ref": "#/components/schemas/ChatGroupSkill" - }, - "type": "array" - }, - "chatGroups": { - "items": { - "$ref": "#/components/schemas/ChatQueue" - }, - "type": "array" - }, - "chatQueues": { - "items": { - "$ref": "#/components/schemas/ChatQueue" - }, - "type": "array" - }, - "createdOn": { - "$ref": "#/components/schemas/DateTime" - }, - "groupName": { - "type": "string" - }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "ChatGroupSkill": { - "properties": { - "active": { - "type": "boolean" - }, - "agentSkillProfiles": { - "$ref": "#/components/schemas/CollectionAgentSkillProfile" - }, - "chatRequeueShortcuts": { - "items": { - "$ref": "#/components/schemas/ChatRequeueShortcut" - }, - "type": "array" - }, - "createdOn": { - "$ref": "#/components/schemas/DateTime" - }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - }, - "skillDesc": { - "type": "string" - }, - "skillId": { - "format": "int32", - "type": "integer" - }, - "skillName": { - "type": "string" - } - }, - "type": "object" - }, - "ChatPriorityGroup": { - "properties": { - "chatPriorityGroupId": { - "format": "int32", - "type": "integer" - }, - "chatQueues": { - "items": { - "$ref": "#/components/schemas/ChatQueue" - }, - "type": "array" - }, - "priorityGroupName": { - "type": "string" - } - }, - "type": "object" - }, - "ChatQueue": { - "properties": { - "account": { - "$ref": "#/components/schemas/Account" - }, - "accountId": { - "type": "string" - }, - "active": { - "type": "boolean" - }, - "agentConnectHttpService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "agentConnectMsg": { - "type": "string" - }, - "agentFrom": { - "type": "string" - }, - "agentMaxAcceptTime": { - "format": "int32", - "type": "integer" - }, - "agentTermHttpService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "agentWrapTime": { - "format": "int32", - "type": "integer" - }, - "appUrl": { - "type": "string" - }, - "callbackCampaign": { - "$ref": "#/components/schemas/Campaign" - }, - "chatGroup": { - "$ref": "#/components/schemas/ChatGroup" - }, - "chatPriorityGroup": { - "$ref": "#/components/schemas/ChatPriorityGroup" - }, - "chatQueueDescription": { - "type": "string" - }, - "chatQueueId": { - "format": "int32", - "type": "integer" - }, - "chatQueueName": { - "type": "string" - }, - "chatQueueOpen": { - "type": "boolean" - }, - "clientFrom": { - "type": "string" - }, - "companyLogo": { - "$ref": "#/components/schemas/Blob" - }, - "createdOn": { - "$ref": "#/components/schemas/DateTime" - }, - "dequeueHttpService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "dispTimeout": { - "format": "int32", - "type": "integer" - }, - "friSched": { - "type": "string" - }, - "gateQueueAnips": { - "items": { - "$ref": "#/components/schemas/ChatQueueAnip" - }, - "type": "array" - }, - "groupId": { - "format": "int32", - "type": "integer" - }, - "idleTimeout": { - "format": "int32", - "type": "integer" - }, - "isActive": { - "type": "boolean" - }, - "longChatTime": { - "format": "int32", - "type": "integer" - }, - "maxQueueEvent": { - "type": "string" - }, - "maxQueueLimit": { - "format": "int32", - "type": "integer" - }, - "monSched": { - "type": "string" - }, - "newChatHttpService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "noAgentEvent": { - "type": "string" - }, - "observeDst": { - "type": "boolean" - }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - }, - "postChatHttpService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "postDispHttpService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "queueClosedEvent": { - "type": "string" - }, - "queuePriority": { - "format": "int32", - "type": "integer" - }, - "requeueShortcutAccess": { - "items": { - "$ref": "#/components/schemas/ChatRequeueShortcutGroupChatQueueAccess" - }, - "type": "array" - }, - "requeueType": { - "type": "string" - }, - "requireCaptcha": { - "type": "boolean" - }, - "satSched": { - "type": "string" - }, - "script": { - "$ref": "#/components/schemas/Script" - }, - "shortChatTime": { - "format": "int32", - "type": "integer" - }, - "slaTime": { - "format": "int32", - "type": "integer" - }, - "specialIpEvent": { - "type": "string" - }, - "sunSched": { - "type": "string" - }, - "surveyId": { - "format": "int32", - "type": "integer" - }, - "surveyPopType": { - "type": "string" - }, - "throttleCalls": { - "format": "int32", - "type": "integer" - }, - "throttleDays": { - "format": "int32", - "type": "integer" - }, - "throttleIpEvent": { - "type": "string" - }, - "thuSched": { - "type": "string" - }, - "tueSched": { - "type": "string" - }, - "wedSched": { - "type": "string" - } - }, - "type": "object" - }, - "ChatQueueAnip": { - "properties": { - "anip": { - "type": "string" - }, - "chatQueueId": { - "format": "int32", - "type": "integer" - }, - "dateAdded": { - "$ref": "#/components/schemas/DateTime" - }, - "recordType": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "type": "object" - }, - "ChatQueueChatWidgetAccess": { - "properties": { - "chatQueue": { - "$ref": "#/components/schemas/ChatQueue" - }, - "chatQueueId": { - "format": "int32", - "type": "integer" - }, - "chatWidget": { - "$ref": "#/components/schemas/ChatWidget" - }, - "guid": { - "type": "string" - }, - "jsonMetadata": { - "type": "string" - }, - "widgetId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "ChatQueueClosedMessage": { - "properties": { - "accountId": { - "type": "string" - }, - "chatQueueClosedMessageId": { - "format": "int32", - "type": "integer" - }, - "chatQueueId": { - "format": "int32", - "type": "integer" - }, - "jsonBaggage": { - "type": "string" - }, - "sourceIp": { - "type": "string" - }, - "timeStamp": { - "$ref": "#/components/schemas/DateTime" - } - }, - "type": "object" - }, - "ChatQueueDisposition": { - "properties": { - "chatGroupSkill": { - "$ref": "#/components/schemas/ChatGroupSkill" - }, - "chatQueue": { - "$ref": "#/components/schemas/ChatQueue" - }, - "destChatQueue": { - "$ref": "#/components/schemas/ChatQueue" - }, - "dispServiceId": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "disposition": { - "type": "string" - }, - "dispositionId": { - "format": "int32", - "type": "integer" - }, - "emailDestinations": { - "type": "string" - }, - "emailTemplate": { - "$ref": "#/components/schemas/EmailTemplate" - }, - "isComplete": { - "type": "boolean" - }, - "isDefault": { - "type": "boolean" - }, - "isDisabled": { - "type": "boolean" - }, - "isSuccess": { - "type": "boolean" - }, - "rank": { - "format": "int32", - "type": "integer" - }, - "timeout": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "ChatQueueEvent": { - "properties": { - "chatQueue": { - "$ref": "#/components/schemas/ChatQueue" - }, - "eventDuration": { - "format": "int32", - "type": "integer" - }, - "eventId": { - "format": "int32", - "type": "integer" - }, - "eventRank": { - "format": "int32", - "type": "integer" - }, - "queueEvent": { - "type": "string" - }, - "sendMessage": { - "type": "string" - } - }, - "type": "object" - }, - "ChatQueueScheduleOverride": { - "properties": { - "chatQueue": { - "$ref": "#/components/schemas/ChatQueue" - }, - "overrideClosedEvent": { - "type": "string" - }, - "overrideDate": { - "$ref": "#/components/schemas/DateTime" - }, - "overrideLabel": { - "type": "string" - }, - "overrideSched": { - "type": "string" - }, - "scheduleOverrideId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "ChatQueueSkinny": { - "properties": { - "accountId": { - "type": "string" - }, - "chatGroupId": { - "format": "int32", - "type": "integer" - }, - "chatQueueId": { - "format": "int32", - "type": "integer" - }, - "chatQueueName": { - "type": "string" - }, - "isActive": { - "type": "boolean" - } - }, - "type": "object" - }, - "ChatQueueSpecialAnip": { - "properties": { - "anip": { - "type": "string" - }, - "dateAdded": { - "$ref": "#/components/schemas/DateTime" - }, - "id": { - "type": "object" - }, - "type": { - "type": "string" - } - }, - "type": "object" - }, - "ChatRequeueShortcut": { - "properties": { - "chatGroupSkill": { - "$ref": "#/components/schemas/ChatGroupSkill" - }, - "chatRequeueShortcutId": { - "format": "int32", - "type": "integer" - }, - "name": { - "type": "string" - }, - "rank": { - "format": "int32", - "type": "integer" - }, - "requeueGroup": { - "$ref": "#/components/schemas/ChatGroup" - }, - "requeueQueue": { - "$ref": "#/components/schemas/ChatQueue" - } - }, - "type": "object" - }, - "ChatRequeueShortcutGroup": { - "properties": { - "chatRequeueShortcutGroupId": { - "format": "int32", - "type": "integer" - }, - "name": { - "type": "string" - } - }, - "type": "object" - }, - "ChatRequeueShortcutGroupChatQueueAccess": { - "properties": { - "chatQueue": { - "$ref": "#/components/schemas/ChatQueue" - }, - "chatQueueId": { - "format": "int32", - "type": "integer" - }, - "chatRequeueShortcutGroup": { - "$ref": "#/components/schemas/ChatRequeueShortcutGroup" - }, - "chatRequeueShortcutGroupId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "ChatRoom": { - "properties": { - "accountId": { - "type": "string" - }, - "permissionType": { - "enum": [ - "ALL", - "EXPLICIT" - ], - "type": "string" - }, - "roomDesc": { - "type": "string" - }, - "roomId": { - "format": "int32", - "type": "integer" - }, - "roomName": { - "type": "string" - } - }, - "type": "object" - }, - "ChatStats": { - "properties": { - "abandoned": { - "format": "int32", - "type": "integer" - }, - "accepted": { - "format": "int32", - "type": "integer" - }, - "accountId": { - "type": "string" - }, - "active": { - "format": "int32", - "type": "integer" - }, - "available": { - "format": "int32", - "type": "integer" - }, - "chatQueueGroupId": { - "format": "int32", - "type": "integer" - }, - "chatQueueGroupName": { - "type": "string" - }, - "chatQueueId": { - "format": "int32", - "type": "integer" - }, - "chatQueueName": { - "type": "string" - }, - "deflected": { - "format": "int32", - "type": "integer" - }, - "inQueue": { - "format": "int32", - "type": "integer" - }, - "lastUpdate": { - "$ref": "#/components/schemas/DateTime" - }, - "longestInQueue": { - "format": "int32", - "type": "integer" - }, - "presented": { - "format": "int32", - "type": "integer" - }, - "routing": { - "format": "int32", - "type": "integer" - }, - "schedule": { - "type": "string" - }, - "scheduleOverride": { - "type": "string" - }, - "selectable": { - "type": "boolean" - }, - "staffed": { - "format": "int32", - "type": "integer" - }, - "totalAbandonTime": { - "format": "int64", - "type": "integer" - }, - "totalAnswerTime": { - "format": "int64", - "type": "integer" - }, - "totalChatTime": { - "format": "int64", - "type": "integer" - }, - "totalQueueTime": { - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "ChatWidget": { - "properties": { - "chatWidgetId": { - "format": "int32", - "type": "integer" - }, - "createdDts": { - "$ref": "#/components/schemas/DateTime" - }, - "json": { - "type": "string" - }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - }, - "updatedDts": { - "$ref": "#/components/schemas/DateTime" - }, - "widgetDesc": { - "type": "string" - }, - "widgetId": { - "format": "int32", - "type": "integer" - }, - "widgetName": { - "type": "string" - } - }, - "type": "object" - }, - "Chronology": { - "properties": { - "zone": { - "$ref": "#/components/schemas/DateTimeZone" - } - }, - "type": "object" - }, - "ClassLoader": { - "properties": { - "parent": { - "$ref": "#/components/schemas/ClassLoader" - } - }, - "title": "ClassLoader", - "type": "object" - }, - "CloudRouteAssignedDestination": { - "properties": { - "allocationPercent": { - "format": "int32", - "type": "integer" - }, - "allocationPercentHours": { - "type": "string" - }, - "assignedDestinationId": { - "format": "int32", - "type": "integer" - }, - "cloudDestination": { - "$ref": "#/components/schemas/CloudRouteDestination" - }, - "cloudProfile": { - "$ref": "#/components/schemas/CloudRouteProfile" - }, - "countryCode": { - "$ref": "#/components/schemas/CountryCode" - }, - "destinationType": { - "enum": [ - "STANDARD", - "DID", - "SIP", - "IN_NETWORK_DID", - "ACD", - "IVR", - "IVR_STUDIO" - ], - "type": "string" - }, - "dtmfEventsEnabled": { - "type": "boolean" - }, - "enablePrerouteHttp": { - "type": "boolean" - }, - "forceAcdQueue": { - "type": "boolean" - }, - "outboundCallerId": { - "type": "string" - }, - "overrideFlag": { - "type": "boolean" - }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - }, - "rank": { - "format": "int32", - "type": "integer" - }, - "repeatIndexStart": { - "format": "int32", - "type": "integer" - }, - "ringDuration": { - "format": "int32", - "type": "integer" - }, - "routeDestination": { - "type": "string" - }, - "takeBackDtmf": { - "type": "string" - }, - "ttAccept": { - "type": "boolean" - }, - "ttAcceptTime": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "CloudRouteAssignedOverride": { - "properties": { - "assignedDestination": { - "$ref": "#/components/schemas/CloudRouteAssignedDestination" - }, - "assignedOverrideId": { - "format": "int32", - "type": "integer" - }, - "countryId": { - "type": "string" - }, - "dnis": { - "type": "string" - }, - "routeDestination": { - "type": "string" - } - }, - "type": "object" - }, - "CloudRouteDestination": { - "properties": { - "active": { - "type": "boolean" - }, - "address": { - "type": "string" - }, - "authKey": { - "type": "string" - }, - "city": { - "type": "string" - }, - "cloudDestinationId": { - "format": "int32", - "type": "integer" - }, - "cloudRouteGroup": { - "$ref": "#/components/schemas/CloudRouteGroup" - }, - "countryCode": { - "$ref": "#/components/schemas/CountryCode" - }, - "deleted": { - "type": "boolean" - }, - "destinationDesc": { - "type": "string" - }, - "destinationName": { - "type": "string" - }, - "destinationType": { - "enum": [ - "STANDARD", - "DID", - "SIP", - "IN_NETWORK_DID", - "ACD", - "IVR", - "IVR_STUDIO" - ], - "type": "string" - }, - "endDate": { - "$ref": "#/components/schemas/DateTime" - }, - "forceAcdQueue": { - "type": "boolean" - }, - "friSched": { - "type": "string" - }, - "isActive": { - "type": "boolean" - }, - "isDeleted": { - "type": "boolean" - }, - "lat": { - "format": "double", - "type": "number" - }, - "lon": { - "format": "double", - "type": "number" - }, - "maxConcurrent": { - "format": "int32", - "type": "integer" - }, - "maxConcurrentHours": { - "type": "string" - }, - "maxConcurrentType": { - "type": "string" - }, - "monSched": { - "type": "string" - }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - }, - "prerouteHttpUrl": { - "type": "string" - }, - "ringDuration": { - "format": "int32", - "type": "integer" - }, - "routeDestination": { - "type": "string" - }, - "satSched": { - "type": "string" - }, - "startDate": { - "$ref": "#/components/schemas/DateTime" - }, - "state": { - "type": "string" - }, - "sunSched": { - "type": "string" - }, - "thuSched": { - "type": "string" - }, - "ttAccept": { - "type": "boolean" - }, - "ttAcceptTime": { - "format": "int32", - "type": "integer" - }, - "tueSched": { - "type": "string" - }, - "wedSched": { - "type": "string" - }, - "zip": { - "type": "string" - } - }, - "type": "object" - }, - "CloudRouteDestinationOverride": { - "properties": { - "cloudDestination": { - "$ref": "#/components/schemas/CloudRouteDestination" - }, - "countryId": { - "type": "string" - }, - "destOverrideId": { - "format": "int32", - "type": "integer" - }, - "dnis": { - "type": "string" - }, - "routeDestination": { - "type": "string" - } - }, - "type": "object" - }, - "CloudRouteDtmfEvent": { - "properties": { - "cloudRouteDtmfId": { - "format": "int32", - "type": "integer" - }, - "dtmfCode": { - "format": "int32", - "type": "integer" - }, - "dtmfEventData": { - "type": "string" - } - }, - "type": "object" - }, - "CloudRouteGroup": { - "properties": { - "cloudGroupId": { - "format": "int32", - "type": "integer" - }, - "cloudRouteDestinations": { - "$ref": "#/components/schemas/CollectionCloudRouteDestination" - }, - "cloudRouteProfiles": { - "$ref": "#/components/schemas/CollectionCloudRouteProfile" - }, - "groupName": { - "type": "string" - }, - "isDefault": { - "type": "boolean" - }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "CloudRouteProfile": { - "properties": { - "billingCode": { - "type": "string" - }, - "billingKey": { - "type": "string" - }, - "callConnSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "callEndSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "callStartSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "cloudProfileId": { - "format": "int32", - "type": "integer" - }, - "cloudRouteGroup": { - "$ref": "#/components/schemas/CloudRouteGroup" - }, - "dequeueDelay": { - "format": "int32", - "type": "integer" - }, - "endcallMsg": { - "type": "string" - }, - "geoMaxDistance": { - "format": "int32", - "type": "integer" - }, - "introMsg": { - "type": "string" - }, - "isActive": { - "type": "boolean" - }, - "isDeleted": { - "type": "boolean" - }, - "longCall": { - "format": "int32", - "type": "integer" - }, - "outboundCallerId": { - "type": "string" - }, - "percentAllocType": { - "type": "string" - }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - }, - "profileDesc": { - "type": "string" - }, - "profileName": { - "type": "string" - }, - "recordCall": { - "type": "boolean" - }, - "repeatCount": { - "format": "int32", - "type": "integer" - }, - "repeatDelay": { - "format": "int32", - "type": "integer" - }, - "revMatch": { - "type": "boolean" - }, - "routeExhaustedAction": { - "type": "string" - }, - "routingType": { - "type": "string" - }, - "shortCall": { - "format": "int32", - "type": "integer" - }, - "stickyDestinationType": { - "type": "string" - }, - "takeBackMsg": { - "type": "string" - }, - "voicemailEmail": { - "type": "string" - }, - "whisperMsg": { - "type": "string" - } - }, - "type": "object" - }, - "CloudRouteProfileSkinny": { - "properties": { - "accountId": { - "type": "string" - }, - "cloudGroupId": { - "format": "int32", - "type": "integer" - }, - "cloudProfileId": { - "format": "int32", - "type": "integer" - }, - "groupId": { - "format": "int32", - "type": "integer" - }, - "isActive": { - "type": "boolean" - }, - "isDeleted": { - "type": "boolean" - }, - "profileName": { - "type": "string" - } - }, - "type": "object" - }, - "CollectionAgent": { - "type": "object" - }, - "CollectionAgentAccountAccess": { - "type": "object" - }, - "CollectionAgentBlockMonitor": { - "type": "object" - }, - "CollectionAgentChatQueueAccess": { - "type": "object" - }, - "CollectionAgentDialGroupMember": { - "type": "object" - }, - "CollectionAgentGateAccess": { - "type": "object" - }, - "CollectionAgentLoadBalanceMember": { - "type": "object" - }, - "CollectionAgentLoginChatQueues": { - "type": "object" - }, - "CollectionAgentLoginGate": { - "type": "object" - }, - "CollectionAgentSkillProfile": { - "type": "object" - }, - "CollectionAgentSupervisor": { - "type": "object" - }, - "CollectionCampaign": { - "type": "object" - }, - "CollectionCampaignDisposition": { - "type": "object" - }, - "CollectionCampaignFilterStates": { - "type": "object" - }, - "CollectionCampaignFilterTimezones": { - "type": "object" - }, - "CollectionCloudRouteDestination": { - "type": "object" - }, - "CollectionCloudRouteProfile": { - "type": "object" - }, - "CollectionCustomCriteriaPlan": { - "type": "object" - }, - "CollectionCustomDialZone": { - "type": "object" - }, - "CollectionCustomDialZoneGroups": { - "type": "object" - }, - "CollectionDncTag": { - "type": "object" - }, - "CollectionJobInfo": { - "type": "object" - }, - "CollectionMultipartFile": { - "type": "object" - }, - "CollectionQuotaTarget": { - "type": "object" - }, - "CollectionRemoteHttpService": { - "type": "object" - }, - "CollectionRemoteHttpServiceInput": { - "type": "object" - }, - "CollectionReportMetaData": { - "type": "object" - }, - "CollectionRequeueShortcut": { - "type": "object" - }, - "CollectionRightsDocument": { - "type": "object" - }, - "CollectionState": { - "type": "object" - }, - "CollectionSurvey": { - "type": "object" - }, - "CollectionTracLocation": { - "type": "object" - }, - "CollectionVisualIvr": { - "type": "object" - }, - "CollectionWhitelistTagMembers": { - "type": "object" - }, - "Collection_AgentAccountAccess_": { - "type": "object" - }, - "Collection_AgentChatQueueAccess_": { - "type": "object" - }, - "Collection_AgentDialGroupMember_": { - "type": "object" - }, - "Collection_AgentGateAccess_": { - "type": "object" - }, - "Collection_AgentLoadBalanceMember_": { - "type": "object" - }, - "Collection_AgentSkillProfile_": { - "type": "object" - }, - "Collection_AgentSupervisor_": { - "type": "object" - }, - "Collection_Agent_": { - "type": "object" - }, - "Collection_CampaignDisposition_": { - "type": "object" - }, - "Collection_CampaignFilterStates_": { - "type": "object" - }, - "Collection_CampaignFilterTimezones_": { - "type": "object" - }, - "Collection_Campaign_": { - "type": "object" - }, - "Collection_CustomDialZone_": { - "type": "object" - }, - "Collection_GateSkinny_": { - "type": "object" - }, - "Collection_QuotaTarget_": { - "type": "object" - }, - "Collection_RequeueShortcut_": { - "type": "object" - }, - "Collection_WhitelistTagMembers_": { - "type": "object" - }, - "ComparableSearchField": { - "properties": { - "operator": { - "enum": [ - "GREATER_THAN", - "LESS_THAN", - "EQUALS" - ], - "type": "string" - }, - "value": { - "type": "object" - } - }, - "type": "object" - }, - "Contact": { - "properties": { - "businessPhone": { - "type": "string" - }, - "company": { - "type": "string" - }, - "department": { - "type": "string" - }, - "email": { - "type": "string" - }, - "emailAsLoginName": { - "type": "boolean" - }, - "firstName": { - "type": "string" - }, - "jobTitle": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "mobilePhone": { - "type": "string" - } - }, - "title": "Contact", - "type": "object" - }, - "Country": { - "properties": { - "countryCode": { - "type": "string" - }, - "countryId": { - "description": "Country code i ISO 3166-1 alpha-3 format", - "type": "string" - }, - "countryName": { - "type": "string" - }, - "maxAniLength": { - "format": "int32", - "type": "integer" - }, - "maxUtcOffset": { - "format": "int32", - "type": "integer" - }, - "minAniLength": { - "format": "int32", - "type": "integer" - }, - "minUtcOffset": { - "format": "int32", - "type": "integer" - } - }, - "required": [ - "countryCode" - ], - "type": "object" - }, - "CountryCode": { - "properties": { - "countryCode": { - "type": "string" - }, - "countryId": { - "type": "string" - }, - "countryName": { - "type": "string" - }, - "maxAniLength": { - "format": "int32", - "type": "integer" - }, - "maxUtcOffset": { - "format": "int32", - "type": "integer" - }, - "minAniLength": { - "format": "int32", - "type": "integer" - }, - "minUtcOffset": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "CustomCriteriaGroup": { - "properties": { - "active": { - "type": "boolean" - }, - "customCriteriaPlan": { - "$ref": "#/components/schemas/CollectionCustomCriteriaPlan" - }, - "groupId": { - "format": "int32", - "type": "integer" - }, - "groupName": { - "type": "string" - }, - "isActive": { - "type": "boolean" - } - }, - "type": "object" - }, - "CustomCriteriaPlan": { - "properties": { - "criteriaJson": { - "type": "string" - }, - "endDate": { - "$ref": "#/components/schemas/DateTime" - }, - "planId": { - "format": "int32", - "type": "integer" - }, - "planName": { - "type": "string" - }, - "startDate": { - "$ref": "#/components/schemas/DateTime" - } - }, - "type": "object" - }, - "CustomDialZone": { - "properties": { - "fridaySchedule": { - "type": "string" - }, - "mondaySchedule": { - "type": "string" - }, - "saturdaySchedule": { - "type": "string" - }, - "sundaySchedule": { - "type": "string" - }, - "thursdaySchedule": { - "type": "string" - }, - "tuesdaySchedule": { - "type": "string" - }, - "wednesdaySchedule": { - "type": "string" - }, - "zoneDesc": { - "type": "string" - }, - "zoneGroup": { - "$ref": "#/components/schemas/CustomDialZoneGroups" - }, - "zoneGroups": { - "$ref": "#/components/schemas/CustomDialZoneGroups" - }, - "zoneId": { - "format": "int32", - "type": "integer" - }, - "zoneKey": { - "type": "string" - } - }, - "type": "object" - }, - "CustomDialZoneGroups": { - "properties": { - "accountId": { - "type": "string" - }, - "baseTimezone": { - "type": "string" - }, - "customDialZones": { - "$ref": "#/components/schemas/CollectionCustomDialZone" - }, - "zoneGroupId": { - "format": "int32", - "type": "integer" - }, - "zoneGroupName": { - "type": "string" - } - }, - "type": "object" - }, - "Dashboard": { - "properties": { - "creationDate": { - "$ref": "#/components/schemas/DateTime" - }, - "data": { - "$ref": "#/components/schemas/JsonNode" - }, - "id": { - "format": "int32", - "type": "integer" - }, - "name": { - "type": "string" - }, - "shared": { - "type": "boolean" - } - }, - "type": "object" - }, - "Role": { - "type": "object", - "properties": { - "description": { - "type": "string" - }, - "roleType": { - "type": "string", - "enum": [ - "SUPER_USER", - "USER", - "MANAGE_USERS", - "MANAGE_RIGHTS", - "ACCESS_SIBLINGS", - "ACCESS_AUDIT_LOG", - "ACCESS_GOODDATA_ADMIN", - "ACCESS_GOODDATA_EDITOR", - "ACCESS_GOODDATA_EXPLORER", - "ACCESS_GOODDATA_VIEWER", - "ACCESS_GOODDATA_EMBEDDED_EXPLORER", - "ACCESS_GOODDATA_EMBEDDED_DASHBOARD", - "ASSUME_USERS", - "REPORT_ADMINISTRATIVE_USER", - "NO_ACCESS" - ] - } - } - }, - "DateTime": { - "properties": { - "afterNow": { - "type": "boolean" - }, - "beforeNow": { - "type": "boolean" - }, - "centuryOfEra": { - "format": "int32", - "type": "integer" - }, - "chronology": { - "$ref": "#/components/schemas/Chronology" - }, - "dayOfMonth": { - "format": "int32", - "type": "integer" - }, - "dayOfWeek": { - "format": "int32", - "type": "integer" - }, - "dayOfYear": { - "format": "int32", - "type": "integer" - }, - "equalNow": { - "type": "boolean" - }, - "era": { - "format": "int32", - "type": "integer" - }, - "hourOfDay": { - "format": "int32", - "type": "integer" - }, - "millis": { - "format": "int64", - "type": "integer" - }, - "millisOfDay": { - "format": "int32", - "type": "integer" - }, - "millisOfSecond": { - "format": "int32", - "type": "integer" - }, - "minuteOfDay": { - "format": "int32", - "type": "integer" - }, - "minuteOfHour": { - "format": "int32", - "type": "integer" - }, - "monthOfYear": { - "format": "int32", - "type": "integer" - }, - "secondOfDay": { - "format": "int32", - "type": "integer" - }, - "secondOfMinute": { - "format": "int32", - "type": "integer" - }, - "weekOfWeekyear": { - "format": "int32", - "type": "integer" - }, - "weekyear": { - "format": "int32", - "type": "integer" - }, - "year": { - "format": "int32", - "type": "integer" - }, - "yearOfCentury": { - "format": "int32", - "type": "integer" - }, - "yearOfEra": { - "format": "int32", - "type": "integer" - }, - "zone": { - "$ref": "#/components/schemas/DateTimeZone" - } - }, - "type": "object" - }, - "DateTimeComparableSearchField": { - "properties": { - "operator": { - "enum": [ - "GREATER_THAN", - "LESS_THAN", - "EQUALS" - ], - "type": "string" - }, - "value": { - "$ref": "#/components/schemas/DateTime" - } - }, - "type": "object" - }, - "DateTimeField": { - "properties": { - "durationField": { - "$ref": "#/components/schemas/DurationField" - }, - "leapDurationField": { - "$ref": "#/components/schemas/DurationField" - }, - "lenient": { - "type": "boolean" - }, - "maximumValue": { - "format": "int32", - "type": "integer" - }, - "minimumValue": { - "format": "int32", - "type": "integer" - }, - "name": { - "type": "string" - }, - "rangeDurationField": { - "$ref": "#/components/schemas/DurationField" - }, - "supported": { - "type": "boolean" - }, - "type": { - "$ref": "#/components/schemas/DateTimeFieldType" - } - }, - "type": "object" - }, - "DateTimeFieldType": { - "properties": { - "durationType": { - "$ref": "#/components/schemas/DurationFieldType" - }, - "name": { - "type": "string" - }, - "rangeDurationType": { - "$ref": "#/components/schemas/DurationFieldType" - } - }, - "type": "object" - }, - "DateTimeZone": { - "properties": { - "fixed": { - "type": "boolean" - }, - "id": { - "type": "string" - } - }, - "type": "object" - }, - "DeferredResultMessage": { - "properties": { - "result": { - "type": "object" - }, - "setOrExpired": { - "type": "boolean" - } - }, - "type": "object" - }, - "DeleteDnisRequest": { - "properties": { - "dnis": { - "type": "string" - }, - "dnisE164": { - "type": "string" - }, - "phoneNumbersI18nEnabled": { - "type": "boolean" - } - }, - "type": "object" - }, - "DestinationCampaignRequest": { - "properties": { - "accountId": { - "type": "string" - }, - "campaignId": { - "format": "int32", - "type": "integer" - }, - "dialGroupId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "DestinationParams": { - "properties": { - "destinationType": { - "enum": [ - "EMAIL", - "FILE_TRANSFER", - "SECURE_FILE_TRANSFER" - ], - "type": "string" - }, - "isCompress": { - "type": "boolean" - }, - "titleDateTimeFormat": { - "type": "string" - } - }, - "type": "object" - }, - "Device": { - "properties": { - "id": { - "type": "string" - }, - "linePooling": { - "type": "string" - }, - "phoneLines": { - "items": { - "type": "object" - }, - "type": "array" - }, - "status": { - "type": "string" - }, - "type": { - "type": "string" - }, - "uri": { - "type": "string" - } - }, - "type": "object" - }, - "DialGroup": { - "properties": { - "agentDialGroupMembers": { - "$ref": "#/components/schemas/CollectionAgentDialGroupMember" - }, - "agentsReady": { - "format": "int32", - "type": "integer" - }, - "allowLeadSearch": { - "type": "string" - }, - "allowPreviewLeadFilters": { - "type": "boolean" - }, - "billingKey": { - "type": "string" - }, - "campaigns": { - "$ref": "#/components/schemas/CollectionCampaign" - }, - "dialGroupDesc": { - "type": "string" - }, - "dialGroupId": { - "format": "int32", - "type": "integer" - }, - "dialGroupName": { - "type": "string" - }, - "dialMode": { - "enum": [ - "PREVIEW", - "CLICK_TO_TALK", - "PREDICTIVE", - "POWER", - "TCPA_SAFE_MODE" - ], - "type": "string" - }, - "enableAbsolutePriority": { - "type": "boolean" - }, - "enableAgentFilter": { - "type": "boolean" - }, - "enableCallbacksAfterMaxDailyPass": { - "type": "boolean" - }, - "enableCallbacksAfterMaxpass": { - "type": "boolean" - }, - "enableListPriority": { - "type": "boolean" - }, - "groupId": { - "format": "int32", - "type": "integer" - }, - "hciEnabled": { - "enum": [ - "DISABLED", - "HCI_FETCH", - "HCI_PACING" - ], - "type": "string" - }, - "isActive": { - "type": "boolean" - }, - "maxLeadsReturned": { - "format": "int32", - "type": "integer" - }, - "maxPorts": { - "format": "int32", - "type": "integer" - }, - "minPredictiveAgents": { - "format": "int32", - "type": "integer" - }, - "outdialServerGroupId": { - "format": "int32", - "type": "integer" - }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - }, - "progressiveCallDelay": { - "format": "int32", - "type": "integer" - }, - "progressiveEnabled": { - "type": "boolean" - }, - "realTimeAgentData": { - "type": "boolean" - }, - "requireFetchedLeadsCalled": { - "type": "boolean" - } - }, - "type": "object" - }, - "DialGroupTimeZoneDialCountWrapper": { - "properties": { - "dialGroupId": { - "format": "int32", - "type": "integer" - }, - "dialGroupName": { - "type": "string" - }, - "dialMode": { - "enum": [ - "PREVIEW", - "CLICK_TO_TALK", - "PREDICTIVE", - "POWER", - "TCPA_SAFE_MODE" - ], - "type": "string" - }, - "leadData": { - "items": { - "$ref": "#/components/schemas/CampaignTimeZoneDialCount" - }, - "type": "array" - } - }, - "type": "object" - }, - "DncListEntry": { - "properties": { - "addedBy": { - "type": "string" - }, - "addedDate": { - "$ref": "#/components/schemas/DateTime" - }, - "countryCode": { - "$ref": "#/components/schemas/CountryCode" - }, - "dncTagId": { - "format": "int32", - "type": "integer" - }, - "phone": { - "type": "string" - }, - "reason": { - "type": "string" - }, - "tag": { - "type": "string" - } - }, - "type": "object" - }, - "DncTag": { - "properties": { - "accountId": { - "type": "string" - }, - "dncTagId": { - "format": "int32", - "type": "integer" - }, - "dncTagLabel": { - "type": "string" - } - }, - "type": "object" - }, - "DnisBulkUpdateRespose": { - "properties": { - "message": { - "type": "string" - }, - "status": { - "type": "string" - }, - "updatedRows": { - "type": "string" - } - }, - "type": "object" - }, - "DnisListPreviewResponse": { - "properties": { - "records": { - "items": { - "$ref": "#/components/schemas/BaseCsvDto" - }, - "type": "array" - }, - "uploadStatus": { - "$ref": "#/components/schemas/DnisResponseValidation" - } - }, - "type": "object" - }, - "DnisListRequest": { - "properties": { - "accountIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "dnisState": { - "type": "string" - }, - "phoneNumbersI18nEnabled": { - "type": "boolean" - }, - "searchText": { - "type": "string" - } - }, - "type": "object" - }, - "DnisMigrationResult": { - "properties": { - "tbl_acd_dnis_pool": { - "$ref": "#/components/schemas/DnisMigrationResultEntry" - }, - "tbl_acd_gate_dnis": { - "$ref": "#/components/schemas/DnisMigrationResultEntry" - }, - "tbl_acd_sms_dnis": { - "$ref": "#/components/schemas/DnisMigrationResultEntry" - } - }, - "type": "object" - }, - "DnisMigrationResultEntry": { - "properties": { - "converted": { - "format": "int32", - "type": "integer" - }, - "convertedAsIs": { - "items": { - "type": "string" - }, - "type": "array" - }, - "total": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "DnisNotification": { - "properties": { - "accountId": { - "type": "string" - }, - "description": { - "type": "string" - }, - "dnis": { - "type": "string" - }, - "missCall": { - "type": "boolean" - }, - "notificationId": { - "format": "int32", - "type": "integer" - }, - "notifyDest": { - "type": "string" - }, - "shortCall": { - "type": "boolean" - }, - "voicemail": { - "type": "boolean" - } - }, - "type": "object" - }, - "DnisPool": { - "properties": { - "active": { - "type": "boolean" - }, - "assignedDnis": { - "$ref": "#/components/schemas/AssignedDnis" - }, - "assignedSmsDnis": { - "$ref": "#/components/schemas/AssignedSmsDnis" - }, - "carrier": { - "type": "string" - }, - "customAppString": { - "type": "string" - }, - "dateCreated": { - "$ref": "#/components/schemas/DateTime" - }, - "dnis": { - "type": "string" - }, - "dnisCategory": { - "type": "string" - }, - "dnisDescription": { - "type": "string" - }, - "dnisE164": { - "type": "string" - }, - "dnisManagedByRC": { - "type": "boolean" - }, - "inboundContext": { - "type": "string" - }, - "lastModified": { - "$ref": "#/components/schemas/DateTime" - }, - "lastModifiedBy": { - "type": "string" - }, - "mediaCode": { - "type": "string" - }, - "mediaFormat": { - "type": "string" - }, - "mediaIsci": { - "type": "string" - }, - "mediaLength": { - "type": "string" - }, - "mediaMarket": { - "type": "string" - }, - "mediaNetwork": { - "type": "string" - }, - "mediaUrl": { - "type": "string" - }, - "mediaVersion": { - "type": "string" - }, - "mediaWebSourcecode": { - "type": "string" - }, - "notes": { - "type": "string" - }, - "originatingDnis": { - "type": "string" - }, - "phoneNumbersI18nEnabled": { - "type": "boolean" - }, - "platformId": { - "type": "string" - }, - "reservedAccount": { - "$ref": "#/components/schemas/Account" - }, - "reservedAccountId": { - "type": "string" - }, - "resporg": { - "type": "string" - }, - "smsEnabled": { - "type": "boolean" - }, - "twilioApiKey": { - "type": "string" - }, - "vendorId": { - "type": "string" - }, - "vruNetworkId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "DnisPoolUpdateRequest": { - "properties": { - "chatQueueId": { - "format": "int32", - "type": "integer" - }, - "dnisPool": { - "$ref": "#/components/schemas/DnisPoolV2" - }, - "endDate": { - "$ref": "#/components/schemas/DateTime" - }, - "product": { - "enum": [ - "ACCOUNT", - "ACD", - "AGENT", - "CHAT_QUEUE", - "OUTBOUND", - "VISUAL_IVR", - "CLOUD_PROFILE", - "CLOUD_DESTINATION", - "TRAC_NUMBER", - "HTTP_SERVICES", - "SCRIPTING", - "TN_MANAGER", - "SURVEY", - "DNIS", - "TEAMS", - "KNOWLEDGE_BASE", - "UTILITIES" - ], - "type": "string" - }, - "productId": { - "format": "int32", - "type": "integer" - }, - "smsEndDate": { - "$ref": "#/components/schemas/DateTime" - }, - "smsStartDate": { - "$ref": "#/components/schemas/DateTime" - }, - "startDate": { - "$ref": "#/components/schemas/DateTime" - }, - "unassignProduct": { - "type": "boolean" - }, - "unassignSmsProduct": { - "type": "boolean" - } - }, - "type": "object" - }, - "DnisPoolV2": { - "properties": { - "active": { - "type": "boolean" - }, - "assignedDnis": { - "$ref": "#/components/schemas/AssignedDnis" - }, - "assignedSmsDnis": { - "$ref": "#/components/schemas/AssignedSmsDnis" - }, - "carrier": { - "type": "string" - }, - "customAppString": { - "type": "string" - }, - "dateCreated": { - "$ref": "#/components/schemas/DateTime" - }, - "dnis": { - "type": "string" - }, - "dnisCategory": { - "type": "string" - }, - "dnisDescription": { - "type": "string" - }, - "dnisE164": { - "type": "string" - }, - "inboundContext": { - "type": "string" - }, - "lastModified": { - "$ref": "#/components/schemas/DateTime" - }, - "lastModifiedBy": { - "type": "string" - }, - "mediaCode": { - "type": "string" - }, - "mediaFormat": { - "type": "string" - }, - "mediaIsci": { - "type": "string" - }, - "mediaLength": { - "type": "string" - }, - "mediaMarket": { - "type": "string" - }, - "mediaNetwork": { - "type": "string" - }, - "mediaUrl": { - "type": "string" - }, - "mediaVersion": { - "type": "string" - }, - "mediaWebSourcecode": { - "type": "string" - }, - "notes": { - "type": "string" - }, - "originatingDnis": { - "type": "string" - }, - "phoneNumbersI18nEnabled": { - "type": "boolean" - }, - "platformId": { - "type": "string" - }, - "reservedAccount": { - "$ref": "#/components/schemas/Account" - }, - "reservedAccountId": { - "type": "string" - }, - "resporg": { - "type": "string" - }, - "smsEnabled": { - "type": "boolean" - }, - "twilioApiKey": { - "type": "string" - }, - "vendorId": { - "type": "string" - }, - "vruNetworkId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "DnisResponseValidation": { - "properties": { - "errorCode": { - "type": "string" - }, - "errorMessage": { - "items": { - "type": "string" - }, - "type": "array" - }, - "totalRecords": { - "format": "int64", - "type": "integer" - }, - "validRecords": { - "format": "int64", - "type": "integer" - }, - "validated": { - "type": "boolean" - } - }, - "type": "object" - }, - "DurationField": { - "properties": { - "name": { - "type": "string" - }, - "precise": { - "type": "boolean" - }, - "supported": { - "type": "boolean" - }, - "type": { - "$ref": "#/components/schemas/DurationFieldType" - }, - "unitMillis": { - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "DurationFieldType": { - "properties": { - "name": { - "type": "string" - } - }, - "type": "object" - }, - "EVUser": { - "properties": { - "email": { - "type": "string" - }, - "ev_user_type": { - "enum": [ - "admin", - "agent" - ], - "type": "string" - }, - "ev_user_uid": { - "type": "string" - }, - "first_name": { - "type": "string" - }, - "is_active": { - "type": "boolean" - }, - "last_name": { - "type": "string" - }, - "rc_sync": { - "type": "boolean" - } - }, - "type": "object" - }, - "Element": { - "properties": { - "elements": { - "items": { - "$ref": "#/components/schemas/Element" - }, - "type": "array" - }, - "isComplex": { - "type": "boolean" - }, - "name": { - "type": "string" - }, - "type": { - "type": "string" - } - }, - "type": "object" - }, - "EmailTemplate": { - "properties": { - "accountId": { - "type": "string" - }, - "allowBccChange": { - "type": "boolean" - }, - "allowBodyChange": { - "type": "boolean" - }, - "allowCcChange": { - "type": "boolean" - }, - "allowFromChange": { - "type": "boolean" - }, - "allowSubjectChange": { - "type": "boolean" - }, - "allowToChange": { - "type": "boolean" - }, - "emailBcc": { - "type": "string" - }, - "emailCc": { - "type": "string" - }, - "emailFrom": { - "type": "string" - }, - "emailRte": { - "type": "string" - }, - "emailSubject": { - "type": "string" - }, - "emailTemplateId": { - "format": "int32", - "type": "integer" - }, - "emailTo": { - "type": "string" - }, - "sendFormat": { - "type": "string" - }, - "templateName": { - "type": "string" - } - }, - "type": "object" - }, - "EmailTemplateAttachment": { - "properties": { - "attachmentId": { - "format": "int32", - "type": "integer" - }, - "attachmentName": { - "type": "string" - }, - "attachmentSize": { - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "EmbeddedChatWidget": { - "properties": { - "accountId": { - "type": "string" - }, - "isOpen": { - "type": "boolean" - }, - "open": { - "type": "boolean" - }, - "showPoweredBy": { - "type": "boolean" - }, - "widgetConfiguration": { - "type": "string" - } - }, - "type": "object" - }, - "Environment": { - "properties": { - "activeProfiles": { - "items": { - "type": "string" - }, - "type": "array" - }, - "defaultProfiles": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "title": "Environment", - "type": "object" - }, - "Error": { - "properties": { - "details": { - "type": "string" - }, - "generalMessage": { - "type": "string" - }, - "requestUri": { - "type": "string" - }, - "timestamp": { - "format": "int64", - "type": "integer" - } - } - }, - "Errors": { - "properties": { - "cause": { - "type": "string" - }, - "details": { - "type": "string" - }, - "developerMessage": { - "type": "string" - }, - "generalMessage": { - "type": "string" - }, - "requestUri": { - "type": "string" - }, - "timestamp": { - "format": "int64", - "type": "integer" - }, - "validationErrors": { - "items": { - "$ref": "#/components/schemas/ValidationErrorData" - }, - "type": "array" - } - }, - "type": "object" - }, - "ExtendedLeadData": { - "properties": { - "important": { - "type": "string" - }, - "interested": { - "type": "boolean" - } - }, - "type": "object" - }, - "FilteredIdView": { - "properties": { - "permission": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "products": { - "items": { - "enum": [ - "ACCOUNT", - "ACD", - "AGENT", - "CHAT_QUEUE", - "OUTBOUND", - "VISUAL_IVR", - "CLOUD_PROFILE", - "CLOUD_DESTINATION", - "TRAC_NUMBER", - "HTTP_SERVICES", - "SCRIPTING", - "TN_MANAGER", - "SURVEY", - "DNIS", - "TEAMS", - "KNOWLEDGE_BASE", - "UTILITIES" - ], - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "permission", - "products" - ], - "type": "object" - }, - "Gate": { - "properties": { - "abandonCampaign": { - "$ref": "#/components/schemas/Campaign" - }, - "acceptTime": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" - }, - "afterCallBaseState": { - "type": "string" - }, - "afterCallState": { - "$ref": "#/components/schemas/AccountAuxState" - }, - "agentConnSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "agentGateAccess": { - "items": { - "$ref": "#/components/schemas/AgentGateAccess" - }, - "type": "array" - }, - "agentPopMessage": { - "type": "string" - }, - "agentTermSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "appUrl": { - "type": "string" - }, - "backupAppUrl": { - "type": "string" - }, - "billingCode": { - "type": "string" - }, - "blockedAniMessage": { - "type": "string" - }, - "callbackCampaign": { - "$ref": "#/components/schemas/Campaign" - }, - "createdOn": { - "$ref": "#/components/schemas/DateTime" - }, - "dequeueDelay": { - "format": "int32", - "type": "integer" - }, - "dequeueSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "dispositionTimeout": { - "format": "int32", - "type": "integer" - }, - "enableGlobalPhoneBook": { - "type": "boolean" - }, - "enableIvrTokens": { - "type": "boolean" - }, - "endCallMessage": { - "type": "string" - }, - "fifoDisabled": { - "type": "boolean" - }, - "friSched": { - "type": "string" - }, - "gateClosedEvent": { - "type": "string" - }, - "gateDesc": { - "type": "string" - }, - "gateGroup": { - "$ref": "#/components/schemas/GateGroup" - }, - "gateId": { - "format": "int32", - "type": "integer" - }, - "gateName": { - "type": "string" - }, - "gateOpen": { - "type": "boolean" - }, - "gatePriority": { - "format": "int32", - "type": "integer" - }, - "gatePriorityGroup": { - "$ref": "#/components/schemas/GatePriorityGroup" - }, - "gateQueueEvents": { - "items": { - "$ref": "#/components/schemas/GateQueueEvent" - }, - "type": "array" - }, - "hangupOnDisposition": { - "type": "boolean" - }, - "isActive": { - "type": "boolean" - }, - "longCallTime": { - "format": "int32", - "type": "integer" - }, - "manualCallerId": { - "type": "string" - }, - "manualCallerIdE164": { - "type": "string" - }, - "maxQueueEvent": { - "type": "string" - }, - "maxQueueLimit": { - "format": "int32", - "type": "integer" - }, - "monSched": { - "type": "string" - }, - "noAgentEvent": { - "type": "string" - }, - "observeDst": { - "type": "boolean" - }, - "onHoldMessage": { - "type": "string" - }, - "outboundCallerId": { - "type": "string" - }, - "pauseRecordingSec": { - "format": "int32", - "type": "integer" - }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - }, - "perspectiveRecordingMode": { - "enum": [ - "DISABLED", - "ALL_AGENT_LEGS" - ], - "type": "string" - }, - "phoneNumbersI18nEnabled": { - "type": "boolean" - }, - "postCallSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "postDispSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "recordCall": { - "format": "int32", - "type": "integer" - }, - "recordingInConference": { - "type": "boolean" - }, - "recordingSettings": { - "enum": [ - "RECORD_FULL_CALL", - "AGENT_FULL_CONTROL_DEFAULT_ON", - "AGENT_FULL_CONTROL_DEFAULT_OFF", - "AGENT_PAUSE" - ], - "type": "string" - }, - "requeueType": { - "enum": [ - "ADVANCED", - "RESTRICTED" - ], - "type": "string" - }, - "resultFileDestination": { - "$ref": "#/components/schemas/ResultFileDestination" - }, - "revMatch": { - "type": "boolean" - }, - "satSched": { - "type": "string" - }, - "script": { - "$ref": "#/components/schemas/Script" - }, - "shortAbandonTime": { - "format": "int32", - "type": "integer" - }, - "shortCallTime": { - "format": "int32", - "type": "integer" - }, - "singleChannelEnabled": { - "type": "boolean" - }, - "slaTime": { - "format": "int32", - "type": "integer" - }, - "specialAniEvent": { - "type": "string" - }, - "stopRecordingOnTransfer": { - "type": "boolean" - }, - "sunSched": { - "type": "string" - }, - "survey": { - "$ref": "#/components/schemas/Survey" - }, - "surveyPopType": { - "type": "string" - }, - "syncQueueWait": { - "format": "int32", - "type": "integer" - }, - "throttleCalls": { - "format": "int32", - "type": "integer" - }, - "throttleDays": { - "format": "int32", - "type": "integer" - }, - "throttlingAniEvent": { - "type": "string" - }, - "thuSched": { - "type": "string" - }, - "transferCallerId": { - "type": "string" - }, - "transferCallerIdE164": { - "type": "string" - }, - "transferTermSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "ttAccept": { - "type": "boolean" - }, - "tueSched": { - "type": "string" - }, - "wedSched": { - "type": "string" - }, - "whisperMessage": { - "type": "string" - }, - "wrapTime": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GateDisposition": { - "properties": { - "destCampaign": { - "$ref": "#/components/schemas/Campaign" - }, - "dispSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "disposition": { - "type": "string" - }, - "dncTagLabel": { - "type": "string" - }, - "doNotCall": { - "type": "boolean" - }, - "dtmfMapping": { - "type": "string" - }, - "emailDestinations": { - "type": "string" - }, - "emailTemplate": { - "$ref": "#/components/schemas/EmailTemplate" - }, - "gateDispositionId": { - "format": "int32", - "type": "integer" - }, - "isComplete": { - "type": "boolean" - }, - "isContact": { - "type": "boolean" - }, - "isDefault": { - "type": "boolean" - }, - "isDisabled": { - "type": "boolean" - }, - "isRequeued": { - "format": "int32", - "type": "integer" - }, - "isSuccess": { - "type": "boolean" - }, - "rank": { - "format": "int32", - "type": "integer" - }, - "requeueDelay": { - "format": "int32", - "type": "integer" - }, - "requireNote": { - "type": "boolean" - }, - "saveSurvey": { - "type": "boolean" - }, - "setAgentFlag": { - "type": "boolean" - }, - "timeout": { - "format": "int32", - "type": "integer" - }, - "xfer": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" - }, - "xferDest": { - "type": "string" - } - }, - "type": "object" - }, - "GateGroup": { - "properties": { - "billingKey": { - "type": "string" - }, - "createdOn": { - "$ref": "#/components/schemas/DateTime" - }, - "endDate": { - "$ref": "#/components/schemas/DateTime" - }, - "gateGroupId": { - "format": "int32", - "type": "integer" - }, - "gates": { - "items": { - "$ref": "#/components/schemas/Gate" - }, - "type": "array" - }, - "groupName": { - "type": "string" - }, - "groupSkills": { - "items": { - "$ref": "#/components/schemas/GateGroupSkill" - }, - "type": "array" - }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - }, - "startDate": { - "$ref": "#/components/schemas/DateTime" - } - }, - "type": "object" - }, - "GateGroupSkill": { - "properties": { - "active": { - "type": "boolean" - }, - "agentSkillProfiles": { - "$ref": "#/components/schemas/CollectionAgentSkillProfile" - }, - "createdOn": { - "$ref": "#/components/schemas/DateTime" - }, - "requeueShortcut": { - "items": { - "$ref": "#/components/schemas/RequeueShortcut" - }, - "type": "array" - }, - "skillDesc": { - "type": "string" - }, - "skillId": { - "format": "int32", - "type": "integer" - }, - "skillName": { - "type": "string" - }, - "whisperAudio": { - "type": "string" - } - }, - "type": "object" - }, - "GateGroupSkinny": { - "properties": { - "accountId": { - "type": "string" - }, - "gateGroupId": { - "format": "int32", - "type": "integer" - }, - "gates": { - "$ref": "#/components/schemas/Collection_GateSkinny_" - }, - "groupName": { - "type": "string" - } - }, - "type": "object" - }, - "GateGroupV2": { - "properties": { - "accountId": { - "type": "string" - }, - "billingKey": { - "type": "string" - }, - "gateGroupId": { - "format": "int32", - "type": "integer" - }, - "groupName": { - "type": "string" - } - }, - "type": "object" - }, - "GatePriorityGroup": { - "properties": { - "gatePriorityGroupId": { - "format": "int32", - "type": "integer" - }, - "gatePriorityGroupName": { - "type": "string" - } - }, - "type": "object" - }, - "GateQueueDtmfEvent": { - "properties": { - "dtmf": { - "type": "string" - }, - "dtmfEvent": { - "type": "string" - }, - "dtmfEventId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GateQueueEvent": { - "properties": { - "enableDtmf": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" - }, - "eventDuration": { - "format": "int32", - "type": "integer" - }, - "eventId": { - "format": "int32", - "type": "integer" - }, - "eventRank": { - "format": "int32", - "type": "integer" - }, - "gate": { - "$ref": "#/components/schemas/Gate" - }, - "queueEvent": { - "type": "string" - } - }, - "type": "object" - }, - "GateScheduleOverride": { - "properties": { - "overrideClosedEvent": { - "type": "string" - }, - "overrideDate": { - "$ref": "#/components/schemas/DateTime" - }, - "overrideLabel": { - "type": "string" - }, - "overrideSched": { - "type": "string" - }, - "scheduleOverrideId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "GateSkinny": { - "properties": { - "gateGroupId": { - "format": "int32", - "type": "integer" - }, - "gateId": { - "format": "int32", - "type": "integer" - }, - "gateName": { - "type": "string" - }, - "isActive": { - "type": "boolean" - } - }, - "type": "object" - }, - "GateSkinnyAssignable": { - "properties": { - "accountId": { - "type": "string" - }, - "gateGroup": { - "$ref": "#/components/schemas/GateGroupV2" - }, - "gateGroupId": { - "format": "int32", - "type": "integer" - }, - "gateId": { - "format": "int32", - "type": "integer" - }, - "gateName": { - "type": "string" - }, - "groupId": { - "format": "int32", - "type": "integer" - }, - "isActive": { - "type": "boolean" - } - }, - "type": "object" - }, - "GateSpecialAni": { - "properties": { - "ani": { - "type": "string" - }, - "aniE164": { - "type": "string" - }, - "dateAdded": { - "$ref": "#/components/schemas/DateTime" - }, - "phoneNumbersI18nEnabled": { - "type": "boolean" - }, - "type": { - "type": "string" - } - }, - "type": "object" - }, - "GateSpecialAniDeleteRequest": { - "properties": { - "ani": { - "type": "string" - }, - "aniE164": { - "type": "string" - }, - "effectiveAni": { - "type": "string" - }, - "phoneNumbersI18nEnabled": { - "type": "boolean" - }, - "type": { - "type": "string" - } - }, - "type": "object" - }, - "GatesLoggedInAgentsView": { - "properties": { - "agentGroupId": { - "format": "int32", - "type": "integer" - }, - "agentId": { - "format": "int32", - "type": "integer" - }, - "firstName": { - "type": "string" - }, - "groupName": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "username": { - "type": "string" - } - }, - "type": "object" - }, - "GatesSelection": { - "properties": { - "gateIds": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - }, - "groupId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "Generic": { - "properties": { - "description": { - "type": "string" - }, - "id": { - "format": "int64", - "type": "integer" - } - } - }, - "GenericEmail": { - "properties": { - "accountId": { - "type": "string" - }, - "attachments": { - "$ref": "#/components/schemas/CollectionMultipartFile" - }, - "emailBcc": { - "type": "string" - }, - "emailCc": { - "type": "string" - }, - "emailFrom": { - "type": "string" - }, - "emailPlainText": { - "type": "string" - }, - "emailRte": { - "type": "string" - }, - "emailSubject": { - "type": "string" - }, - "emailTo": { - "type": "string" - } - }, - "type": "object" - }, - "GetRcLinkedAdminsRequest": { - "properties": { - "rcAccountId": { - "type": "string" - }, - "rcExtensionIds": { - "items": { - "format": "int64", - "type": "integer" - }, - "type": "array" - } - }, - "type": "object" - }, - "HistorySource": { - "properties": { - "sourceDescription": { - "type": "string" - }, - "sourceGroupDescription": { - "type": "string" - }, - "sourceGroupId": { - "format": "int32", - "type": "integer" - }, - "sourceGroupName": { - "type": "string" - }, - "sourceId": { - "format": "int32", - "type": "integer" - }, - "sourceName": { - "type": "string" - }, - "sourceType": { - "type": "string" - } - }, - "type": "object" - }, - "HttpServiceMapping": { - "properties": { - "originalValue": { - "type": "string" - }, - "replacementValue": { - "type": "string" - } - }, - "type": "object" - }, - "IVRApplication": { - "properties": { - "accountId": { - "type": "string" - }, - "appDesc": { - "type": "string" - }, - "appId": { - "format": "int32", - "type": "integer" - }, - "appName": { - "type": "string" - } - }, - "type": "object" - }, - "ImportNumber": { - "properties": { - "customAppString": { - "type": "string" - }, - "dnis": { - "type": "string" - }, - "dnisDescription": { - "type": "string" - }, - "dnisE164": { - "type": "string" - }, - "inboundContext": { - "type": "string" - }, - "notes": { - "type": "string" - }, - "originatingDnis": { - "type": "string" - }, - "resporg": { - "type": "string" - } - }, - "type": "object" - }, - "ImportNumbersRequest": { - "properties": { - "numbersForImport": { - "items": { - "$ref": "#/components/schemas/ImportNumber" - }, - "type": "array" - }, - "phoneNumbersI18nEnabled": { - "type": "boolean" - }, - "rcAccountId": { - "type": "string" - }, - "subAccountId": { - "type": "string" - } - }, - "type": "object" - }, - "InputStream": { - "type": "object" - }, - "IvrStats": { - "properties": { - "accountId": { - "type": "string" - }, - "active": { - "format": "int32", - "type": "integer" - }, - "connected": { - "format": "int32", - "type": "integer" - }, - "ivrGroupId": { - "format": "int32", - "type": "integer" - }, - "ivrGroupName": { - "type": "string" - }, - "lastUpdate": { - "$ref": "#/components/schemas/DateTime" - }, - "presented": { - "format": "int32", - "type": "integer" - }, - "selectable": { - "type": "boolean" - }, - "transferCloud": { - "format": "int32", - "type": "integer" - }, - "transferGate": { - "format": "int32", - "type": "integer" - }, - "transferTrac": { - "format": "int32", - "type": "integer" - }, - "visualIvrId": { - "format": "int32", - "type": "integer" - }, - "visualIvrName": { - "type": "string" - } - }, - "type": "object" - }, - "JobInfo": { - "properties": { - "finalFireTimeMillis": { - "format": "int64", - "type": "integer" - }, - "jobId": { - "format": "int32", - "type": "integer" - }, - "jobParam": { - "$ref": "#/components/schemas/JobParamobject" - }, - "jobState": { - "enum": [ - "NONE", - "NORMAL", - "PAUSED", - "COMPLETE", - "ERROR", - "BLOCKED" - ], - "type": "string" - }, - "jobType": { - "enum": [ - "DNC_DOWNLOAD", - "ALERTING_JOB", - "LIST_DELETE", - "REPORT" - ], - "type": "string" - }, - "lastRunDateTime": { - "$ref": "#/components/schemas/DateTime" - }, - "name": { - "type": "string" - }, - "nextFireTimeMillis": { - "format": "int64", - "type": "integer" - }, - "nextRunDateTime": { - "$ref": "#/components/schemas/DateTime" - }, - "ownerId": { - "format": "int32", - "type": "integer" - }, - "schedule": { - "$ref": "#/components/schemas/Schedule" - } - }, - "type": "object" - }, - "JobParamobject": { - "properties": { - "data": { - "type": "object" - } - }, - "type": "object" - }, - "JsonNode": { - "properties": { - "array": { - "type": "boolean" - }, - "bigDecimal": { - "type": "boolean" - }, - "bigInteger": { - "type": "boolean" - }, - "binary": { - "type": "boolean" - }, - "boolean": { - "type": "boolean" - }, - "containerNode": { - "type": "boolean" - }, - "double": { - "type": "boolean" - }, - "empty": { - "type": "boolean" - }, - "float": { - "type": "boolean" - }, - "floatingPointNumber": { - "type": "boolean" - }, - "int": { - "type": "boolean" - }, - "integralNumber": { - "type": "boolean" - }, - "long": { - "type": "boolean" - }, - "missingNode": { - "type": "boolean" - }, - "nodeType": { - "enum": [ - "ARRAY", - "BINARY", - "BOOLEAN", - "MISSING", - null, - "NUMBER", - "OBJECT", - "POJO", - "STRING" - ], - "type": "string" - }, - "null": { - "type": "boolean" - }, - "number": { - "type": "boolean" - }, - "object": { - "type": "boolean" - }, - "pojo": { - "type": "boolean" - }, - "short": { - "type": "boolean" - }, - "textual": { - "type": "boolean" - }, - "valueNode": { - "type": "boolean" - } - }, - "type": "object" - }, - "KnowledgeBaseArticle": { - "properties": { - "active": { - "type": "boolean" - }, - "content": { - "type": "string" - }, - "contentPlain": { - "type": "string" - }, - "createdOn": { - "$ref": "#/components/schemas/DateTime" - }, - "knowledgeBaseArticleId": { - "format": "int32", - "type": "integer" - }, - "knowledgeBaseCategory": { - "$ref": "#/components/schemas/KnowledgeBaseCategory" - }, - "labels": { - "type": "string" - }, - "order": { - "format": "int32", - "type": "integer" - }, - "showSend": { - "type": "boolean" - }, - "title": { - "type": "string" - }, - "updatedOn": { - "$ref": "#/components/schemas/DateTime" - } - }, - "type": "object" - }, - "KnowledgeBaseCategory": { - "properties": { - "active": { - "type": "boolean" - }, - "createdOn": { - "$ref": "#/components/schemas/DateTime" - }, - "description": { - "type": "string" - }, - "groupId": { - "format": "int32", - "type": "integer" - }, - "knowledgeBaseArticles": { - "items": { - "$ref": "#/components/schemas/KnowledgeBaseArticle" - }, - "type": "array" - }, - "knowledgeBaseCategoryId": { - "format": "int32", - "type": "integer" - }, - "knowledgeBaseGroup": { - "$ref": "#/components/schemas/KnowledgeBaseGroup" - }, - "order": { - "format": "int32", - "type": "integer" - }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - }, - "title": { - "type": "string" - }, - "updatedOn": { - "$ref": "#/components/schemas/DateTime" - } - }, - "type": "object" - }, - "KnowledgeBaseGroup": { - "properties": { - "knowledgeBaseCategories": { - "items": { - "$ref": "#/components/schemas/KnowledgeBaseCategory" - }, - "type": "array" - }, - "knowledgeBaseGroupId": { - "format": "int32", - "type": "integer" - }, - "name": { - "type": "string" - }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "Lead": { - "properties": { - "address1": { - "type": "string" - }, - "address2": { - "type": "string" - }, - "auxData1": { - "type": "string" - }, - "auxData2": { - "type": "string" - }, - "auxData3": { - "type": "string" - }, - "auxData4": { - "type": "string" - }, - "auxData5": { - "type": "string" - }, - "auxPhone": { - "type": "string" - }, - "city": { - "type": "string" - }, - "email": { - "type": "string" - }, - "extendedLeadData": { - "$ref": "#/components/schemas/ExtendedLeadData" - }, - "externId": { - "format": "int64", - "type": "integer" - }, - "firstName": { - "type": "string" - }, - "gateKeeper": { - "type": "string" - }, - "lastName": { - "type": "string" - }, - "leadPhone": { - "description": "multiple values can be submitted with a pipe delimiter between phone numbers", - "type": "string" - }, - "midName": { - "type": "string" - }, - "state": { - "type": "string" - }, - "suffix": { - "type": "string" - }, - "title": { - "type": "string" - }, - "zip": { - "type": "string" - } - }, - "required": [ - "externId" - ], - "type": "object" - }, - "LeadActionParams": { - "properties": { - "paramMap": { - "type": "object" - } - }, - "type": "object" - }, - "LeadActionResult": { - "properties": { - "dialerRefreshed": { - "type": "boolean" - }, - "errorMessage": { - "type": "string" - }, - "leadActionType": { - "type": "string" - }, - "leadDeleteCount": { - "format": "int32", - "type": "integer" - }, - "leadUpdateCount": { - "format": "int32", - "type": "integer" - }, - "redialDeleteCount": { - "format": "int32", - "type": "integer" - }, - "success": { - "type": "boolean" - } - }, - "type": "object" - }, - "LeadListPagePreview": { - "properties": { - "pageName": { - "type": "string" - }, - "pageNumber": { - "format": "int32", - "type": "integer" - }, - "rowData": { - "items": { - "items": { - "type": "string" - }, - "type": "array" - }, - "type": "array" - } - }, - "type": "object" - }, - "LeadListPreviewResponse": { - "properties": { - "mappingColumns": { - "items": { - "enum": [ - "LEAD_PHONE", - "EXTERN_ID", - "STATE", - "LEAD_TIMEZONE", - "PENDING_AGENT_ID", - "TITLE", - "FIRST_NAME", - "MID_NAME", - "LAST_NAME", - "SUFFIX", - "EMAIL", - "ADDRESS1", - "ADDRESS2", - "CITY", - "ZIP", - "GATE_KEEPER", - "AUX_DATA1", - "AUX_DATA2", - "AUX_DATA3", - "AUX_DATA4", - "AUX_DATA5", - "AUX_PHONE", - "AUX_EXTERNAL_URL", - "AUX_GREETING", - "LIVE_ANSWER_MESSAGE", - "MACH_ANSWER_MESSAGE", - "CALLER_ID", - "LEAD_PRIORITY", - "COUNTRY" - ], - "type": "string" - }, - "type": "array" - }, - "pagePreviews": { - "items": { - "$ref": "#/components/schemas/LeadListPagePreview" - }, - "type": "array" - }, - "transactionId": { - "type": "string" - }, - "personaPhoneConfig": { - "description": "Configured additional persona phone fields available for mapping when the campaign uses strategic calling configuration.", - "items": { - "$ref": "#/components/schemas/PersonaPhoneConfigFields" - }, - "type": "array" - } - }, - "type": "object" - }, - "LeadListProcessingRequest": { - "properties": { - "description": { - "type": "string" - }, - "dialPriority": { - "enum": [ - "IMMEDIATE", - "NORMAL" - ], - "type": "string" - }, - "dncTags": { - "items": { - "type": "string" - }, - "type": "array" - }, - "duplicateHandling": { - "enum": [ - "RETAIN_ALL", - "REMOVE_ALL_EXISTING", - "REMOVE_FROM_LIST" - ], - "type": "string" - }, - "extendedLeadDataMappings": { - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "type": "object" - }, - "fileContainsHeaders": { - "type": "boolean" - }, - "fileType": { - "enum": [ - "EXCEL", - "PIPE", - "COMMA", - "TAB" - ], - "type": "string" - }, - "listState": { - "enum": [ - "ACTIVE", - "PAUSED", - "PENDING_DNC", - "LOADING", - "DELETED", - "READY", - "CALLBACKS", - "CALLBACKS_AGENT", - "DUPLICATES_NOT_MERGED", - "DUPLICATES_NOT_MOVED", - "ARCHIVED" - ], - "type": "string" - }, - "pageColumnMappings": { - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "type": "object" - }, - "pageNumber": { - "format": "int32", - "type": "integer" - }, - "quoteChar": { - "type": "string" - }, - "timeZoneOption": { - "enum": [ - "NPA_NXX", - "ZIPCODE", - "EXPLICIT", - "COUNTRY", - "NOT_APPLICABLE" - ], - "type": "string" - }, - "transactionId": { - "type": "string" - }, - "uploadLeads": { - "items": { - "$ref": "#/components/schemas/CampaignLead" - }, - "type": "array" - }, - "additionalPhoneMappings": { - "additionalProperties": { - "format": "int32", - "type": "integer" - }, - "description": "Maps persona phone IDs to the source column indexes used by leadLoader/process. JSON object keys are persona phone IDs, and values are column indexes from the uploaded file preview.", - "type": "object" - }, - "phoneNumbersI18nEnabled": { - "type": "boolean" - }, - "internationalNumberFormat": { - "type": "boolean" - }, - "numberOriginCountry": { - "type": "string" - }, - "scheduleArchiveDts": { - "format": "date-time", - "type": "string" - } - }, - "type": "object" - }, - "LeadListProcessingResult": { - "properties": { - "deletedCount": { - "format": "int32", - "type": "integer" - }, - "dncReturnedCount": { - "format": "int32", - "type": "integer" - }, - "dncUploadCount": { - "format": "int32", - "type": "integer" - }, - "failedAgentAssignment": { - "description": "Number of accepted leads whose reserveAgent value could not be assigned because the agent ID was invalid or the agent does not have access to the account.", - "format": "int32", - "type": "integer" - }, - "hasDeletedLeads": { - "type": "boolean" - }, - "internalDncCount": { - "format": "int32", - "type": "integer" - }, - "leadsAccepted": { - "format": "int32", - "type": "integer" - }, - "leadsConverted": { - "format": "int32", - "type": "integer" - }, - "leadsInserted": { - "format": "int32", - "type": "integer" - }, - "leadsSupplied": { - "format": "int32", - "type": "integer" - }, - "listState": { - "enum": [ - "ACTIVE", - "PAUSED", - "PENDING_DNC", - "LOADING", - "DELETED", - "READY", - "CALLBACKS", - "CALLBACKS_AGENT", - "DUPLICATES_NOT_MERGED", - "DUPLICATES_NOT_MOVED" - ], - "type": "string" - }, - "message": { - "type": "string" - }, - "processingResult": { - "type": "string" - }, - "processingStatus": { - "enum": [ - "NO_LEADS_PASSED_VALIDATION", - "DNC_ACCOUNT_SETTINGS", - "DNC_UPLOAD_FAILED", - "DEFAULT_NOT_A_FAILURE", - "DNC_GREATER_ONE_DAY", - "GENERAL_FAILURE" - ], - "type": "string" - }, - "quotaCount": { - "format": "int32", - "type": "integer" - }, - "rejectedRows": { - "items": { - "$ref": "#/components/schemas/RejectedRow" - }, - "type": "array" - }, - "timeZoneOption": { - "enum": [ - "NPA_NXX", - "ZIPCODE", - "EXPLICIT", - "NOT_APPLICABLE" - ], - "type": "string" - }, - "uploadFileName": { - "type": "string" - }, - "whitelistCount": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "LeadManagerRequest": { - "properties": { - "campaignLeadSearchCriteria": { - "$ref": "#/components/schemas/CampaignLeadSearchCriteria" - }, - "leadActionParams": { - "$ref": "#/components/schemas/LeadActionParams" - } - }, - "type": "object" - }, - "LocalTime": { - "properties": { - "chronology": { - "$ref": "#/components/schemas/Chronology" - }, - "fieldTypes": { - "items": { - "$ref": "#/components/schemas/DateTimeFieldType" - }, - "type": "array" - }, - "fields": { - "items": { - "$ref": "#/components/schemas/DateTimeField" - }, - "type": "array" - }, - "hourOfDay": { - "format": "int32", - "type": "integer" - }, - "millisOfDay": { - "format": "int32", - "type": "integer" - }, - "millisOfSecond": { - "format": "int32", - "type": "integer" - }, - "minuteOfHour": { - "format": "int32", - "type": "integer" - }, - "secondOfMinute": { - "format": "int32", - "type": "integer" - }, - "values": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - } - }, - "type": "object" - }, - "LoggedInAgentsByQueue": { - "properties": { - "loggedInAgentCount": { - "format": "int32", - "type": "integer" - }, - "queueId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "MainAccount": { - "properties": { - "dataRetentionDays": { - "format": "int32", - "type": "integer" - }, - "enableAmdProfiles": { - "type": "boolean" - }, - "enableConsultCall": { - "type": "boolean" - }, - "enablePhoneNumbersI18n": { - "type": "boolean" - }, - "engageAccountId": { - "type": "string" - }, - "isActive": { - "format": "int32", - "type": "integer" - }, - "mainAccountId": { - "type": "string" - }, - "mainAccountName": { - "type": "string" - }, - "rcAccountId": { - "type": "string" - } - }, - "type": "object" - }, - "MainAccountCreationDto": { - "properties": { - "dataRetentionDays": { - "format": "int32", - "type": "integer" - }, - "engageAccountId": { - "type": "string" - }, - "enterpriseAccountId": { - "type": "string" - }, - "mainAccountId": { - "type": "string" - }, - "mainAccountName": { - "type": "string" - }, - "rcAccountId": { - "type": "string" - } - }, - "type": "object" - }, - "MainAccountDto": { - "properties": { - "dataRetentionDays": { - "format": "int32", - "type": "integer" - }, - "engageAccountId": { - "type": "string" - }, - "isActive": { - "format": "int32", - "type": "integer" - }, - "mainAccountId": { - "type": "string" - }, - "mainAccountName": { - "type": "string" - }, - "rcAccountId": { - "type": "string" - } - }, - "type": "object" - }, - "MainAccountUpdateDto": { - "properties": { - "engageAccountId": { - "type": "string" - } - }, - "type": "object" - }, - "MappingTemplate": { - "properties": { - "account": { - "$ref": "#/components/schemas/Account" - }, - "createdBy": { - "format": "int32", - "type": "integer" - }, - "dateCreated": { - "$ref": "#/components/schemas/DateTime" - }, - "lastUpdated": { - "$ref": "#/components/schemas/DateTime" - }, - "mappingData": { - "type": "string" - }, - "mappingId": { - "format": "int32", - "type": "integer" - }, - "mappingName": { - "type": "string" - }, - "updatedBy": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "MediaCodeValuesOnDnisPool": { - "properties": { - "category": { - "type": "string" - }, - "code": { - "type": "string" - }, - "duration": { - "type": "string" - }, - "format": { - "type": "string" - }, - "isci": { - "type": "string" - }, - "market": { - "type": "string" - }, - "network": { - "type": "string" - }, - "sourceCode": { - "type": "string" - }, - "url": { - "type": "string" - }, - "version": { - "type": "string" - } - }, - "type": "object" - }, - "Message": { - "properties": { - "accountId": { - "type": "string" - }, - "actionType": { - "enum": [ - "INITIALIZE", - "CONNECT", - "DISCONNECT", - "TYPING", - "MESSAGE", - "DELIVERED", - "SENT", - "ACTIVE", - "MONITOR_START", - "MONITOR_STOP", - "CHAT_HISTORY" - ], - "type": "string" - }, - "activeChatUii": { - "type": "string" - }, - "apiKey": { - "type": "string" - }, - "browserInfo": { - "type": "string" - }, - "chatQueueId": { - "format": "int32", - "type": "integer" - }, - "chatWebsocketConnectUri": { - "type": "string" - }, - "chatWidgetAccessGuid": { - "type": "string" - }, - "destinationJmsQueue": { - "type": "string" - }, - "mediaLinks": { - "items": { - "type": "string" - }, - "type": "array" - }, - "originatingHost": { - "type": "string" - }, - "payload": { - "type": "string" - }, - "recipient": { - "type": "string" - }, - "referer": { - "type": "string" - }, - "sender": { - "type": "string" - }, - "senderType": { - "type": "string" - }, - "sessionGuid": { - "type": "string" - }, - "status": { - "enum": [ - "SUCCESS", - "FAILED" - ], - "type": "string" - }, - "statusMessage": { - "type": "string" - }, - "textMessageDirection": { - "type": "string" - }, - "textMessageType": { - "enum": [ - "SMS", - "MMS" - ], - "type": "string" + "isActive": { + "type": "boolean" }, - "time": { - "$ref": "#/components/schemas/DateTime" + "isDeleted": { + "type": "boolean" }, - "type": { - "enum": [ - "SMS", - "WEB_CHAT", - "CHAT_ADMIN", - "SMS_TWILIO" - ], + "profileName": { "type": "string" - }, - "whisper": { - "format": "int32", - "type": "integer" } }, "type": "object" }, - "NextivaAccountIntegration": { - "properties": { - "_type": { - "type": "string" - }, - "accountId": { - "type": "string" - }, - "corpAcctNumber": { - "type": "string" - }, - "description": { - "type": "string" - }, - "encryptedAuthToken": { - "type": "string" - }, - "hasAccess": { - "type": "boolean" - }, - "integrationType": { - "type": "string" - }, - "isActive": { - "type": "boolean" - } - }, + "CollectionAgent": { "type": "object" }, - "NotificationGroup": { - "properties": { - "description": { - "type": "string" - }, - "groupId": { - "format": "int32", - "type": "integer" - }, - "groupName": { - "type": "string" - } - }, + "CollectionAgentAccountAccess": { + "type": "object" + }, + "CollectionAgentChatQueueAccess": { + "type": "object" + }, + "CollectionAgentDialGroupMember": { + "type": "object" + }, + "CollectionAgentGateAccess": { + "type": "object" + }, + "CollectionAgentLoadBalanceMember": { "type": "object" }, - "NotificationTarget": { + "CollectionAgentSkillProfile": { + "type": "object" + }, + "CollectionAgentSupervisor": { + "type": "object" + }, + "CollectionCampaign": { + "type": "object" + }, + "CollectionCampaignDisposition": { + "type": "object" + }, + "CollectionCampaignFilterStates": { + "type": "object" + }, + "CollectionCampaignFilterTimezones": { + "type": "object" + }, + "CollectionCloudRouteDestination": { + "type": "object" + }, + "CollectionCloudRouteProfile": { + "type": "object" + }, + "CollectionCustomDialZone": { + "type": "object" + }, + "CollectionQuotaTarget": { + "type": "object" + }, + "CollectionRemoteHttpService": { + "type": "object" + }, + "CollectionRemoteHttpServiceInput": { + "type": "object" + }, + "CollectionRequeueShortcut": { + "type": "object" + }, + "CollectionRightsDocument": { + "type": "object" + }, + "CollectionWhitelistTagMembers": { + "type": "object" + }, + "ComparableSearchField": { "properties": { - "notificationGroup": { - "$ref": "#/components/schemas/NotificationGroup" - }, - "smsOrEmail": { - "type": "string" - }, - "targetId": { - "format": "int32", - "type": "integer" - }, - "type": { + "operator": { "enum": [ - "SMS", - "EMAIL", - "USER" + "GREATER_THAN", + "LESS_THAN", + "EQUALS" ], "type": "string" }, - "user": { - "$ref": "#/components/schemas/User" + "value": { + "type": "object" } }, "type": "object" }, - "Operation": { + "Contact": { "properties": { - "bindingName": { + "businessPhone": { "type": "string" }, - "operation": { + "company": { "type": "string" }, - "parts": { - "items": { - "$ref": "#/components/schemas/Element" - }, - "type": "array" + "department": { + "type": "string" }, - "portName": { + "email": { "type": "string" }, - "soapAction": { + "emailAsLoginName": { + "type": "boolean" + }, + "firstName": { "type": "string" }, - "style": { + "jobTitle": { "type": "string" }, - "tagetNamespace": { + "lastName": { "type": "string" - } - }, - "type": "object" - }, - "OutboundAndInboundDailyCallData": { - "properties": { - "inboundCallTotal": { - "format": "int32", - "type": "integer" }, - "outboundCallTotal": { - "format": "int32", - "type": "integer" + "mobilePhone": { + "type": "string" } }, + "title": "Contact", "type": "object" }, - "OutboundStats": { + "CountryCode": { "properties": { - "abandon": { - "format": "int32", - "type": "integer" + "countryCode": { + "type": "string" }, - "accountId": { + "countryId": { "type": "string" }, - "active": { - "format": "int32", - "type": "integer" + "countryName": { + "type": "string" }, - "answer": { + "maxAniLength": { "format": "int32", "type": "integer" }, - "available": { + "maxUtcOffset": { "format": "int32", "type": "integer" }, - "busy": { + "minAniLength": { "format": "int32", "type": "integer" }, - "campaignId": { + "minUtcOffset": { "format": "int32", "type": "integer" - }, - "campaignName": { + } + }, + "type": "object" + }, + "CustomDialZoneGroups": { + "properties": { + "accountId": { "type": "string" }, - "complete": { - "format": "int32", - "type": "integer" - }, - "connects": { - "format": "int32", - "type": "integer" - }, - "dialGroupId": { - "format": "int32", - "type": "integer" - }, - "dialGroupName": { + "baseTimezone": { "type": "string" }, - "dnc": { - "format": "int32", - "type": "integer" - }, - "fax": { - "format": "int32", - "type": "integer" - }, - "intercept": { - "format": "int32", - "type": "integer" - }, - "lastUpdate": { - "$ref": "#/components/schemas/DateTime" - }, - "machine": { - "format": "int32", - "type": "integer" + "customDialZones": { + "$ref": "#/components/schemas/CollectionCustomDialZone" }, - "noanswer": { + "zoneGroupId": { "format": "int32", "type": "integer" }, - "notHumanAnswers": { - "format": "int32", - "type": "integer" + "zoneGroupName": { + "type": "string" + } + }, + "type": "object" + }, + "Dashboard": { + "properties": { + "creationDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "other": { - "format": "int32", - "type": "integer" + "data": { + "$ref": "#/components/schemas/JsonNode" }, - "pending": { + "id": { "format": "int32", "type": "integer" }, - "ready": { - "format": "int32", - "type": "integer" + "name": { + "type": "string" }, - "selectable": { + "shared": { "type": "boolean" - }, - "staffed": { - "format": "int32", - "type": "integer" - }, - "successDispositions": { - "format": "int32", - "type": "integer" - }, - "totalTalkTime": { - "format": "int64", - "type": "integer" } }, "type": "object" }, - "PassDispositionRequest": { + "Role": { + "type": "object", "properties": { - "destinationCampaignRequest": { - "$ref": "#/components/schemas/DestinationCampaignRequest" + "description": { + "type": "string" }, - "passDisposition": { - "$ref": "#/components/schemas/CampaignPassDisposition" + "roleType": { + "type": "string", + "enum": [ + "SUPER_USER", + "USER", + "MANAGE_USERS", + "MANAGE_RIGHTS", + "ACCESS_SIBLINGS", + "ACCESS_AUDIT_LOG", + "ACCESS_GOODDATA_ADMIN", + "ACCESS_GOODDATA_EDITOR", + "ACCESS_GOODDATA_EXPLORER", + "ACCESS_GOODDATA_VIEWER", + "ACCESS_GOODDATA_EMBEDDED_EXPLORER", + "ACCESS_GOODDATA_EMBEDDED_DASHBOARD", + "ASSUME_USERS", + "REPORT_ADMINISTRATIVE_USER", + "NO_ACCESS" + ] } - }, - "type": "object" + } }, - "PbxDirectoryFilter": { + "DateTimeComparableSearchField": { "properties": { - "accountId": { - "type": "string" - }, - "contactCenterExtension": { - "enum": [ - "INCLUDE_ALL", - "EXCLUDE_AGENTS_ONLY", - "EXCLUDE_AGENTS_AND_SUPERVISORS" - ], - "type": "string" - }, - "corporateExtension": { + "operator": { "enum": [ - "INCLUDE_ALL", - "INCLUDE_SPECIFIC_RANGES", - "EXCLUDE_SPECIFIC_RANGES" + "GREATER_THAN", + "LESS_THAN", + "EQUALS" ], "type": "string" }, - "corporateExtensionRange": { + "value": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" - }, - "id": { - "format": "int32", - "type": "integer" - }, - "includeInactiveExtensions": { - "type": "boolean" - } - }, - "type": "object" - }, - "PbxDirectoryFilterMailbox": { - "properties": { - "mailboxDetails": { - "items": { - "$ref": "#/components/schemas/PbxDirectoryMailboxDetail" - }, - "type": "array" - }, - "pbxDirectoryEnable": { - "type": "boolean" - }, - "pbxDirectoryFilter": { - "$ref": "#/components/schemas/PbxDirectoryFilter" } }, "type": "object" }, - "PbxDirectoryMailboxDetail": { + "DeleteDnisRequest": { "properties": { - "agentType": { - "enum": [ - "AGENT", - "SUPERVISOR", - "MULTI_USER", - "MULTI_SUPERVISOR" - ], + "dnis": { "type": "string" }, - "mailboxId": { + "dnisE164": { "type": "string" + }, + "phoneNumbersI18nEnabled": { + "type": "boolean" } }, "type": "object" }, - "PhoneBookEntry": { + "DialGroup": { "properties": { - "accountId": { - "type": "string" + "agentDialGroupMembers": { + "$ref": "#/components/schemas/CollectionAgentDialGroupMember" }, - "countryId": { + "agentsReady": { + "format": "int32", + "type": "integer" + }, + "allowLeadSearch": { "type": "string" }, - "dateCreated": { - "$ref": "#/components/schemas/DateTime" + "allowPreviewLeadFilters": { + "type": "boolean" }, - "destName": { + "billingKey": { "type": "string" }, - "destination": { + "campaigns": { + "$ref": "#/components/schemas/CollectionCampaign" + }, + "dialGroupDesc": { "type": "string" }, - "entryId": { + "dialGroupId": { "format": "int32", "type": "integer" }, - "notes": { + "dialGroupName": { "type": "string" }, - "type": { + "dialMode": { "enum": [ - "GATE", - "GLOBAL", - "CAMPAIGN" + "PREVIEW", + "CLICK_TO_TALK", + "PREDICTIVE", + "POWER", + "TCPA_SAFE_MODE" ], "type": "string" }, - "typeId": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "PhoneNumbersI18nMigrationStatusInfoResponse": { - "properties": { - "errorMessage": { - "type": "string" + "enableAbsolutePriority": { + "type": "boolean" }, - "finalStatus": { - "type": "string" + "enableAgentFilter": { + "type": "boolean" }, - "startTime": { - "format": "int64", - "type": "integer" + "enableCallbacksAfterMaxDailyPass": { + "type": "boolean" }, - "subStatuses": { - "additionalProperties": { - "type": "string" - }, - "type": "object" + "enableCallbacksAfterMaxpass": { + "type": "boolean" }, - "taskId": { - "type": "string" - } - }, - "type": "object" - }, - "PhoneNumbersI18nMigrationTaskResponse": { - "properties": { - "finalStatus": { - "type": "string" + "enableListPriority": { + "type": "boolean" }, - "mainAccount": { - "$ref": "#/components/schemas/MainAccount" + "groupId": { + "format": "int32", + "type": "integer" }, - "taskId": { + "hciEnabled": { + "enum": [ + "DISABLED", + "HCI_FETCH", + "HCI_PACING" + ], "type": "string" - } - }, - "type": "object" - }, - "Platform": { - "properties": { - "id": { + }, + "isActive": { + "type": "boolean" + }, + "maxLeadsReturned": { "format": "int32", "type": "integer" }, - "iqPort": { + "maxPorts": { "format": "int32", "type": "integer" }, - "iqSslPort": { + "minPredictiveAgents": { "format": "int32", "type": "integer" }, - "iqUrl": { - "type": "string" + "outdialServerGroupId": { + "format": "int32", + "type": "integer" }, - "name": { - "type": "string" + "permissions": { + "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" + }, + "type": "array" }, - "platformDesc": { - "type": "string" + "progressiveCallDelay": { + "format": "int32", + "type": "integer" }, - "platformId": { - "type": "string" + "progressiveEnabled": { + "type": "boolean" }, - "telePlatformId": { - "type": "string" + "realTimeAgentData": { + "type": "boolean" }, - "webSocketPort": { - "format": "int32", - "type": "integer" + "requireFetchedLeadsCalled": { + "type": "boolean" } }, "type": "object" }, - "PlatformDialer": { + "DnisBulkUpdateRespose": { "properties": { - "dialerDesc": { + "message": { "type": "string" }, - "dialerId": { - "format": "int32", - "type": "integer" - }, - "dialerType": { + "status": { "type": "string" }, - "id": { - "format": "int32", - "type": "integer" - }, - "name": { + "updatedRows": { "type": "string" + } + }, + "type": "object" + }, + "DnisListPreviewResponse": { + "properties": { + "records": { + "items": { + "$ref": "#/components/schemas/BaseCsvDto" + }, + "type": "array" }, - "tcpaSafeMode": { - "type": "boolean" + "uploadStatus": { + "$ref": "#/components/schemas/DnisResponseValidation" } }, "type": "object" }, - "PoolUsage": { + "DnisListRequest": { "properties": { - "active": { - "type": "boolean" + "accountIds": { + "items": { + "type": "string" + }, + "type": "array" }, - "mode": { - "enum": [ - "PREVIEW", - "CLICK_TO_TALK", - "PREDICTIVE", - "POWER", - "TCPA_SAFE_MODE" - ], + "dnisState": { "type": "string" }, - "name": { - "type": "string" + "phoneNumbersI18nEnabled": { + "type": "boolean" }, - "usageType": { - "enum": [ - "OUTBOUND", - "INBOUND" - ], + "searchText": { "type": "string" } }, "type": "object" }, - "PrepayMinutePool": { + "DnisPool": { "properties": { - "accountId": { + "active": { + "type": "boolean" + }, + "assignedDnis": { + "$ref": "#/components/schemas/AssignedDnis" + }, + "assignedSmsDnis": { + "$ref": "#/components/schemas/AssignedSmsDnis" + }, + "carrier": { "type": "string" }, - "notificationEmail": { + "customAppString": { "type": "string" }, - "poolDesc": { + "dateCreated": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "poolName": { + "dnis": { "type": "string" }, - "poolTime": { - "format": "int32", - "type": "integer" + "dnisCategory": { + "type": "string" + }, + "dnisDescription": { + "type": "string" + }, + "dnisE164": { + "type": "string" }, - "tenPercentWarn": { + "dnisManagedByRC": { "type": "boolean" }, - "twentyPercentWarn": { - "type": "boolean" + "inboundContext": { + "type": "string" }, - "usedTime": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "PrepayTransaction": { - "properties": { - "accountId": { + "lastModified": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "address1": { + "lastModifiedBy": { "type": "string" }, - "city": { + "mediaCode": { "type": "string" }, - "comments": { + "mediaFormat": { "type": "string" }, - "country": { + "mediaIsci": { "type": "string" }, - "dollarAmount": { - "format": "double", - "type": "number" + "mediaLength": { + "type": "string" }, - "email": { + "mediaMarket": { "type": "string" }, - "firstName": { + "mediaNetwork": { "type": "string" }, - "lastName": { + "mediaUrl": { "type": "string" }, - "minutes": { - "format": "int32", - "type": "integer" + "mediaVersion": { + "type": "string" }, - "phone": { + "mediaWebSourcecode": { "type": "string" }, - "poolName": { + "notes": { "type": "string" }, - "state": { + "originatingDnis": { "type": "string" }, - "transDate": { - "$ref": "#/components/schemas/DateTime" + "phoneNumbersI18nEnabled": { + "type": "boolean" }, - "transType": { + "platformId": { "type": "string" }, - "transactionId": { - "format": "int32", - "type": "integer" + "reservedAccount": { + "$ref": "#/components/schemas/Account" }, - "transactionName": { + "reservedAccountId": { "type": "string" }, - "zip": { - "type": "string" - } - }, - "type": "object" - }, - "PrerouteCheckStatus": { - "properties": { - "reason": { + "resporg": { "type": "string" }, - "status": { + "smsEnabled": { "type": "boolean" + }, + "twilioApiKey": { + "type": "string" + }, + "vendorId": { + "type": "string" + }, + "vruNetworkId": { + "format": "int32", + "type": "integer" } }, "type": "object" }, - "ProductOperationResult": { + "DnisPoolUpdateRequest": { "properties": { - "id": { + "chatQueueId": { "format": "int32", "type": "integer" }, - "success": { - "type": "boolean" - } - }, - "type": "object" - }, - "ProductPermission": { - "properties": { - "cascade": { - "type": "boolean" + "dnisPool": { + "$ref": "#/components/schemas/DnisPoolV2" }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" + "endDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, "product": { "enum": [ @@ -10997,656 +4756,658 @@ "UTILITIES" ], "type": "string" - } - }, - "type": "object" - }, - "ProductsSelection": { - "properties": { - "groupId": { - "format": "int32", - "type": "integer" - }, - "ids": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - } - }, - "type": "object" - }, - "QuotaGroup": { - "properties": { - "active": { - "type": "boolean" }, - "campaigns": { - "$ref": "#/components/schemas/CollectionCampaign" - }, - "isActive": { - "type": "boolean" - }, - "quotaGroupId": { + "productId": { "format": "int32", "type": "integer" }, - "quotaGroupName": { + "smsEndDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "quotaTargets": { - "$ref": "#/components/schemas/CollectionQuotaTarget" - } - }, - "type": "object" - }, - "QuotaManagementGroup": { - "properties": { - "quotaGroupId": { - "format": "int32", - "type": "integer" + "smsStartDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "quotaGroupName": { + "startDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "quotaTargetStats": { - "items": { - "$ref": "#/components/schemas/QuotaTargetStats" - }, - "type": "array" + "unassignProduct": { + "type": "boolean" + }, + "unassignSmsProduct": { + "type": "boolean" } }, "type": "object" }, - "QuotaTarget": { + "DnisPoolV2": { "properties": { - "clientMetadata": { - "type": "string" - }, - "criteriaJs": { - "type": "string" - }, - "currentCount": { - "format": "int32", - "type": "integer" - }, - "quotaGroup": { - "$ref": "#/components/schemas/QuotaGroup" - }, - "quotaMetOn": { - "$ref": "#/components/schemas/DateTime" + "active": { + "type": "boolean" }, - "quotaTargetId": { - "format": "int32", - "type": "integer" + "assignedDnis": { + "$ref": "#/components/schemas/AssignedDnis" }, - "targetCount": { - "format": "int32", - "type": "integer" + "assignedSmsDnis": { + "$ref": "#/components/schemas/AssignedSmsDnis" }, - "targetName": { + "carrier": { "type": "string" - } - }, - "type": "object" - }, - "QuotaTargetStats": { - "properties": { - "campaigns": { - "items": { - "$ref": "#/components/schemas/CampaignStats" - }, - "type": "array" }, - "currentCount": { - "format": "int32", - "type": "integer" + "customAppString": { + "type": "string" }, - "quotaGroupId": { - "format": "int32", - "type": "integer" + "dateCreated": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "quotaMetOn": { - "$ref": "#/components/schemas/DateTime" + "dnis": { + "type": "string" }, - "quotaTargetId": { - "format": "int32", - "type": "integer" + "dnisCategory": { + "type": "string" }, - "quotaTargetName": { + "dnisDescription": { "type": "string" }, - "targetCount": { - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, - "RTASubscriptionRequest": { - "required": [ - "subscriptionName", - "notificationUrl" - ], - "properties": { - "subscriptionName": { - "description": "Subscription name.", + "dnisE164": { "type": "string" }, - "description": { - "description": "Human-readable description.", + "inboundContext": { "type": "string" }, - "retryCount": { - "description": "Maximum delivery retry count. Maximum allowed value is 10. Default is 3.", - "format": "int32", - "type": "integer" + "lastModified": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "notificationUrl": { - "description": "Publicly accessible endpoint that receives agent-state notifications. The URL must be reachable by RingCentral, must not be blocked by a firewall, and HTTPS receivers must support TLS 1.2 or higher. During endpoint validation, the receiver must return 200 OK within 3000 milliseconds, echo the validation request's Validation-Token header value in the response Validation-Token header, and keep the complete response, including headers and body, no larger than 1024 bytes. Responses larger than this can fail setup with {\"errorCode\":\"SUB-525\",\"message\":\"WebHook server response is invalid\"}.", + "lastModifiedBy": { "type": "string" }, - "authConfigId": { - "description": "Auth configuration ID used when RingCX sends notification requests to the receiver.", - "format": "uuid", + "mediaCode": { "type": "string" }, - "active": { - "description": "Whether the subscription is active.", - "type": "boolean" + "mediaFormat": { + "type": "string" }, - "customHeaders": { - "additionalProperties": { - "type": "object" - }, - "description": "Additional headers to send with notification requests.", - "type": "object" + "mediaIsci": { + "type": "string" }, - "expiresAt": { - "description": "Expiration time as epoch seconds. Use 0 for no configured expiration.", - "format": "int64", - "type": "integer" - } - }, - "type": "object" - }, - "RTASubscriptionResponse": { - "properties": { - "subscriptionId": { - "format": "uuid", + "mediaLength": { "type": "string" }, - "mainAccountId": { + "mediaMarket": { "type": "string" }, - "subAccountId": { + "mediaNetwork": { "type": "string" }, - "subscriptionName": { + "mediaUrl": { "type": "string" }, - "description": { + "mediaVersion": { "type": "string" }, - "notificationUrl": { + "mediaWebSourcecode": { "type": "string" }, - "authConfigId": { - "format": "uuid", + "notes": { "type": "string" }, - "active": { - "type": "boolean" + "originatingDnis": { + "type": "string" }, - "maxRetryCount": { - "format": "int32", - "type": "integer" + "phoneNumbersI18nEnabled": { + "type": "boolean" }, - "customHeaders": { - "additionalProperties": { - "type": "object" - }, - "type": "object" + "platformId": { + "type": "string" }, - "expiresAt": { - "format": "int64", - "type": "integer" + "reservedAccount": { + "$ref": "#/components/schemas/Account" }, - "createdBy": { + "reservedAccountId": { "type": "string" }, - "createdAt": { - "format": "date-time", + "resporg": { "type": "string" }, - "updatedBy": { + "smsEnabled": { + "type": "boolean" + }, + "twilioApiKey": { "type": "string" }, - "updatedAt": { - "format": "date-time", + "vendorId": { "type": "string" }, - "authConfig": { - "$ref": "#/components/schemas/AuthConfig" + "vruNetworkId": { + "format": "int32", + "type": "integer" } }, "type": "object" }, - "RcAccountAccessResponse": { + "DnisResponseValidation": { "properties": { - "errorMessage": { + "errorCode": { "type": "string" }, - "hasAccess": { - "type": "boolean" + "errorMessage": { + "items": { + "type": "string" + }, + "type": "array" }, - "rcAccountId": { - "type": "string" + "totalRecords": { + "format": "int64", + "type": "integer" + }, + "validRecords": { + "format": "int64", + "type": "integer" + }, + "validated": { + "type": "boolean" } }, "type": "object" }, - "RcExtensionRegionalSettings": { + "EmailTemplate": { "properties": { - "greetingsLanguageId": { - "format": "int32", - "type": "integer" - }, - "greetingsLanguageLocaleCode": { + "accountId": { "type": "string" }, - "greetingsLanguageName": { - "type": "string" + "allowBccChange": { + "type": "boolean" }, - "homeCountryCode": { - "type": "string" + "allowBodyChange": { + "type": "boolean" }, - "homeCountryId": { - "format": "int32", - "type": "integer" + "allowCcChange": { + "type": "boolean" }, - "homeCountryName": { - "type": "string" + "allowFromChange": { + "type": "boolean" }, - "regionalFormatId": { - "format": "int32", - "type": "integer" + "allowSubjectChange": { + "type": "boolean" }, - "regionalFormatLocaleCode": { + "allowToChange": { + "type": "boolean" + }, + "emailBcc": { "type": "string" }, - "regionalFormatName": { + "emailCc": { "type": "string" }, - "timeFormat": { + "emailFrom": { "type": "string" }, - "timeZoneBias": { + "emailRte": { "type": "string" }, - "timeZoneDescription": { + "emailSubject": { "type": "string" }, - "timeZoneId": { + "emailTemplateId": { "format": "int32", "type": "integer" }, - "userLanguageId": { - "format": "int32", - "type": "integer" + "emailTo": { + "type": "string" }, - "userLanguageLocaleCode": { + "sendFormat": { "type": "string" }, - "userLanguageName": { + "templateName": { "type": "string" } }, "type": "object" }, - "RcOfficeUser": { + "Errors": { "properties": { - "email": { + "cause": { "type": "string" }, - "firstName": { + "details": { "type": "string" }, - "lastName": { + "developerMessage": { "type": "string" }, - "rcUserId": { + "generalMessage": { + "type": "string" + }, + "requestUri": { + "type": "string" + }, + "timestamp": { "format": "int64", "type": "integer" }, - "regionalSettings": { - "$ref": "#/components/schemas/RcExtensionRegionalSettings" - } - }, - "type": "object" - }, - "RcUserMappingResponse": { - "properties": { - "ev_users": { + "validationErrors": { "items": { - "$ref": "#/components/schemas/EVUser" + "$ref": "#/components/schemas/ValidationErrorData" }, "type": "array" - }, - "rc_user_uid": { - "format": "int64", - "type": "integer" } }, "type": "object" }, - "RcUserSyncUpdateRequest": { + "Gate": { "properties": { - "active": { - "type": "boolean" + "abandonCampaign": { + "$ref": "#/components/schemas/Campaign" }, - "email": { + "acceptTime": { + "format": "byte", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type": "string" }, - "firstName": { + "afterCallBaseState": { "type": "string" }, - "isActive": { - "type": "boolean" + "afterCallState": { + "$ref": "#/components/schemas/AccountAuxState" }, - "lastName": { + "agentConnSoapService": { + "$ref": "#/components/schemas/RemoteHttpService" + }, + "agentGateAccess": { + "items": { + "$ref": "#/components/schemas/AgentGateAccess" + }, + "type": "array" + }, + "agentPopMessage": { "type": "string" }, - "rcSync": { - "type": "boolean" + "agentTermSoapService": { + "$ref": "#/components/schemas/RemoteHttpService" }, - "regionalSettings": { - "$ref": "#/components/schemas/RcExtensionRegionalSettings" - } - }, - "type": "object" - }, - "RecordingDestinationV2": { - "properties": { - "accountId": { + "appUrl": { + "type": "string" + }, + "backupAppUrl": { "type": "string" }, - "destDir": { + "billingCode": { "type": "string" }, - "destType": { - "enum": [ - "SFTP", - "S3", - "FTP", - "UNKNOWN" - ], + "blockedAniMessage": { "type": "string" }, - "destinationId": { + "callbackCampaign": { + "$ref": "#/components/schemas/Campaign" + }, + "createdOn": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" + }, + "dequeueDelay": { + "format": "int32", + "type": "integer" + }, + "dequeueSoapService": { + "$ref": "#/components/schemas/RemoteHttpService" + }, + "dispositionTimeout": { "format": "int32", "type": "integer" }, - "destinationJson": { + "enableGlobalPhoneBook": { + "type": "boolean" + }, + "enableIvrTokens": { + "type": "boolean" + }, + "endCallMessage": { "type": "string" }, - "destinationName": { + "fifoDisabled": { + "type": "boolean" + }, + "friSched": { "type": "string" - } - }, - "type": "object" - }, - "RecordingTaskV2": { - "properties": { - "accountId": { + }, + "gateClosedEvent": { "type": "string" }, - "active": { + "gateDesc": { + "type": "string" + }, + "gateGroup": { + "$ref": "#/components/schemas/GateGroup" + }, + "gateId": { + "format": "int32", + "type": "integer" + }, + "gateName": { + "type": "string" + }, + "gateOpen": { "type": "boolean" }, - "deleted": { + "gatePriority": { + "format": "int32", + "type": "integer" + }, + "gatePriorityGroup": { + "$ref": "#/components/schemas/GatePriorityGroup" + }, + "gateQueueEvents": { + "items": { + "$ref": "#/components/schemas/GateQueueEvent" + }, + "type": "array" + }, + "hangupOnDisposition": { "type": "boolean" }, - "filterConfig": { - "type": "string" + "isActive": { + "type": "boolean" }, - "lastDaySync": { - "$ref": "#/components/schemas/DateTime" + "longCallTime": { + "format": "int32", + "type": "integer" }, - "lastPushTime": { - "$ref": "#/components/schemas/DateTime" + "manualCallerId": { + "type": "string" }, - "lastQueryTime": { - "$ref": "#/components/schemas/DateTime" + "manualCallerIdE164": { + "type": "string" }, - "nextPushTime": { - "$ref": "#/components/schemas/DateTime" + "maxQueueEvent": { + "type": "string" }, - "nextQueryTime": { - "$ref": "#/components/schemas/DateTime" + "maxQueueLimit": { + "format": "int32", + "type": "integer" }, - "pushStatusDesc": { + "monSched": { "type": "string" }, - "queryStatusDesc": { + "noAgentEvent": { "type": "string" }, - "recordingDestinationV2": { - "$ref": "#/components/schemas/RecordingDestinationV2" + "observeDst": { + "type": "boolean" }, - "recordingFilename": { + "onHoldMessage": { "type": "string" }, - "taskDesc": { + "outboundCallerId": { "type": "string" }, - "taskId": { + "pauseRecordingSec": { "format": "int32", "type": "integer" }, - "taskName": { + "permissions": { + "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" + }, + "type": "array" + }, + "perspectiveRecordingMode": { + "enum": [ + "DISABLED", + "ALL_AGENT_LEGS" + ], "type": "string" }, - "taskStart": { - "$ref": "#/components/schemas/DateTime" + "phoneNumbersI18nEnabled": { + "type": "boolean" + }, + "postCallSoapService": { + "$ref": "#/components/schemas/RemoteHttpService" + }, + "postDispSoapService": { + "$ref": "#/components/schemas/RemoteHttpService" }, - "taskState": { + "recordCall": { + "format": "int32", + "type": "integer" + }, + "recordingInConference": { + "type": "boolean" + }, + "recordingSettings": { "enum": [ - "READY", - "TEST", - "RUNNING", - "FAILED", - "DISABLED", - "UNKNOWN" + "RECORD_FULL_CALL", + "AGENT_FULL_CONTROL_DEFAULT_ON", + "AGENT_FULL_CONTROL_DEFAULT_OFF", + "AGENT_PAUSE" ], "type": "string" }, - "taskType": { + "requeueType": { "enum": [ - "INTELLITASK_RECORDING_PUSH" + "ADVANCED", + "RESTRICTED" ], "type": "string" - } - }, - "type": "object" - }, - "RedirectView": { - "properties": { - "applicationContext": { - "$ref": "#/components/schemas/ApplicationContext" }, - "attributesMap": { - "type": "object" + "resultFileDestination": { + "$ref": "#/components/schemas/ResultFileDestination" }, - "beanName": { - "type": "string" + "revMatch": { + "type": "boolean" }, - "contentType": { + "satSched": { "type": "string" }, - "exposePathVariables": { - "type": "boolean" + "script": { + "$ref": "#/components/schemas/Script" }, - "hosts": { - "items": { - "type": "string" - }, - "type": "array" + "shortAbandonTime": { + "format": "int32", + "type": "integer" }, - "propagateQueryProperties": { - "type": "boolean" + "shortCallTime": { + "format": "int32", + "type": "integer" }, - "redirectView": { + "singleChannelEnabled": { "type": "boolean" }, - "requestContextAttribute": { + "slaTime": { + "format": "int32", + "type": "integer" + }, + "specialAniEvent": { "type": "string" }, - "staticAttributes": { - "type": "object" + "stopRecordingOnTransfer": { + "type": "boolean" }, - "url": { - "type": "string" - } - }, - "title": "RedirectView", - "type": "object" - }, - "RegionalSettingRequestResponse": { - "properties": { - "formattingLocale": { + "sunSched": { "type": "string" }, - "greetingLanguage": { + "survey": { + "$ref": "#/components/schemas/Survey" + }, + "surveyPopType": { "type": "string" }, - "homeCountry": { + "syncQueueWait": { "format": "int32", "type": "integer" }, - "homeCountryCode": { + "throttleCalls": { + "format": "int32", + "type": "integer" + }, + "throttleDays": { + "format": "int32", + "type": "integer" + }, + "throttlingAniEvent": { "type": "string" }, - "language": { + "thuSched": { "type": "string" }, - "timeFormat": { + "transferCallerId": { "type": "string" }, - "timezone": { + "transferCallerIdE164": { + "type": "string" + }, + "transferTermSoapService": { + "$ref": "#/components/schemas/RemoteHttpService" + }, + "ttAccept": { + "type": "boolean" + }, + "tueSched": { + "type": "string" + }, + "wedSched": { + "type": "string" + }, + "whisperMessage": { + "type": "string" + }, + "wrapTime": { "format": "int32", "type": "integer" } }, "type": "object" }, - "RejectedRow": { + "GateDisposition": { "properties": { - "message": { + "destCampaign": { + "$ref": "#/components/schemas/Campaign" + }, + "dispSoapService": { + "$ref": "#/components/schemas/RemoteHttpService" + }, + "disposition": { "type": "string" }, - "rowData": { - "items": { - "type": "string" - }, - "type": "array" - } - }, - "type": "object" - }, - "RemoteHttpService": { - "properties": { - "accountId": { + "dncTagLabel": { "type": "string" }, - "enableMappings": { + "doNotCall": { "type": "boolean" }, - "httpPassword": { + "dtmfMapping": { "type": "string" }, - "httpServiceConfig": { + "emailDestinations": { "type": "string" }, - "httpServiceGroup": { - "$ref": "#/components/schemas/RemoteHttpServiceGroup" + "emailTemplate": { + "$ref": "#/components/schemas/EmailTemplate" }, - "httpServiceInputs": { - "$ref": "#/components/schemas/CollectionRemoteHttpServiceInput" + "gateDispositionId": { + "format": "int32", + "type": "integer" }, - "httpUsername": { - "type": "string" + "isComplete": { + "type": "boolean" }, - "isDebug": { + "isContact": { "type": "boolean" }, - "isEnabled": { + "isDefault": { "type": "boolean" }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" + "isDisabled": { + "type": "boolean" }, - "returntype": { - "type": "string" + "isRequeued": { + "format": "int32", + "type": "integer" }, - "sendAllSurveyData": { + "isSuccess": { "type": "boolean" }, - "serviceDescription": { - "type": "string" + "rank": { + "format": "int32", + "type": "integer" }, - "serviceId": { + "requeueDelay": { "format": "int32", "type": "integer" }, - "serviceType": { - "enum": [ - "SOAP", - "HTTP_POST", - "HTTP_GET", - "HTTP" - ], - "type": "string" + "requireNote": { + "type": "boolean" }, - "soapAction": { - "type": "string" + "saveSurvey": { + "type": "boolean" }, - "soapEndpoint": { - "type": "string" + "setAgentFlag": { + "type": "boolean" }, - "soapOperationname": { + "timeout": { + "format": "int32", + "type": "integer" + }, + "xfer": { + "format": "byte", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type": "string" }, - "soapPortname": { + "xferDest": { + "type": "string" + } + }, + "type": "object" + }, + "GateGroup": { + "properties": { + "billingKey": { "type": "string" }, - "soapServicename": { + "createdOn": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "targetNamespace": { + "endDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" - } - }, - "type": "object" - }, - "RemoteHttpServiceGroup": { - "properties": { + }, + "gateGroupId": { + "format": "int32", + "type": "integer" + }, + "gates": { + "items": { + "$ref": "#/components/schemas/Gate" + }, + "type": "array" + }, "groupName": { "type": "string" }, - "isDefault": { - "type": "boolean" + "groupSkills": { + "items": { + "$ref": "#/components/schemas/GateGroupSkill" + }, + "type": "array" }, "permissions": { "items": { @@ -11661,1318 +5422,1021 @@ }, "type": "array" }, - "serviceGroupId": { - "format": "int32", - "type": "integer" - }, - "services": { - "$ref": "#/components/schemas/CollectionRemoteHttpService" + "startDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" } }, "type": "object" }, - "RemoteHttpServiceInput": { + "GateGroupSkill": { "properties": { - "inputId": { - "format": "int32", - "type": "integer" + "active": { + "type": "boolean" }, - "name": { - "type": "string" + "agentSkillProfiles": { + "$ref": "#/components/schemas/CollectionAgentSkillProfile" }, - "rank": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", + "createdOn": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "simpleDataType": { + "requeueShortcut": { + "items": { + "$ref": "#/components/schemas/RequeueShortcut" + }, + "type": "array" + }, + "skillDesc": { "type": "string" }, - "type": { + "skillId": { + "format": "int32", + "type": "integer" + }, + "skillName": { "type": "string" }, - "value": { + "whisperAudio": { "type": "string" } }, "type": "object" }, - "ReportCriteria": { + "GateGroupV2": { "properties": { "accountId": { "type": "string" }, - "criteriaType": { - "enum": [ - "DIALER_RESULT_DOWNLOAD_CRITERIA", - "GLOBAL_CALL_TYPE_CRITERIA", - "IVR_DETAIL_CRITERIA", - "TFN_DID_MANAGER_CRITERIA", - "ALL_CALLS_CRITERIA", - "CASPER_CRITERIA" - ], - "type": "string" - }, - "databaseTimezone": { - "type": "string" - }, - "endDate": { - "$ref": "#/components/schemas/DateTime" - }, - "endDateRange": { - "$ref": "#/components/schemas/TimeRange" - }, - "scheduleTimezoneName": { + "billingKey": { "type": "string" }, - "startDate": { - "$ref": "#/components/schemas/DateTime" - }, - "startDateRange": { - "$ref": "#/components/schemas/TimeRange" + "gateGroupId": { + "format": "int32", + "type": "integer" }, - "timezoneName": { + "groupName": { "type": "string" } }, "type": "object" }, - "ReportMetaData": { + "GatePriorityGroup": { "properties": { - "cciReport": { - "type": "boolean" - }, - "parameterList": { - "items": { - "type": "string" - }, - "type": "array" - }, - "reportGroup": { - "type": "string" + "gatePriorityGroupId": { + "format": "int32", + "type": "integer" }, - "reportName": { + "gatePriorityGroupName": { "type": "string" } }, "type": "object" }, - "ReportParams": { + "GateQueueDtmfEvent": { "properties": { - "accountId": { + "dtmf": { "type": "string" }, - "compressReport": { - "type": "boolean" + "dtmfEvent": { + "type": "string" }, - "delimiter": { - "enum": [ - "PIPE", - "COMMA", - "TAB", - "EXCEL", - "HTML" - ], + "dtmfEventId": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GateQueueEvent": { + "properties": { + "enableDtmf": { + "format": "byte", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type": "string" }, - "destination": { - "$ref": "#/components/schemas/DestinationParams" + "eventDuration": { + "format": "int32", + "type": "integer" }, - "maxRows": { + "eventId": { "format": "int32", "type": "integer" }, - "reportCriteria": { - "$ref": "#/components/schemas/ReportCriteria" + "eventRank": { + "format": "int32", + "type": "integer" }, - "reportName": { - "type": "string" + "gate": { + "$ref": "#/components/schemas/Gate" }, - "reportType": { - "enum": [ - "DIALER_RESULT_DOWNLOAD", - "GLOBAL_CALL_TYPE_EXCEL", - "GLOBAL_CALL_TYPE_DELIMITED", - "ALL_CALLS", - "IVR_DETAIL", - "TFN_DID_MANAGER_SUPERUSER_EXCEL", - "TFN_DID_MANAGER_EXCEL", - "TFN_DID_MANAGER_DELIMITED", - "CASPER_REPORT" - ], + "queueEvent": { "type": "string" - }, - "requestUser": { - "$ref": "#/components/schemas/User" - }, - "schedule": { - "$ref": "#/components/schemas/Schedule" - }, - "scheduledReport": { - "type": "boolean" } }, "type": "object" }, - "RequeueShortcut": { + "GateScheduleOverride": { "properties": { - "campaign": { - "$ref": "#/components/schemas/Campaign" - }, - "gate": { - "$ref": "#/components/schemas/Gate" - }, - "groupSkill": { - "$ref": "#/components/schemas/GateGroupSkill" - }, - "name": { + "overrideClosedEvent": { "type": "string" }, - "rank": { - "format": "int32", - "type": "integer" + "overrideDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "requeueGate": { - "$ref": "#/components/schemas/Gate" + "overrideLabel": { + "type": "string" }, - "requeueGateGroup": { - "$ref": "#/components/schemas/GateGroup" + "overrideSched": { + "type": "string" }, - "requeueShortcutId": { + "scheduleOverrideId": { "format": "int32", "type": "integer" } }, "type": "object" }, - "ResourcePermission": { + "GateSkinnyAssignable": { "properties": { - "cascade": { - "type": "boolean" + "accountId": { + "type": "string" }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" + "gateGroup": { + "$ref": "#/components/schemas/GateGroupV2" }, - "resourceId": { + "gateGroupId": { "format": "int32", "type": "integer" }, - "resourceType": { - "enum": [ - "ACCOUNT", - "GATE_GROUP", - "GATE", - "AGENT", - "AGENT_GROUP", - "OUTBOUND_DIAL_GROUP", - "OUTBOUND_CAMPAIGN", - "VISUAL_IVR", - "VISUAL_IVR_GROUP", - "TRAC_NUMBER", - "TRAC_GROUP", - "CLOUD_PROFILE", - "CLOUD_DESTINATION", - "CLOUD_PROFILE_GROUP", - "CLOUD_GROUP", - "CLOUD_DESTINATION_GROUP", - "HTTP_SERVICE", - "HTTP_SERVICE_GROUP", - "SCRIPT", - "SCRIPT_GROUP", - "TN_MANAGER", - "UTILITIES", - "CHAT_QUEUE", - "CHAT_GROUP", - "KNOWLEDGEBASE_GROUP", - "KNOWLEDGEBASE_CATEGORY" - ], - "type": "string" - } - }, - "type": "object" - }, - "ResponseEntity": { - "properties": { - "body": { - "type": "object" + "gateId": { + "format": "int32", + "type": "integer" }, - "statusCode": { - "enum": [ - "100", - "101", - "102", - "103", - "200", - "201", - "202", - "203", - "204", - "205", - "206", - "207", - "208", - "226", - "300", - "301", - "302", - "303", - "304", - "305", - "307", - "308", - "400", - "401", - "402", - "403", - "404", - "405", - "406", - "407", - "408", - "409", - "410", - "411", - "412", - "413", - "414", - "415", - "416", - "417", - "418", - "419", - "420", - "421", - "422", - "423", - "424", - "426", - "428", - "429", - "431", - "451", - "500", - "501", - "502", - "503", - "504", - "505", - "506", - "507", - "508", - "509", - "510", - "511" - ], + "gateName": { "type": "string" }, - "statusCodeValue": { + "groupId": { "format": "int32", "type": "integer" + }, + "isActive": { + "type": "boolean" } }, "type": "object" }, - "ResultFileDestination": { - "properties": { - "aggregateOutput": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" - }, - "destType": { + "GateSpecialAni": { + "properties": { + "ani": { "type": "string" }, - "destinationId": { - "format": "int32", - "type": "integer" - }, - "destinationName": { + "aniE164": { "type": "string" }, - "emailDest": { + "dateAdded": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "ftpDir": { - "type": "string" + "phoneNumbersI18nEnabled": { + "type": "boolean" }, - "ftpPwd": { + "type": { "type": "string" + } + }, + "type": "object" + }, + "GatesLoggedInAgentsView": { + "properties": { + "agentGroupId": { + "format": "int32", + "type": "integer" }, - "ftpServer": { - "type": "string" + "agentId": { + "format": "int32", + "type": "integer" }, - "ftpUid": { + "firstName": { "type": "string" }, - "passive": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", + "groupName": { "type": "string" }, - "sendEmptyFiles": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", + "lastName": { "type": "string" }, - "sftp": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", + "username": { "type": "string" } }, "type": "object" }, - "RightsDocTable": { + "InputStream": { + "type": "object" + }, + "JsonNode": { "properties": { - "accountId": { - "type": "string" + "array": { + "type": "boolean" }, - "creationDate": { - "$ref": "#/components/schemas/DateTime" + "bigDecimal": { + "type": "boolean" }, - "isMaster": { + "bigInteger": { "type": "boolean" }, - "owner": { - "$ref": "#/components/schemas/User" + "binary": { + "type": "boolean" }, - "rightsDocJson": { - "type": "string" + "boolean": { + "type": "boolean" }, - "rightsDocName": { + "containerNode": { + "type": "boolean" + }, + "double": { + "type": "boolean" + }, + "empty": { + "type": "boolean" + }, + "float": { + "type": "boolean" + }, + "floatingPointNumber": { + "type": "boolean" + }, + "int": { + "type": "boolean" + }, + "integralNumber": { + "type": "boolean" + }, + "long": { + "type": "boolean" + }, + "missingNode": { + "type": "boolean" + }, + "nodeType": { + "enum": [ + "ARRAY", + "BINARY", + "BOOLEAN", + "MISSING", + null, + "NUMBER", + "OBJECT", + "POJO", + "STRING" + ], "type": "string" + }, + "null": { + "type": "boolean" + }, + "number": { + "type": "boolean" + }, + "object": { + "type": "boolean" + }, + "pojo": { + "type": "boolean" + }, + "short": { + "type": "boolean" + }, + "textual": { + "type": "boolean" + }, + "valueNode": { + "type": "boolean" } }, "type": "object" }, - "RightsDocument": { + "LeadActionParams": { "properties": { - "accountId": { + "paramMap": { + "type": "object" + } + }, + "type": "object" + }, + "LeadActionResult": { + "properties": { + "dialerRefreshed": { + "type": "boolean" + }, + "errorMessage": { "type": "string" }, - "accountPermissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" + "leadActionType": { + "type": "string" }, - "assigned": { - "type": "boolean" + "leadDeleteCount": { + "format": "int32", + "type": "integer" }, - "cascade": { - "type": "boolean" + "leadUpdateCount": { + "format": "int32", + "type": "integer" }, - "isMaster": { + "redialDeleteCount": { + "format": "int32", + "type": "integer" + }, + "success": { "type": "boolean" + } + }, + "type": "object" + }, + "LeadListPagePreview": { + "properties": { + "pageName": { + "type": "string" }, - "ownerId": { + "pageNumber": { "format": "int32", "type": "integer" }, - "productPermissions": { - "items": { - "$ref": "#/components/schemas/ProductPermission" - }, - "type": "array" - }, - "resourcePermissions": { + "rowData": { "items": { - "$ref": "#/components/schemas/ResourcePermission" + "items": { + "type": "string" + }, + "type": "array" }, "type": "array" - }, - "rightsDocId": { - "format": "int32", - "type": "integer" - }, - "rightsDocName": { - "type": "string" } }, "type": "object" }, - "SIPRegistrationResult": { + "LeadListPreviewResponse": { "properties": { - "device": { - "$ref": "#/components/schemas/Device" - }, - "sipErrorCodes": { + "mappingColumns": { "items": { + "enum": [ + "LEAD_PHONE", + "EXTERN_ID", + "STATE", + "LEAD_TIMEZONE", + "PENDING_AGENT_ID", + "TITLE", + "FIRST_NAME", + "MID_NAME", + "LAST_NAME", + "SUFFIX", + "EMAIL", + "ADDRESS1", + "ADDRESS2", + "CITY", + "ZIP", + "GATE_KEEPER", + "AUX_DATA1", + "AUX_DATA2", + "AUX_DATA3", + "AUX_DATA4", + "AUX_DATA5", + "AUX_PHONE", + "AUX_EXTERNAL_URL", + "AUX_GREETING", + "LIVE_ANSWER_MESSAGE", + "MACH_ANSWER_MESSAGE", + "CALLER_ID", + "LEAD_PRIORITY", + "COUNTRY" + ], "type": "string" }, "type": "array" }, - "sipFlags": { - "$ref": "#/components/schemas/SipFlags" - }, - "sipInfo": { + "pagePreviews": { "items": { - "$ref": "#/components/schemas/SipInfo" + "$ref": "#/components/schemas/LeadListPagePreview" }, "type": "array" }, - "sipInfoPstn": { + "transactionId": { + "type": "string" + }, + "personaPhoneConfig": { + "description": "Configured additional persona phone fields available for mapping when the campaign uses strategic calling configuration.", "items": { - "type": "object" + "$ref": "#/components/schemas/PersonaPhoneConfigFields" }, "type": "array" } }, "type": "object" }, - "Schedule": { + "LeadListProcessingRequest": { "properties": { - "dayOfTheMonth": { - "format": "int32", - "type": "integer" + "description": { + "type": "string" + }, + "dialPriority": { + "enum": [ + "IMMEDIATE", + "NORMAL" + ], + "type": "string" }, - "daysOfWeek": { + "dncTags": { "items": { - "enum": [ - "SUNDAY", - "MONDAY", - "TUESDAY", - "WEDNESDAY", - "THURSDAY", - "FRIDAY", - "SATURDAY" - ], "type": "string" }, "type": "array" }, - "endDate": { - "$ref": "#/components/schemas/DateTime" + "duplicateHandling": { + "enum": [ + "RETAIN_ALL", + "REMOVE_ALL_EXISTING", + "REMOVE_FROM_LIST" + ], + "type": "string" }, - "endTime": { - "$ref": "#/components/schemas/LocalTime" + "extendedLeadDataMappings": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "type": "object" }, - "interval": { - "format": "int32", - "type": "integer" + "fileContainsHeaders": { + "type": "boolean" }, - "month": { + "fileType": { "enum": [ - "JANUARY", - "FEBRUARY", - "MARCH", - "APRIL", - "MAY", - "JUNE", - "JULY", - "AUGUST", - "SEPTEMBER", - "OCTOBER", - "NOVEMBER", - "DECEMBER" + "EXCEL", + "PIPE", + "COMMA", + "TAB" ], "type": "string" }, - "repeatOption": { + "listState": { "enum": [ - "SINGLE", - "MINUTE", - "HOURLY", - "DAILY", - "WEEKLY", - "MONTHLY", - "CALENDAR", - "YEARLY" + "ACTIVE", + "PAUSED", + "PENDING_DNC", + "LOADING", + "DELETED", + "READY", + "CALLBACKS", + "CALLBACKS_AGENT", + "DUPLICATES_NOT_MERGED", + "DUPLICATES_NOT_MOVED", + "ARCHIVED" ], "type": "string" }, - "scheduleTimezoneName": { - "type": "string" - }, - "startDate": { - "$ref": "#/components/schemas/DateTime" - }, - "startTime": { - "$ref": "#/components/schemas/LocalTime" + "pageColumnMappings": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "type": "object" }, - "versionNum": { + "pageNumber": { "format": "int32", "type": "integer" - } - }, - "type": "object" - }, - "SchedulerStateResponse": { - "properties": { - "currentState": { - "enum": [ - "RUN", - "PAUSE" - ], - "type": "string" }, - "message": { + "quoteChar": { "type": "string" - } - }, - "type": "object" - }, - "Script": { - "properties": { - "account": { - "$ref": "#/components/schemas/Account" - }, - "created": { - "$ref": "#/components/schemas/DateTime" }, - "description": { + "timeZoneOption": { + "enum": [ + "NPA_NXX", + "ZIPCODE", + "EXPLICIT", + "COUNTRY", + "NOT_APPLICABLE" + ], "type": "string" }, - "groupId": { - "format": "int32", - "type": "integer" - }, - "isActive": { - "type": "boolean" - }, - "name": { + "transactionId": { "type": "string" }, - "permissions": { + "uploadLeads": { "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" + "$ref": "#/components/schemas/CampaignLead" }, "type": "array" }, - "scriptGroup": { - "$ref": "#/components/schemas/ScriptGroup" - }, - "scriptId": { - "format": "int32", - "type": "integer" + "additionalPhoneMappings": { + "additionalProperties": { + "format": "int32", + "type": "integer" + }, + "description": "Maps persona phone IDs to the source column indexes used by leadLoader/process. JSON object keys are persona phone IDs, and values are column indexes from the uploaded file preview.", + "type": "object" }, - "updated": { - "$ref": "#/components/schemas/DateTime" - } - }, - "type": "object" - }, - "ScriptConfig": { - "properties": { - "account": { - "$ref": "#/components/schemas/Account" + "phoneNumbersI18nEnabled": { + "type": "boolean" }, - "description": { - "type": "string" + "internationalNumberFormat": { + "type": "boolean" }, - "name": { + "numberOriginCountry": { "type": "string" }, - "scriptId": { - "format": "int32", - "type": "integer" - }, - "scriptJson": { + "scheduleArchiveDts": { + "format": "date-time", "type": "string" - }, - "updated": { - "$ref": "#/components/schemas/DateTime" } }, "type": "object" }, - "ScriptGroup": { + "LeadListProcessingResult": { "properties": { - "account": { - "$ref": "#/components/schemas/Account" - }, - "groupId": { + "deletedCount": { "format": "int32", "type": "integer" }, - "name": { - "type": "string" + "dncReturnedCount": { + "format": "int32", + "type": "integer" }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" + "dncUploadCount": { + "format": "int32", + "type": "integer" }, - "scripts": { - "items": { - "$ref": "#/components/schemas/Script" - }, - "type": "array" - } - }, - "type": "object" - }, - "SecurityStrategyModel": { - "properties": { - "accountId": { - "type": "string" + "failedAgentAssignment": { + "description": "Number of accepted leads whose reserveAgent value could not be assigned because the agent ID was invalid or the agent does not have access to the account.", + "format": "int32", + "type": "integer" }, - "fullPermission": { + "hasDeletedLeads": { "type": "boolean" }, - "productIds": { - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" + "internalDncCount": { + "format": "int32", + "type": "integer" }, - "redshiftProduct": { - "enum": [ - "ACCOUNT", - "AGENT", - "AGENT_DISPOSITION", - "AGENT_EXTERNAL_ID", - "AGENT_GROUP_ID", - "AGENT_TEAM", - "ANI", - "CALL_ID", - "CAMPAIGN", - "CHAT_QUEUE", - "CHAT_QUEUE_GROUP", - "CLOUD_DESTINATION", - "CLOUD_DESTINATION_GROUP_ID", - "CLOUD_PROFILE", - "CLOUD_PROFILE_GROUP_ID", - "DIAL_GROUP", - "DIAL_TYPE", - "DNC_TAG", - "DNIS", - "GATE", - "GATE_GROUP", - "INCLUDE_DIAL_GROUP", - "INCLUDE_MEDIA", - "INTERNAL_CHAT", - "LIST_STATE", - "LEAD_LIST", - "OPT_OUT", - "OUTBOUND_DISPOSITION", - "ROLLUP_AGENT", - "SCRIPTING", - "SCRIPT_GROUP_ID", - "STARTS_WITH_NPA_EXCLUDE", - "STARTS_WITH_NPA_INCLUDE", - "SURVEY", - "TRACK_GROUP_ID", - "TRACK_NUMBER", - "USERNAME", - "VISUAL_IVR", - "VISUAL_IVR_GROUP_ID", - "WHITELIST_TAG" - ], - "type": "string" - } - }, - "type": "object" - }, - "SecurityStrategyView": { - "properties": { - "accountIds": { - "items": { - "type": "string" - }, - "type": "array" + "leadsAccepted": { + "format": "int32", + "type": "integer" }, - "fullPermission": { - "type": "boolean" + "leadsConverted": { + "format": "int32", + "type": "integer" }, - "redshiftProducts": { - "items": { - "enum": [ - "ACCOUNT", - "AGENT", - "AGENT_DISPOSITION", - "AGENT_EXTERNAL_ID", - "AGENT_GROUP_ID", - "AGENT_TEAM", - "ANI", - "CALL_ID", - "CAMPAIGN", - "CHAT_QUEUE", - "CHAT_QUEUE_GROUP", - "CLOUD_DESTINATION", - "CLOUD_DESTINATION_GROUP_ID", - "CLOUD_PROFILE", - "CLOUD_PROFILE_GROUP_ID", - "DIAL_GROUP", - "DIAL_TYPE", - "DNC_TAG", - "DNIS", - "GATE", - "GATE_GROUP", - "INCLUDE_DIAL_GROUP", - "INCLUDE_MEDIA", - "INTERNAL_CHAT", - "LIST_STATE", - "LEAD_LIST", - "OPT_OUT", - "OUTBOUND_DISPOSITION", - "ROLLUP_AGENT", - "SCRIPTING", - "SCRIPT_GROUP_ID", - "STARTS_WITH_NPA_EXCLUDE", - "STARTS_WITH_NPA_INCLUDE", - "SURVEY", - "TRACK_GROUP_ID", - "TRACK_NUMBER", - "USERNAME", - "VISUAL_IVR", - "VISUAL_IVR_GROUP_ID", - "WHITELIST_TAG" - ], - "type": "string" - }, - "type": "array" - } - }, - "required": [ - "accountIds", - "fullPermission", - "redshiftProducts" - ], - "type": "object" - }, - "SimplePostgresChild": { - "properties": { - "accountId": { + "leadsInserted": { "format": "int32", "type": "integer" }, - "groupId": { + "leadsSupplied": { "format": "int32", "type": "integer" }, - "groupName": { + "listState": { + "enum": [ + "ACTIVE", + "PAUSED", + "PENDING_DNC", + "LOADING", + "DELETED", + "READY", + "CALLBACKS", + "CALLBACKS_AGENT", + "DUPLICATES_NOT_MERGED", + "DUPLICATES_NOT_MOVED" + ], "type": "string" }, - "objId": { - "format": "int32", - "type": "integer" + "message": { + "type": "string" }, - "objectName": { + "processingResult": { "type": "string" }, - "objectTimestamp": { + "processingStatus": { + "enum": [ + "NO_LEADS_PASSED_VALIDATION", + "DNC_ACCOUNT_SETTINGS", + "DNC_UPLOAD_FAILED", + "DEFAULT_NOT_A_FAILURE", + "DNC_GREATER_ONE_DAY", + "GENERAL_FAILURE" + ], "type": "string" - } - }, - "type": "object" - }, - "SimplePostgresParent": { - "properties": { - "accountId": { + }, + "quotaCount": { "format": "int32", "type": "integer" }, - "children": { - "items": { - "$ref": "#/components/schemas/SimplePostgresChild" - }, - "type": "array" - }, - "filters": { + "rejectedRows": { "items": { - "type": "string" + "$ref": "#/components/schemas/RejectedRow" }, "type": "array" }, - "groupId": { - "format": "int32", - "type": "integer" + "timeZoneOption": { + "enum": [ + "NPA_NXX", + "ZIPCODE", + "EXPLICIT", + "NOT_APPLICABLE" + ], + "type": "string" }, - "groupName": { + "uploadFileName": { "type": "string" }, - "objectTimestamp": { - "format": "int64", + "whitelistCount": { + "format": "int32", "type": "integer" + } + }, + "type": "object" + }, + "LeadManagerRequest": { + "properties": { + "campaignLeadSearchCriteria": { + "$ref": "#/components/schemas/CampaignLeadSearchCriteria" }, - "product": { - "type": "string" + "leadActionParams": { + "$ref": "#/components/schemas/LeadActionParams" } }, "type": "object" }, - "SipFlags": { + "MainAccount": { "properties": { - "dcspVoice": { + "dataRetentionDays": { "format": "int32", "type": "integer" }, - "dscpEnabled": { + "enableAmdProfiles": { "type": "boolean" }, - "dscpSignaling": { - "format": "int32", - "type": "integer" + "enableConsultCall": { + "type": "boolean" + }, + "enablePhoneNumbersI18n": { + "type": "boolean" + }, + "engageAccountId": { + "type": "string" }, - "dscpVideo": { + "isActive": { "format": "int32", "type": "integer" }, - "outboundCallsEnabled": { - "type": "boolean" + "mainAccountId": { + "type": "string" }, - "voipCountryBlocked": { - "type": "boolean" + "mainAccountName": { + "type": "string" }, - "voipFeatureEnabled": { - "type": "boolean" + "rcAccountId": { + "type": "string" } }, "type": "object" }, - "SipInfo": { + "MediaCodeValuesOnDnisPool": { "properties": { - "authorizationId": { + "category": { "type": "string" }, - "domain": { + "code": { "type": "string" }, - "outboundProxy": { + "duration": { "type": "string" }, - "password": { + "format": { "type": "string" }, - "transport": { + "isci": { "type": "string" }, - "username": { - "type": "string" - } - }, - "type": "object" - }, - "State": { - "properties": { - "description": { + "market": { "type": "string" }, - "state": { + "network": { "type": "string" - } - }, - "type": "object" - }, - "StateProvince": { - "properties": { - "code": { + }, + "sourceCode": { "type": "string" }, - "searchString": { + "url": { "type": "string" - } - }, - "type": "object" - }, - "SuppressedType": { - "properties": { - "name": { + }, + "version": { "type": "string" } }, "type": "object" }, - "Survey": { + "PhoneBookEntry": { "properties": { "accountId": { "type": "string" }, - "active": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" - }, - "enableTokens": { - "format": "int32", - "type": "integer" - }, - "exportFlag": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" - }, - "headingCss": { + "countryId": { "type": "string" }, - "lastModified": { - "$ref": "#/components/schemas/Timestamp" - }, - "name": { + "dateCreated": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "submitText": { + "destName": { "type": "string" }, - "surveyDesc": { + "destination": { "type": "string" }, - "surveyId": { + "entryId": { "format": "int32", "type": "integer" }, - "surveyName": { + "notes": { "type": "string" }, - "tableCss": { + "type": { + "enum": [ + "GATE", + "GLOBAL", + "CAMPAIGN" + ], "type": "string" }, - "textCss": { - "type": "string" + "typeId": { + "format": "int32", + "type": "integer" } }, "type": "object" }, - "SurveyGroup": { + "PrerouteCheckStatus": { "properties": { - "groupName": { - "type": "string" - }, - "isDefault": { - "format": "byte", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", - "type": "string" - }, - "name": { + "reason": { "type": "string" }, - "surveyGroupId": { - "format": "int32", - "type": "integer" - }, - "surveys": { - "$ref": "#/components/schemas/CollectionSurvey" + "status": { + "type": "boolean" } }, "type": "object" }, - "TelephonyServerGroup": { + "ProductPermission": { "properties": { - "active": { + "cascade": { "type": "boolean" }, - "currentConnections": { - "format": "int32", - "type": "integer" - }, - "groupId": { - "format": "int32", - "type": "integer" - }, - "groupName": { - "type": "string" + "permissions": { + "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" + }, + "type": "array" }, - "groupVendor": { + "product": { + "enum": [ + "ACCOUNT", + "ACD", + "AGENT", + "CHAT_QUEUE", + "OUTBOUND", + "VISUAL_IVR", + "CLOUD_PROFILE", + "CLOUD_DESTINATION", + "TRAC_NUMBER", + "HTTP_SERVICES", + "SCRIPTING", + "TN_MANAGER", + "SURVEY", + "DNIS", + "TEAMS", + "KNOWLEDGE_BASE", + "UTILITIES" + ], "type": "string" - }, - "isActive": { - "type": "boolean" - }, - "maxAgents": { - "format": "int32", - "type": "integer" } }, "type": "object" }, - "TimeRange": { + "QuotaGroup": { "properties": { - "rangeType": { - "enum": [ - "MINUTE", - "HOUR", - "DAY", - "WEEK", - "MONTH", - "YEAR", - "NOW" - ], - "type": "string" + "active": { + "type": "boolean" }, - "rangeValue": { + "campaigns": { + "$ref": "#/components/schemas/CollectionCampaign" + }, + "isActive": { + "type": "boolean" + }, + "quotaGroupId": { "format": "int32", "type": "integer" }, - "rangeValueValid": { - "type": "boolean" + "quotaGroupName": { + "type": "string" + }, + "quotaTargets": { + "$ref": "#/components/schemas/CollectionQuotaTarget" } }, "type": "object" }, - "Timestamp": { + "RTASubscriptionRequest": { + "required": [ + "subscriptionName", + "notificationUrl" + ], "properties": { - "date": { - "format": "int32", - "type": "integer" + "subscriptionName": { + "description": "Subscription name.", + "type": "string" }, - "day": { - "format": "int32", - "type": "integer" + "description": { + "description": "Human-readable description.", + "type": "string" }, - "hours": { + "retryCount": { + "description": "Maximum delivery retry count. Maximum allowed value is 10. Default is 3.", "format": "int32", "type": "integer" }, - "minutes": { - "format": "int32", - "type": "integer" + "notificationUrl": { + "description": "Publicly accessible endpoint that receives agent-state notifications. The URL must be reachable by RingCentral, must not be blocked by a firewall, and HTTPS receivers must support TLS 1.2 or higher. During endpoint validation, the receiver must return 200 OK within 3000 milliseconds, echo the validation request's Validation-Token header value in the response Validation-Token header, and keep the complete response, including headers and body, no larger than 1024 bytes. Responses larger than this can fail setup with {\"errorCode\":\"SUB-525\",\"message\":\"WebHook server response is invalid\"}.", + "type": "string" }, - "month": { - "format": "int32", - "type": "integer" + "authConfigId": { + "description": "Auth configuration ID used when RingCX sends notification requests to the receiver.", + "format": "uuid", + "type": "string" }, - "nanos": { - "format": "int32", - "type": "integer" + "active": { + "description": "Whether the subscription is active.", + "type": "boolean" }, - "seconds": { - "format": "int32", - "type": "integer" + "customHeaders": { + "additionalProperties": { + "type": "object" + }, + "description": "Additional headers to send with notification requests.", + "type": "object" }, - "time": { + "expiresAt": { + "description": "Expiration time as epoch seconds. Use 0 for no configured expiration.", "format": "int64", "type": "integer" - }, - "timezoneOffset": { - "format": "int32", - "type": "integer" - }, - "year": { - "format": "int32", - "type": "integer" } }, "type": "object" }, - "Timezone": { + "RTASubscriptionResponse": { "properties": { - "description": { + "subscriptionId": { + "format": "uuid", "type": "string" }, - "name": { - "type": "string" - } - }, - "type": "object" - }, - "TnManagerSearchCriteria": { - "properties": { - "accountId": { + "mainAccountId": { "type": "string" }, - "accountIds": { - "items": { - "type": "string" - }, - "type": "array" - }, - "active": { - "type": "boolean" - }, - "assigned": { - "type": "boolean" - }, - "assignedSms": { - "type": "boolean" - }, - "criteriaType": { - "enum": [ - "DIALER_RESULT_DOWNLOAD_CRITERIA", - "GLOBAL_CALL_TYPE_CRITERIA", - "IVR_DETAIL_CRITERIA", - "TFN_DID_MANAGER_CRITERIA", - "ALL_CALLS_CRITERIA", - "CASPER_CRITERIA" - ], + "subAccountId": { "type": "string" }, - "customAppString": { + "subscriptionName": { "type": "string" }, - "databaseTimezone": { + "description": { "type": "string" }, - "dnis": { - "items": { - "type": "string" - }, - "type": "array" - }, - "dnisFilter": { + "notificationUrl": { "type": "string" }, - "endDate": { - "$ref": "#/components/schemas/DateTime" + "authConfigId": { + "format": "uuid", + "type": "string" }, - "endDateRange": { - "$ref": "#/components/schemas/TimeRange" + "active": { + "type": "boolean" }, - "groupId": { + "maxRetryCount": { "format": "int32", "type": "integer" }, - "inboundContext": { + "customHeaders": { + "additionalProperties": { + "type": "object" + }, + "type": "object" + }, + "expiresAt": { + "format": "int64", + "type": "integer" + }, + "createdBy": { "type": "string" }, - "notes": { + "createdAt": { + "format": "date-time", "type": "string" }, - "objectId": { - "format": "int32", - "type": "integer" + "updatedBy": { + "type": "string" }, - "phoneNumbersI18nEnabled": { - "type": "boolean" + "updatedAt": { + "format": "date-time", + "type": "string" }, - "product": { - "enum": [ - "ACCOUNT", - "ACD", - "AGENT", - "CHAT_QUEUE", - "OUTBOUND", - "VISUAL_IVR", - "CLOUD_PROFILE", - "CLOUD_DESTINATION", - "TRAC_NUMBER", - "HTTP_SERVICES", - "SCRIPTING", - "TN_MANAGER", - "SURVEY", - "DNIS", - "TEAMS", - "KNOWLEDGE_BASE", - "UTILITIES" - ], + "authConfig": { + "$ref": "#/components/schemas/AuthConfig" + } + }, + "type": "object" + }, + "RegionalSettingRequestResponse": { + "properties": { + "formattingLocale": { "type": "string" }, - "scheduleTimezoneName": { + "greetingLanguage": { "type": "string" }, - "startDate": { - "$ref": "#/components/schemas/DateTime" + "homeCountry": { + "format": "int32", + "type": "integer" }, - "startDateRange": { - "$ref": "#/components/schemas/TimeRange" + "homeCountryCode": { + "type": "string" }, - "timezoneName": { + "language": { "type": "string" }, - "vendorId": { + "timeFormat": { "type": "string" }, - "vruNetworkId": { + "timezone": { "format": "int32", "type": "integer" } }, "type": "object" }, - "TracGroup": { + "RejectedRow": { "properties": { - "groupName": { + "message": { "type": "string" }, - "isDefault": { - "type": "boolean" - }, - "permissions": { + "rowData": { "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], "type": "string" }, "type": "array" - }, - "tracGroupId": { - "format": "int32", - "type": "integer" - }, - "tracNumbers": { - "items": { - "$ref": "#/components/schemas/TracNumber" - }, - "type": "array" } }, "type": "object" }, - "TracLocation": { + "RemoteHttpService": { "properties": { - "account": { - "$ref": "#/components/schemas/Account" - }, "accountId": { "type": "string" }, - "address": { - "type": "string" - }, - "city": { - "type": "string" + "enableMappings": { + "type": "boolean" }, - "description": { + "httpPassword": { "type": "string" }, - "destination": { + "httpServiceConfig": { "type": "string" }, - "isDefault": { - "type": "boolean" + "httpServiceGroup": { + "$ref": "#/components/schemas/RemoteHttpServiceGroup" }, - "lat": { - "format": "double", - "type": "number" + "httpServiceInputs": { + "$ref": "#/components/schemas/CollectionRemoteHttpServiceInput" }, - "locationId": { - "format": "int32", - "type": "integer" + "httpUsername": { + "type": "string" }, - "locator": { - "$ref": "#/components/schemas/TracLocator" + "isDebug": { + "type": "boolean" }, - "lon": { - "format": "double", - "type": "number" + "isEnabled": { + "type": "boolean" }, "permissions": { "items": { @@ -12987,34 +6451,56 @@ }, "type": "array" }, - "ringDuration": { + "returntype": { + "type": "string" + }, + "sendAllSurveyData": { + "type": "boolean" + }, + "serviceDescription": { + "type": "string" + }, + "serviceId": { "format": "int32", "type": "integer" }, - "state": { + "serviceType": { + "enum": [ + "SOAP", + "HTTP_POST", + "HTTP_GET", + "HTTP" + ], "type": "string" }, - "ttAccept": { - "type": "boolean" + "soapAction": { + "type": "string" }, - "zip": { + "soapEndpoint": { + "type": "string" + }, + "soapOperationname": { + "type": "string" + }, + "soapPortname": { + "type": "string" + }, + "soapServicename": { + "type": "string" + }, + "targetNamespace": { "type": "string" } }, "type": "object" }, - "TracLocator": { + "RemoteHttpServiceGroup": { "properties": { - "description": { + "groupName": { "type": "string" }, - "locatorId": { - "format": "int32", - "type": "integer" - }, - "maxDistance": { - "format": "int32", - "type": "integer" + "isDefault": { + "type": "boolean" }, "permissions": { "items": { @@ -13029,71 +6515,121 @@ }, "type": "array" }, - "tracLocation": { - "$ref": "#/components/schemas/CollectionTracLocation" + "serviceGroupId": { + "format": "int32", + "type": "integer" + }, + "services": { + "$ref": "#/components/schemas/CollectionRemoteHttpService" } }, "type": "object" }, - "TracNumber": { + "RemoteHttpServiceInput": { "properties": { - "accountId": { + "inputId": { + "format": "int32", + "type": "integer" + }, + "name": { "type": "string" }, - "assignedDnis": { - "$ref": "#/components/schemas/AssignedDnis" + "rank": { + "format": "byte", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", + "type": "string" }, - "billingCode": { + "simpleDataType": { "type": "string" }, - "billingKey": { + "type": { "type": "string" }, - "closeLocatorId": { - "format": "int32", - "type": "integer" + "value": { + "type": "string" + } + }, + "type": "object" + }, + "ReportCriteria": { + "properties": { + "accountId": { + "type": "string" }, - "closeType": { + "criteriaType": { "enum": [ - "STANDARD", - "STANDARD_PARALLEL", - "LOCATOR" + "DIALER_RESULT_DOWNLOAD_CRITERIA", + "GLOBAL_CALL_TYPE_CRITERIA", + "IVR_DETAIL_CRITERIA", + "TFN_DID_MANAGER_CRITERIA", + "ALL_CALLS_CRITERIA", + "CASPER_CRITERIA" ], "type": "string" }, - "dequeueDelay": { - "format": "int32", - "type": "integer" + "databaseTimezone": { + "type": "string" }, - "description": { + "endDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "endcallMsg": { + "endDateRange": { + "$ref": "#/components/schemas/TimeRange" + }, + "scheduleTimezoneName": { "type": "string" }, - "friSched": { + "startDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "introMsg": { + "startDateRange": { + "$ref": "#/components/schemas/TimeRange" + }, + "timezoneName": { "type": "string" + } + }, + "type": "object" + }, + "RequeueShortcut": { + "properties": { + "campaign": { + "$ref": "#/components/schemas/Campaign" }, - "monSched": { + "gate": { + "$ref": "#/components/schemas/Gate" + }, + "groupSkill": { + "$ref": "#/components/schemas/GateGroupSkill" + }, + "name": { "type": "string" }, - "openLocatorId": { + "rank": { "format": "int32", "type": "integer" }, - "openType": { - "enum": [ - "STANDARD", - "STANDARD_PARALLEL", - "LOCATOR" - ], - "type": "string" + "requeueGate": { + "$ref": "#/components/schemas/Gate" }, - "outboundCallerId": { - "type": "string" + "requeueGateGroup": { + "$ref": "#/components/schemas/GateGroup" + }, + "requeueShortcutId": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "ResourcePermission": { + "properties": { + "cascade": { + "type": "boolean" }, "permissions": { "items": { @@ -13108,513 +6644,597 @@ }, "type": "array" }, - "postCallSoapService": { - "$ref": "#/components/schemas/RemoteHttpService" - }, - "recordCall": { + "resourceId": { "format": "int32", "type": "integer" }, - "revMatch": { - "format": "int32", - "type": "integer" + "resourceType": { + "enum": [ + "ACCOUNT", + "GATE_GROUP", + "GATE", + "AGENT", + "AGENT_GROUP", + "OUTBOUND_DIAL_GROUP", + "OUTBOUND_CAMPAIGN", + "VISUAL_IVR", + "VISUAL_IVR_GROUP", + "TRAC_NUMBER", + "TRAC_GROUP", + "CLOUD_PROFILE", + "CLOUD_DESTINATION", + "CLOUD_PROFILE_GROUP", + "CLOUD_GROUP", + "CLOUD_DESTINATION_GROUP", + "HTTP_SERVICE", + "HTTP_SERVICE_GROUP", + "SCRIPT", + "SCRIPT_GROUP", + "TN_MANAGER", + "UTILITIES", + "CHAT_QUEUE", + "CHAT_GROUP", + "KNOWLEDGEBASE_GROUP", + "KNOWLEDGEBASE_CATEGORY" + ], + "type": "string" + } + }, + "type": "object" + }, + "ResultFileDestination": { + "properties": { + "aggregateOutput": { + "format": "byte", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", + "type": "string" }, - "satSched": { + "destType": { "type": "string" }, - "shortCallTime": { + "destinationId": { "format": "int32", "type": "integer" }, - "sunSched": { + "destinationName": { "type": "string" }, - "surveyId": { - "format": "int32", - "type": "integer" + "emailDest": { + "type": "string" }, - "thuSched": { + "ftpDir": { "type": "string" }, - "tracGroup": { - "$ref": "#/components/schemas/TracGroup" + "ftpPwd": { + "type": "string" }, - "tracId": { - "format": "int32", - "type": "integer" + "ftpServer": { + "type": "string" + }, + "ftpUid": { + "type": "string" + }, + "passive": { + "format": "byte", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", + "type": "string" + }, + "sendEmptyFiles": { + "format": "byte", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", + "type": "string" + }, + "sftp": { + "format": "byte", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", + "type": "string" + } + }, + "type": "object" + }, + "RightsDocTable": { + "properties": { + "accountId": { + "type": "string" }, - "tueSched": { + "creationDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "voicemailEnabled": { - "format": "int32", - "type": "integer" + "isMaster": { + "type": "boolean" }, - "wedSched": { + "owner": { + "$ref": "#/components/schemas/User" + }, + "rightsDocJson": { "type": "string" }, - "whisperMsg": { + "rightsDocName": { "type": "string" } }, "type": "object" }, - "TracNumberSkinny": { + "RightsDocument": { "properties": { "accountId": { "type": "string" }, - "description": { - "type": "string" + "accountPermissions": { + "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" + }, + "type": "array" }, - "groupId": { - "format": "int32", - "type": "integer" + "assigned": { + "type": "boolean" }, - "tracGroupId": { + "cascade": { + "type": "boolean" + }, + "isMaster": { + "type": "boolean" + }, + "ownerId": { "format": "int32", "type": "integer" }, - "tracId": { + "productPermissions": { + "items": { + "$ref": "#/components/schemas/ProductPermission" + }, + "type": "array" + }, + "resourcePermissions": { + "items": { + "$ref": "#/components/schemas/ResourcePermission" + }, + "type": "array" + }, + "rightsDocId": { "format": "int32", "type": "integer" + }, + "rightsDocName": { + "type": "string" } }, "type": "object" }, - "TracRoutingRule": { + "Script": { "properties": { - "description": { - "type": "string" + "account": { + "$ref": "#/components/schemas/Account" }, - "destination": { + "created": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "openRule": { - "type": "boolean" - }, - "parallelDelay": { - "format": "int32", - "type": "integer" - }, - "rank": { - "format": "int32", - "type": "integer" + "description": { + "type": "string" }, - "ringDuration": { + "groupId": { "format": "int32", "type": "integer" }, - "ruleId": { - "format": "int32", - "type": "integer" + "isActive": { + "type": "boolean" }, - "ruleType": { - "enum": [ - "STANDARD", - "STANDARD_SIP", - "ENCRYPTED_SIP", - "GATE_XFER", - "TRAC_XFER", - "IN_NETWORK", - "VIVR" - ], + "name": { "type": "string" }, - "tracNumber": { - "$ref": "#/components/schemas/TracNumber" + "permissions": { + "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" + }, + "type": "array" }, - "ttAccept": { - "type": "boolean" + "scriptGroup": { + "$ref": "#/components/schemas/ScriptGroup" }, - "xferGateId": { + "scriptId": { "format": "int32", "type": "integer" }, - "xferTracId": { - "format": "int32", - "type": "integer" + "updated": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" } }, "type": "object" }, - "TracScheduleOverride": { + "ScriptGroup": { "properties": { - "overrideClosedEvent": { - "type": "string" + "account": { + "$ref": "#/components/schemas/Account" }, - "overrideDate": { - "$ref": "#/components/schemas/DateTime" + "groupId": { + "format": "int32", + "type": "integer" }, - "overrideLabel": { + "name": { "type": "string" }, - "overrideSched": { - "type": "string" + "permissions": { + "items": { + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" + }, + "type": "array" }, - "scheduleOverrideId": { - "format": "int32", - "type": "integer" + "scripts": { + "items": { + "$ref": "#/components/schemas/Script" + }, + "type": "array" } }, "type": "object" }, - "UniqueAgentResponse": { + "Survey": { "properties": { - "agentId": { + "accountId": { + "type": "string" + }, + "active": { + "format": "byte", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", + "type": "string" + }, + "enableTokens": { "format": "int32", "type": "integer" }, - "ani": { + "exportFlag": { + "format": "byte", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type": "string" }, - "dnis": { + "headingCss": { "type": "string" }, - "dnisE164": { - "type": "string" + "lastModified": { + "$ref": "#/components/schemas/Timestamp" }, - "firstName": { + "name": { "type": "string" }, - "lastName": { + "submitText": { "type": "string" }, - "uii": { + "surveyDesc": { "type": "string" }, - "username": { - "type": "string" - } - }, - "type": "object" - }, - "UpdateAgentLoginDialGroupResponse": { - "properties": { - "agentId": { + "surveyId": { "format": "int32", "type": "integer" }, - "agentName": { + "surveyName": { "type": "string" }, - "message": { + "tableCss": { "type": "string" }, - "success": { - "type": "boolean" - } - }, - "type": "object" - }, - "UpdatePhoneNumbersI18nRequest": { - "properties": { - "enablePhoneNumbersI18n": { - "type": "boolean" + "textCss": { + "type": "string" } }, "type": "object" }, - "UploadLeadsRequest": { + "TimeRange": { "properties": { - "description": { - "type": "string" - }, - "dialPriority": { - "description": "Setting this to `IMMEDIATE` allows you to insert a lead to the top of the dialer cache for immediate dialing if you want a normal insert then do not add this parameter.", - "enum": [ - "IMMEDIATE", - "NORMAL" - ], - "type": "string" - }, - "duplicateHandling": { - "enum": [ - "RETAIN_ALL", - "REMOVE_ALL_EXISTING", - "REMOVE_FROM_LIST" - ], - "type": "string" - }, - "listState": { + "rangeType": { "enum": [ - "ACTIVE" + "MINUTE", + "HOUR", + "DAY", + "WEEK", + "MONTH", + "YEAR", + "NOW" ], "type": "string" }, - "timeZoneOption": { - "enum": [ - "NPA_NXX", - "ZIPCODE", - "EXPLICIT" - ], - "type": "string" + "rangeValue": { + "format": "int32", + "type": "integer" }, - "uploadLeads": { - "items": { - "$ref": "#/components/schemas/CampaignLead" - }, - "type": "array" + "rangeValueValid": { + "type": "boolean" } }, "type": "object" }, - "UploadLeadsResponse": { + "Timestamp": { "properties": { - "deletedCount": { + "date": { "format": "int32", "type": "integer" }, - "dncReturnedCount": { + "day": { "format": "int32", "type": "integer" }, - "dncUploadCount": { + "hours": { "format": "int32", "type": "integer" }, - "hasDeletedLeads": { - "type": "boolean" - }, - "internalDncCount": { + "minutes": { "format": "int32", "type": "integer" }, - "leadsAccepted": { + "month": { "format": "int32", "type": "integer" }, - "leadsConverted": { + "nanos": { "format": "int32", "type": "integer" }, - "leadsInserted": { + "seconds": { "format": "int32", "type": "integer" }, - "leadsSupplied": { - "format": "int32", + "time": { + "format": "int64", "type": "integer" }, - "listState": { - "type": "string" - }, - "message": { - "description": "Values can be `Your uploaded lead list has successfully completed processing` or `Your uploaded lead list file processing has failed`", - "type": "string" - }, - "processingResult": { - "description": "Values can be `OK` or `Failed`", - "type": "string" - }, - "processingStatus": { - "description": "Values can be `DEFAULT_NOT_A_FAILURE` or `GENERAL_FAILURE`", - "type": "string" - }, - "quotaCount": { + "timezoneOffset": { "format": "int32", "type": "integer" }, - "timeZoneOption": { + "year": { + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Timezone": { + "properties": { + "description": { "type": "string" }, - "uploadFileName": { + "name": { "type": "string" - }, - "whitelistCount": { - "format": "int32", - "type": "integer" } }, - "required": [ - "message", - "leadsSupplied", - "leadsConverted", - "leadsAccepted", - "leadsInserted", - "internalDncCount", - "dncUploadCount", - "dncReturnedCount", - "whitelistCount", - "uploadFileName", - "deletedCount", - "quotaCount", - "listState", - "timeZoneOption", - "hasDeletedLeads", - "processingResult", - "processingStatus" - ], "type": "object" }, - "User": { + "TnManagerSearchCriteria": { "properties": { - "children": { + "accountId": { + "type": "string" + }, + "accountIds": { "items": { - "$ref": "#/components/schemas/User" + "type": "string" }, "type": "array" }, - "creationDate": { - "$ref": "#/components/schemas/DateTime" + "active": { + "type": "boolean" }, - "enabled": { + "assigned": { "type": "boolean" }, - "firstName": { + "assignedSms": { + "type": "boolean" + }, + "criteriaType": { + "enum": [ + "DIALER_RESULT_DOWNLOAD_CRITERIA", + "GLOBAL_CALL_TYPE_CRITERIA", + "IVR_DETAIL_CRITERIA", + "TFN_DID_MANAGER_CRITERIA", + "ALL_CALLS_CRITERIA", + "CASPER_CRITERIA" + ], "type": "string" }, - "fullName": { + "customAppString": { "type": "string" }, - "lastName": { + "databaseTimezone": { "type": "string" }, - "parentPath": { + "dnis": { + "items": { + "type": "string" + }, + "type": "array" + }, + "dnisFilter": { "type": "string" }, - "phoneNumber": { + "endDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" }, - "phoneNumberE164": { + "endDateRange": { + "$ref": "#/components/schemas/TimeRange" + }, + "groupId": { + "format": "int32", + "type": "integer" + }, + "inboundContext": { + "type": "string" + }, + "notes": { "type": "string" }, + "objectId": { + "format": "int32", + "type": "integer" + }, "phoneNumbersI18nEnabled": { "type": "boolean" }, - "rcAccountId": { + "product": { + "enum": [ + "ACCOUNT", + "ACD", + "AGENT", + "CHAT_QUEUE", + "OUTBOUND", + "VISUAL_IVR", + "CLOUD_PROFILE", + "CLOUD_DESTINATION", + "TRAC_NUMBER", + "HTTP_SERVICES", + "SCRIPTING", + "TN_MANAGER", + "SURVEY", + "DNIS", + "TEAMS", + "KNOWLEDGE_BASE", + "UTILITIES" + ], "type": "string" }, - "rcUserId": { - "format": "int64", - "type": "integer" + "scheduleTimezoneName": { + "type": "string" }, - "regionalSettings": { - "$ref": "#/components/schemas/RegionalSettingRequestResponse" + "startDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" }, - "roles": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Role" - } + "startDateRange": { + "$ref": "#/components/schemas/TimeRange" }, - "rootUser": { - "type": "boolean" + "timezoneName": { + "type": "string" }, - "userId": { + "vendorId": { + "type": "string" + }, + "vruNetworkId": { "format": "int32", "type": "integer" - }, - "userManagedByRC": { - "type": "boolean" - }, - "userName": { - "type": "string" } }, "type": "object" }, - "UserDetailsResult": { + "TracGroup": { "properties": { - "adminId": { - "format": "int32", - "type": "integer" + "groupName": { + "type": "string" }, - "agentDetails": { + "isDefault": { + "type": "boolean" + }, + "permissions": { "items": { - "$ref": "#/components/schemas/AgentDetailsResult" + "enum": [ + "CREATE", + "READ", + "UPDATE", + "DELETE", + "REPORT" + ], + "type": "string" }, "type": "array" }, - "flr": { - "type": "boolean" + "tracGroupId": { + "format": "int32", + "type": "integer" }, - "iqUrl": { + "tracNumbers": { + "items": { + "$ref": "#/components/schemas/TracNumber" + }, + "type": "array" + } + }, + "type": "object" + }, + "TracNumber": { + "properties": { + "accountId": { "type": "string" }, - "loginHashcode": { - "type": "string" + "assignedDnis": { + "$ref": "#/components/schemas/AssignedDnis" }, - "mainAccountId": { + "billingCode": { "type": "string" }, - "managedMainAccountIds": { - "items": { - "type": "string" - }, - "type": "array" + "billingKey": { + "type": "string" }, - "port": { + "closeLocatorId": { "format": "int32", "type": "integer" }, - "rcAccountId": { - "format": "int64", - "type": "integer" + "closeType": { + "enum": [ + "STANDARD", + "STANDARD_PARALLEL", + "LOCATOR" + ], + "type": "string" }, - "rcUserId": { - "format": "int64", + "dequeueDelay": { + "format": "int32", "type": "integer" }, - "regionalSettings": { - "$ref": "#/components/schemas/RegionalSettingRequestResponse" - }, - "xAuthToken": { - "type": "string" - } - }, - "type": "object" - }, - "UserLoginView": { - "properties": { - "accounts": { - "items": { - "$ref": "#/components/schemas/AccountView" - }, - "type": "array" - }, - "authToken": { + "description": { "type": "string" }, - "platformHost": { + "endcallMsg": { "type": "string" }, - "user": { - "$ref": "#/components/schemas/User" - } - }, - "type": "object" - }, - "ValidationErrorData": { - "properties": { - "attributeName": { + "friSched": { "type": "string" }, - "message": { + "introMsg": { "type": "string" }, - "value": { + "monSched": { "type": "string" - } - }, - "type": "object" - }, - "VisualIvr": { - "properties": { - "account": { - "$ref": "#/components/schemas/Account" }, - "debug": { - "type": "boolean" + "openLocatorId": { + "format": "int32", + "type": "integer" }, - "debugEmail": { + "openType": { + "enum": [ + "STANDARD", + "STANDARD_PARALLEL", + "LOCATOR" + ], "type": "string" }, - "isActive": { - "type": "boolean" - }, - "isDeleted": { - "type": "boolean" + "outboundCallerId": { + "type": "string" }, "permissions": { "items": { @@ -13629,473 +7249,316 @@ }, "type": "array" }, - "reportConfig": { - "type": "string" + "postCallSoapService": { + "$ref": "#/components/schemas/RemoteHttpService" }, - "version": { + "recordCall": { "format": "int32", "type": "integer" }, - "visualIvrDesc": { - "type": "string" + "revMatch": { + "format": "int32", + "type": "integer" }, - "visualIvrGroup": { - "$ref": "#/components/schemas/VisualIvrGroup" + "satSched": { + "type": "string" }, - "visualIvrId": { + "shortCallTime": { "format": "int32", "type": "integer" }, - "visualIvrName": { + "sunSched": { "type": "string" - } - }, - "type": "object" - }, - "VisualIvrConfig": { - "properties": { - "account": { - "$ref": "#/components/schemas/Account" }, - "data": { - "type": "string" + "surveyId": { + "format": "int32", + "type": "integer" }, - "visualIvrDesc": { + "thuSched": { "type": "string" }, - "visualIvrId": { + "tracGroup": { + "$ref": "#/components/schemas/TracGroup" + }, + "tracId": { "format": "int32", "type": "integer" }, - "visualIvrName": { - "type": "string" - } - }, - "type": "object" - }, - "VisualIvrGroup": { - "properties": { - "groupName": { + "tueSched": { "type": "string" }, - "isDefault": { - "type": "boolean" - }, - "ivrGroupId": { + "voicemailEnabled": { "format": "int32", "type": "integer" }, - "permissions": { - "items": { - "enum": [ - "CREATE", - "READ", - "UPDATE", - "DELETE", - "REPORT" - ], - "type": "string" - }, - "type": "array" + "wedSched": { + "type": "string" }, - "visualIvrs": { - "$ref": "#/components/schemas/CollectionVisualIvr" + "whisperMsg": { + "type": "string" } }, "type": "object" }, - "VisualIvrSkinny": { + "TracNumberSkinny": { "properties": { "accountId": { "type": "string" }, + "description": { + "type": "string" + }, "groupId": { "format": "int32", "type": "integer" }, - "isActive": { - "type": "boolean" - }, - "isDeleted": { - "type": "boolean" - }, - "visualIvrDesc": { - "type": "string" - }, - "visualIvrGroupId": { + "tracGroupId": { "format": "int32", "type": "integer" }, - "visualIvrId": { + "tracId": { "format": "int32", "type": "integer" - }, - "visualIvrName": { - "type": "string" } }, "type": "object" }, - "WFM": { + "TracRoutingRule": { "properties": { - "accountId": { + "description": { "type": "string" }, - "wfmType": { - "enum": [ - "GENERIC", - "GENERIC_UDP", - "ASPECT", - "AC2", - "PIPKINS", - "MONET", - "NONE" - ], - "type": "string" - } - }, - "type": "object" - }, - "WhitelistEntry": { - "properties": { - "addedBy": { + "destination": { "type": "string" }, - "addedDts": { - "$ref": "#/components/schemas/DateTime" - }, - "expireDate": { - "$ref": "#/components/schemas/DateTime" - }, - "isIntl": { + "openRule": { "type": "boolean" }, - "notes": { - "type": "string" + "parallelDelay": { + "format": "int32", + "type": "integer" }, - "phone": { - "type": "string" + "rank": { + "format": "int32", + "type": "integer" }, - "whitelistTag": { - "$ref": "#/components/schemas/WhitelistTag" + "ringDuration": { + "format": "int32", + "type": "integer" }, - "whitelistTagId": { + "ruleId": { "format": "int32", "type": "integer" - } - }, - "type": "object" - }, - "WhitelistTag": { - "properties": { - "accountId": { - "type": "string" }, - "addedBy": { + "ruleType": { + "enum": [ + "STANDARD", + "STANDARD_SIP", + "ENCRYPTED_SIP", + "GATE_XFER", + "TRAC_XFER", + "IN_NETWORK", + "VIVR" + ], "type": "string" }, - "addedDts": { - "$ref": "#/components/schemas/DateTime" + "tracNumber": { + "$ref": "#/components/schemas/TracNumber" }, - "tag": { - "type": "string" + "ttAccept": { + "type": "boolean" }, - "whitelistTagId": { + "xferGateId": { "format": "int32", "type": "integer" }, - "wlTagId": { + "xferTracId": { "format": "int32", "type": "integer" } }, "type": "object" }, - "WhitelistTagMembers": { + "TracScheduleOverride": { "properties": { - "campaign": { - "$ref": "#/components/schemas/Campaign" + "overrideClosedEvent": { + "type": "string" }, - "campaignId": { + "overrideDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", + "type": "string" + }, + "overrideLabel": { + "type": "string" + }, + "overrideSched": { + "type": "string" + }, + "scheduleOverrideId": { "format": "int32", "type": "integer" - }, - "whitelistTag": { - "$ref": "#/components/schemas/WhitelistTag" } }, "type": "object" }, - "WsdlDefinition": { + "User": { "properties": { - "operations": { + "children": { "items": { - "$ref": "#/components/schemas/Operation" + "$ref": "#/components/schemas/User" }, "type": "array" }, - "serviceName": { + "creationDate": { + "description": "Date and time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", + "example": "2026-08-12T22:30:00.000+0000", "type": "string" - } - }, - "type": "object" - }, - "SubAccount": { - "type": "object", - "required": [ - "subAccountId", - "subAccountName", - "isActive" - ], - "properties": { - "subAccountId": { - "type": "string", - "description": "Engage Voice sub-account id", - "example": "15910001" }, - "subAccountName": { - "type": "string", - "description": "Engage Sub-account name", - "example": "Cappuccino Engage Development" + "enabled": { + "type": "boolean" }, - "isActive": { - "type": "boolean", - "description": "true if sub-account is active", - "example": true - } - } - }, - "QueueWithAgents": { - "type": "object", - "required": [ - "queueId", - "queueName", - "gateGroupId", - "isActive", - "createdOn" - ], - "properties": { - "queueId": { - "type": "integer", - "format": "int32", - "description": "Unique ID for inbound queue", - "example": 555 + "firstName": { + "type": "string" }, - "queueName": { - "type": "string", - "description": "Name of inbound queue", - "example": "Test queue" + "fullName": { + "type": "string" + }, + "lastName": { + "type": "string" + }, + "parentPath": { + "type": "string" + }, + "phoneNumber": { + "type": "string" + }, + "phoneNumberE164": { + "type": "string" }, - "gateGroupId": { - "type": "integer", - "format": "int32", - "description": "inbound queue group ID", - "example": 1009 + "phoneNumbersI18nEnabled": { + "type": "boolean" }, - "isActive": { - "type": "boolean", - "description": "true if the inbound queue is active", - "example": true + "rcAccountId": { + "type": "string" }, - "createdOn": { - "type": "string", - "format": "date-time", - "description": "Timestamp when inbound group was created", - "example": "2020-07-21T17:32:28Z" + "rcUserId": { + "format": "int64", + "type": "integer" }, - "agentIds": { + "regionalSettings": { + "$ref": "#/components/schemas/RegionalSettingRequestResponse" + }, + "roles": { "type": "array", - "description": "List of agents who connected to this queue", "items": { - "type": "integer", - "format": "int32" - }, - "example": [ - 10, - 20 - ] - } - } - }, - "HistoricalReportParams": { - "description": "Parameters for historical reports", - "required": [ - "startDate", - "timeInterval", - "timeZone", - "outputFormat" - ], - "type": "object", - "properties": { - "startDate": { - "type": "string", - "description": "Start date and time for the logging interval. Note: The report will be generated to the nearest minute (Seconds will not be taken into account).", - "example": "2021-02-28 08:27:00" + "$ref": "#/components/schemas/Role" + } }, - "timeInterval": { - "type": "integer", - "format": "int32", - "enum": [ - 15, - 30, - 45, - 60 - ], - "description": "Interval length in minutes.", - "example": 60 + "rootUser": { + "type": "boolean" }, - "timeZone": { - "type": "string", - "description": "Timezone name which should be used for report generation", - "example": "US/Eastern" + "userId": { + "format": "int32", + "type": "integer" }, - "reportType": { - "type": "string", - "enum": [ - "WEM" - ], - "description": "Report type which defines required input parameters", - "default": "WEM", - "example": "WEM" + "userManagedByRC": { + "type": "boolean" }, - "outputFormat": { - "type": "string", - "enum": [ - "CSV", - "XML" - ], - "description": "Report file format", - "example": "CSV" + "userName": { + "type": "string" } - } + }, + "type": "object" }, - "RealtimeReportParams": { - "description": "Parameters for realtime reports", - "required": [ - "startDate", - "timeInterval", - "timeZone", - "outputFormat" - ], - "type": "object", + "UserLoginView": { "properties": { - "segmentEndTime": { - "type": "string", - "description": "Beginning of the lookup window in 'YYYY-MM-DD HH:mm:ss' format. The API searches forward from this value for the number of seconds specified by timeInterval.", - "example": "2021-02-28 08:27:15" - }, - "timeInterval": { - "type": "integer", - "format": "int32", - "minimum": 1, - "maximum": 10800, - "description": "Length of the lookup window in seconds, measured forward from segmentEndTime. Maximum allowed length is 10800 (3 hours). Query completed intervals; results for recent interactions can change while metadata and recording URLs are still processing.", - "example": 1800 + "accounts": { + "items": { + "$ref": "#/components/schemas/AccountView" + }, + "type": "array" }, - "timeZone": { - "type": "string", - "description": "Timezone name which should be used for report generation", - "example": "US/Eastern" + "authToken": { + "type": "string" }, - "reportType": { - "type": "string", - "enum": [ - "WEM" - ], - "description": "Client who requests the report", - "default": "WEM", - "example": "WEM" + "platformHost": { + "type": "string" }, - "outputFormat": { - "type": "string", - "enum": [ - "CSV", - "XML" - ], - "description": "Report file format", - "example": "CSV" + "user": { + "$ref": "#/components/schemas/User" } - } + }, + "type": "object" }, - "BaseWemStateInfo": { - "type": "object", - "required": [ - "createdAt", - "updatedAt", - "version" - ], + "ValidationErrorData": { "properties": { - "createdAt": { - "type": "string", - "format": "datetime", - "description": "Creation date and time" + "attributeName": { + "type": "string" }, - "updatedAt": { - "type": "string", - "format": "datetime", - "description": "Date and time of last update action" + "message": { + "type": "string" }, - "version": { - "type": "integer", - "description": "Version number" + "value": { + "type": "string" } - } + }, + "type": "object" }, - "MainAccountWemState": { - "description": "Main Account WEM state", - "type": "object", - "required": [ - "mainAccountId", - "mainAccountName", - "status" - ], + "VisualIvrSkinny": { "properties": { - "mainAccountId": { - "type": "string", - "description": "Main Account Id", - "example": "99990033" + "accountId": { + "type": "string" }, - "mainAccountName": { - "type": "string", - "description": "Main Account Name", - "example": "Internal Account" + "groupId": { + "format": "int32", + "type": "integer" }, - "status": { - "type": "string", - "enum": [ - "ACTIVE", - "SUSPENDED" - ], - "description": "WEM feature status:\n * `ACTIVE` - WEM feature is active for that Customer\n * `SUSPENDED` - WEM feature is suspended for that Customer\n", - "example": "ACTIVE" + "isActive": { + "type": "boolean" + }, + "isDeleted": { + "type": "boolean" + }, + "visualIvrDesc": { + "type": "string" + }, + "visualIvrGroupId": { + "format": "int32", + "type": "integer" + }, + "visualIvrId": { + "format": "int32", + "type": "integer" + }, + "visualIvrName": { + "type": "string" } - } + }, + "type": "object" }, - "SubAccountWemState": { - "description": "Engage Voice sub-account WEM state", + "SubAccount": { "type": "object", "required": [ "subAccountId", - "status" + "subAccountName", + "isActive" ], "properties": { "subAccountId": { "type": "string", "description": "Engage Voice sub-account id", - "example": "99990033" + "example": "15910001" }, - "accountName": { + "subAccountName": { "type": "string", - "description": "Engage Voice sub-account name", - "example": "Internal Account" + "description": "Engage Sub-account name", + "example": "Cappuccino Engage Development" }, - "status": { - "type": "string", - "enum": [ - "ACTIVE", - "INACTIVE" - ], - "description": "WEM feature status:\n * `ACTIVE` - WEM feature is active for that subaccount\n * `INACTIVE` - WEM feature is inactive for that subaccount\n" + "isActive": { + "type": "boolean", + "description": "true if sub-account is active", + "example": true } } }, @@ -14273,114 +7736,6 @@ } } }, - "InteractionSegmentMetaData2Array": { - "type": "array", - "items": { - "$ref": "#/components/schemas/InteractionSegmentMetaData2" - } - }, - "InteractionSegmentMetaData2": { - "type": "object", - "required": [ - "interactionId", - "interactionStartTime", - "interactionDuration", - "segmentId", - "segmentAgentId", - "segmentContactStartTime", - "segmentDuration", - "segmentCallingAddress", - "segmentCalledAddress", - "segmentDirection", - "segmentRecordingURL", - "segmentAgentGroupId" - ], - "properties": { - "interactionId": { - "type": "string", - "description": "Unique interaction ID used to connect different call segments together in transfer/conference scenarios.", - "example": "20200721123305013105000001977" - }, - "interactionStartTimeMs": { - "type": "string", - "format": "date-time", - "description": "Start time of the interaction. Could be different from segment start time if customer was engaged with the IVR, waited in queue, etc before agent joined the conversation. Milliseconds precision.", - "example": "2020-07-21T17:32:28.001Z" - }, - "interactionDurationMs": { - "type": "integer", - "format": "int32", - "description": "The total duration of the interaction. Milliseconds precision.", - "example": 832 - }, - "segmentID": { - "type": "integer", - "format": "int32", - "description": "Unique segment sequnce ID within the interaction.", - "example": 2 - }, - "segmentAgentId": { - "type": "integer", - "format": "int32", - "description": "RingCentral user id.", - "example": 1009 - }, - "segmentContactStartTimeMs": { - "type": "string", - "format": "date-time", - "description": "Time agent joined the conversation. Milliseconds precision.", - "example": "2020-07-21T17:32:40.002Z" - }, - "segmentContactEndTimeMs": { - "type": "string", - "format": "date-time", - "description": "Time agent left the conversation. Milliseconds precision.", - "example": "2020-07-21T17:32:42.045Z" - }, - "segmentDuration": { - "type": "integer", - "format": "int32", - "description": "Segment duration (available even when segmentContactEndTime is not provided). Seconds.", - "example": 832 - }, - "interactionCallingAddress": { - "type": "string", - "description": "The ANI of the interaction", - "example": 4155058987 - }, - "interactionCalledAddress": { - "type": "string", - "description": "The DNIS of the interaction", - "example": 8776239199 - }, - "interactionDirection": { - "type": "string", - "enum": [ - "INBOUND", - "OUTBOUND" - ], - "description": "Direction of the interaction.", - "example": "INBOUND" - }, - "segmentRecordingURL": { - "type": "string", - "description": "URL for segment recording", - "example": "https://c02-recordings.virtualacd.biz/api/v1/calls/recordings/?v=1&accountId=99990001&bucket=c02-recordings®ion=us-east-1&compliance=false&file=99990001/202205/09/20220509120710013214000058679-2.WAV" - }, - "segmentAgentGroupId": { - "type": "string", - "description": "Agent group Id", - "example": 8 - }, - "segmentEvents": { - "type": "array", - "description": "Ordered list of events. Can be empty if segmentRecordingURL is empty. In other cases array start with the event `REC_START`. Events don't overlap each other.", - "items": { - "$ref": "#/components/schemas/InteractionSegmentEvent" - } - } - } - }, "InteractionSegmentEvent": { "type": "object", "required": [