github.com/grokify/go-ringcentral-client@v0.3.31/codegen/specs-engagevoice_v3.0.0.json

{"components":{"schemas":{"Agent":{"properties":{"agentId":{"type":"integer"},"agentRank":{"default":0,"type":"integer"},"allowAgentReports":{"default":false,"type":"boolean"},"allowAgentStats":{"default":true,"type":"boolean"},"allowAutoAnswer":{"default":false,"type":"boolean"},"allowBlended":{"default":false,"type":"boolean"},"allowCallControl":{"default":true,"type":"boolean"},"allowCampStats":{"default":true,"type":"boolean"},"allowChat":{"default":false,"type":"boolean"},"allowChatStats":{"default":true,"type":"boolean"},"allowChatVoiceConcurrent":{"default":false,"type":"boolean"},"allowCrossGateRequeue":{"default":true,"type":"boolean"},"allowEndcallforeveryone":{"default":true,"type":"boolean"},"allowExternalChat":{"default":false,"type":"boolean"},"allowFromIpAddresses":{"type":"string"},"allowGateStats":{"default":true,"type":"boolean"},"allowHangup":{"default":true,"type":"boolean"},"allowHistoricalDialing":{"default":true,"type":"boolean"},"allowHold":{"default":true,"type":"boolean"},"allowInbound":{"default":true,"type":"boolean"},"allowInboundIntlTransfer":{"default":false,"type":"boolean"},"allowLeadInserts":{"default":false,"type":"boolean"},"allowLoginControl":{"default":true,"type":"boolean"},"allowLoginUpdates":{"default":true,"type":"boolean"},"allowManualCalls":{"default":true,"type":"boolean"},"allowManualIntlCalls":{"default":false,"type":"boolean"},"allowManualIntlTransfer":{"default":false,"type":"boolean"},"allowManualOutboundGates":{"default":false,"type":"boolean"},"allowManualPass":{"default":true,"type":"boolean"},"allowOffHook":{"default":false,"type":"boolean"},"allowOutbound":{"default":false,"type":"boolean"},"allowRequeue":{"default":true,"type":"boolean"},"allowSelfAgentStats":{"default":false,"type":"boolean"},"allowTransfer":{"default":true,"type":"boolean"},"altDefaultLoginDest":{"type":"string"},"defaultAutoAnswerOn":{"default":true,"type":"boolean"},"defaultLoginDest":{"default":"","type":"string"},"directAgentExtension":{"type":"string"},"disableSupervisorMonitoring":{"default":false,"type":"boolean"},"email":{"type":"string"},"enableSoftphone":{"default":false,"type":"boolean"},"externalAgentId":{"type":"string"},"firstName":{"type":"string"},"gatesControlAgentVisibility":{"default":false,"type":"boolean"},"ghostRnaAction":{"default":"AVAILABLE","type":"string"},"initLoginBaseState":{"default":"AVAILABLE","type":"string"},"initLoginBaseStateId":{"type":"integer"},"isActive":{"default":true,"type":"boolean"},"lastLoginDate":{"format":"date-time","type":"string"},"lastName":{"type":"string"},"loadBalanceEnabled":{"default":false,"type":"boolean"},"location":{"type":"string"},"manualOutboundDefaultCallerId":{"default":"","type":"string"},"maxChats":{"default":5,"type":"integer"},"multiAccountAgent":{"default":false,"type":"boolean"},"parentAgentId":{"type":"integer"},"password":{"type":"string"},"phoneLoginPin":{"type":"string"},"rcUserId":{"format":"int64","type":"integer"},"showLeadHistory":{"default":true,"type":"boolean"},"softphoneId":{"default":0,"type":"integer"},"team":{"type":"string"},"transientAgent":{"default":false,"type":"boolean"},"transientDelete":{"default":false,"type":"boolean"},"transientDeleteDate":{"format":"date-time","type":"string"},"userManagedByRC":{"default":false,"type":"boolean"},"username":{"type":"string"}}},"AgentGroup":{"description":"WIP: `permissions` is an array that needs definition","properties":{"agentGroupId":{"format":"int64","type":"integer"},"groupName":{"type":"string"},"isDefault":{"type":"boolean"}},"type":"object"},"Campaign":{"properties":{"campaignDesc":{"type":"string"},"campaignId":{"format":"int64","type":"integer"},"campaignName":{"type":"string"},"dialGroup":{"$ref":"#/components/schemas/Generic"},"isActive":{"format":"int64","type":"integer"},"permissions":{"items":{"type":"object"},"type":"array"},"script":{"$ref":"#/components/schemas/Generic"}}},"CampaignLead":{"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"},"city":{"type":"string"},"dupeKeyOverride":{"format":"int64","type":"integer"},"email":{"type":"string"},"externId":{"type":"string"},"extraData":{"type":"string"},"firstName":{"type":"string"},"gateKeeper":{"type":"string"},"id":{"format":"int64","type":"integer"},"lastName":{"type":"string"},"lastPassDispo":{"type":"string"},"leadId":{"format":"int64","type":"integer"},"leadPasses":{"type":"integer"},"leadPhone":{"type":"string"},"leadState":{"type":"string"},"leadTimezone":{"type":"string"},"liveAnswerMessage":{"type":"string"},"loadedDts":{"description":"Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 Spec because it doesn't have a `:` between hours and minutes.","type":"string"},"machAnswerMessage":{"type":"string"},"maxPasses":{"type":"integer"},"midName":{"type":"string"},"name":{"type":"string"},"nextDialTime":{"description":"Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 Spec because it doesn't have a `:` between hours and minutes.","type":"string"},"sortCol":{"type":"string"},"speedToLeadAgentConn":{"type":"integer"},"speedToLeadFirstPass":{"type":"integer"},"state":{"type":"string"},"suffix":{"type":"string"},"suppressed":{"type":"boolean"},"title":{"type":"string"},"zip":{"type":"string"}},"type":"object"},"CampaignLeadSearchCriteria":{"properties":{"address1":{"type":"string"},"address2":{"type":"string"},"agentDispositions":{"items":{"type":"string"},"type":"array"},"agentId":{"type":"integer"},"auxData1":{"type":"string"},"auxData2":{"type":"string"},"auxData3":{"type":"string"},"auxData4":{"type":"string"},"auxData5":{"type":"string"},"callerId":{"type":"string"},"campaignIds":{"items":{"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":{"type":"integer"},"type":"array"},"leadPassesCriteria":{"$ref":"#/components/schemas/ComparableSearchField"},"leadPhoneNum":{"type":"string"},"leadPhoneNumbers":{"items":{"type":"string"},"type":"array"},"leadTimezones":{"$ref":"#/components/schemas/Timezone"},"listIds":{"items":{"type":"integer"},"type":"array"},"loadedDtsEnd":{"description":"Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 Spec because it doesn't have a `:` between hours and minutes.","type":"string"},"loadedDtsStart":{"description":"Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 Spec because it doesn't have a `:` between hours and minutes.","type":"string"},"nextDialTimeCriteria":{"$ref":"#/components/schemas/DateTimeComparableSearchField"},"orphanedLeadsOnly":{"type":"boolean"},"pendingAgentId":{"type":"integer"},"physicalStates":{"items":{"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":{"type":"integer"},"campaignLead":{"$ref":"#/components/schemas/CampaignLead"},"campaignName":{"type":"string"},"city":{"type":"string"},"dialGroupId":{"type":"integer"},"dupeKeyOverride":{"format":"int64","type":"integer"},"email":{"type":"string"},"externId":{"type":"string"},"extraData":{"type":"string"},"firstName":{"type":"string"},"gateKeeper":{"type":"string"},"id":{"type":"string"},"lastName":{"type":"string"},"lastPassAgentName":{"type":"string"},"lastPassDate":{"description":"Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 Spec because it doesn't have a `:` between hours and minutes.","type":"string"},"lastPassDispo":{"type":"string"},"lastPassDisposition":{"type":"string"},"lastPassDts":{"description":"Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 Spec because it doesn't have a `:` between hours and minutes.","type":"string"},"leadId":{"format":"int64","type":"integer"},"leadPasses":{"type":"integer"},"leadPhone":{"type":"string"},"leadState":{"type":"string"},"leadTimezone":{"type":"string"},"listDesc":{"type":"string"},"listId":{"type":"integer"},"liveAnswerMessage":{"type":"string"},"loadedDts":{"description":"Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 Spec because it doesn't have a `:` between hours and minutes.","type":"string"},"machAnswerMessage":{"type":"string"},"maxPasses":{"type":"integer"},"midName":{"type":"string"},"name":{"type":"string"},"nextDialTime":{"description":"Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 Spec because it doesn't have a `:` between hours and minutes.","type":"string"},"pendingAgentName":{"type":"string"},"sortCol":{"type":"string"},"speedToLeadAgentConn":{"type":"integer"},"speedToLeadFirstPass":{"type":"integer"},"state":{"type":"string"},"stateDts":{"description":"Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 Spec because it doesn't have a `:` between hours and minutes.","type":"string"},"suffix":{"type":"string"},"suppressed":{"type":"boolean"},"title":{"type":"string"},"uploadDate":{"description":"Date-time in Java format. Example: `2019-01-01T01:01:01.000+0000`. Note this is not compatible with RFC-3339 which is used by OpenAPI 3.0 Spec because it doesn't have a `:` between hours and minutes.","type":"string"},"uploadedBy":{"type":"string"},"zip":{"type":"string"}},"type":"object"},"ComparableSearchField":{"properties":{"operator":{"description":"Values can be `\u003e`, `\u003c` and `=`","type":"string"},"value":{"type":"string"}},"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"},"DateTimeComparableSearchField":{"properties":{"operator":{"description":"Values can be `\u003e`, `\u003c` and `=`","type":"string"},"value":{"format":"date-time","type":"string"}},"type":"object"},"DialGroup":{"properties":{"agentDialGroupMembers":{"type":"object"},"agentsReady":{"type":"integer"},"billingKey":{"type":"string"},"dialGroupDesc":{"type":"string"},"dialGroupId":{"format":"int64","type":"integer"},"dialGroupName":{"type":"string"},"dialMode":{"description":"Can be `PREDICTIVE`","type":"string"},"enableAgentFilter":{"type":"boolean"},"hciEnabled":{"description":"Can be `DISABLED`","type":"string"},"isActive":{"type":"boolean"},"maxPorts":{"type":"integer"},"outdialServerGroupId":{"type":"integer"},"permissions":{"items":{"type":"object"},"type":"array"},"realTimeAgentData":{"type":"boolean"}},"type":"object"},"Error":{"properties":{"details":{"type":"string"},"generalMessage":{"type":"string"},"requestUri":{"type":"string"},"timestamp":{"format":"int64","type":"integer"}}},"ExtendedLeadData":{"properties":{"important":{"type":"string"},"interested":{"type":"boolean"}},"type":"object"},"Generic":{"properties":{"description":{"type":"string"},"id":{"format":"int64","type":"integer"}}},"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"},"SuppressedType":{"properties":{"name":{"type":"string"}},"type":"object"},"Timezone":{"properties":{"description":{"type":"string"},"name":{"type":"string"}},"type":"object"},"UploadLeadsRequest":{"properties":{"description":{"type":"string"},"dialPriority":{"description":"Setting this to `IMMEDIATE` allows you to insert a lead to the top of the dialer cache for immediate dialing if you want a normal insert then do not add this parameter.","enum":["IMMEDIATE","NORMAL"],"type":"string"},"duplicateHandling":{"enum":["RETAIN_ALL","REMOVE_ALL_EXISTING","REMOVE_FROM_LIST"],"type":"string"},"listState":{"enum":["ACTIVE"],"type":"string"},"timeZoneOption":{"enum":["NPA_NXX","ZIPCODE","EXPLICIT"],"type":"string"},"uploadLeads":{"items":{"$ref":"#/components/schemas/CampaignLead"},"type":"array"}},"type":"object"},"UploadLeadsResponse":{"properties":{"deletedCount":{"format":"int32","type":"integer"},"dncReturnedCount":{"format":"int32","type":"integer"},"dncUploadCount":{"format":"int32","type":"integer"},"hasDeletedLeads":{"type":"boolean"},"internalDncCount":{"format":"int32","type":"integer"},"leadsAccepted":{"format":"int32","type":"integer"},"leadsConverted":{"format":"int32","type":"integer"},"leadsInserted":{"format":"int32","type":"integer"},"leadsSupplied":{"format":"int32","type":"integer"},"listState":{"type":"string"},"message":{"description":"Values can be `Your uploaded lead list has successfully completed processing` or `Your uploaded lead list file processing has failed`","type":"string"},"processingResult":{"description":"Values can be `OK` or `Failed`","type":"string"},"processingStatus":{"description":"Values can be `DEFAULT_NOT_A_FAILURE` or `GENERAL_FAILURE`","type":"string"},"quotaCount":{"format":"int32","type":"integer"},"timeZoneOption":{"type":"string"},"uploadFileName":{"type":"string"},"whitelistCount":{"format":"int32","type":"integer"}},"required":["message","leadsSupplied","leadsConverted","leadsAccepted","leadsInserted","internalDncCount","dncUploadCount","dncReturnedCount","whitelistCount","uploadFileName","deletedCount","quotaCount","listState","timeZoneOption","hasDeletedLeads","processingResult","processingStatus"],"type":"object"},"User":{"description":"Children field is still needed","properties":{"enabled":{"type":"boolean"},"firstName":{"type":"string"},"lastName":{"type":"string"},"parentPath":{"type":"string"},"userId":{"format":"int64","type":"integer"},"userName":{"type":"string"}},"required":["userId"],"type":"object"}},"securitySchemes":{"ApiKeyAuth":{"in":"header","name":"X-Auth-Token","type":"apiKey"}}},"info":{"description":"","termsOfService":"https://developers.ringcentral.com","title":"RingCentral Engage Voice API","version":"1.0"},"openapi":"3.0.0","paths":{"/admin/accounts/{accountId}/agentGroups":{"get":{"description":"Returns a listing of agent groups for an account","operationId":"getAgentGroups","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AgentGroup"},"type":"array"}}},"description":"Success"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Server Error"}},"summary":"Get Agent Groups","tags":["Agents"]}},"/admin/accounts/{accountId}/agentGroups/{agentGroupId}/agents":{"get":{"description":"Returns a listing of agents for an agent group","operationId":"getAgents","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"path","name":"agentGroupId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Agent"},"type":"array"}}},"description":"Success"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Server Error"}},"summary":"Get Group Agents","tags":["Agents"]}},"/admin/accounts/{accountId}/campaignLeads/leadSearch":{"post":{"description":"Allows searching of campaign leads for a single campaign\n\nPermissions: READ on Account (Permission Override)","operationId":"searchLeads","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"query","name":"count","required":false,"schema":{"type":"integer"}},{"in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"in":"query","name":"maxRows","required":false,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignLeadSearchCriteria"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CampaignLeadSearchResultsView"},"type":"array"}}},"description":"Success"}},"summary":"Search Leads","tags":["Campaign Leads"]}},"/admin/accounts/{accountId}/campaignLeads/leadStates":{"get":{"description":"Returns a listing of all lead states for an account\n\nPermissions: READ on Account","operationId":"getLeadStates","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Success"}},"summary":"Get Lead States","tags":["Campaign Leads"]}},"/admin/accounts/{accountId}/campaignLeads/systemDispositions":{"get":{"description":"Returns a listing of all system dispositions for an account\n\nPermissions: READ on Account","operationId":"getSystemDispositions","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Success"}},"summary":"Get Systems Dispositions","tags":["Campaign Leads"]}},"/admin/accounts/{accountId}/campaignLeads/{leadId}":{"patch":{"description":"Allows updating of a campaign lead, only updating those fields passed in\n\nPermissions: READ on Account (Permission Override), UPDATE on Campaign","operationId":"patchCampaignLead","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"path","name":"leadId","required":true,"schema":{"type":"integer"}},{"in":"query","name":"campaignId","required":true,"schema":{"type":"integer"}},{"in":"query","name":"listId","required":false,"schema":{"type":"integer"}},{"in":"query","name":"timezoneOption","required":false,"schema":{"enum":["NPA_NXX","ZIPCODE","EXPLICIT","NOT_APPLICABLE"],"type":"string"}},{"description":"`RETAIN_ALL`: Retain all records, `REMOVE_ALL_EXISTING`: Remove duplicates from all existing lists, `REMOVE_FROM_LIST`: Remove duplicates from this list","in":"query","name":"duplicateHandling","required":false,"schema":{"default":"RETAIN_ALL","enum":["RETAIN_ALL","REMOVE_ALL_EXISTING","REMOVE_FROM_LIST"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignLead"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignLead"}}},"description":"Success"}},"summary":"Patch Campaign Lead","tags":["Campaigns"]},"put":{"description":"Allows updating of a campaign lead, updating entire lead including fields not passed in.\n\nPermissions: READ on Account (Permission Override), UPDATE on Campaign","operationId":"updateCampaignLead","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"path","name":"leadId","required":true,"schema":{"type":"integer"}},{"in":"query","name":"campaignId","required":true,"schema":{"type":"integer"}},{"in":"query","name":"listId","required":false,"schema":{"type":"integer"}},{"in":"query","name":"timezoneOption","required":false,"schema":{"enum":["NPA_NXX","ZIPCODE","EXPLICIT","NOT_APPLICABLE"],"type":"string"}},{"description":"`RETAIN_ALL`: Retain all records, `REMOVE_ALL_EXISTING`: Remove duplicates from all existing lists, `REMOVE_FROM_LIST`: Remove duplicates from this list","in":"query","name":"duplicateHandling","required":false,"schema":{"default":"RETAIN_ALL","enum":["RETAIN_ALL","REMOVE_ALL_EXISTING","REMOVE_FROM_LIST"],"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignLead"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignLead"}}},"description":"Success"}},"summary":"Update Campaign Lead","tags":["Campaigns"]}},"/admin/accounts/{accountId}/campaigns/{campaignId}/leadLoader/direct":{"post":{"description":"Uploads a single lead or list of leads to a new or existing list","operationId":"uploadLeads","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"path","name":"campaignId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadLeadsRequest"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadLeadsResponse"}}},"description":"Success"}},"summary":"Upload Leads","tags":["Campaigns"]}},"/admin/accounts/{accountId}/countries/available":{"get":{"description":"Get a list of available countries","operationId":"getAvailableCountries","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Country"},"type":"array"}}},"description":"Success"}},"summary":"Get Available Countries","tags":["Countries"]}},"/admin/accounts/{accountId}/dialGroups":{"get":{"description":"Returns a listing of dial groups for an account","operationId":"getDialGroups","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DialGroup"},"type":"array"}}},"description":"Success"}},"summary":"Get Dial Groups","tags":["Dial Groups"]}},"/admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns":{"get":{"description":"Returns a listing of campaigns for a dial group","operationId":"getCampaigns","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"type":"string"}},{"in":"path","name":"dialGroupId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Campaign"},"type":"array"}}},"description":"Success"}},"summary":"Get Campaigns","tags":["Dial Groups"]}},"/admin/accounts/{accountId}/dialGroups/{dialGroupId}/campaigns/{campaignId}/clearCache":{"post":{"description":"lears the cache for a campaign\n\nPermissions: READ on Campaign (Permission Override)","operationId":"clearCampaignCache","parameters":[{"in":"path","name":"accountId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"path","name":"dialGroupId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"path","name":"campaignId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"An `application/json` Content-Type header is required. Submit an empty body to trigger the header.","required":true},"responses":{"201":{"description":"Created"}},"summary":"Clear Campaign Cache","tags":["Dial Groups"]}},"/admin/token":{"get":{"description":"Retrieves all API Tokens for the authenticated user","operationId":"getTokens","responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Success"}},"summary":"Get Tokens","tags":["Auth"]}},"/admin/users":{"get":{"description":"Returns a listing of all users that a user has access to","operationId":"getUsers","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/User"},"type":"array"}}},"description":"Success"}},"summary":"Get Users","tags":["Users"]}}},"security":[{"ApiKeyAuth":[]}],"servers":[{"url":"https://portal.vacd.biz/api/v1"}],"tags":[{"name":"Agents"},{"name":"Auth"},{"name":"Campaign Leads"},{"name":"Campaigns"},{"name":"Countries"},{"name":"Dial Groups"},{"name":"Leads"},{"name":"Users"}]}