{"id":20916234,"url":"https://github.com/qualityunit/liveagent-api-scala-akka","last_synced_at":"2025-06-26T12:04:32.982Z","repository":{"id":79247325,"uuid":"207301044","full_name":"QualityUnit/LiveAgent-api-scala-akka","owner":"QualityUnit","description":null,"archived":false,"fork":false,"pushed_at":"2020-10-14T06:27:44.000Z","size":283,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-01-19T16:27:22.668Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/QualityUnit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-09-09T12:13:36.000Z","updated_at":"2020-10-14T06:27:41.000Z","dependencies_parsed_at":"2023-04-18T11:53:25.159Z","dependency_job_id":null,"html_url":"https://github.com/QualityUnit/LiveAgent-api-scala-akka","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2FLiveAgent-api-scala-akka","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2FLiveAgent-api-scala-akka/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2FLiveAgent-api-scala-akka/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/QualityUnit%2FLiveAgent-api-scala-akka/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/QualityUnit","download_url":"https://codeload.github.com/QualityUnit/LiveAgent-api-scala-akka/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243308600,"owners_count":20270448,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-18T16:20:56.108Z","updated_at":"2025-03-12T23:21:57.408Z","avatar_url":"https://github.com/QualityUnit.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# api-client\n\nLiveAgent API\n- API version: 3.0.0\n\nThis page contains complete API documentation for LiveAgent software. To display additional info and examples for specific API method, just click on the method name in the list below.\u003cbr/\u003e\u003cbr/\u003eTo be able to make API requests you need to generate an API key in your admin panel first. [See this article for detailed info.](https://support.ladesk.com/741982-API-key)\u003cbr/\u003e\u003cbr/\u003eAdditional info about more advanced agent, contact or ticket API filters can be found [in this article](https://support.ladesk.com/513528-APIv3-advanced-filter-examples).\u003cbr/\u003e\u003cbr/\u003eIf you have any question or doubts regarding this API, please do not hesitate to contact our support team.\n\n\n*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*\n\n## Requirements\n\nBuilding the API client library requires:\n1. Java 1.7+\n2. Maven/Gradle/SBT\n\n## Installation\n\nTo install the API client library to your local Maven repository, simply execute:\n\n```shell\nmvn clean install\n```\n\nTo deploy it to a remote Maven repository instead, configure the settings of the repository and execute:\n\n```shell\nmvn clean deploy\n```\n\nRefer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.\n\n### Maven users\n\nAdd this dependency to your project's POM:\n\n```xml\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.liveagent.legacy\u003c/groupId\u003e\n  \u003cartifactId\u003eapi-client\u003c/artifactId\u003e\n  \u003cversion\u003e6.18.2\u003c/version\u003e\n  \u003cscope\u003ecompile\u003c/scope\u003e\n\u003c/dependency\u003e\n```\n\n### Gradle users\n\nAdd this dependency to your project's build file:\n\n```groovy\ncompile \"com.liveagent.legacy:api-client:6.18.2\"\n```\n\n### SBT users\n\n```scala\nlibraryDependencies += \"com.liveagent.legacy\" % \"api-client\" % \"6.18.2\"\n```\n\n## Getting Started\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://localhost/api/v3*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AgentPhoneApi* | **getAgentPhone** | **GET** /agent_phone/{agentId} | Gets phone currently used by agent (use me as agentId for self)\n*AgentPhoneApi* | **setAgentPhone** | **PUT** /agent_phone/{agentId} | Sets phone currently used by agent (use me as agentId for self)\n*AgentsApi* | **convertRegisteredVisitor** | **POST** /agents/convert | Convert registered visitor\n*AgentsApi* | **deleteAgent** | **DELETE** /agents/{userId} | Agent\n*AgentsApi* | **getAgent** | **GET** /agents/{userId} | Agent\n*AgentsApi* | **getAgentByEmail** | **POST** /agents/_by_email | Agent\n*AgentsApi* | **getAgentStatuses** | **GET** /agents/{userId}/status | Get agent statuses in departments\n*AgentsApi* | **getAgents** | **GET** /agents/ | Agent list\n*AgentsApi* | **getAgentsActivity** | **GET** /agents/activity | Agent Activity list\n*AgentsApi* | **loginAgent** | **POST** /agents/{userId}/_login | Login agent\n*AgentsApi* | **logoutAgent** | **POST** /agents/{userId}/_logout | Logout agent\n*AgentsApi* | **pauseAgent** | **POST** /agents/{userId}/_pause | Pause agent\n*AgentsApi* | **undeleteAgent** | **POST** /agents/undelete | Undelete agent\n*AgentsApi* | **updateAgent** | **PUT** /agents/{userId} | Update agent\n*ApiApi* | **createApiKeys** | **POST** /apikeys | Creates api key\n*ApiApi* | **deleteApiKey** | **DELETE** /apikeys/{apikeyId} | Deletes api key\n*ApiApi* | **generateApiKey** | **POST** /apikeys/_generate | Gets new api keys\n*ApiApi* | **generateSSOKey** | **POST** /sso | Generate SSO key\n*ApiApi* | **getApiInfo** | **GET** /api/info/{apiVersion} | Gets api info\n*ApiApi* | **getApiKey** | **GET** /apikeys/{apikeyId} | Gets api keys\n*ApiApi* | **getApiKeys** | **GET** /apikeys | Gets api keys\n*ApiApi* | **getApiPrivileges** | **GET** /api/privileges | Gets api privileges\n*ApiApi* | **getApiV3KeysCount** | **GET** /api/v3/count | Gets count for api v3 keys\n*ApiApi* | **getSSOKey** | **GET** /sso | Get SSO key\n*ApiApi* | **login** | **POST** /apikeys/_login | Creates or returns API key from login.\n*ApiApi* | **updateApiKey** | **PUT** /apikeys/{apikeyId} | Updates api key\n*BansApi* | **createBan** | **POST** /bans/ | Create ban\n*BansApi* | **excludeIPBan** | **PUT** /bans/_exclude | Exclude banned IP address\n*BansApi* | **expireBan** | **POST** /bans/{banId}/_expire | Expire ban\n*BansApi* | **getBan** | **GET** /bans/{banId} | Get ban item\n*BansApi* | **getBans** | **GET** /bans/ | Bans list\n*BansApi* | **updateBan** | **PUT** /bans/{banId} | Update ban\n*BillingApi* | **checkVat** | **POST** /billing/_check_vat | Vat validity\n*BillingApi* | **getCoupon** | **GET** /coupons/{couponCode} | Coupon\n*CallsApi* | **callAddMessage** | **POST** /calls/{callId}/messages | Adds a message to the call group in corresponding ticket\n*CallsApi* | **callAddRecording** | **POST** /calls/{callId}/recordings | Adds a recording to the call group in corresponding ticket\n*CallsApi* | **callAnswer** | **POST** /calls/{callId}/_answer | Set call as answered by agent\n*CallsApi* | **callChangeChannelStatus** | **PUT** /calls/{callId}/channels/{channelId}/_status | Change channel status\n*CallsApi* | **callCreate** | **POST** /calls/{callId} | Create new call\n*CallsApi* | **callFetchIvr** | **POST** /calls/{callId}/_fetchIvr | Fetches IVR for the call from external URL\n*CallsApi* | **callGetStatus** | **GET** /calls/{callId}/status | Return the status of call\n*CallsApi* | **callMoveChannel** | **POST** /calls/{callId}/channels/{channelId}/_move | Moves existing channel to target call\n*CallsApi* | **callRemoveChannel** | **DELETE** /calls/{callId}/channels/{channelId} | Removes channel from the call\n*CallsApi* | **callReroute** | **POST** /calls/{callId}/_reroute | Let the call ring to another agent\n*CallsApi* | **callRing** | **POST** /calls/{callId}/_ring | Let the call ring\n*CallsApi* | **callStart** | **POST** /call/_start | Starts new outcoming / internal call\n*CallsApi* | **callStartCanceled** | **POST** /call/_startCanceled | Callback that starting call canceled\n*CallsApi* | **callStartFailed** | **POST** /call/_startFailed | Callback that starting call failed\n*CallsApi* | **callStop** | **POST** /calls/{callId}/_stop | Stops the call\n*CallsApi* | **callTransfer** | **POST** /calls/{callId}/_transfer | Transfers call to different department / agent\n*CallsApi* | **confirmRing** | **POST** /calls/{callId}/_confirmRing | Confirm that call is ringing\n*CallsApi* | **dtmfChannel** | **POST** /calls/{callId}/channels/{channelId}/_dtmf | Send provided DTMF to channel\n*CallsApi* | **endChannel** | **POST** /calls/{callId}/channels/{channelId}/_end | End channel\n*CallsApi* | **getCallsCount** | **GET** /calls/count | Gets count for calls history\n*CallsApi* | **getCallsList** | **GET** /calls | Gets list of calls\n*CallsApi* | **holdChannel** | **POST** /calls/{callId}/channels/{channelId}/_hold | Hold channel\n*CallsApi* | **merge** | **POST** /calls/{callId}/_merge | Merge two calls\n*CallsApi* | **muteChannel** | **POST** /calls/{callId}/channels/{channelId}/_mute | Mute channel\n*CallsApi* | **stopRing** | **POST** /calls/{callId}/_stopRing | Stop ringing of call\n*CallsApi* | **unholdChannel** | **POST** /calls/{callId}/channels/{channelId}/_unhold | Unhold channel\n*CallsApi* | **unmuteChannel** | **POST** /calls/{callId}/channels/{channelId}/_unmute | Unmute channel\n*CannedMessagesApi* | **createCannedMessage** | **POST** /canned_messages | Create canned message\n*CannedMessagesApi* | **deleteCannedMessage** | **DELETE** /canned_messages/{cannedMessageId} | Canned message\n*CannedMessagesApi* | **getCannedMessage** | **GET** /canned_messages/{cannedMessageId} | Gets canned message\n*CannedMessagesApi* | **getCannedMessagesList** | **GET** /canned_messages | Gets list of canned messages\n*CannedMessagesApi* | **updateCannedMessage** | **PUT** /canned_messages/{cannedMessageId} | Update canned message\n*ChatsApi* | **getChatsList** | **GET** /chats | Gets list of chats\n*CompaniesApi* | **createCompany** | **POST** /companies | Create new company\n*CompaniesApi* | **deleteCompany** | **DELETE** /companies/{companyId} | Delete company\n*CompaniesApi* | **getCompaniesList** | **GET** /companies | Gets list of companies\n*CompaniesApi* | **getSpecificCompany** | **GET** /companies/{companyId} | Get company by specific id\n*CompaniesApi* | **registerCompany** | **PUT** /companies/{companyId}/_register | Register company\n*CompaniesApi* | **unregisterCompany** | **DELETE** /companies/{companyId}/_unregister | Unregister company\n*CompaniesApi* | **updateCompany** | **PUT** /companies/{companyId} | Update company\n*ContactPhonesApi* | **getContactPhone** | **GET** /contact_phones/{phone} | Get contact phone\n*ContactPhonesApi* | **getContactPhonesList** | **GET** /contact_phones | Gets list of contact phones\n*ContactsApi* | **createContact** | **POST** /contacts | Create new contact\n*ContactsApi* | **deleteContact** | **DELETE** /contacts/{contactId} | Delete contact\n*ContactsApi* | **getContactsList** | **GET** /contacts | Gets list of contacts\n*ContactsApi* | **getSpecificContact** | **GET** /contacts/{contactId} | Get contact by specific id\n*ContactsApi* | **patchContact** | **PATCH** /contacts/{contactId} | Update contact partially\n*ContactsApi* | **registerContact** | **PUT** /contacts/{contactId}/_register | Register contact\n*ContactsApi* | **unregisterContact** | **DELETE** /contacts/{contactId}/_unregister | Unregister contact\n*ContactsApi* | **updateContact** | **PUT** /contacts/{contactId} | Update whole contact\n*CountriesApi* | **getCountries** | **GET** /countries/ | Country list\n*CustomButtonsApi* | **createCustomButton** | **POST** /custom_buttons | Create new custom button\n*CustomButtonsApi* | **deleteCustomButton** | **DELETE** /custom_buttons/{customButtonId} | Delete custom button\n*CustomButtonsApi* | **getCustomButton** | **GET** /custom_buttons/{customButtonId} | Get custom button by id\n*CustomButtonsApi* | **getCustomButtonsList** | **GET** /custom_buttons | Gets list of custom buttons\n*CustomButtonsApi* | **updateCustomButton** | **PUT** /custom_buttons/{customButtonId} | Update custom button\n*DefaultApi* | **ping** | **GET** /ping | Check that API is responding\n*DepartmentsApi* | **getDepartmentList** | **GET** /departments | Gets list of departments\n*DepartmentsApi* | **getSpecificDepartment** | **GET** /departments/{departmentId} | Get department by specific id\n*DepartmentsApi* | **ifAgentIsInDepartment** | **GET** /departments/{departmentId}/{agentId} | Is agent is department\n*DepartmentsApi* | **updateDepartmentMailAccount** | **PUT** /departments/{departmentId}/mailAccount/{mailAccountId} | Update department mail account\n*DevicesApi* | **createDevice** | **POST** /devices | Create new device\n*DevicesApi* | **createDeviceDepartmentPlans** | **POST** /devices/{deviceId}/departments/{departmentId}/plans | Create device department plans\n*DevicesApi* | **deleteDevice** | **DELETE** /devices/{deviceId} | Delete device\n*DevicesApi* | **deleteDeviceDepartment** | **DELETE** /devices/{deviceId}/departments/{departmentId} | Delete device department\n*DevicesApi* | **deleteDeviceDepartmentPlans** | **DELETE** /devices/{deviceId}/departments/{departmentId}/plans | Delete device department plans\n*DevicesApi* | **deleteDeviceDepartments** | **DELETE** /devices/{deviceId}/departments | Delete device departments\n*DevicesApi* | **getDevice** | **GET** /devices/{deviceId} | Get device by id\n*DevicesApi* | **getDeviceDepartment** | **GET** /devices/{deviceId}/departments/{departmentId} | Get device department by id\n*DevicesApi* | **getDeviceDepartmentPlan** | **GET** /devices/{deviceId}/departments/{departmentId}/plans | Get device department plan\n*DevicesApi* | **getDeviceDepartments** | **GET** /devices/{deviceId}/departments | Get device departments\n*DevicesApi* | **getDeviceDepartmentsByDepartmentId** | **GET** /devices/departments/{departmentId} | Get device departments by department id\n*DevicesApi* | **getDevicesList** | **GET** /devices | Gets list of devices\n*DevicesApi* | **getMyMobileDevicesList** | **GET** /devices/_app_/ | Gets list of current agent\u0026#39;s mobile devices. Creates new one if there are no devices.\n*DevicesApi* | **updateDevice** | **PUT** /devices/{deviceId} | Update device\n*DevicesApi* | **updateDeviceDepartment** | **PUT** /devices/{deviceId}/departments/{departmentId} | Update device department\n*DevicesApi* | **updateDeviceDepartmentPlan** | **PUT** /devices/{deviceId}/departments/{departmentId}/plans | Update device department plan\n*DevicesApi* | **updateDeviceDepartments** | **PUT** /devices/departments/update | Update device departments\n*ElasticApi* | **getIndexStatus** | **GET** /elastic/status | Get reindex status\n*ElasticApi* | **reindex** | **POST** /elastic/reindex | Reindex selected fields\n*ElasticApi* | **reindexAll** | **POST** /elastic/reindexAll | Reindex all fields\n*ExtensionsApi* | **getExtension** | **GET** /extensions/{extensionId} | Gets Extension\n*ExtensionsApi* | **getExtensionsCount** | **GET** /extensions/count | Gets count for extensions\n*ExtensionsApi* | **getExtensionsList** | **GET** /extensions | Gets list of extensions\n*ExtensionsApi* | **setExtension** | **PUT** /extensions/{extensionId} | Set extension\n*FilesApi* | **uploadFile** | **POST** /files | Upload new file to the system\n*FiltersApi* | **createFilter** | **POST** /filters/ | Create filter\n*FiltersApi* | **deleteFilter** | **DELETE** /filters/{filterId} | Delete filter\n*FiltersApi* | **getFilter** | **GET** /filters/{filterId} | Get filter\n*FiltersApi* | **getFilters** | **GET** /filters/ | Filters list\n*FiltersApi* | **updateFilter** | **PUT** /filters/{filterId} | Update filter\n*GridApi* | **getAgentsGridList** | **GET** /grid/agents | Gets list of agents for grid\n*GridApi* | **getAgentsGridListCount** | **GET** /grid/agents/count | Gets count of agents for agents grid\n*GridApi* | **getCallsSlaLogGridList** | **GET** /grid/calls/sla | Gets list of call slas for grid\n*GridApi* | **getCallsSlaLogGridListCount** | **GET** /grid/calls/sla/count | Gets count of calls for tickets sla grid\n*GridApi* | **getChatsGridList** | **GET** /grid/chats | Gets list of chats for chats grid\n*GridApi* | **getChatsGridListCount** | **GET** /grid/chats/count | Gets count of chats for chats grid\n*GridApi* | **getChatsSlaLogGridList** | **GET** /grid/chats/sla | Gets list of chat slas for grid\n*GridApi* | **getChatsSlaLogGridListCount** | **GET** /grid/chats/sla/count | Gets count of chats for chats sla grid\n*GridApi* | **getDepartmensGridListCount** | **GET** /grid/departments/count | Gets count of departments for department grid\n*GridApi* | **getDepartmentsGridList** | **GET** /grid/departments | Gets list of departments for grid\n*GridApi* | **getEventLogsGridList** | **GET** /grid/eventlogs | Gets list of event logs for grid\n*GridApi* | **getEventLogsGridListCount** | **GET** /grid/eventlogs/count | Gets count of logs for event logs grid\n*GridApi* | **getTagsGridList** | **GET** /grid/tags | Gets list of tags for grid\n*GridApi* | **getTagsGridListCount** | **GET** /grid/tags/count | Gets count of tags for tags grid\n*GridApi* | **getTicketsGridList** | **GET** /grid/tickets | Gets list of tickets for tickets grid\n*GridApi* | **getTicketsGridListCount** | **GET** /grid/tickets/count | Gets count of tickets for tickets grid\n*GridApi* | **getTicketsSlaLogGridList** | **GET** /grid/tickets/sla | Gets list of ticket slas for grid\n*GridApi* | **getTicketsSlaLogGridListCount** | **GET** /grid/tickets/sla/count | Gets count of tickets for tickets sla grid\n*GridApi* | **getTimeReportsGridList** | **GET** /grid/reports/time | Gets list of reports for time reports grid\n*GridApi* | **getTimeReportsGridListCount** | **GET** /grid/reports/time/count | Gets count of time reporst grid\n*GroupsApi* | **createGroup** | **POST** /groups | Create contact group\n*GroupsApi* | **deleteGroup** | **DELETE** /groups/{groupId} | Delete contact group\n*GroupsApi* | **getGroupById** | **GET** /groups/{groupId} | Get contact group by group id\n*GroupsApi* | **getGroupsList** | **GET** /groups | Gets list of contact groups\n*GroupsApi* | **updateGroup** | **PUT** /groups/{groupId} | Update contact group\n*HostingApi* | **getInfo** | **GET** /hosting/info | Used hosting system info\n*InvoicesApi* | **dowloadInvoice** | **POST** /invoices/{invoiceNumber}/_download | Download invoice\n*InvoicesApi* | **getInvoices** | **GET** /invoices/ | Invoice list\n*MailAccountApi* | **getMailAccount** | **GET** /mail_accounts/{mailAccountId} | Gets mail account\n*MailAccountApi* | **getMailAccountByEmailAddress** | **POST** /mail_accounts/_by_email | Gets mail account by email address\n*MailAccountApi* | **getMailAccountList** | **GET** /mail_accounts | Gets list of mail accounts\n*MessagesApi* | **getMessage** | **GET** /messages/{messageId} | Get message\n*MicroservicesApi* | **getAgentNames** | **POST** /agent_names | Agent names\n*MicroservicesApi* | **getDepartmentNames** | **POST** /department_names | Department names\n*MicroservicesApi* | **getDepartments** | **GET** /principal/{principalId}/departments | Get principal departments\n*MicroservicesApi* | **getRole** | **GET** /principal/{principalId}/role | Get principal role\n*MicroservicesApi* | **resolveBrowser** | **POST** /principal/resolveBrowser | Resolve browser\n*MicroservicesApi* | **resolveUserIdFromApiKey** | **POST** /principal/resolveUserIdFromApiKey | Get user id from apikey\n*MicroservicesApi* | **resolveUserIdFromSession** | **POST** /principal/resolveUserIdFromSession | Get user id from session\n*MicroservicesApi* | **resolveUserIdFromVisitorId** | **POST** /principal/resolveUserIdFromVisitorId | Get user id from visitor id\n*MicroservicesApi* | **resolveVisitor** | **POST** /principal/resolveVisitor | Resolve visitor\n*MicroservicesApi* | **validateCredentials** | **POST** /principal/validateCredentials | Validate principal credentials\n*MicroservicesGmailApi* | **activateGmailAccount** | **POST** /gmail_accounts/{gmailAccountId}/_activate | \n*MicroservicesGmailApi* | **createGmailAccount** | **POST** /gmail_accounts/{gmailAccountId} | \n*MicroservicesGmailApi* | **deactivateGmailAccount** | **POST** /gmail_accounts/{gmailAccountId}/_deactivate | \n*MicroservicesGmailApi* | **deleteGmailAccount** | **DELETE** /gmail_accounts/{gmailAccountId} | \n*MicroservicesGmailApi* | **rejectGmailAccount** | **POST** /gmail_accounts/{gmailAccountId}/_reject | \n*MicroservicesGmailApi* | **updateGmailAccount** | **PUT** /gmail_accounts/{gmailAccountId} | \n*MicroservicesGmailApi* | **updateGmailAccountDepartment** | **POST** /gmail_accounts/{gmailAccountId}/_change_department | \n*PageVisitsApi* | **getPageVisitByContactId** | **GET** /page_visits/{contactId}/contact | Gets a page visits\n*PhoneNumbersApi* | **addNumber** | **POST** /phone_numbers | Add new number\n*PhoneNumbersApi* | **getAvailablePrefix** | **GET** /phone_numbers/availablePrefix | Gets available dial out prefix\n*PhoneNumbersApi* | **getPhoneNumber** | **GET** /phone_numbers/{phoneNumberId} | Gets phone number\n*PhoneNumbersApi* | **getPhoneNumbersList** | **GET** /phone_numbers | Gets list of available phone numbers\n*PhoneNumbersApi* | **removePhoneNumber** | **DELETE** /phone_numbers/{phoneNumberId} | Remove phone number\n*PhoneNumbersApi* | **updatePhoneNumber** | **PUT** /phone_numbers/{phoneNumberId} | Update phone number\n*PhoneNumbersApi* | **updatePhoneNumberStatus** | **PUT** /phone_numbers/{phoneNumberId}/status | Update phone number status\n*PhonesApi* | **createPhone** | **POST** /phones | Creates external phone\n*PhonesApi* | **getPhone** | **GET** /phones/{phoneId} | Gets phone device (use _app_ for LiveAgent Phone app device and _web_ for web device)\n*PhonesApi* | **getPhonesList** | **GET** /phones | Gets list of available phone devices. Special filters (userId - filter phones available for specified user only) \n*PhonesApi* | **removePhone** | **DELETE** /phones/{phoneId} | Remove phone\n*PhonesApi* | **updatePhone** | **PUT** /phones/{phoneId} | Update phone\n*PhonesApi* | **updatePhoneParams** | **PUT** /phones/{phoneId}/_updateParams | Update phone params\n*PredefinedAnswersApi* | **createPredefinedAnswer** | **POST** /predefined_answers | Create predefined answer\n*PredefinedAnswersApi* | **deletePredefinedAnswer** | **DELETE** /predefined_answers/{predefinedAnswerId} | Predefined answer\n*PredefinedAnswersApi* | **getPredefinedAnswer** | **GET** /predefined_answers/{predefinedAnswerId} | Gets canned message\n*PredefinedAnswersApi* | **getPredefinedAnswersList** | **GET** /predefined_answers | Gets list of predefined answers\n*PredefinedAnswersApi* | **updatePredefinedAnswer** | **PUT** /predefined_answers/{predefinedAnswerId} | Update predefined answer\n*QueueApi* | **getQueueBatch** | **GET** /queue/batch/{batchId} | Retrieves the batch status and remaining items to process\n*SettingsApi* | **getSettings** | **GET** /settings | Gets settings list\n*SlackApi* | **getConversation** | **GET** /slack/conversation/{id} | Gets info about Slack workspace channel\n*SlackApi* | **getConversations** | **GET** /slack/conversations | Gets Slack workspace channels\n*SlackApi* | **getSlackUser** | **GET** /slack/user/{id} | Gets info about Slack user\n*SlackApi* | **getTemplate** | **GET** /slack/template/{id} | Get Slack template\n*SlackApi* | **getTemplates** | **GET** /slack/templates/ | Gets Slack notification templates\n*SlackApi* | **getUsers** | **GET** /slack/users | Gets Slack users in workspace\n*SlackApi* | **saveTemplate** | **PUT** /slack/template/{id} | Save Slack template\n*SlasApi* | **getSla** | **GET** /slas/{levelId} | Gets sla\n*SlasApi* | **getSlaTicketHistory** | **GET** /slas/{ticketId}/history | Gets ticket sla history\n*SlasApi* | **getSlasList** | **GET** /slas | Gets list of slas\n*SubscriptionsApi* | **changeAddons** | **PUT** /subscriptions/{subscriptionId}/addons/ | Addon change\n*SubscriptionsApi* | **changePlan** | **POST** /subscriptions/{subscriptionId}/_upgrade | Change plan\n*SubscriptionsApi* | **getActiveAddons** | **GET** /subscriptions/{subscriptionId}/addons/ | Addon list\n*SubscriptionsApi* | **getBillingInfo** | **GET** /subscriptions/{subscriptionId}/billingInfo | Billing info\n*SubscriptionsApi* | **getBillingMetrics** | **GET** /subscriptions/{subscriptionId}/billingMetrics | Billing metrics\n*SubscriptionsApi* | **getBillingStatus** | **GET** /subscriptions/{subscriptionId}/billingStatus | Billing status\n*SubscriptionsApi* | **getDomainInfo** | **GET** /subscriptions/{subscriptionId}/domain | Domain info\n*SubscriptionsApi* | **getPaymentMethod** | **GET** /subscriptions/{subscriptionId}/paymentMethod | Payment method\n*SubscriptionsApi* | **getPaymentProcessor** | **GET** /subscriptions/{subscriptionId}/paymentProcessor | Payment processor\n*SubscriptionsApi* | **getSubscription** | **GET** /subscriptions/{subscriptionId} | Subscription\n*SubscriptionsApi* | **getSubscriptionAttributes** | **GET** /subscriptions/{subscriptionId}/attributes/ | Subscription attribute list\n*SubscriptionsApi* | **getSubscriptionDiscounts** | **GET** /subscriptions/{subscriptionId}/discounts | Subscription discounts\n*SubscriptionsApi* | **getSubscriptionInvoices** | **GET** /subscriptions/{subscriptionId}/invoices/ | Subscription invoice list\n*SubscriptionsApi* | **getUpgradeVariations** | **GET** /subscriptions/{subscriptionId}/upgradeVariations | Upgrade variation list\n*SubscriptionsApi* | **resumeBilling** | **POST** /subscriptions/{subscriptionId}/_cancelStop | Restart billing\n*SubscriptionsApi* | **setBillingInfo** | **PUT** /subscriptions/{subscriptionId}/billingInfo | Billing info\n*SubscriptionsApi* | **setCustomDomain** | **PUT** /subscriptions/{subscriptionId}/domain | Custom domain\n*SubscriptionsApi* | **setPaymentMethod** | **PUT** /subscriptions/{subscriptionId}/paymentMethod | Payment method\n*SubscriptionsApi* | **setSubscriptionUsage** | **PUT** /subscriptions/{subscriptionId}/usage | Subscription usage\n*SubscriptionsApi* | **stopBilling** | **POST** /subscriptions/{subscriptionId}/_stop | Stop billing\n*SubscriptionsApi* | **updateApplication** | **POST** /subscriptions/{subscriptionId}/_update | Update subscription\n*SubscriptionsApi* | **validateBillingInfo** | **POST** /subscriptions/{subscriptionId}/_validateBillingInfo | Test Billing info\n*TagsApi* | **createTag** | **POST** /tags | Create tag\n*TagsApi* | **deleteTag** | **DELETE** /tags/{tagId} | Delete tag\n*TagsApi* | **getTagById** | **GET** /tags/{tagId} | Get tag by tag id\n*TagsApi* | **getTagsList** | **GET** /tags | Gets list of tags\n*TagsApi* | **updateTag** | **PUT** /tags/{tagId} | Update tag\n*TicketsApi* | **createTicket** | **POST** /tickets | Create ticket\n*TicketsApi* | **deleteTicket** | **DELETE** /tickets/{ticketId} | Deletes ticket\n*TicketsApi* | **getTicket** | **GET** /tickets/{ticketId} | Gets ticket\n*TicketsApi* | **getTicketAttribute** | **GET** /tickets/{ticketId}/attributes/{attributeName} | Gets ticket attribute\n*TicketsApi* | **getTicketHistory** | **GET** /tickets/history | Gets ticket\n*TicketsApi* | **getTicketHistoryCount** | **GET** /tickets/history/count | Gets count for ticket history\n*TicketsApi* | **getTicketHistory_0** | **GET** /tickets/{ticketId}/history | Gets ticket history\n*TicketsApi* | **getTicketMessageGroups** | **GET** /tickets/{ticketId}/messages | Gets ticket message groups and messages\n*TicketsApi* | **getTicketSla** | **GET** /tickets/{ticketId}/sla | Gets ticket Sla\n*TicketsApi* | **getTicketsList** | **GET** /tickets | Gets list of tickets\n*TicketsApi* | **setTicketAttribute** | **PUT** /tickets/{ticketId}/attributes/{attributeName} | Sets ticket attribute\n*TicketsApi* | **setTicketPostpone** | **PUT** /tickets/{ticketId}/postpone | Sets postpone status to ticket\n*TicketsApi* | **updateTicket** | **PUT** /tickets/{ticketId} | Updates ticket\n*TokenApi* | **getAccessToken** | **GET** /token | Access token\n*UserApi* | **getUser** | **GET** /users/{userId} | User\n*VariationsApi* | **getVariation** | **GET** /variations/{variationId} | Variation\n*ViberApi* | **changeStatus** | **PUT** /viber_accounts/{accountId}/status | Update Viber account status\n*ViberApi* | **connectAccount** | **POST** /viber_accounts | Connect Viber account\n*ViberApi* | **disconnect** | **DELETE** /viber_accounts/{accountId} | Disconnect Viber account\n*ViberApi* | **get** | **GET** /viber_accounts/{accountId} | Get Viber account\n*ViberApi* | **getAccounts** | **GET** /viber_accounts | Gets Viber accounts\n*ViberApi* | **getAccountsCount** | **GET** /viber_accounts/count | Gets count for Viber accounts\n*ViberApi* | **update** | **PUT** /viber_accounts/{accountId} | Update Viber account\n\n\n## Documentation for Models\n\n - [ActiveTicket](ActiveTicket.md)\n - [Addon](Addon.md)\n - [AddonList](AddonList.md)\n - [Agent](Agent.md)\n - [AgentActivity](AgentActivity.md)\n - [AgentName](AgentName.md)\n - [AgentRow](AgentRow.md)\n - [AgentStatus](AgentStatus.md)\n - [AgentStatuses](AgentStatuses.md)\n - [ApiInfo](ApiInfo.md)\n - [ApiKey](ApiKey.md)\n - [ApiKeyLogin](ApiKeyLogin.md)\n - [ApiKeyValue](ApiKeyValue.md)\n - [ApiKeyWithPrivileges](ApiKeyWithPrivileges.md)\n - [ApiKeyWithPrivilegesAllOf](ApiKeyWithPrivilegesAllOf.md)\n - [ApiPrivilege](ApiPrivilege.md)\n - [AttributeSimple](AttributeSimple.md)\n - [AvailablePrefix](AvailablePrefix.md)\n - [Ban](Ban.md)\n - [BanListItem](BanListItem.md)\n - [BanListItemAllOf](BanListItemAllOf.md)\n - [Batch](Batch.md)\n - [BillingInfo](BillingInfo.md)\n - [BillingMetric](BillingMetric.md)\n - [BillingStatus](BillingStatus.md)\n - [Browser](Browser.md)\n - [BrowserId](BrowserId.md)\n - [Call](Call.md)\n - [CallAgent](CallAgent.md)\n - [CallListItem](CallListItem.md)\n - [CallMessage](CallMessage.md)\n - [CallStatus](CallStatus.md)\n - [CallTransferResult](CallTransferResult.md)\n - [CannedMessage](CannedMessage.md)\n - [ChatInformation](ChatInformation.md)\n - [ChatRow](ChatRow.md)\n - [Company](Company.md)\n - [CompanyAllOf](CompanyAllOf.md)\n - [CompanyListItem](CompanyListItem.md)\n - [CompanyRequest](CompanyRequest.md)\n - [Contact](Contact.md)\n - [ContactAllOf](ContactAllOf.md)\n - [ContactListItem](ContactListItem.md)\n - [ContactPhone](ContactPhone.md)\n - [ContactRequest](ContactRequest.md)\n - [Count](Count.md)\n - [Country](Country.md)\n - [Coupon](Coupon.md)\n - [CreateGmailAccountRequest](CreateGmailAccountRequest.md)\n - [CustomButton](CustomButton.md)\n - [CustomFields](CustomFields.md)\n - [Customer](Customer.md)\n - [DayInterval](DayInterval.md)\n - [Department](Department.md)\n - [DepartmentName](DepartmentName.md)\n - [DepartmentRow](DepartmentRow.md)\n - [Departments](Departments.md)\n - [Device](Device.md)\n - [DeviceDepartment](DeviceDepartment.md)\n - [DeviceDepartmentList](DeviceDepartmentList.md)\n - [DeviceDepartmentPlan](DeviceDepartmentPlan.md)\n - [DeviceDepartmentPlanList](DeviceDepartmentPlanList.md)\n - [DiscountValue](DiscountValue.md)\n - [Domain](Domain.md)\n - [ElasticMessage](ElasticMessage.md)\n - [EmailAddressObj](EmailAddressObj.md)\n - [ErrorResponse](ErrorResponse.md)\n - [EventLogRow](EventLogRow.md)\n - [Extension](Extension.md)\n - [Filter](Filter.md)\n - [FilterCondition](FilterCondition.md)\n - [GmailAccountSettings](GmailAccountSettings.md)\n - [Group](Group.md)\n - [HostingInfo](HostingInfo.md)\n - [Ids](Ids.md)\n - [IndexStatus](IndexStatus.md)\n - [IndexStatusData](IndexStatusData.md)\n - [Invoice](Invoice.md)\n - [InvoiceItem](InvoiceItem.md)\n - [InvoiceList](InvoiceList.md)\n - [Ivr](Ivr.md)\n - [IvrChoice](IvrChoice.md)\n - [IvrFetch](IvrFetch.md)\n - [IvrFetchParam](IvrFetchParam.md)\n - [IvrStep](IvrStep.md)\n - [LegacyDepartmentId](LegacyDepartmentId.md)\n - [MailAccount](MailAccount.md)\n - [Message](Message.md)\n - [MessageGroup](MessageGroup.md)\n - [PageVisit](PageVisit.md)\n - [PaymentInfo](PaymentInfo.md)\n - [PaymentMethod](PaymentMethod.md)\n - [PaymentProcessorType](PaymentProcessorType.md)\n - [PhoneDevice](PhoneDevice.md)\n - [PhoneNumber](PhoneNumber.md)\n - [PredefinedAnswer](PredefinedAnswer.md)\n - [PrincipalCredentials](PrincipalCredentials.md)\n - [ReindexData](ReindexData.md)\n - [Role](Role.md)\n - [SSOKey](SSOKey.md)\n - [SessionId](SessionId.md)\n - [Setting](Setting.md)\n - [Sla](Sla.md)\n - [SlaBusinessHours](SlaBusinessHours.md)\n - [SlaHistory](SlaHistory.md)\n - [SlaLogRow](SlaLogRow.md)\n - [SlaValues](SlaValues.md)\n - [SlackConversation](SlackConversation.md)\n - [SlackTemplate](SlackTemplate.md)\n - [SlackUser](SlackUser.md)\n - [StopReason](StopReason.md)\n - [StoredFile](StoredFile.md)\n - [Subscription](Subscription.md)\n - [Tag](Tag.md)\n - [TagRow](TagRow.md)\n - [Ticket](Ticket.md)\n - [TicketAttribute](TicketAttribute.md)\n - [TicketHistory](TicketHistory.md)\n - [TicketInformation](TicketInformation.md)\n - [TicketListItem](TicketListItem.md)\n - [TicketPostpone](TicketPostpone.md)\n - [TicketRow](TicketRow.md)\n - [TicketSla](TicketSla.md)\n - [TicketUpdatable](TicketUpdatable.md)\n - [TimeReportRow](TimeReportRow.md)\n - [Token](Token.md)\n - [Upgrade](Upgrade.md)\n - [UsageData](UsageData.md)\n - [User](User.md)\n - [UserId](UserId.md)\n - [Variation](Variation.md)\n - [VariationUpgrade](VariationUpgrade.md)\n - [VariationUpgrades](VariationUpgrades.md)\n - [ViberAccount](ViberAccount.md)\n - [ViberAccountListItem](ViberAccountListItem.md)\n - [ViberAccountListItemAllOf](ViberAccountListItemAllOf.md)\n - [Visitor](Visitor.md)\n - [VisitorId](VisitorId.md)\n\n\n## Documentation for Authorization\n\nAuthentication schemes defined for the API:\n### apikey\n\n- **Type**: API key\n- **API key parameter name**: apikey\n- **Location**: HTTP header\n\n\n## Author\n\nsupport@qualityunit.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqualityunit%2Fliveagent-api-scala-akka","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqualityunit%2Fliveagent-api-scala-akka","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqualityunit%2Fliveagent-api-scala-akka/lists"}