{
"swagger": "2.0",
"info": {
"description": "This 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.To 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.liveagent.com\/741982-API-key)Additional info about more advanced agent, contact or ticket API filters can be found [in this article](https:\/\/support.liveagent.com\/513528-APIv3-advanced-filter-examples).If you have any question or doubts regarding this API, please do not hesitate to contact our support team.",
"version": "3.0.0",
"title": "LiveAgent API",
"contact": {
"email": "support@qualityunit.com"
}
},
"host": "support.qualityunit.com",
"basePath": "\/api\/v3\/",
"tags": [
{
"name": "agents"
},
{
"name": "agent_phone"
},
{
"name": "api"
},
{
"name": "bans"
},
{
"name": "billing"
},
{
"name": "calls"
},
{
"name": "canned_messages"
},
{
"name": "companies"
},
{
"name": "contacts"
},
{
"name": "contact_phones"
},
{
"name": "countries"
},
{
"name": "custom_buttons"
},
{
"name": "devices"
},
{
"name": "departments"
},
{
"name": "elastic"
},
{
"name": "extensions"
},
{
"name": "files"
},
{
"name": "filters"
},
{
"name": "grid"
},
{
"name": "groups"
},
{
"name": "hosting"
},
{
"name": "chats"
},
{
"name": "invoices"
},
{
"name": "mail_account"
},
{
"name": "messages"
},
{
"name": "page_visits"
},
{
"name": "phones"
},
{
"name": "phone_numbers"
},
{
"name": "ping"
},
{
"name": "predefined_answers"
},
{
"name": "queue"
},
{
"name": "settings"
},
{
"name": "sip_configuration"
},
{
"name": "slack"
},
{
"name": "slas"
},
{
"name": "subscriptions"
},
{
"name": "tags"
},
{
"name": "tickets"
},
{
"name": "user"
},
{
"name": "variations"
},
{
"name": "viber"
},
{
"name": "time_zones"
}
],
"schemes": [
"https",
"http"
],
"consumes": [
"application\/json"
],
"produces": [
"application\/json",
"application\/pdf"
],
"paths": {
"\/ping": {
"get": {
"tags": [
"ping"
],
"summary": "Check that API is responding",
"operationId": "ping",
"produces": [
"application\/json"
],
"parameters": [],
"security": [
{
"apikey": []
},
{
"privileges": []
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_RestApi_Token::ping",
"x-show": "all"
}
},
"\/agents": {
"get": {
"tags": [
"agents"
],
"summary": "Agent list",
"description": "List of agents",
"operationId": "getAgents",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent.read"
]
}
],
"responses": {
"200": {
"description": "Agent list",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Agent"
}
}
},
"206": {
"description": "Agent list",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Agent"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Agents::getAll",
"x-show": "all"
}
},
"\/agents\/activity": {
"get": {
"tags": [
"agents"
],
"summary": "Agent Activity list",
"description": "List of online agents with their activity status (A - Available, B - Busy) and open tickets.",
"operationId": "_getAgentsActivity",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent.manage"
]
}
],
"responses": {
"200": {
"description": "Agent Activity list",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/AgentActivity"
}
}
},
"206": {
"description": "Agent Activity list",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/AgentActivity"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_AgentsActivity::getList",
"x-show": "all"
}
},
"\/agents\/{userId}": {
"get": {
"tags": [
"agents"
],
"summary": "Agent",
"description": "Retrieves an agent",
"operationId": "getAgent",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent.read",
"agent.own"
]
}
],
"responses": {
"200": {
"description": "Requested agent",
"schema": {
"$ref": "#\/definitions\/Agent"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Agents::getAgent",
"x-show": "all"
},
"delete": {
"tags": [
"agents"
],
"summary": "Agent",
"description": "Deletes an agent",
"operationId": "deleteAgent",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent.manage"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Agents::deleteAgent",
"x-show": "all"
}
},
"\/agents\/{userId}\/updateVoiceStatus": {
"post": {
"tags": [
"agents"
],
"summary": "Update general voice status",
"description": "Update general voice status",
"operationId": "updateCallSettings",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "voiceStatus",
"in": "query",
"required": true,
"type": "string",
"enum": [
"N",
"F"
]
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent.manage",
"agent.own"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Agents::updateVoiceStatus",
"x-show": "all"
}
},
"\/agents\/{userId}\/status": {
"get": {
"tags": [
"agents"
],
"summary": "Get agent statuses in departments",
"description": "Gets agent statuses in departments",
"operationId": "getAgentStatuses",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent_status.read"
]
}
],
"responses": {
"200": {
"description": "Agent statuses",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/AgentStatus"
}
}
},
"404": {
"description": "Agent not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Agents::getAgentStatuses",
"x-show": "all"
}
},
"\/agents\/{userId}\/_pause": {
"post": {
"tags": [
"agents"
],
"summary": "Pause agent",
"description": "Pauses an agent",
"operationId": "pauseAgent",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent_status.manage"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Agents::pauseAgent",
"x-show": "all"
}
},
"\/agents\/{userId}\/_logout": {
"post": {
"tags": [
"agents"
],
"summary": "Logout agent",
"description": "Logout an agent",
"operationId": "logoutAgent",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent_status.manage"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Agents::logoutAgent",
"x-show": "all"
}
},
"\/agents\/{userId}\/login_key": {
"get": {
"tags": [
"agents"
],
"summary": "Get login key",
"description": "Get temporary (10 sec. valid ) key for user to login",
"operationId": "loginKey",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"hosting.login"
]
}
],
"responses": {
"200": {
"description": "User login key",
"schema": {
"$ref": "#\/definitions\/LoginKey"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Agents::getLoginKey",
"x-show": "all"
}
},
"\/agents\/undelete": {
"post": {
"tags": [
"agents"
],
"summary": "Undelete agent",
"description": "Undelete deleted agent",
"operationId": "undeleteAgent",
"produces": [
"application\/json"
],
"parameters": [
{
"in": "body",
"name": "agent",
"required": false,
"schema": {
"$ref": "#\/definitions\/Agent"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent.manage"
]
}
],
"responses": {
"200": {
"description": "Agent that was undeleted",
"schema": {
"$ref": "#\/definitions\/Agent"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Agents::undeleteAgent",
"x-show": "all"
}
},
"\/agents\/convert": {
"post": {
"tags": [
"agents"
],
"summary": "Convert registered visitor",
"description": "Convert registered visitor to agent",
"operationId": "convertRegisteredVisitor",
"produces": [
"application\/json"
],
"parameters": [
{
"in": "body",
"name": "agent",
"required": false,
"schema": {
"$ref": "#\/definitions\/Agent"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent.manage"
]
}
],
"responses": {
"200": {
"description": "Agent that was created",
"schema": {
"$ref": "#\/definitions\/Agent"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Agents::convertRegisteredVisitor",
"x-show": "all"
}
},
"\/bans": {
"get": {
"tags": [
"bans"
],
"summary": "Bans list",
"description": "List of bans",
"operationId": "getBans",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"settings.read"
]
}
],
"responses": {
"200": {
"description": "Bans list",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/BanListItem"
}
}
},
"206": {
"description": "Bans list",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/BanListItem"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Bans::getList",
"x-show": "all"
},
"post": {
"tags": [
"bans"
],
"summary": "Create ban",
"description": "Create new ban record",
"operationId": "createBan",
"produces": [
"application\/json"
],
"parameters": [
{
"in": "body",
"name": "ban",
"required": false,
"schema": {
"$ref": "#\/definitions\/Ban"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"settings.write"
]
}
],
"responses": {
"200": {
"description": "Created ban",
"schema": {
"$ref": "#\/definitions\/Ban"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Bans::createBan",
"x-show": "all"
}
},
"\/bans\/_exclude": {
"put": {
"tags": [
"bans"
],
"summary": "Exclude banned IP address",
"description": "Exclude IP from banned IP ranges",
"operationId": "excludeIPBan",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "ipAddress",
"in": "query",
"description": "IP address you want exclude form IP Ban",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"settings.write"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Bans::excludeIPBan",
"x-show": "all"
}
},
"\/bans\/{banId}": {
"get": {
"tags": [
"bans"
],
"summary": "Get ban item",
"description": "Ban item",
"operationId": "getBan",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "banId",
"in": "path",
"required": true,
"type": "integer"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"settings.read"
]
}
],
"responses": {
"200": {
"description": "Requested ban",
"schema": {
"$ref": "#\/definitions\/Ban"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Bans::getBan",
"x-show": "all"
},
"put": {
"tags": [
"bans"
],
"summary": "Update ban",
"description": "Update ban",
"operationId": "updateBan",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "banId",
"in": "path",
"required": true,
"type": "integer"
},
{
"in": "body",
"name": "ban",
"required": false,
"schema": {
"$ref": "#\/definitions\/Ban"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"settings.write"
]
}
],
"responses": {
"200": {
"description": "Updated ban",
"schema": {
"$ref": "#\/definitions\/Ban"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Bans::updateBan",
"x-show": "all"
}
},
"\/bans\/{banId}\/_expire": {
"post": {
"tags": [
"bans"
],
"summary": "Expire ban",
"description": "Expire ban",
"operationId": "expireBan",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "banId",
"in": "path",
"required": true,
"type": "integer"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"settings.write"
]
}
],
"responses": {
"200": {
"description": "Expired ban",
"schema": {
"$ref": "#\/definitions\/Ban"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Bans::expireBan",
"x-show": "all"
}
},
"\/custom_buttons": {
"get": {
"tags": [
"custom_buttons"
],
"summary": "Gets list of custom buttons",
"operationId": "getCustomButtonsList",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"custom_button.read"
]
}
],
"responses": {
"200": {
"description": "Custom buttons response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/CustomButton"
}
}
},
"206": {
"description": "Custom buttons response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/CustomButton"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_CustomButtons::getList",
"x-show": "all"
},
"post": {
"tags": [
"custom_buttons"
],
"summary": "Create new custom button",
"operationId": "createCustomButton",
"produces": [
"application\/json"
],
"parameters": [
{
"in": "body",
"name": "customButton",
"required": false,
"schema": {
"$ref": "#\/definitions\/CustomButton"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"custom_button.write"
]
}
],
"responses": {
"200": {
"description": "Custom button response",
"schema": {
"$ref": "#\/definitions\/CustomButton"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_CustomButtons::create",
"x-show": "all"
}
},
"\/custom_buttons\/{customButtonId}": {
"get": {
"tags": [
"custom_buttons"
],
"summary": "Get custom button by id",
"operationId": "getCustomButton",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "customButtonId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"custom_button.read"
]
}
],
"responses": {
"200": {
"description": "Custom button response",
"schema": {
"$ref": "#\/definitions\/CustomButton"
}
},
"404": {
"description": "Custom button was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_CustomButtons::get",
"x-show": "all"
},
"put": {
"tags": [
"custom_buttons"
],
"summary": "Update custom button",
"operationId": "updateCustomButton",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "customButtonId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "customButton",
"required": false,
"schema": {
"$ref": "#\/definitions\/CustomButton"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"custom_button.write"
]
}
],
"responses": {
"200": {
"description": "Custom button was updated",
"schema": {
"$ref": "#\/definitions\/CustomButton"
}
},
"404": {
"description": "Custom button was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_CustomButtons::update",
"x-show": "all"
},
"delete": {
"tags": [
"custom_buttons"
],
"summary": "Delete custom button",
"operationId": "deleteCustomButton",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "customButtonId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"custom_button.write"
]
}
],
"responses": {
"200": {
"description": "Custom button was deleted",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"404": {
"description": "Custom button was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_CustomButtons::delete",
"x-show": "all"
}
},
"\/devices": {
"get": {
"tags": [
"devices"
],
"summary": "Gets list of devices",
"operationId": "getDevicesList",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"device.own",
"device.manage",
"agent.manage"
]
}
],
"responses": {
"200": {
"description": "Device response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Device"
}
}
},
"206": {
"description": "Device response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Device"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Devices::getList",
"x-show": "all"
},
"post": {
"tags": [
"devices"
],
"summary": "Create new device",
"operationId": "createDevice",
"produces": [
"application\/json"
],
"parameters": [
{
"in": "body",
"name": "device",
"required": false,
"schema": {
"$ref": "#\/definitions\/Device"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"device.own",
"device.manage"
]
}
],
"responses": {
"200": {
"description": "Device response",
"schema": {
"$ref": "#\/definitions\/Device"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Devices::createDevice",
"x-show": "all"
}
},
"\/devices\/departments\/{departmentId}": {
"get": {
"tags": [
"devices"
],
"summary": "Get device departments by department id",
"operationId": "getDeviceDepartmentsByDepartmentId",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "departmentId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent_status.read"
]
}
],
"responses": {
"200": {
"description": "Device departments response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/DeviceDepartment"
}
}
},
"404": {
"description": "Device was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_DeviceDepartments::getDepartmentsByDepartmentId",
"x-show": "all"
}
},
"\/devices\/departments\/update": {
"put": {
"tags": [
"devices"
],
"summary": "Update device departments",
"operationId": "updateDeviceDepartments",
"produces": [
"application\/json"
],
"parameters": [
{
"in": "body",
"name": "deviceDepartments",
"required": false,
"schema": {
"$ref": "#\/definitions\/DeviceDepartmentList"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent_status.own",
"agent_status.manage"
]
}
],
"responses": {
"200": {
"description": "Device departments response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/DeviceDepartment"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_DeviceDepartments::updateDeviceDepartments",
"x-show": "all"
}
},
"\/devices\/{deviceId}": {
"get": {
"tags": [
"devices"
],
"summary": "Get device by id",
"operationId": "getDevice",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "deviceId",
"in": "path",
"required": true,
"type": "integer"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"device.own",
"device.manage"
]
}
],
"responses": {
"200": {
"description": "Device response",
"schema": {
"$ref": "#\/definitions\/Device"
}
},
"404": {
"description": "Device was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Devices::get",
"x-show": "all"
},
"put": {
"tags": [
"devices"
],
"summary": "Update device",
"operationId": "updateDevice",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "deviceId",
"in": "path",
"required": true,
"type": "integer"
},
{
"in": "body",
"name": "device",
"required": false,
"schema": {
"$ref": "#\/definitions\/Device"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"device.own",
"device.manage"
]
}
],
"responses": {
"200": {
"description": "Device was updated",
"schema": {
"$ref": "#\/definitions\/Device"
}
},
"404": {
"description": "Device was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Devices::updateDevice",
"x-show": "all"
},
"delete": {
"tags": [
"devices"
],
"summary": "Delete device",
"operationId": "deleteDevice",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "deviceId",
"in": "path",
"required": true,
"type": "integer"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"device.own",
"device.manage"
]
}
],
"responses": {
"200": {
"description": "Device was updated",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"404": {
"description": "Device was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Devices::deleteDevice",
"x-show": "all"
}
},
"\/devices\/{deviceId}\/departments": {
"get": {
"tags": [
"devices"
],
"summary": "Get device departments",
"operationId": "getDeviceDepartments",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "deviceId",
"in": "path",
"required": true,
"type": "integer"
},
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_sortFields",
"in": "query",
"description": "'Sort fields (json object {column:direction, ...}).'
Direction can be:
- \"ASC\" (ascending)
- \"DESC\" (descending) If _sortFields is defined, _sortField and _sortDir is ignored.",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent_status.read"
]
}
],
"responses": {
"200": {
"description": "Device departments response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/DeviceDepartment"
}
}
},
"206": {
"description": "Device departments response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/DeviceDepartment"
}
}
},
"404": {
"description": "Device was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_DeviceDepartments::getDepartments",
"x-show": "all"
}
},
"\/devices\/{deviceId}\/departments\/{departmentId}": {
"get": {
"tags": [
"devices"
],
"summary": "Get device department by id",
"operationId": "getDeviceDepartment",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "deviceId",
"in": "path",
"required": true,
"type": "integer"
},
{
"name": "departmentId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent_status.read"
]
}
],
"responses": {
"200": {
"description": "Device department response",
"schema": {
"$ref": "#\/definitions\/DeviceDepartment"
}
},
"404": {
"description": "Device department was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_DeviceDepartments::getDepartment",
"x-show": "all"
},
"put": {
"tags": [
"devices"
],
"summary": "Update device department",
"operationId": "updateDeviceDepartment",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "deviceId",
"in": "path",
"required": true,
"type": "integer"
},
{
"name": "departmentId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "deviceDepartment",
"required": false,
"schema": {
"$ref": "#\/definitions\/DeviceDepartment"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent_status.own",
"agent_status.manage"
]
}
],
"responses": {
"200": {
"description": "Device was updated",
"schema": {
"$ref": "#\/definitions\/DeviceDepartment"
}
},
"404": {
"description": "Device was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_DeviceDepartments::updateDeviceDepartment",
"x-show": "all"
}
},
"\/devices\/{deviceId}\/plans": {
"get": {
"tags": [
"devices"
],
"summary": "Get device plans",
"operationId": "getDevicePlans",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "deviceId",
"in": "path",
"required": true,
"type": "integer"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent_status.read"
]
}
],
"responses": {
"200": {
"description": "Device departments plans response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/IndexedDeviceDepartmentPlans"
}
}
},
"404": {
"description": "Device department was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_DeviceDepartmentPlans::getPlans",
"x-show": "all"
}
},
"\/devices\/{deviceId}\/departments\/{departmentId}\/plans": {
"post": {
"tags": [
"devices"
],
"summary": "Create device department plans",
"operationId": "createDeviceDepartmentPlans",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "deviceId",
"in": "path",
"required": true,
"type": "integer"
},
{
"name": "departmentId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "plan",
"required": false,
"schema": {
"$ref": "#\/definitions\/DeviceDepartmentPlanList"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent_status.own",
"agent_status.manage"
]
}
],
"responses": {
"200": {
"description": "Device department response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/DeviceDepartmentPlan"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_DeviceDepartmentPlans::createPlans",
"x-show": "all"
},
"delete": {
"tags": [
"devices"
],
"summary": "Delete device department plans",
"description": "Deletes a device department plans",
"operationId": "deleteDeviceDepartmentPlans",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "deviceId",
"in": "path",
"required": true,
"type": "integer"
},
{
"name": "departmentId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"agent_status.own",
"agent_status.manage"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"404": {
"description": "Device or department was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_DeviceDepartmentPlans::removePlans",
"x-show": "all"
}
},
"\/calls": {
"get": {
"tags": [
"calls"
],
"summary": "Gets list of calls",
"operationId": "getCallsList",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_perPage",
"in": "query",
"description": "Results per page.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
},
{
"name": "_cursor",
"in": "query",
"description": "used for iteration through resultset. Cursor identifies specific page in resultset.",
"required": false,
"type": "string"
},
{
"name": "_sortField",
"in": "query",
"required": false,
"type": "string",
"default": "dateFinished",
"enum": [
"dateFinished",
"dateCreated"
]
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"call.read"
]
}
],
"responses": {
"200": {
"description": "Call response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/CallListItem"
}
}
},
"206": {
"description": "Call response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/CallListItem"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Calls::getList",
"x-show": "all"
}
},
"\/phones": {
"get": {
"tags": [
"phones"
],
"summary": "Gets list of available phone devices.\nSpecial filters (userId - filter phones available for specified user only)\n",
"operationId": "getPhonesList",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"phone.read",
"phone.own"
]
}
],
"deprecated": true,
"responses": {
"200": {
"description": "PhoneDevices response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PhoneDevice"
}
}
},
"206": {
"description": "PhoneDevices response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PhoneDevice"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Phones::getList",
"x-show": "all"
}
},
"\/phones\/{phoneId}": {
"get": {
"tags": [
"phones"
],
"summary": "Gets phone device (use _app_ for LiveAgent Phone app device and _web_ for web device)",
"operationId": "getPhone",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "phoneId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"phone.read",
"phone.own"
]
}
],
"deprecated": true,
"responses": {
"200": {
"description": "PhoneDevices response",
"schema": {
"$ref": "#\/definitions\/PhoneDevice"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Phones::get",
"x-show": "all"
}
},
"\/phone_numbers": {
"get": {
"tags": [
"phone_numbers"
],
"summary": "Gets list of available phone numbers",
"operationId": "getPhoneNumbersList",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_perPage",
"in": "query",
"description": "Results per page.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"required": false,
"type": "string",
"enum": [
"id",
"number",
"name"
]
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
},
{
"name": "_cursor",
"in": "query",
"description": "used for iteration through resultset. Cursor identifies specific page in resultset.",
"required": false,
"type": "string"
},
{
"name": "additionalObjects",
"in": "query",
"description": "Additional objects",
"required": false,
"type": "array",
"items": {
"type": "string"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"phone.read",
"phone.own"
]
}
],
"responses": {
"200": {
"description": "PhoneNumber response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PhoneNumber"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_PhoneNumbers::getList",
"x-show": "all",
"x-max-page-size": 500
}
},
"\/phone_numbers\/{phoneNumberId}": {
"get": {
"tags": [
"phone_numbers"
],
"summary": "Gets phone number",
"operationId": "getPhoneNumber",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "phoneNumberId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"phone.own",
"phone.read"
]
}
],
"responses": {
"200": {
"description": "PhoneNumber response",
"schema": {
"$ref": "#\/definitions\/PhoneNumber"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_PhoneNumbers::get",
"x-show": "all"
}
},
"\/contacts": {
"get": {
"tags": [
"contacts"
],
"summary": "Gets list of contacts",
"operationId": "getContactsList",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.read"
]
}
],
"responses": {
"200": {
"description": "Contact response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ContactListItem"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Contacts::getList",
"x-show": "all"
},
"post": {
"tags": [
"contacts"
],
"summary": "Create new contact",
"operationId": "createContact",
"produces": [
"application\/json"
],
"parameters": [
{
"in": "body",
"name": "contact",
"required": false,
"schema": {
"$ref": "#\/definitions\/ContactRequest"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.create"
]
}
],
"responses": {
"200": {
"description": "Contact was created",
"schema": {
"$ref": "#\/definitions\/Contact"
}
},
"400": {
"description": "Data is missing",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Contacts::createContact",
"x-show": "all"
}
},
"\/contacts\/{contactId}": {
"get": {
"tags": [
"contacts"
],
"summary": "Get contact by specific id",
"operationId": "getSpecificContact",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "contactId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.read"
]
}
],
"responses": {
"200": {
"description": "Contact response",
"schema": {
"$ref": "#\/definitions\/Contact"
}
},
"404": {
"description": "Contact was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Contacts::getContactById",
"x-show": "all"
},
"put": {
"tags": [
"contacts"
],
"summary": "Update whole contact",
"operationId": "updateContact",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "contactId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "contact",
"required": false,
"schema": {
"$ref": "#\/definitions\/ContactRequest"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.edit"
]
}
],
"responses": {
"200": {
"description": "Contact was updated",
"schema": {
"$ref": "#\/definitions\/Contact"
}
},
"400": {
"description": "Data is missing",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Contacts::updateContact",
"x-show": "all"
},
"delete": {
"tags": [
"contacts"
],
"summary": "Delete contact",
"description": "Deletes a contact",
"operationId": "deleteContact",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "contactId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "deleteTickets",
"in": "query",
"description": "true<\/u>: Delete the customer from all lists and also delete all their tickets.
false<\/u>: Delete the customer from all lists but leave their tickets intact.",
"required": true,
"type": "boolean"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.delete"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"404": {
"description": "Contact was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Contacts::deleteContact",
"x-show": "all"
},
"patch": {
"tags": [
"contacts"
],
"summary": "Update contact partially",
"operationId": "patchContact",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "contactId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "contact",
"required": false,
"schema": {
"$ref": "#\/definitions\/ContactRequest"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.edit"
]
}
],
"responses": {
"200": {
"description": "Contact was updated",
"schema": {
"$ref": "#\/definitions\/Contact"
}
},
"400": {
"description": "Data is missing",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Contacts::patchContact",
"x-show": "all"
}
},
"\/contacts\/{contactId}\/_register": {
"put": {
"tags": [
"contacts"
],
"summary": "Register contact",
"operationId": "registerContact",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "contactId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "registration_email",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "sendRegistrationMail",
"in": "query",
"description": "If this parameter is false, the registration mail will not be sent",
"required": false,
"type": "boolean",
"default": true,
"enum": [
"true",
"false"
]
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.edit"
]
}
],
"responses": {
"200": {
"description": "Contact was registered",
"schema": {
"$ref": "#\/definitions\/Contact"
}
},
"400": {
"description": "Data is missing",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Contacts::registerContact",
"x-show": "all"
}
},
"\/contacts\/{contactId}\/_unregister": {
"delete": {
"tags": [
"contacts"
],
"summary": "Unregister contact",
"operationId": "unregisterContact",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "contactId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.edit"
]
}
],
"responses": {
"200": {
"description": "Contact was unregistered",
"schema": {
"$ref": "#\/definitions\/Contact"
}
},
"400": {
"description": "Data is missing",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Contacts::unregisterContact",
"x-show": "all"
}
},
"\/companies": {
"get": {
"tags": [
"companies"
],
"summary": "Gets list of companies",
"operationId": "getCompaniesList",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.read"
]
}
],
"responses": {
"200": {
"description": "Company response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/CompanyListItem"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Companies::getList",
"x-show": "all"
},
"post": {
"tags": [
"companies"
],
"summary": "Create new company",
"operationId": "createCompany",
"produces": [
"application\/json"
],
"parameters": [
{
"in": "body",
"name": "company",
"required": false,
"schema": {
"$ref": "#\/definitions\/CompanyRequest"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.create"
]
}
],
"responses": {
"200": {
"description": "Company was created",
"schema": {
"$ref": "#\/definitions\/Company"
}
},
"400": {
"description": "Data is missing",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Companies::createCompany",
"x-show": "all"
}
},
"\/companies\/{companyId}": {
"get": {
"tags": [
"companies"
],
"summary": "Get company by specific id",
"operationId": "getSpecificCompany",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "companyId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.read"
]
}
],
"responses": {
"200": {
"description": "Company response",
"schema": {
"$ref": "#\/definitions\/Company"
}
},
"404": {
"description": "Company was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Companies::getCompanyById",
"x-show": "all"
},
"put": {
"tags": [
"companies"
],
"summary": "Update company",
"operationId": "updateCompany",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "companyId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "company",
"required": false,
"schema": {
"$ref": "#\/definitions\/CompanyRequest"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.edit"
]
}
],
"responses": {
"200": {
"description": "Company was updated",
"schema": {
"$ref": "#\/definitions\/Company"
}
},
"400": {
"description": "Data is missing",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Companies::updateCompany",
"x-show": "all"
},
"delete": {
"tags": [
"companies"
],
"summary": "Delete company",
"description": "Deletes a company",
"operationId": "deleteCompany",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "companyId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "deleteTickets",
"in": "query",
"description": "true<\/u>: Delete company from all lists and also delete all its tickets.
false<\/u>: Delete company from all lists but leave its tickets intact.",
"required": true,
"type": "boolean"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.delete"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"404": {
"description": "Company was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Companies::deleteCompany",
"x-show": "all"
}
},
"\/companies\/{companyId}\/_register": {
"put": {
"tags": [
"companies"
],
"summary": "Register company",
"operationId": "registerCompany",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "companyId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "registration_email",
"in": "query",
"required": true,
"type": "string"
},
{
"name": "sendRegistrationMail",
"in": "query",
"description": "If this parameter is false, the registration mail will not be sent",
"required": false,
"type": "boolean",
"default": true,
"enum": [
"true",
"false"
]
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.edit"
]
}
],
"responses": {
"200": {
"description": "Company was registered",
"schema": {
"$ref": "#\/definitions\/Company"
}
},
"400": {
"description": "Data is missing",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Companies::registerContact",
"x-show": "all"
}
},
"\/companies\/{companyId}\/_unregister": {
"delete": {
"tags": [
"companies"
],
"summary": "Unregister company",
"operationId": "unregisterCompany",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "companyId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact.edit"
]
}
],
"responses": {
"200": {
"description": "Company was unregistered",
"schema": {
"$ref": "#\/definitions\/Company"
}
},
"400": {
"description": "Data is missing",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Companies::unregisterContact",
"x-show": "all"
}
},
"\/files": {
"post": {
"tags": [
"files"
],
"summary": "Upload new file to the system",
"operationId": "uploadFile",
"consumes": [
"multipart\/form-data",
"application\/x-www-form-urlencoded"
],
"produces": [
"application\/json"
],
"parameters": [
{
"name": "file",
"in": "formData",
"required": false,
"type": "file"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"file.add"
]
}
],
"responses": {
"200": {
"description": "File response",
"schema": {
"$ref": "#\/definitions\/StoredFile"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Files::upload",
"x-show": "all"
}
},
"\/tags": {
"get": {
"tags": [
"tags"
],
"summary": "Gets list of tags",
"operationId": "getTagsList",
"produces": [
"application\/json"
],
"parameters": [],
"security": [
{
"apikey": []
},
{
"privileges": [
"tag.read"
]
}
],
"responses": {
"200": {
"description": "Tags response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Tag"
}
}
},
"206": {
"description": "Tags response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Tag"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Tag::getList",
"x-show": "all"
},
"post": {
"tags": [
"tags"
],
"summary": "Create tag",
"description": "Create new tag",
"operationId": "createTag",
"produces": [
"application\/json"
],
"parameters": [
{
"in": "body",
"name": "tag",
"required": false,
"schema": {
"$ref": "#\/definitions\/TagRequest"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"tag.manage"
]
}
],
"responses": {
"200": {
"description": "Tag that was created",
"schema": {
"$ref": "#\/definitions\/Tag"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Tag::createTag",
"x-show": "all"
}
},
"\/tags\/{tagId}": {
"get": {
"tags": [
"tags"
],
"summary": "Get tag by tag id",
"operationId": "getTagById",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "tagId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"tag.read"
]
}
],
"responses": {
"200": {
"description": "Tag response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Tag"
}
}
},
"404": {
"description": "Tag was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Tag::getTagById",
"x-show": "all"
},
"put": {
"tags": [
"tags"
],
"summary": "Update tag",
"operationId": "updateTag",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "tagId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "tag",
"required": false,
"schema": {
"$ref": "#\/definitions\/TagRequest"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"tag.manage"
]
}
],
"responses": {
"200": {
"description": "Tag was updated",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Tag"
}
}
},
"400": {
"description": "Data is missing",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Tag::updateTag",
"x-show": "all"
},
"delete": {
"tags": [
"tags"
],
"summary": "Delete tag",
"description": "Deletes a tag",
"operationId": "deleteTag",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "tagId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"tag.manage"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Tag::deleteTag",
"x-show": "all"
}
},
"\/groups": {
"get": {
"tags": [
"groups"
],
"summary": "Gets list of contact groups",
"operationId": "getGroupsList",
"produces": [
"application\/json"
],
"parameters": [],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact_group.read"
]
}
],
"responses": {
"200": {
"description": "Contact groups response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Group"
}
}
},
"206": {
"description": "Contact groups response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Group"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Group::getList",
"x-show": "all"
},
"post": {
"tags": [
"groups"
],
"summary": "Create contact group",
"description": "Create new contact group",
"operationId": "createGroup",
"produces": [
"application\/json"
],
"parameters": [
{
"in": "body",
"name": "group",
"required": false,
"schema": {
"$ref": "#\/definitions\/Group"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact_group.manage"
]
}
],
"responses": {
"200": {
"description": "Contact group that was created",
"schema": {
"$ref": "#\/definitions\/Group"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Group::createGroup",
"x-show": "all"
}
},
"\/groups\/{groupId}": {
"get": {
"tags": [
"groups"
],
"summary": "Get contact group by group id",
"operationId": "getGroupById",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact_group.read"
]
}
],
"responses": {
"200": {
"description": "Contact group response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Group"
}
}
},
"404": {
"description": "Contact group was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Group::getGroupById",
"x-show": "all"
},
"put": {
"tags": [
"groups"
],
"summary": "Update contact group",
"operationId": "updateGroup",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "group",
"required": false,
"schema": {
"$ref": "#\/definitions\/Group"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact_group.manage"
]
}
],
"responses": {
"200": {
"description": "Contact group was updated",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Group"
}
}
},
"400": {
"description": "Data is missing",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Group::updateGroup",
"x-show": "all"
},
"delete": {
"tags": [
"groups"
],
"summary": "Delete contact group",
"description": "Deletes a contact group",
"operationId": "deleteGroup",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "groupId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"contact_group.manage"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Group::deleteGroup",
"x-show": "all"
}
},
"\/canned_messages": {
"get": {
"tags": [
"canned_messages"
],
"summary": "Gets list of canned messages",
"operationId": "getCannedMessagesList",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"canned_message.read"
]
}
],
"responses": {
"200": {
"description": "Canned message response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/CannedMessage"
}
}
},
"206": {
"description": "Canned message response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/CannedMessage"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_CannedMessages::getList",
"x-show": "all"
},
"post": {
"tags": [
"canned_messages"
],
"summary": "Create canned message",
"description": "Create new canned message",
"operationId": "createCannedMessage",
"produces": [
"application\/json"
],
"parameters": [
{
"in": "body",
"name": "canned_message",
"required": false,
"schema": {
"$ref": "#\/definitions\/CannedMessage"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"canned_message.manage"
]
}
],
"responses": {
"200": {
"description": "Canned message that was created",
"schema": {
"$ref": "#\/definitions\/CannedMessage"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_CannedMessages::createCannedMessage",
"x-show": "all"
}
},
"\/canned_messages\/{cannedMessageId}": {
"get": {
"tags": [
"canned_messages"
],
"summary": "Gets canned message",
"operationId": "getCannedMessage",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "cannedMessageId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"canned_message.read"
]
}
],
"responses": {
"200": {
"description": "Canned message response",
"schema": {
"$ref": "#\/definitions\/CannedMessage"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_CannedMessages::getCannedMessage",
"x-show": "all"
},
"put": {
"tags": [
"canned_messages"
],
"summary": "Update canned message",
"description": "Update a canned message",
"operationId": "updateCannedMessage",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "cannedMessageId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "canned_message",
"required": false,
"schema": {
"$ref": "#\/definitions\/CannedMessage"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"canned_message.manage"
]
}
],
"responses": {
"200": {
"description": "Canned message that was updated",
"schema": {
"$ref": "#\/definitions\/CannedMessage"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_CannedMessages::updateCannedMessage",
"x-show": "all"
},
"delete": {
"tags": [
"canned_messages"
],
"summary": "Canned message",
"description": "Deletes a canned message",
"operationId": "deleteCannedMessage",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "cannedMessageId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"canned_message.manage"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_CannedMessages::deleteCannedMessage",
"x-show": "all"
}
},
"\/page_visits\/{contactId}\/contact": {
"get": {
"tags": [
"page_visits"
],
"summary": "Gets a page visits",
"description": "Gets a page visits for user contact id. If elastic search is enabled and it throws\nexception, error is logged and empty array is returned.\n",
"operationId": "getPageVisitByContactId",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "contactId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"page_visit.read"
]
}
],
"responses": {
"200": {
"description": "Page visit response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PageVisit"
}
}
},
"206": {
"description": "Page visit response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PageVisit"
}
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_PageVisit::getPageVisitByContactId",
"x-show": "all"
}
},
"\/predefined_answers": {
"get": {
"tags": [
"predefined_answers"
],
"summary": "Gets list of predefined answers",
"operationId": "getPredefinedAnswersList",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"predefined_answer.read"
]
}
],
"responses": {
"200": {
"description": "Predefined answer response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PredefinedAnswer"
}
}
},
"206": {
"description": "Predefined answer response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/PredefinedAnswer"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_PredefinedAnswers::getList",
"x-show": "all"
},
"post": {
"tags": [
"predefined_answers"
],
"summary": "Create predefined answer",
"description": "Create new predefined answer",
"operationId": "createPredefinedAnswer",
"produces": [
"application\/json"
],
"parameters": [
{
"in": "body",
"name": "predefined_answer",
"required": false,
"schema": {
"$ref": "#\/definitions\/PredefinedAnswer"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"predefined_answer.manage"
]
}
],
"responses": {
"200": {
"description": "Predefined answer that was created",
"schema": {
"$ref": "#\/definitions\/PredefinedAnswer"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_PredefinedAnswers::createPredefinedAnswer",
"x-show": "all"
}
},
"\/predefined_answers\/{predefinedAnswerId}": {
"get": {
"tags": [
"predefined_answers"
],
"summary": "Gets canned message",
"operationId": "getPredefinedAnswer",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "predefinedAnswerId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"predefined_answer.read"
]
}
],
"responses": {
"200": {
"description": "Predefined answer response",
"schema": {
"$ref": "#\/definitions\/PredefinedAnswer"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_PredefinedAnswers::getPredefinedAnswer",
"x-show": "all"
},
"put": {
"tags": [
"predefined_answers"
],
"summary": "Update predefined answer",
"description": "Update a predefined answer",
"operationId": "updatePredefinedAnswer",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "predefinedAnswerId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "predefined_answer",
"required": false,
"schema": {
"$ref": "#\/definitions\/PredefinedAnswer"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"predefined_answer.manage"
]
}
],
"responses": {
"200": {
"description": "Predefined answer that was updated",
"schema": {
"$ref": "#\/definitions\/PredefinedAnswer"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_PredefinedAnswers::updatePredefinedAnswer",
"x-show": "all"
},
"delete": {
"tags": [
"predefined_answers"
],
"summary": "Predefined answer",
"description": "Deletes a predefined answer",
"operationId": "deletePredefinedAnswer",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "predefinedAnswerId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"predefined_answer.manage"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_PredefinedAnswers::deletePredefinedAnswer",
"x-show": "all"
}
},
"\/grid\/reports\/time": {
"get": {
"tags": [
"grid"
],
"summary": "Gets list of reports for time reports grid",
"operationId": "getTimeReportsGridList",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_perPage",
"in": "query",
"description": "Results per page.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
},
{
"name": "_cursor",
"in": "query",
"description": "used for iteration through resultset. Cursor identifies specific page in resultset.",
"required": false,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"time_report.read"
]
}
],
"responses": {
"200": {
"description": "A list of time reports",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TimeReportRow"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_TimeReports::getList",
"x-max-page-size": 5000,
"x-show": "all"
}
},
"\/tickets": {
"get": {
"tags": [
"tickets"
],
"summary": "Gets list of tickets",
"operationId": "getTicketsList",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"required": false,
"type": "string",
"default": "date_created",
"enum": [
"importance",
"date_created",
"date_changed"
]
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"ticket.read",
"ticket.read_all"
]
}
],
"responses": {
"200": {
"description": "Tickets response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Ticket"
}
}
},
"206": {
"description": "Tickets response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Ticket"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Tickets::getList",
"x-handler-no-constructor-params": true,
"x-handler-method-needs-params": true,
"x-show": "all"
},
"post": {
"tags": [
"tickets"
],
"summary": "Create ticket",
"description": "Create new ticket",
"operationId": "createTicket",
"produces": [
"application\/json"
],
"parameters": [
{
"in": "body",
"name": "ticket",
"required": false,
"schema": {
"$ref": "#\/definitions\/TicketListItem"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"ticket.create",
"ticket.answer"
]
}
],
"responses": {
"200": {
"description": "Ticket that was created",
"schema": {
"$ref": "#\/definitions\/TicketInformation"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Tickets::createTicket",
"x-handler-no-constructor-params": true,
"x-show": "all"
}
},
"\/tickets\/history": {
"get": {
"tags": [
"tickets"
],
"summary": "Gets ticket",
"operationId": "_getTicketHistory",
"produces": [
"application\/json",
"text\/csv"
],
"parameters": [
{
"name": "_perPage",
"in": "query",
"description": "Results per page.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
},
{
"name": "_cursor",
"in": "query",
"description": "used for iteration through resultset. Cursor identifies specific page in resultset.",
"required": false,
"type": "string"
},
{
"name": "_sortField",
"in": "query",
"required": false,
"type": "string",
"enum": [
"id",
"conversation_id",
"department_id",
"agent_id",
"status",
"date_from",
"date_to",
"elapsed_time"
]
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"ticket.read"
]
}
],
"responses": {
"200": {
"description": "Ticket response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TicketHistory"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_TicketsHistory::getList",
"x-show": "all",
"x-max-page-size": 500
}
},
"\/tickets\/{ticketId}": {
"get": {
"tags": [
"tickets"
],
"summary": "Gets ticket",
"operationId": "getTicket",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "ticketId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"ticket.read"
]
}
],
"responses": {
"200": {
"description": "Ticket response",
"schema": {
"$ref": "#\/definitions\/Ticket"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Tickets::get",
"x-handler-no-constructor-params": true,
"x-handler-method-needs-params": true,
"x-show": "all"
},
"put": {
"tags": [
"tickets"
],
"summary": "Updates ticket",
"operationId": "updateTicket",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "ticketId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "Ticket",
"required": false,
"schema": {
"$ref": "#\/definitions\/TicketUpdatable"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"ticket.operate"
]
}
],
"responses": {
"200": {
"description": "Ticket response",
"schema": {
"$ref": "#\/definitions\/Ticket"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Tickets::updateTicket",
"x-handler-no-constructor-params": true,
"x-show": "all"
},
"delete": {
"tags": [
"tickets"
],
"summary": "Deletes ticket",
"operationId": "deleteTicket",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "ticketId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"ticket.change_state",
"ticket.close"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Tickets::deleteTicket",
"x-handler-no-constructor-params": true,
"x-show": "all"
}
},
"\/tickets\/{ticketId}\/messages": {
"get": {
"tags": [
"tickets"
],
"summary": "Gets ticket message groups and messages",
"operationId": "getTicketMessageGroups",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "ticketId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "includeQuotedMessages",
"in": "query",
"description": "If set, response will include quoted messages context, otherwise - only metadata.",
"required": false,
"type": "boolean",
"default": false
},
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"ticket.read"
]
}
],
"responses": {
"200": {
"description": "Ticket message groups",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MessageGroup"
}
}
},
"206": {
"description": "Ticket message groups",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/MessageGroup"
}
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_MessageGroups::getTicketMessageGroups",
"x-show": "all"
}
},
"\/tickets\/{ticketId}\/history": {
"get": {
"tags": [
"tickets"
],
"summary": "Gets ticket history",
"operationId": "getTicketHistory",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "ticketId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"ticket.read"
]
}
],
"responses": {
"200": {
"description": "Ticket history",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TicketHistory"
}
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_TicketsHistory::getConversationHistory",
"x-show": "all"
}
},
"\/tickets\/{ticketId}\/sla": {
"get": {
"tags": [
"tickets"
],
"summary": "Gets ticket Sla",
"operationId": "getTicketSla",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "ticketId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"ticket.read"
]
}
],
"responses": {
"200": {
"description": "Ticket SLA response",
"schema": {
"$ref": "#\/definitions\/TicketSla"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Tickets::getTicketSla",
"x-handler-no-constructor-params": true,
"x-handler-method-needs-params": true,
"x-show": "all"
}
},
"\/tickets\/{ticketId}\/postpone": {
"put": {
"tags": [
"tickets"
],
"summary": "Sets postpone status to ticket",
"operationId": "setTicketPostpone",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "ticketId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "postponeData",
"required": false,
"schema": {
"$ref": "#\/definitions\/TicketPostpone"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"ticket.change_state"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"403": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Tickets::setTicketPostpone",
"x-handler-no-constructor-params": true,
"x-show": "all"
}
},
"\/tickets\/{ticketId}\/attributes\/{attributeName}": {
"get": {
"tags": [
"tickets"
],
"summary": "Gets ticket attribute",
"operationId": "getTicketAttribute",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "ticketId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "attributeName",
"in": "path",
"required": true,
"type": "string",
"enum": [
"endChatOrCall",
"note"
]
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"ticket.read"
]
}
],
"responses": {
"200": {
"description": "Ticket attribute",
"schema": {
"$ref": "#\/definitions\/TicketAttribute"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Tickets::getAttribute",
"x-handler-no-constructor-params": true,
"x-show": "all"
},
"put": {
"tags": [
"tickets"
],
"summary": "Sets ticket attribute",
"operationId": "setTicketAttribute",
"consumes": [
"application\/x-www-form-urlencoded"
],
"produces": [
"application\/json"
],
"parameters": [
{
"name": "ticketId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "attributeName",
"in": "path",
"required": true,
"type": "string",
"enum": [
"endChatOrCall",
"note"
]
},
{
"name": "value",
"in": "formData",
"description": "New attribute value",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"ticket.operate"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Tickets::setAttribute",
"x-handler-no-constructor-params": true,
"x-handler-method-needs-params": true,
"x-show": "all"
}
},
"\/departments": {
"get": {
"tags": [
"departments"
],
"summary": "Gets list of departments",
"operationId": "getDepartmentList",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"user.read"
]
}
],
"responses": {
"200": {
"description": "Department response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Department"
}
}
},
"206": {
"description": "Department response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Department"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Departments::getAll",
"x-show": "all"
}
},
"\/departments\/{departmentId}": {
"get": {
"tags": [
"departments"
],
"summary": "Get department by specific id",
"operationId": "getSpecificDepartment",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "departmentId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"user.read"
]
}
],
"responses": {
"200": {
"description": "Department response",
"schema": {
"$ref": "#\/definitions\/Department"
}
},
"404": {
"description": "Department was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Departments::getDepartmentById",
"x-show": "all"
}
},
"\/departments\/{departmentId}\/{agentId}": {
"get": {
"tags": [
"departments"
],
"summary": "Is the agent in the department",
"operationId": "ifAgentIsInDepartment",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "departmentId",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "agentId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"user.read"
]
}
],
"responses": {
"200": {
"description": "Y or N",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"404": {
"description": "Department was not found",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Departments::getAgentInDepartment",
"x-show": "all"
}
},
"\/slas": {
"get": {
"tags": [
"slas"
],
"summary": "Gets list of slas",
"description": "Gets list of slas",
"operationId": "getSlasList",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"sla.read"
]
}
],
"responses": {
"200": {
"description": "Slas response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Sla"
}
}
},
"206": {
"description": "Slas response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Sla"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Slas::getList",
"x-show": "all"
}
},
"\/slas\/{levelId}": {
"get": {
"tags": [
"slas"
],
"summary": "Gets sla",
"description": "Gets sla",
"operationId": "getSla",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "levelId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"sla.read"
]
}
],
"responses": {
"200": {
"description": "Sla response",
"schema": {
"$ref": "#\/definitions\/Sla"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Slas::getById",
"x-show": "all"
}
},
"\/slas\/{ticketId}\/history": {
"get": {
"tags": [
"slas"
],
"summary": "Gets ticket sla history",
"description": "Gets ticket sla history",
"operationId": "getSlaTicketHistory",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "ticketId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"sla.read"
]
}
],
"responses": {
"200": {
"description": "Sla response",
"schema": {
"$ref": "#\/definitions\/SlaHistory"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Slas::getSlaHistory",
"x-show": "all"
}
},
"\/chats": {
"get": {
"tags": [
"chats"
],
"summary": "Gets list of chats",
"operationId": "getChatsList",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"chats.read"
]
}
],
"responses": {
"200": {
"description": "Call response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ChatInformation"
}
}
},
"206": {
"description": "Call response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ChatInformation"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Chats::getList",
"x-show": "all"
}
},
"\/users\/{userId}": {
"get": {
"tags": [
"user"
],
"summary": "User",
"description": "Retrieves a user(users)",
"operationId": "getUser",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"user.read"
]
}
],
"responses": {
"200": {
"description": "Requested user",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/User"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Users::getUsers",
"x-show": "all"
}
},
"\/queue\/batch\/{batchId}": {
"get": {
"tags": [
"queue"
],
"summary": "Retrieves the batch status and remaining items to process",
"description": "Retrieves the batch status and remaining items to process",
"operationId": "getQueueBatch",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "batchId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"ticket.mass"
]
}
],
"responses": {
"200": {
"description": "Batch response",
"schema": {
"$ref": "#\/definitions\/Batch"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_QueueBatch::get",
"x-show": "all"
}
},
"\/filters": {
"get": {
"tags": [
"filters"
],
"summary": "Filters list",
"description": "List of filters",
"operationId": "getFilters",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "_page",
"in": "query",
"description": "Page to display. Not used if _from is defined.",
"required": false,
"type": "integer",
"default": 1
},
{
"name": "_perPage",
"in": "query",
"description": "Results per page. Used only if _page is used.",
"required": false,
"type": "integer",
"default": 10
},
{
"name": "_sortDir",
"in": "query",
"description": "Sorting direction ASC or DESC",
"required": false,
"type": "string",
"default": "ASC",
"enum": [
"ASC",
"DESC"
]
},
{
"name": "_sortField",
"in": "query",
"description": "Sorting field",
"required": false,
"type": "string"
},
{
"name": "_filters",
"in": "query",
"description": "Filter as json object {\"column1\":\"value\", \"column2\":\"value\", ...} or list of filters as json array [[\"column\",\"operator\",\"value\"], ...]",
"required": false,
"type": "string"
},
{
"name": "_from",
"in": "query",
"description": "Result set start. Takes precedence over _page.",
"required": false,
"type": "integer",
"default": 0
},
{
"name": "_to",
"in": "query",
"description": "Result set end. Used only if _from is used.",
"required": false,
"type": "integer",
"default": 0
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"filter.read"
]
}
],
"responses": {
"200": {
"description": "Filters list",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Filter"
}
}
},
"206": {
"description": "Filters list",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Filter"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Filters::getList",
"x-show": "all"
},
"post": {
"tags": [
"filters"
],
"summary": "Create filter",
"description": "Create new filter",
"operationId": "createFilter",
"produces": [
"application\/json"
],
"parameters": [
{
"in": "body",
"name": "filter",
"required": false,
"schema": {
"$ref": "#\/definitions\/Filter"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"filter.write"
]
}
],
"responses": {
"200": {
"description": "Created filter",
"schema": {
"$ref": "#\/definitions\/Filter"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Filters::createFilter",
"x-show": "all"
}
},
"\/filters\/{filterId}": {
"get": {
"tags": [
"filters"
],
"summary": "Get filter",
"description": "Filter",
"operationId": "getFilter",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "filterId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"filter.read"
]
}
],
"responses": {
"200": {
"description": "Requested filter",
"schema": {
"$ref": "#\/definitions\/Filter"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Filters::getFilter",
"x-show": "all"
},
"put": {
"tags": [
"filters"
],
"summary": "Update filter",
"description": "Update filter",
"operationId": "updateFilter",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "filterId",
"in": "path",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "filter",
"required": false,
"schema": {
"$ref": "#\/definitions\/Filter"
}
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"filter.write"
]
}
],
"responses": {
"200": {
"description": "Updated filter",
"schema": {
"$ref": "#\/definitions\/Filter"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Filters::updateFilter",
"x-show": "all"
},
"delete": {
"tags": [
"filters"
],
"summary": "Delete filter",
"description": "Delete filter",
"operationId": "deleteFilter",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "filterId",
"in": "path",
"required": true,
"type": "string"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"filter.write"
]
}
],
"responses": {
"200": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
},
"404": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Filters::deleteFilter",
"x-show": "all"
}
},
"\/settings": {
"get": {
"tags": [
"settings"
],
"summary": "Gets settings list",
"operationId": "getSettings",
"produces": [
"application\/json"
],
"parameters": [
{
"name": "settingsNames",
"in": "query",
"required": false,
"type": "array",
"items": {
"type": "string"
},
"collectionFormat": "pipes"
}
],
"security": [
{
"apikey": []
},
{
"privileges": [
"settings.read"
]
}
],
"responses": {
"200": {
"description": "A list of settings values",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Setting"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Settings::getSettings",
"x-show": "all"
}
},
"\/time_zones": {
"get": {
"tags": [
"time_zones"
],
"summary": "Gets list of timezones",
"description": "Gets list of timezones",
"operationId": "getTimezonesList",
"produces": [
"application\/json"
],
"parameters": [],
"responses": {
"200": {
"description": "Timezones response",
"schema": {
"type": "array",
"items": {
"$ref": "#\/definitions\/TimeZones"
}
}
},
"default": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
}
},
"x-handler": "La_Api_V3_Timezones::getTimeZones",
"x-show": "all"
}
}
},
"securityDefinitions": {
"apikey": {
"type": "apiKey",
"name": "apikey",
"in": "header"
},
"privileges": {
"type": "oauth2",
"authorizationUrl": "https:\/\/www.liveagent.com\/",
"tokenUrl": "https:\/\/www.liveagent.com\/",
"flow": "accessCode",
"scopes": {
"call.read": "Call read",
"agent.own": "Read\/write me",
"agent.read": "Agent read",
"agent.manage": "Agent manage",
"agent_status.read": "Read agent status",
"agent_status.own": "Manage own status",
"agent_status.manage": "Manage agent status",
"phone.read": "Read all phones",
"phone.own": "Read\/write phones available to me",
"user.read": "Read all contacts",
"file.add": "Upload files",
"hosting.login": "agent login",
"tag.read": "Read tags",
"tag.manage": "Manage tags",
"contact_group.read": "Read contact groups",
"contact_group.manage": "Manage contact groups",
"canned_message.read": "Read canned messages",
"canned_message.manage": "Manege canned messages",
"predefined_answer.read": "Read predefined answer",
"predefined_answer.manage": "Manage predefined answer",
"time_report.read": "Read time reports",
"ticket.answer": "Ticket answer",
"ticket.create": "Create new conversation",
"ticket.close": "Close ticket",
"ticket.read": "Ticket read",
"ticket.read_all": "Ticket read all",
"ticket.operate": "Operations with ticket(update)",
"ticket.change_state": "Operations with ticket(change state, delete)",
"ticket.mass": "Ticket mass action (status and remaining items to process)",
"device.own": "Read\/write devices available to me",
"device.manage": "Manage agent devices",
"sla.read": "Read sla",
"chats.read": "Read chats",
"settings.read": "Read ban",
"settings.write": "Write ban",
"page_visit.read": "Read page visits",
"custom_button.read": "Read custom buttons",
"custom_button.write": "Modify custom buttons",
"contact.create": "Create contact",
"contact.read": "Read contact",
"contact.edit": "Edit contact",
"contact.delete": "Delete contact",
"filter.read": "Read filters",
"filter.write": "Write tickets filters"
}
}
},
"definitions": {
"Agent": {
"type": "object",
"required": [
"email",
"name"
],
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"role": {
"type": "string",
"default": "agent",
"enum": [
"owner",
"admin",
"agent"
]
},
"roleId": {
"type": "string"
},
"avatar_url": {
"type": "string"
},
"online_status": {
"type": "string",
"description": "F - offline, N - online, P - paused, C - mobile\n",
"readOnly": true
},
"status": {
"type": "string",
"description": "A - active, X - deleted\n",
"readOnly": true
},
"gender": {
"type": "string",
"description": "M - male, F - female, X - unspecified\n",
"default": "X",
"enum": [
"M",
"F",
"X"
]
},
"last_pswd_change": {
"type": "string",
"format": "date-time"
},
"twofactor_auth": {
"type": "string",
"description": "Y - active, N - not active\n",
"readOnly": true,
"default": "N"
},
"voice_status": {
"type": "string",
"description": "F - Agents are unable to receive calls, however, are able to make calls.\nN - Agents are able to make and receive calls.\n",
"enum": [
"F",
"N"
]
},
"sip_phone_id": {
"type": "string"
}
},
"description": "Agent"
},
"AgentActivity": {
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"agent_status": {
"type": "string",
"description": "A - Available \/ B - Busy\n",
"readOnly": true
},
"active_tickets": {
"type": "array",
"items": {
"$ref": "#\/definitions\/ActiveTicket"
}
}
},
"description": "AgentActivity"
},
"ActiveTicket": {
"type": "object",
"properties": {
"ticket_id": {
"type": "string",
"readOnly": true
},
"ticket_code": {
"type": "string",
"readOnly": true
},
"date_joined": {
"type": "string",
"format": "date-time"
},
"department_id": {
"type": "string"
},
"status": {
"type": "string",
"description": "V - Viewing \/ J - Replying, Chatting \/ R - Ringing \/ C - Calling\n",
"readOnly": true
},
"ticket_status": {
"type": "string",
"description": "C - Opened \/ R - Resolved \/ A - Answered \/ X - Deleted \/ T - Chat \/ P - Call\n",
"readOnly": true
}
},
"description": "ActiveTicket"
},
"Ban": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"date_created": {
"type": "string",
"format": "date-time"
},
"agent_id": {
"type": "string"
},
"start_ip": {
"type": "string",
"format": "IP-address"
},
"end_ip": {
"type": "string",
"format": "IP-address"
},
"date_valid": {
"type": "string",
"format": "date-time"
},
"contact_id": {
"type": "string"
},
"conversation_id": {
"type": "string"
},
"reason": {
"type": "string"
}
}
},
"BanListItem": {
"allOf": [
{
"$ref": "#\/definitions\/Ban"
},
{
"type": "object",
"properties": {
"agent_name": {
"type": "string"
},
"contact_name": {
"type": "string"
},
"conversation_code": {
"type": "string"
}
}
}
]
},
"Batch": {
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"is_committed": {
"type": "boolean",
"readOnly": true
},
"item_count": {
"type": "integer",
"readOnly": true
}
}
},
"ErrorResponse": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
},
"Filter": {
"type": "object",
"properties": {
"filter_id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"filter_type": {
"type": "string"
},
"user_id": {
"type": "string"
},
"rtype": {
"type": "string",
"description": "C - Custom, P - Preset",
"readOnly": true
},
"is_public": {
"type": "boolean",
"readOnly": true
},
"user_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"department_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"conditions": {
"type": "array",
"items": {
"$ref": "#\/definitions\/FilterCondition"
}
}
}
},
"FilterCondition": {
"type": "object",
"properties": {
"field_id": {
"type": "string",
"readOnly": true
},
"section_code": {
"type": "string"
},
"code": {
"type": "string"
},
"operator": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"OkResponse": {
"type": "object"
},
"CallListItem": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ticketId": {
"type": "string"
},
"type": {
"type": "string",
"description": "I - incoming, O - outgoing, T - internal",
"enum": [
"I",
"O",
"T"
]
},
"fromNumber": {
"type": "string"
},
"fromName": {
"type": "string"
},
"toNumber": {
"type": "string"
},
"toName": {
"type": "string"
},
"viaNumber": {
"type": "string"
},
"dateCreated": {
"type": "string",
"format": "date-time"
},
"dateAnswered": {
"type": "string",
"format": "date-time"
},
"dateFinished": {
"type": "string",
"format": "date-time"
},
"callDuration": {
"type": "string"
}
},
"description": "Short version of call"
},
"PhoneDevice": {
"type": "object",
"required": [
"id",
"type"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"description": "A - LiveAgent phone app, S - SIP phone, E - PSTN phone, W - In panel web phone, R - SIP provider extension",
"enum": [
"A",
"S",
"E",
"W",
"R"
]
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"reg_status": {
"type": "string",
"enum": [
"F",
"N"
]
},
"connection_host": {
"type": "string"
},
"connection_user": {
"type": "string"
},
"connection_pass": {
"type": "string"
},
"last_modified": {
"type": "string"
},
"user_agent": {
"type": "string"
},
"agent_id": {
"type": "string"
},
"trunk_id": {
"type": "number"
},
"pass_original_caller_id": {
"type": "string"
},
"params": {
"type": "string",
"description": "Additional params column with no specific meaning"
}
},
"description": "Phone device that can be used by an agent to answer calls"
},
"PhoneNumber": {
"type": "object",
"required": [
"id",
"number"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"description": "S - Asterisk",
"enum": [
"S"
]
},
"dial_out_prefix": {
"type": "integer",
"description": "Prefix needed to originate call using this number",
"minimum": 1,
"maximum": 999
},
"dial_out_prefix_formatted": {
"type": "string",
"description": "Dial out prefix in 2 or 3 digits string format according to application settings"
},
"record_in_call": {
"type": "boolean"
},
"record_out_call": {
"type": "boolean"
},
"number": {
"type": "string"
},
"name": {
"type": "string"
},
"departmentid": {
"type": "string"
},
"department": {
"$ref": "#\/definitions\/Department"
},
"status": {
"type": "string",
"description": "A - Active, I - Inactive",
"enum": [
"A",
"I"
]
},
"status_message": {
"type": "string"
},
"host_settings": {
"type": "string",
"description": "json encoded host settings"
},
"host": {
"type": "string"
},
"port": {
"type": "string"
},
"user": {
"type": "string"
},
"auth_user": {
"type": "string"
},
"password": {
"type": "string"
},
"proxy_host": {
"type": "string"
},
"proxy_port": {
"type": "string"
},
"proxy_user": {
"type": "string"
},
"providerid": {
"type": "string"
},
"ivr": {
"type": "string"
}
},
"description": "Phone number that can receive and originate call"
},
"StoredFile": {
"type": "object",
"required": [
"id"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"type": {
"type": "string"
},
"size": {
"type": "number",
"format": "int"
}
},
"description": "File stored in LiveAgent"
},
"ContactListItem": {
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"company_id": {
"type": "string"
},
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"system_name": {
"type": "string",
"readOnly": true
},
"description": {
"type": "string",
"readOnly": true
},
"avatar_url": {
"type": "string"
},
"type": {
"type": "string",
"description": "V - visitor, R - registered visitor",
"default": "V",
"enum": [
"V",
"R"
]
},
"gender": {
"type": "string",
"description": "M - Male, F - Female, O - Other, X - Unspecified"
},
"date_created": {
"type": "string",
"format": "date-time",
"description": "Set automatically",
"readOnly": true
},
"date_changed": {
"type": "string",
"format": "date-time",
"description": "Set automatically",
"readOnly": true
},
"language": {
"type": "string"
},
"city": {
"type": "string"
},
"countrycode": {
"type": "string"
},
"ip": {
"type": "string"
},
"registration_email": {
"type": "string"
},
"emails": {
"type": "array",
"items": {
"type": "string"
}
},
"phones": {
"type": "array",
"items": {
"type": "string"
}
},
"groups": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Short version of contact"
},
"ContactRequest": {
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"company_id": {
"type": "string"
},
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"system_name": {
"type": "string",
"readOnly": true
},
"description": {
"type": "string",
"readOnly": true
},
"avatar_url": {
"type": "string"
},
"gender": {
"type": "string",
"description": "M - Male, F - Female, O - Other, X - Unspecified"
},
"language": {
"type": "string"
},
"city": {
"type": "string"
},
"countrycode": {
"type": "string"
},
"ip": {
"type": "string"
},
"emails": {
"type": "array",
"items": {
"type": "string"
}
},
"phones": {
"type": "array",
"items": {
"type": "string"
}
},
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"job_position": {
"type": "string"
},
"note": {
"type": "string"
},
"useragent": {
"type": "string"
},
"screen": {
"type": "string"
},
"time_offset": {
"type": "number"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#\/definitions\/CustomFields"
}
}
},
"description": "Long version of contact without date"
},
"Contact": {
"allOf": [
{
"$ref": "#\/definitions\/ContactRequest"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "V - visitor, R - registered visitor",
"default": "V",
"enum": [
"V",
"R"
]
},
"date_created": {
"type": "string",
"format": "date-time",
"description": "Set automatically",
"readOnly": true
},
"date_changed": {
"type": "string",
"format": "date-time",
"description": "Set automatically",
"readOnly": true
}
}
}
],
"description": "Long version of contact"
},
"CompanyListItem": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"system_name": {
"type": "string"
},
"description": {
"type": "string",
"readOnly": true
},
"avatar_url": {
"type": "string"
},
"type": {
"type": "string",
"description": "V - visitor, R - registered visitor",
"default": "V",
"enum": [
"V",
"R"
]
},
"date_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_changed": {
"type": "string",
"format": "date-time",
"description": "Set automatically",
"readOnly": true
},
"language": {
"type": "string"
},
"city": {
"type": "string"
},
"countrycode": {
"type": "string"
},
"ip": {
"type": "string"
},
"emails": {
"type": "array",
"items": {
"type": "string"
}
},
"phones": {
"type": "array",
"items": {
"type": "string"
}
},
"groups": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Short version of company"
},
"CompanyRequest": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"system_name": {
"type": "string"
},
"description": {
"type": "string",
"readOnly": true
},
"avatar_url": {
"type": "string"
},
"language": {
"type": "string"
},
"city": {
"type": "string"
},
"countrycode": {
"type": "string"
},
"ip": {
"type": "string"
},
"emails": {
"type": "array",
"items": {
"type": "string"
}
},
"phones": {
"type": "array",
"items": {
"type": "string"
}
},
"groups": {
"type": "array",
"items": {
"type": "string"
}
},
"note": {
"type": "string"
},
"useragent": {
"type": "string"
},
"screen": {
"type": "string"
},
"time_offset": {
"type": "number"
},
"latitude": {
"type": "number"
},
"longitude": {
"type": "number"
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#\/definitions\/CustomFields"
}
}
},
"description": "Version of company without date"
},
"Company": {
"allOf": [
{
"$ref": "#\/definitions\/CompanyRequest"
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "V - visitor, R - registered visitor",
"default": "V",
"enum": [
"V",
"R"
]
},
"date_created": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"date_changed": {
"type": "string",
"format": "date-time",
"description": "Set automatically",
"readOnly": true
}
}
}
],
"description": "Long version of company"
},
"CustomButton": {
"type": "object",
"required": [
"method",
"type",
"url"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"type": "string"
},
"method": {
"type": "string",
"enum": [
"GET",
"POST"
]
},
"image_url": {
"type": "string"
},
"type": {
"type": "string",
"description": "- E (External) - content will be opened in new browser tab",
"enum": [
"E",
"B"
]
},
"status": {
"type": "string",
"description": "- A - Active - I - Inactive",
"enum": [
"A",
"I"
]
},
"parameters": {
"type": "string"
}
}
},
"CustomFields": {
"type": "object",
"required": [
"code",
"value"
],
"properties": {
"code": {
"type": "string"
},
"value": {
"type": "string"
}
},
"description": "Custom fields"
},
"Tag": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"background_color": {
"type": "string"
},
"is_public": {
"type": "string",
"description": "- Y - Public tag - N - Private tag",
"enum": [
"Y",
"N",
""
]
},
"is_archived": {
"type": "string",
"description": "- Y - Archived tag - N - Active tag",
"enum": [
"Y",
"N"
]
}
},
"description": "Conversation Tag"
},
"TagRequest": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"background_color": {
"type": "string"
},
"is_public": {
"type": "string",
"description": "- Y - Public tag - N - Private tag",
"enum": [
"Y",
"N",
""
]
}
},
"description": "Conversation Tag for create and update operations"
},
"Group": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"color": {
"type": "string"
},
"background_color": {
"type": "string"
}
},
"description": "Contact Group"
},
"CannedMessage": {
"type": "object",
"required": [
"messagetext"
],
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"userid": {
"type": "string"
},
"departmentid": {
"type": "string"
},
"messagetext": {
"type": "string",
"minLength": 1
},
"keywords": {
"type": "string"
}
},
"description": "Canned message"
},
"PageVisit": {
"type": "object",
"properties": {
"browser": {
"type": "string"
},
"date_visit": {
"type": "string",
"format": "date-time"
},
"title": {
"type": "string"
},
"url": {
"type": "string"
},
"referrerurl": {
"type": "string"
}
},
"description": "Page visit"
},
"PredefinedAnswer": {
"type": "object",
"required": [
"body",
"name"
],
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"userid": {
"type": "string"
},
"departmentid": {
"type": "string"
},
"name": {
"type": "string",
"minLength": 1
},
"subject": {
"type": "string"
},
"body": {
"type": "string",
"minLength": 1
},
"format": {
"type": "string",
"description": "Format of body field: T - text, H - html",
"default": "T",
"enum": [
"T",
"H"
]
}
},
"description": "Predefined answer"
},
"TicketAttribute": {
"type": "object",
"required": [
"name"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"description": "Ticket attribute"
},
"TicketUpdatable": {
"type": "object",
"properties": {
"owner_contactid": {
"type": "string"
},
"departmentid": {
"type": "string"
},
"agentid": {
"type": "string"
},
"status": {
"type": "string",
"description": "
I - init
N - new
T - chatting
P - calling
R - resolved
X - deleted
B - spam
A - answered
C - open
W - postponed",
"enum": [
"I",
"N",
"T",
"P",
"R",
"X",
"B",
"A",
"C",
"W"
]
},
"subject": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#\/definitions\/CustomFields"
}
}
},
"description": "Ticket"
},
"TimeReportRow": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"agentid": {
"type": "string"
},
"agent": {
"type": "string"
},
"conversationid": {
"type": "string"
},
"ticket": {
"type": "string"
},
"parent_contactid": {
"type": "string"
},
"company": {
"type": "string"
},
"contactid": {
"type": "string"
},
"customer": {
"type": "string"
},
"customer_firstname": {
"type": "string"
},
"customer_lastname": {
"type": "string"
},
"customer_systemname": {
"type": "string"
},
"agent_ticket": {
"type": "string"
},
"reportdate": {
"type": "string"
},
"reportedtime": {
"type": "string"
},
"reportedtime_hhmmss": {
"type": "string"
},
"spenttime": {
"type": "string"
},
"dateinvoiced": {
"type": "string"
},
"note": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"auto",
"manual"
]
}
},
"description": "Time report"
},
"Ticket": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"owner_contactid": {
"type": "string"
},
"owner_email": {
"type": "string"
},
"owner_name": {
"type": "string"
},
"departmentid": {
"type": "string"
},
"agentid": {
"type": "string"
},
"status": {
"type": "string",
"description": "
I - init
N - new
T - chatting
P - calling
R - resolved
X - deleted
B - spam
A - answered
C - open
W - postponed
L - closed",
"enum": [
"I",
"N",
"T",
"P",
"R",
"X",
"B",
"A",
"C",
"W",
"L"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"code": {
"type": "string"
},
"channel_type": {
"type": "string",
"description": "
E - email
B - contact button
M - contact form
I - invitation
C - call
W - call button
F - facebook
A - facebook message
T - twitter
Q - forum
S - suggestion"
},
"date_created": {
"type": "string"
},
"date_changed": {
"type": "string"
},
"date_resolved": {
"type": "string"
},
"date_due": {
"type": "string"
},
"date_deleted": {
"type": "string"
},
"last_activity": {
"type": "string",
"format": "date-time"
},
"last_activity_public": {
"type": "string"
},
"public_access_urlcode": {
"type": "string"
},
"subject": {
"type": "string"
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#\/definitions\/CustomFields"
}
}
},
"description": "Ticket"
},
"TicketSla": {
"type": "object",
"properties": {
"conversationid": {
"type": "string"
},
"sla_level_id": {
"type": "string"
},
"sla_level_name": {
"type": "string"
},
"first_answer": {
"type": "string",
"format": "date-time"
},
"first_assign": {
"type": "string",
"format": "date-time"
},
"first_resolve": {
"type": "string",
"format": "date-time"
},
"next_answer": {
"type": "string",
"format": "date-time"
}
},
"description": "Ticket SLA"
},
"TicketListItem": {
"type": "object",
"required": [
"departmentid",
"message",
"recipient",
"subject",
"useridentifier"
],
"properties": {
"useridentifier": {
"type": "string"
},
"subject": {
"type": "string"
},
"departmentid": {
"type": "string"
},
"recipient": {
"type": "string"
},
"message": {
"type": "string"
},
"recipient_name": {
"type": "string"
},
"carbon_copies": {
"type": "string"
},
"blind_carbon_copies": {
"type": "string"
},
"status": {
"type": "string",
"description": "
N - new
T - chatting
P - calling
R - resolved
X - deleted
B - spam
A - answered
C - open
W - postponed",
"default": "N",
"enum": [
"N",
"T",
"P",
"R",
"X",
"B",
"A",
"C",
"W"
]
},
"mail_message_id": {
"type": "string"
},
"do_not_send_mail": {
"type": "string",
"description": "Y - yes, N - no",
"default": "N",
"enum": [
"Y",
"N"
]
},
"use_template": {
"type": "string",
"description": "Y - yes, N - no",
"default": "Y",
"enum": [
"Y",
"N"
]
},
"is_html_message": {
"type": "string",
"description": "Y - yes, N - no",
"default": "N",
"enum": [
"Y",
"N"
]
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#\/definitions\/CustomFields"
}
},
"tags": {
"type": "array",
"description": "array of tags id",
"items": {
"type": "string"
}
},
"attachments": {
"type": "string"
}
},
"description": "New ticket items"
},
"TicketInformation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"ownerid": {
"type": "string"
},
"owner_contactid": {
"type": "string"
},
"departmentid": {
"type": "string"
},
"agentid": {
"type": "string"
},
"status": {
"type": "string"
},
"tags": {
"type": "string"
},
"code": {
"type": "string"
},
"channel_type": {
"type": "string"
},
"date_created": {
"type": "string"
},
"public_access_urlcode": {
"type": "string"
},
"subject": {
"type": "string"
},
"custom_fields": {
"type": "array",
"items": {
"$ref": "#\/definitions\/CustomFields"
}
}
},
"description": "Basic ticket information"
},
"TicketPostpone": {
"type": "object",
"required": [
"date_time"
],
"properties": {
"date_time": {
"type": "string",
"description": "- date and time with valid format: YYYY-MM-DD HH:MM:SS"
}
},
"description": "Ticket postpone status"
},
"TicketHistory": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"conversation_id": {
"type": "string"
},
"conversation_code": {
"type": "string"
},
"department_id": {
"type": "string"
},
"department_name": {
"type": "string"
},
"agent_id": {
"type": "string"
},
"status": {
"type": "string"
},
"date_from": {
"type": "string"
},
"date_to": {
"type": "string"
},
"elapsed_time": {
"type": "string"
}
},
"description": "Ticket history"
},
"AgentStatus": {
"type": "object",
"properties": {
"departmentid": {
"type": "string"
},
"online_status": {
"type": "string",
"description": "R - read
M - message
T - chat
P - phone"
},
"preset_status": {
"type": "string",
"description": "R - read
M - message
T - chat
P - phone"
},
"work_allocation_allowed": {
"type": "boolean"
}
},
"description": "Agent department status"
},
"Device": {
"type": "object",
"required": [
"agent_id",
"preset_status",
"service_type",
"type"
],
"properties": {
"id": {
"type": "number"
},
"agent_id": {
"type": "string"
},
"phone_id": {
"type": "string"
},
"phone": {
"$ref": "#\/definitions\/PhoneDevice"
},
"type": {
"type": "string",
"description": "W - WEB A - MOBILE APP E - EXTERNAL (Corresponds to the phone types: SIP, API, PSTN, SIP Provider Extension)",
"enum": [
"W",
"A",
"E"
]
},
"service_type": {
"type": "string",
"description": "M - MESSAGE T - CHAT P - PHONE",
"enum": [
"M",
"T",
"P"
]
},
"online_status": {
"type": "string",
"description": "N - ONLINE F - OFFLINE",
"default": "N",
"enum": [
"N",
"F"
]
},
"preset_status": {
"type": "string",
"description": "N - ONLINE F - OFFLINE",
"enum": [
"N",
"F"
]
},
"route_if_offline": {
"type": "string",
"description": "Y - Yes N - No",
"default": "Y",
"enum": [
"Y",
"N"
]
}
},
"description": "Device object"
},
"DeviceDepartment": {
"type": "object",
"required": [
"department_id",
"device_id",
"user_id"
],
"properties": {
"device_id": {
"type": "integer"
},
"department_id": {
"type": "string"
},
"user_id": {
"type": "string"
},
"department_name": {
"type": "string"
},
"online_status": {
"type": "string"
},
"preset_status": {
"type": "string"
},
"work_allocation_allowed": {
"type": "boolean"
}
},
"description": "Device department object"
},
"DeviceDepartmentList": {
"type": "object",
"properties": {
"DeviceDepartments": {
"type": "array",
"items": {
"$ref": "#\/definitions\/DeviceDepartment"
}
}
},
"description": "Device departments"
},
"DeviceDepartmentPlan": {
"type": "object",
"properties": {
"device_id": {
"type": "number"
},
"department_id": {
"type": "string"
},
"plan_id_start": {
"type": "string"
},
"plan_id_end": {
"type": "string"
},
"day": {
"type": "number"
},
"start": {
"type": "string"
},
"end": {
"type": "string"
},
"title": {
"type": "string"
}
},
"description": "Device department plan object"
},
"DeviceDepartmentPlanList": {
"type": "object",
"properties": {
"DeviceDepartments": {
"type": "array",
"items": {
"$ref": "#\/definitions\/DeviceDepartmentPlan"
}
}
},
"description": "Device department plans"
},
"IndexedDeviceDepartmentPlans": {
"type": "object",
"properties": {
"department_id": {
"type": "string"
},
"plans": {
"type": "array",
"items": {
"$ref": "#\/definitions\/DeviceDepartmentPlan"
}
}
},
"description": "Device department plans indexed by department id"
},
"Department": {
"type": "object",
"properties": {
"department_id": {
"type": "string"
},
"agent_count": {
"type": "number"
},
"name": {
"type": "string"
},
"online_status": {
"type": "string"
},
"agent_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"mailaccount_id": {
"type": "string",
"readOnly": true
}
},
"description": "Department"
},
"MessageGroup": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"userid": {
"type": "string"
},
"user_full_name": {
"type": "string"
},
"type": {
"type": "string",
"description": "M - OFFLINE_LEGACY C - CHAT P - CALL V - OUTGOING_CALL 1 - INTERNAL_CALL I - INTERNAL U - INTERNAL_OFFLINE Z - INTERNAL_COLLAPSED S - STARTINFO T - TRANSFER R - RESOLVE J - POSTPONE X - DELETE B - SPAM G - TAG F - FACEBOOK W - TWITTER Y - RETWEET A - KNOWLEDGEBASE_START K - KNOWLEDGEBASE O - FORWARD Q - FORWARD_REPLY L - SPLITTED 2 - MERGED 3 - INCOMING_EMAIL 4 - OUTGOING_EMAIL 5 - OFFLINE 6 - TYPE_WHATSAPP 7 - TYPE_RECEIVED_ANSWER 8 - TYPE_INSTANT_MESSAGE",
"enum": [
"M",
"C",
"P",
"V",
"1",
"I",
"U",
"Z",
"S",
"T",
"R",
"J",
"X",
"B",
"G",
"F",
"W",
"H",
"E",
"D",
"N",
"Y",
"A",
"K",
"O",
"Q",
"L",
"2",
"3",
"4",
"5",
"6",
"7",
"8"
]
},
"status": {
"type": "string",
"description": "D - DELETED P - PROMOTED V - VISIBLE S - SPLITTED M - MERGED I - INITIALIZING R - CONNECTING C - CALLING",
"enum": [
"D",
"P",
"V",
"S",
"M",
"I",
"R",
"C"
]
},
"datecreated": {
"type": "string",
"format": "date-time"
},
"datefinished": {
"type": "string",
"format": "date-time"
},
"sort_order": {
"type": "integer"
},
"mail_msg_id": {
"type": "string"
},
"pop3_msg_id": {
"type": "string"
},
"messages": {
"type": "array",
"items": {
"$ref": "#\/definitions\/Message"
}
}
}
},
"Message": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"userid": {
"type": "string"
},
"type": {
"type": "string",
"description": "M - MESSAGE Y - MESSAGE_LEGACY Q - QUOTED_TEXT I - INTERNAL F - FILE T - TITLE E - END D - DISCONNECT H - HEADER R - TRANSFER S - SYSTEM U - USERAGENT G - TAG V - VOICE 1 - VOICE_INTERNAL N - NOTE L - NOTE_FILE Z - FORMFIELD A - TEXT_HEADER O - TEXT_FOOTER J - STATUS B - SPLITTED W - RANKING_FEATURE_REWARD P - RANKING_FEATURE_PUNISHMENT C - RANKING_FEATURE_COMMENT K - SYSTEM_PUBLIC X - SYSTEM_VISITOR 0 - ERROR_FOOTER 2 - MERGED 3 - INVITATION_REROUTE 4 - TYPE_MESSAGE_UNDELIVERED 5 - TYPE_LINKED 6 - TYPE_REMOVED_ATTACHMENT",
"enum": [
"M",
"Y",
"Q",
"I",
"F",
"T",
"E",
"D",
"H",
"R",
"S",
"U",
"G",
"V",
"1",
"N",
"L",
"Z",
"A",
"O",
"J",
"B",
"W",
"P",
"C",
"K",
"X",
"0",
"2",
"3",
"4",
"5",
"6"
]
},
"datecreated": {
"type": "string",
"format": "date-time"
},
"format": {
"type": "string",
"description": "T - TEXT H - HTML J - JSON X - TEXT_LEGACY \/\/ text with possibility of internal form links (e.g. note, ranking comment, quoted, header, footer, internal) Y - HTML_LEGACY \/\/ html with possibility of internal form links (e.g. tag) Z - JSON_LEGACY \/\/ json with possibility of internal form links (e.g. footer)",
"enum": [
"T",
"H",
"J",
"X",
"Y",
"Z"
]
},
"message": {
"type": "string"
},
"visibility": {
"type": "string"
}
}
},
"Sla": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"values": {
"$ref": "#\/definitions\/SlaValues"
},
"business_hours": {
"$ref": "#\/definitions\/SlaBusinessHours"
}
},
"description": "Sla Info"
},
"SlaValues": {
"type": "object",
"properties": {
"first_answer": {
"type": "integer"
},
"first_assign": {
"type": "integer"
},
"first_resolve": {
"type": "integer"
},
"next_answer": {
"type": "integer"
},
"chat_answer": {
"type": "integer"
},
"call_answer": {
"type": "integer"
}
},
"description": "All possible SLAs"
},
"SlaBusinessHours": {
"type": "object",
"properties": {
"timezone": {
"type": "string"
},
"monday": {
"$ref": "#\/definitions\/DayInterval"
},
"tuesday": {
"$ref": "#\/definitions\/DayInterval"
},
"wednesday": {
"$ref": "#\/definitions\/DayInterval"
},
"thursday": {
"$ref": "#\/definitions\/DayInterval"
},
"friday": {
"$ref": "#\/definitions\/DayInterval"
},
"saturday": {
"$ref": "#\/definitions\/DayInterval"
},
"sunday": {
"$ref": "#\/definitions\/DayInterval"
},
"exclude_holidays": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
}
}
},
"description": "Sla business hours"
},
"DayInterval": {
"type": "object",
"properties": {
"start": {
"type": "string"
},
"end": {
"type": "string"
}
},
"description": "Start and end hours"
},
"SlaHistory": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sla_level_id": {
"type": "string"
},
"sla_type": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_due": {
"type": "string"
},
"date_closed": {
"type": "string"
},
"total_time": {
"type": "integer"
},
"elapsed_time": {
"type": "integer"
}
},
"description": "Ticket sla history"
},
"ChatInformation": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"subject": {
"type": "string"
},
"preview": {
"type": "string"
},
"chat_order": {
"type": "string",
"format": "date-time"
},
"date_created": {
"type": "string",
"format": "date-time"
},
"status_date_started": {
"type": "string",
"format": "date-time"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"rstatus": {
"type": "string",
"description": "
I - Init
T - Chatting
R - Resolved"
},
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"system_name": {
"type": "string"
},
"avatar_url": {
"type": "string"
},
"countrycode": {
"type": "string"
},
"city": {
"type": "string"
},
"departmentId": {
"type": "string"
},
"agentId": {
"type": "string"
},
"status": {
"type": "string",
"description": "
C - Chatting
T - Finished
R - Ringing
Q - In queue"
},
"emails": {
"type": "array",
"items": {
"type": "string"
}
}
},
"description": "Chat"
},
"User": {
"type": "object",
"properties": {
"id": {
"type": "string",
"readOnly": true
},
"name": {
"type": "string"
},
"email": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"owner",
"admin",
"agent",
"visitor",
"ext_admin",
"reg_visitor",
"system",
"unknown_role"
]
},
"avatar_url": {
"type": "string"
}
},
"description": "User"
},
"Setting": {
"type": "object",
"properties": {
"name": {
"type": "string",
"enum": [
"TIMEZONE",
"regional_settings_is_default",
"dateformat",
"timeformat",
"shorttimeformat",
"thousandsseparator",
"decimalseparator"
]
},
"value": {
"type": "string"
}
},
"description": "Settings value"
},
"LoginKey": {
"type": "object",
"properties": {
"login_key": {
"type": "string"
}
},
"description": "User login key"
},
"TimeZones": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"parameters": {},
"responses": {
"error": {
"description": "Error response",
"schema": {
"$ref": "#\/definitions\/ErrorResponse"
}
},
"ok": {
"description": "OK response",
"schema": {
"$ref": "#\/definitions\/OkResponse"
}
}
}
}