json ID登录-的OpenAPI
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了json ID登录-的OpenAPI相关的知识，希望对你有一定的参考价值。
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "LiveChat REST API",
"description": "## Introduction\n\nWelcome to the LiveChat API documentation!\n\nOur API provides a set of flexible tools which you can use to create new outstanding projects. We smile a bit more each time we see skilled developers unleash their creativity!\n\nPlease note that this documentation refers to the latest API version: 2.0. If you are looking for the previous version, check out the deprecated API 1.0 documentation.\n\n## Basic API usage\n\nAll LiveChat API requests start with `https://api.livechatinc.com/`.\n\nPlease note that all LiveChat API requests must use \\`HTTPS\\` protocol.\n\nThe next segment of the URL path depends on the type of your request. For example, use: `https://api.livechatinc.com/agents` to get or modify the agents data.\n\nAll requests must have \\`X-API-VERSION\\` header set to the number of the version that you'd like to use. The most recent version is 2.\n\n## Authentication\n\nTwo common authentication methods are supported: **OAuth 2.0** and **API key**.\n\n### OAuth 2.0\n\nOAuth 2.0 authentication is the recommended way of authenticating to LiveChat API.\n\nIt is the most secure way of making API calls. With this flow, you will get access only to some parts of LiveChat account, such as reading agents list. This is more secure than [API key flow](https://docs.livechatinc.com/rest-api/#api-key) which has always access to all LiveChat account data.\n\nTo start using OAuth 2.0, please read a dedicated [Authorization](https://docs.livechatinc.com/authorization) guide.\n\n### API key\n\nIf you want to build a private app that will run on your own server, you can skip the OAuth 2.0 flow and use the API key. Please note this flow of making API calls is less secure because the API key gives access to all LiveChat account data.\n\nWith this authorization method, you will need to include your LiveChat login and `API_KEY` for each method call. You’ll find the API key in [your LiveChat profile](https://my.livechatinc.com/agents/api-key).\n\nAuthentication to the API occurs via [HTTP Basic Auth](http://en.wikipedia.org/wiki/Basic_access_authentication). Provide your `login` as the basic auth username and the `API_KEY` as the password. You must authenticate for all requests.\n\nAll API requests must be made over HTTPS.\n\n## Data format\n\nThe LiveChat API returns the data in the [JSON](http://en.wikipedia.org/wiki/JSON) format. Check out the following example.\n\n## JSONP\n\nAll requests made with HTTP GET are [JSONP](http://en.wikipedia.org/wiki/JSONP)-enabled. To use JSONP, append `callback=` and the name of your callback function to the request.\n\n## Error handling\n\nThe errors are returned using the standard HTTP error code syntax. In general, the codes in the 2xx range indicate success, the codes in the 4xx range indicate an error (incorrect or missing parameters, not authenticated etc.), and the codes in the 5xx range indicate an error with the LiveChat servers. Any additional info is included in the body of the return call, JSON-formatted.\n\n### HTTP status codes summary\n\n- `400` – The request is incorrect, please make sure that the passed arguments are matching the format in the method’s documentation.\n- `401` – Unauthorized. You attempt to authenticate with an invalid username or API key.\n- `404` – Not Found. You attempt to request a resource which doesn’t exist.\n- `500` – Internal Server Error. Something unexpected happened on our end. Please try again or contact our support.\n\n## Cross-domain\n\nAll cross-domain API requests made by a web browser are denied for security reasons. It means that the browser-based requests are not allowed from 3rd party domains (including `localhost`).\n\n## LiveChat API libraries\n\nAll API calls include an API key that can be easily stolen when making a request using a web browser. It means you should use backend languages for API requests. Here is a list of the ready-to-use libraries:\n\n- [PHP library for LiveChat API](https://github.com/livechat/api-client-php), hosted on Github.\n- [node.js library for LiveChat API](https://github.com/livechat/api-client-nodejs), hosted on Github.\n- [Ruby library for LiveChat API](https://github.com/cxz/livechat_client), hosted on Github.\n- [C# library for LiveChat API](https://github.com/livechat/api-client-csharp), hosted on Github.\n\n### External LiveChat API libraries\n\n- [R library for LiveChat API](https://github.com/lawwu/livechatR), hosted on Github.\n\nDid you write your own library and want it listed here? Let us know!"
},
"host": "api.livechatinc.com",
"basePath": "/",
"securityDefinitions": {
"auth": {
"type": "oauth2",
"flow": "implicit",
"authorizationUrl": "http://example.com/auth",
"scopes": {},
"x-skip-client-authentication": false
}
},
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/webhooks/12345": {
"delete": {
"description": "Deletes a webhook with the given ID.\n\n",
"summary": "Delete a webhook",
"tags": [
"Webhooks"
],
"operationId": "Webhooks12345Delete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/webhooks/12345",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a webhook",
"x-testDescription": "Deletes a webhook with the given ID.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/chats/ratings": {
"get": {
"description": "Shows how many chats have been rated and how they have been rated during a specified period.\n\n",
"summary": "Chat ratings report",
"tags": [
"Reports"
],
"operationId": "ReportsChatsRatingsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "group",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "date_from",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "date_to",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "group_by",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/chats/ratings?group=2&date_from=2012-01-29&date_to=2013-01-29&group_by=month",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Chat ratings report",
"x-testDescription": "Shows how many chats have been rated and how they have been rated during a specified period.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/canned_responses/ABC123": {
"get": {
"description": "Returns the list of all currently set canned responses.",
"summary": "List all canned responses1",
"tags": [
"Canned responses"
],
"operationId": "CannedResponsesABC123Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/canned_responses/ABC123",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List all canned responses1",
"x-testDescription": "Returns the list of all currently set canned responses."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Updates the specified canned response by setting the values of the parameters passed. Any parameters not provided will be left unchanged.\n\n",
"summary": "Update a canned response",
"tags": [
"Canned responses"
],
"operationId": "CannedResponsesABC123Put",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "tags[0]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/canned_responses/ABC123",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "tags[0]=bye"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a canned response",
"x-testDescription": "Updates the specified canned response by setting the values of the parameters passed. Any parameters not provided will be left unchanged.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Removes a canned response with the given CANNED_RESPONSE_ID.",
"summary": "Remove a canned response",
"tags": [
"Canned responses"
],
"operationId": "CannedResponsesABC123Delete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/canned_responses/ABC123",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Remove a canned response",
"x-testDescription": "Removes a canned response with the given CANNED_RESPONSE_ID."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/groups/ABC123": {
"put": {
"description": "Updates the specified group by setting the values of the parameters passed. Any parameters not provided will be left unchanged.\n\n",
"summary": "Update a group",
"tags": [
"Groups"
],
"operationId": "GroupsABC123Put",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "name",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "agents[0]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "agents[1]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/groups/ABC123",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "name=Quality+Assurance&agents[0]=john.doe@mycompany.com&agents[1]=jane.doe@mycompany.com"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a group",
"x-testDescription": "Updates the specified group by setting the values of the parameters passed. Any parameters not provided will be left unchanged.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Removes a group with the given GROUP_ID.",
"summary": "Remove a group",
"tags": [
"Goals"
],
"operationId": "GroupsABC123Delete2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/groups/ABC123",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Remove a group",
"x-testDescription": "Removes a group with the given GROUP_ID."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/chats/engagement": {
"get": {
"description": "This report shows you where you get your chats from. They can come from i.e. automatic invitations, manual invitations or the visitors can start the chats by themselves.",
"summary": "Chat engagement",
"tags": [
"Reports"
],
"operationId": "ReportsChatsEngagementGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "date_to",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "agent",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "group_by",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/chats/engagement?date_from=2013-01-29&date_to=2013-01-29&agent=john.doe@mycompany.com&group_by=hour",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Chat engagement",
"x-testDescription": "This report shows you where you get your chats from. They can come from i.e. automatic invitations, manual invitations or the visitors can start the chats by themselves."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/greetings": {
"get": {
"description": "Returns the list of all greetings.",
"summary": "List all greetings",
"tags": [
"Greetings"
],
"operationId": "GreetingsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "groups",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/greetings?groups=ABC123",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List all greetings",
"x-testDescription": "Returns the list of all greetings."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Use this function to create a new greeting.",
"summary": "Create a new greeting",
"tags": [
"Greetings"
],
"operationId": "GreetingsPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "name",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "rules[0][type]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "rules[0][value]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "rules[0][operator]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "rules[1][type]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "rules[1][value]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "rules[1][operator]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/greetings",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "name=my custom invitation&rules[0][type]=visit_time_page&rules[0][value]=15&rules[0][operator]=greater_than&rules[1][type]=visits_number&rules[1][value]=2&rules[1][operator]=greater_or_equal"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new greeting",
"x-testDescription": "Use this function to create a new greeting."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/webhooks": {
"get": {
"description": "Returns a list of webhooks that have been created in a LiveChat account.\n\n",
"summary": "Display configured webhooks",
"tags": [
"Webhooks"
],
"operationId": "WebhooksGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/webhooks",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Display configured webhooks",
"x-testDescription": "Returns a list of webhooks that have been created in a LiveChat account.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Creates a new webhook.\n\n",
"summary": "Create a new webhook",
"tags": [
"Webhooks"
],
"operationId": "WebhooksPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "event_type",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "data_types[]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "url",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/webhooks",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "event_type=chat_started&data_types[]=chat&url=http://my-company.com/parse_webhook.php"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new webhook",
"x-testDescription": "Creates a new webhook.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/chats/greetings": {
"get": {
"description": "Returns the “greetings to chats to goals” conversion rates report.\n\ndisplayed is the number of displayed greetings. accepted tells you how many chats resulted from these greetings. goals tells you how many goals resulted from these greetings.\n\n",
"summary": "Greetings",
"tags": [
"Reports"
],
"operationId": "ReportsChatsGreetingsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "date_to",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "group_by",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/chats/greetings?date_from=2014-01-13&date_to=2014-02-14&group_by=month",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Greetings",
"x-testDescription": "Returns the “greetings to chats to goals” conversion rates report.\n\ndisplayed is the number of displayed greetings. accepted tells you how many chats resulted from these greetings. goals tells you how many goals resulted from these greetings.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/tags": {
"get": {
"description": "Returns tags from all groups.\n\n",
"summary": "List all tags",
"tags": [
"Tags"
],
"operationId": "TagsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "group",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/tags?group=1",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List all tags",
"x-testDescription": "Returns tags from all groups.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Adds a new tag. Note that only the owner and the admins are authorized to use this.\n\n",
"summary": "Add a tag",
"tags": [
"Tags"
],
"operationId": "TagsPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "tag",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "author",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "group",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/tags",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "tag=support&author=john.doe@mycompany.com&group=1"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Add a tag",
"x-testDescription": "Adds a new tag. Note that only the owner and the admins are authorized to use this.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/agents/john@public.com": {
"get": {
"description": "Returns complete details of the agent for the given LOGIN.",
"summary": "Get a single agent details",
"tags": [
"Agents"
],
"operationId": "AgentsJohnPublicComGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/agents/john@public.com",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single agent details",
"x-testDescription": "Returns complete details of the agent for the given LOGIN."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Returns complete details of the agent for the given LOGIN.",
"summary": "Get a single agent details",
"tags": [
"Agents"
],
"operationId": "AgentsJohnPublicComPut",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "job_title",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/agents/john@public.com",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "job_title=Super Support Agent"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single agent details1",
"x-testDescription": "Returns complete details of the agent for the given LOGIN."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Removes an agent.",
"summary": "Remove an agent",
"tags": [
"Agents"
],
"operationId": "AgentsJohnPublicComDelete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/agents/john@public.com",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Remove an agent",
"x-testDescription": "Removes an agent."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/tickets": {
"get": {
"description": "Returns all tickets.\n\n",
"summary": "Get list of tickets",
"tags": [
"Tickets"
],
"operationId": "TicketsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "status",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/tickets?date_from=2013-11-15&status=open",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get list of tickets",
"x-testDescription": "Returns all tickets.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Creates a new ticket.\n\n",
"summary": "Create a ticket",
"tags": [
"Tickets"
],
"operationId": "TicketsPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "subject",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "message",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "requester[mail]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "requester[name]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": "",
"schema": {
"$ref": "#/definitions/CreateATicketresponse"
}
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/tickets/solved_tickets": {
"get": {
"description": "Shows the number of the tickets solved during the specified period.\n\n",
"summary": "Solved tickets",
"tags": [
"Reports"
],
"operationId": "ReportsTicketsSolvedTicketsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "date_to",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/tickets/solved_tickets?date_from=2014-01-10&date_to=2014-01-20",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Solved tickets",
"x-testDescription": "Shows the number of the tickets solved during the specified period.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/chats/first_response_time": {
"get": {
"description": "The average amount of time it takes the agents to respond to a new chat over a specified period of time.",
"summary": "Chats first response time",
"tags": [
"Reports"
],
"operationId": "ReportsChatsFirstResponseTimeGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/chats/first_response_time",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Chats first response time",
"x-testDescription": "The average amount of time it takes the agents to respond to a new chat over a specified period of time."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/canned_responses": {
"get": {
"description": "Returns the list of all currently set canned responses.",
"summary": "List all canned responses",
"tags": [
"Canned responses"
],
"operationId": "CannedResponsesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/canned_responses",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List all canned responses",
"x-testDescription": "Returns the list of all currently set canned responses."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Creates a new canned response.\n\n",
"summary": "Create a new canned response",
"tags": [
"Canned responses"
],
"operationId": "CannedResponsesPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "text",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "tags[0]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "tags[1]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/canned_responses",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "text=Have a great day, goodbye.&tags[0]=bye&tags[1]=cu"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new canned response",
"x-testDescription": "Creates a new canned response.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/chats/ratings/ranking": {
"get": {
"description": "Shows the ratio of good to bad ratings for each operator.",
"summary": "Chat Ranking",
"tags": [
"Reports"
],
"operationId": "ReportsChatsRatingsRankingGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/chats/ratings/ranking",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Chat Ranking",
"x-testDescription": "Shows the ratio of good to bad ratings for each operator."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/groups": {
"get": {
"description": "Returns all created groups.\n\n",
"summary": "List all groups",
"tags": [
"Groups"
],
"operationId": "GroupsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/groups",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List all groups",
"x-testDescription": "Returns all created groups.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Creates a new group in your license.\n\n",
"summary": "Create a new group",
"tags": [
"Groups"
],
"operationId": "GroupsPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "name",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "agents[0]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "agents[1]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/groups",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "name=Human Resources&agents[0]=jenny.doe@mycompany.com&agents[1]=john.doe@mycompany.com"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new group",
"x-testDescription": "Creates a new group in your license.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/chats/ABC123": {
"get": {
"description": "Returns a single chat item for the given CHAT_ID.",
"summary": "Get single chat",
"tags": [
"Archives"
],
"operationId": "ChatsABC123Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/chats/ABC123",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get single chat",
"x-testDescription": "Returns a single chat item for the given CHAT_ID."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/tickets/ticket_sources": {
"get": {
"description": "Shows the distribution of the tickets between various channels.",
"summary": "Ticket sources",
"tags": [
"Reports"
],
"operationId": "ReportsTicketsTicketSourcesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "date_to",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/tickets/ticket_sources?date_from=2014-01-10&date_to=2014-01-20",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Ticket sources",
"x-testDescription": "Shows the distribution of the tickets between various channels."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/greetings/ABC123": {
"get": {
"description": "Returns the specified greeting.\n\n",
"summary": "Get a single greeting",
"tags": [
"Greetings"
],
"operationId": "GreetingsABC123Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/greetings/ABC123",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single greeting",
"x-testDescription": "Returns the specified greeting.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Removes a greeting.",
"summary": "Remove a greeting",
"tags": [
"Greetings"
],
"operationId": "GreetingsABC123Delete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/greetings/ABC123",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Remove a greeting",
"x-testDescription": "Removes a greeting."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/groups/{group_id}": {
"get": {
"description": "Returns group details for the given GROUP_ID.\n",
"summary": "Get a single group details",
"tags": [
"Groups"
],
"operationId": "GroupsByGroupIdGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "group_id",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/chats/total_chats": {
"get": {
"description": "Shows how many chats occurred during the specified period.\n\n",
"summary": "Total chats",
"tags": [
"Reports"
],
"operationId": "ReportsChatsTotalChatsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "date_to",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "agent",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "group_by",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/chats/total_chats?date_from=2013-01-29&date_to=2013-01-29&agent=john.doe@mycompany.com&group_by=hour",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Total chats",
"x-testDescription": "Shows how many chats occurred during the specified period.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/goals": {
"get": {
"description": "Returns all currently set goals. The active parameter indicates whether a goal is enabled or not.",
"summary": "List all goals",
"tags": [
"Goals"
],
"operationId": "GoalsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/goals",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List all goals",
"x-testDescription": "Returns all currently set goals. The active parameter indicates whether a goal is enabled or not."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Creates a new goal.\n\n",
"summary": "Add a new goal",
"tags": [
"Goals"
],
"operationId": "GoalsPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "name",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "type",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "url",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "match_type",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/goals",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "name=new_goal&type=url&url=http://www.mystore.com/checkout/thank_you&match_type=exact"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Add a new goal",
"x-testDescription": "Creates a new goal.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/chats": {
"get": {
"description": "Returns all ended chats.",
"summary": "Get list of chats",
"tags": [
"Archives"
],
"operationId": "ChatsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/chats",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get list of chats",
"x-testDescription": "Returns all ended chats."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/agents": {
"get": {
"description": "Returns all LiveChat agents list",
"summary": "List all agents",
"tags": [
"Agents"
],
"operationId": "AgentsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/agents",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List all agents",
"x-testDescription": "Returns all LiveChat agents list"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Creates a new agent in your license.\n\n",
"summary": "Create a new agent",
"tags": [
"Agents"
],
"operationId": "AgentsPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "login",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "name",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/agents",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "login=john@public.com&name=John Public"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Create a new agent",
"x-testDescription": "Creates a new agent in your license.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/goals/ABC123": {
"get": {
"description": "Returns the goal details for the given GOAL_ID.",
"summary": "Get a single goal details",
"tags": [
"Goals"
],
"operationId": "GoalsABC123Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/goals/ABC123",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get a single goal details",
"x-testDescription": "Returns the goal details for the given GOAL_ID."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"put": {
"description": "Updates the specified goal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.\n\nThe GOAL_ID is obtained from the goals list.",
"summary": "Update a goal",
"tags": [
"Goals"
],
"operationId": "GoalsABC123Put",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "name",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "active",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/goals/ABC123",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "name=new_goal&active=0"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update a goal",
"x-testDescription": "Updates the specified goal by setting the values of the parameters passed. Any parameters not provided will be left unchanged.\n\nThe GOAL_ID is obtained from the goals list."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"delete": {
"description": "Removes a goal with the given GOAL_ID.\n\n",
"summary": "Remove a goal",
"tags": [
"Goals"
],
"operationId": "GoalsABC123Delete",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/goals/ABC123",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Remove a goal",
"x-testDescription": "Removes a goal with the given GOAL_ID.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/tickets/ratings": {
"get": {
"description": "Shows the tickets that were rated during the specified period.\n\n",
"summary": "Ticket ratings report",
"tags": [
"Reports"
],
"operationId": "ReportsTicketsRatingsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "group",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "date_from",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "date_to",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "group_by",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/tickets/ratings?group=2&date_from=2012-01-29&date_to=2013-01-29&group_by=month",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Ticket ratings report",
"x-testDescription": "Shows the tickets that were rated during the specified period.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/tickets/5FUED/tags": {
"put": {
"description": "Updates tags associated with the ticket.\n\n",
"summary": "Update ticket tags",
"tags": [
"Tickets"
],
"operationId": "Tickets5FUEDTagsPut",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "tag[]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/tickets/5FUED/tags",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "tag[]=sales"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update ticket tags",
"x-testDescription": "Updates tags associated with the ticket.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/tickets/ratings/ranking": {
"get": {
"description": "Shows the ratio of good to bad ratings for each operator.\n\n",
"summary": "Ticket Ranking",
"tags": [
"Reports"
],
"operationId": "ReportsTicketsRatingsRankingGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/tickets/ratings/ranking",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Ticket Ranking",
"x-testDescription": "Shows the ratio of good to bad ratings for each operator.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/chats/response_time": {
"get": {
"description": "The average amount of time it takes the agents to respond to a new message in a chat during a specified period.",
"summary": "Chats response time",
"tags": [
"Reports"
],
"operationId": "ReportsChatsResponseTimeGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/chats/response_time",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Chats response time",
"x-testDescription": "The average amount of time it takes the agents to respond to a new message in a chat during a specified period."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/availability": {
"get": {
"description": "Shows how long an agent (or a group or the whole account) was available for chatting during a specified period. When querying for one day, the results are shown in minutes per every hour, otherwise in hours for each day.",
"summary": "Availability",
"tags": [
"Reports"
],
"operationId": "ReportsAvailabilityGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/availability",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Availability",
"x-testDescription": "Shows how long an agent (or a group or the whole account) was available for chatting during a specified period. When querying for one day, the results are shown in minutes per every hour, otherwise in hours for each day."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/chats/ABC123/tags": {
"put": {
"description": "This method updates the tags assigned to a chat.\n\n",
"summary": "Update chat tags",
"tags": [
"Archives"
],
"operationId": "ChatsABC123TagsPut",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "tag[0]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "tag[1]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/chats/ABC123/tags",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "tag[0]=support&tag[1]=feedback"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update chat tags",
"x-testDescription": "This method updates the tags assigned to a chat.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/visitors": {
"get": {
"description": "Returns a list of the visitors on the pages with the tracking code installed.\n\n",
"summary": "List all visitors",
"tags": [
"Visitors"
],
"operationId": "VisitorsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "state",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "group[]",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/visitors?state=chatting&group[]=0",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "List all visitors",
"x-testDescription": "Returns a list of the visitors on the pages with the tracking code installed.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/tickets/resolution_time": {
"get": {
"description": "Shows the resolution time of the tickets that were solved during the specified period.\n\n",
"summary": "Tickets resolution time",
"tags": [
"Reports"
],
"operationId": "ReportsTicketsResolutionTimeGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "date_to",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/tickets/resolution_time?date_from=2014-01-10&date_to=2014-01-20",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Tickets resolution time",
"x-testDescription": "Shows the resolution time of the tickets that were solved during the specified period.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/tags/support": {
"delete": {
"description": "Deletes a tag from the chosen group. The agents will no longer be able to tag chats and tickets using this tag.\n\nDeleting a tag will not remove it from the archived chats and tickets.\n",
"summary": "Delete a tag",
"tags": [
"Tags"
],
"operationId": "TagsSupportDelete",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "group",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "DELETE",
"uri": "/tags/support",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "group=1"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Delete a tag",
"x-testDescription": "Deletes a tag from the chosen group. The agents will no longer be able to tag chats and tickets using this tag.\n\nDeleting a tag will not remove it from the archived chats and tickets.\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/chats/goals": {
"get": {
"description": "Shows the number of reached goals.\n\n",
"summary": "Goals",
"tags": [
"Reports"
],
"operationId": "ReportsChatsGoalsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "goal",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "group_by",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/chats/goals?date_from=2013-01-01&goal=71&group_by=month",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Goals",
"x-testDescription": "Shows the number of reached goals.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/chats/queued_visitors": {
"get": {
"description": "Shows how many visitors waited in the queue and how many abandoned the queue or proceeded to chats",
"summary": "Queued visitors",
"tags": [
"Reports"
],
"operationId": "ReportsChatsQueuedVisitorsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "group",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/chats/queued_visitors?date_from=2013-01-29&group=2",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Queued visitors",
"x-testDescription": "Shows how many visitors waited in the queue and how many abandoned the queue or proceeded to chats"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/chats/queued_visitors/waiting_times": {
"get": {
"description": "Shows the Minimum, Average and Maximum waiting time.",
"summary": "Queue waiting times",
"tags": [
"Reports"
],
"operationId": "ReportsChatsQueuedVisitorsWaitingTimesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "group",
"in": "query",
"required": true,
"type": "integer",
"format": "int32",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/chats/queued_visitors/waiting_times?date_from=2013-01-29&group=2",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Queue waiting times",
"x-testDescription": "Shows the Minimum, Average and Maximum waiting time."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/chats/chatting_time": {
"get": {
"description": "Shows how much time an agent (or a group) spent on chatting during a specified period. When querying for one day, the results are shown in minutes per every hour, otherwise in hours for each day.",
"summary": "Chatting time",
"tags": [
"Reports"
],
"operationId": "ReportsChatsChattingTimeGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/chats/chatting_time",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Chatting time",
"x-testDescription": "Shows how much time an agent (or a group) spent on chatting during a specified period. When querying for one day, the results are shown in minutes per every hour, otherwise in hours for each day."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/goals/ABC123/mark_as_successful": {
"post": {
"description": "The GOAL_ID is obtained from the goals list.",
"summary": "Mark a goal as successful",
"tags": [
"Goals"
],
"operationId": "GoalsABC123MarkAsSuccessfulPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "visitor_id",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/goals/ABC123/mark_as_successful",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "visitor_id=ABC123"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Mark a goal as successful",
"x-testDescription": "The GOAL_ID is obtained from the goals list."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/status": {
"get": {
"description": "Returns the current LiveChat status. Available return values: online, offline.\n\n",
"summary": "Get status",
"tags": [
"Status"
],
"operationId": "StatusGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/status",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get status",
"x-testDescription": "Returns the current LiveChat status. Available return values: online, offline.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/greetings/2491": {
"put": {
"description": "Use this request to change the name or message of a greeting.",
"summary": "Update greeting",
"tags": [
"Greetings"
],
"operationId": "Greetings2491Put",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "name",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "properties[greeting-message_text]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "PUT",
"uri": "/greetings/2491",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "name=athletic shoes&properties[greeting-message_text]=Hello"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Update greeting",
"x-testDescription": "Use this request to change the name or message of a greeting."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/tickets/first_response_time": {
"get": {
"description": "Shows the time of the first response to the tickets that were responded to for the first time during the specified period.",
"summary": "Tickets first response time",
"tags": [
"Reports"
],
"operationId": "ReportsTicketsFirstResponseTimeGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "date_to",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "agent",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/tickets/first_response_time?date_from=2014-01-10&date_to=2014-01-20&agent=john.doe@mycompany.com",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Tickets first response time",
"x-testDescription": "Shows the time of the first response to the tickets that were responded to for the first time during the specified period."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/chats/ABC123/send_transcript": {
"post": {
"summary": "Send chat transcript to e-mail",
"tags": [
"Archives"
],
"operationId": "ChatsABC123SendTranscriptPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/chats/ABC123/send_transcript",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Send chat transcript to e-mail"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/chats/agents_occupancy": {
"get": {
"description": "This request shows the maximum number of concurrent chats that happened at the same hour on a particular day.",
"summary": "Number of simultaneous chats",
"tags": [
"Reports"
],
"operationId": "ReportsChatsAgentsOccupancyGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "weekday",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/chats/agents_occupancy?weekday=mon",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Number of simultaneous chats",
"x-testDescription": "This request shows the maximum number of concurrent chats that happened at the same hour on a particular day."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/visitors/S1352647457.ac951bfe2e/details": {
"post": {
"description": "Displays additional information about a visitor in LiveChat apps.",
"summary": "Add custom visitor details",
"tags": [
"Visitors"
],
"operationId": "VisitorsS1352647457Ac951bfe2eDetailsPost",
"produces": [
"application/json"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"parameters": [
{
"name": "license_id",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "token",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "id",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "fields[0][name]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "fields[0][value]",
"in": "formData",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/visitors/S1352647457.ac951bfe2e/details",
"headers": {
"Content-Type": "application/x-www-form-urlencoded",
"X-API-Version": "2"
},
"body": "license_id=12345&token=26132406c42c96ba61ed42689b70f719&id=my-app&fields[0][name]=Age&fields[0][value]=36"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Add custom visitor details",
"x-testDescription": "Displays additional information about a visitor in LiveChat apps."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/tickets/5FUED": {
"get": {
"description": "Returns a single ticket item for the given TICKET_ID",
"summary": "Get single ticket",
"tags": [
"Tickets"
],
"operationId": "Tickets5FUEDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/tickets/5FUED",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Get single ticket",
"x-testDescription": "Returns a single ticket item for the given TICKET_ID"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/tickets/new_tickets": {
"get": {
"description": "Shows the number of the tickets created during the specified period.\n\n",
"summary": "New tickets",
"tags": [
"Reports"
],
"operationId": "ReportsTicketsNewTicketsGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "date_from",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "date_to",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "group_by",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "X-API-Version",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/tickets/new_tickets?date_from=2013-01-29&date_to=2013-01-29&group_by=hour",
"headers": {
"X-API-Version": "2"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "New tickets",
"x-testDescription": "Shows the number of the tickets created during the specified period.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
}
},
"definitions": {
"CreateATicketresponse": {
"title": "Create a ticketResponse",
"type": "object",
"properties": {
"events": {
"description": "",
"example": [
{
"author": {
"id": "mary.brown@email.com",
"name": "Mary+Brown",
"type": "client"
},
"date": "\"2018-03-02T13:51:30Z\"",
"is_private": false,
"message": "Hi,I+have a problem with my shoes. Could you please advise?",
"type": "message",
"source": {
"type": "lc2",
"url": "null"
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Event"
}
},
"id": {
"description": "",
"example": "8PQRU",
"type": "string"
},
"requester": {
"$ref": "#/definitions/Requester"
},
"groups": {
"description": "",
"example": [
{
"id": 0,
"name": "All operators"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Group"
}
},
"status": {
"description": "",
"example": "open",
"type": "string"
},
"subject": {
"description": "",
"example": "I have a problem",
"type": "string"
},
"modified": {
"description": "",
"example": "3/2/2018 1:51:30 PM",
"type": "string"
},
"source": {
"$ref": "#/definitions/Source6"
},
"opened": {
"description": "",
"example": [
{
"from": "2018-03-02T13:51:30Z"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Opened"
}
},
"firstResponse": {
"description": "",
"example": {},
"type": "object"
},
"tags": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"rate": {
"description": "",
"example": "not_rated",
"type": "string"
},
"date": {
"description": "",
"example": "3/2/2018 1:51:30 PM",
"type": "string"
},
"currentGroup": {
"$ref": "#/definitions/CurrentGroup"
}
},
"required": [
"events",
"id",
"requester",
"groups",
"status",
"subject",
"modified",
"source",
"opened",
"firstResponse",
"tags",
"rate",
"date",
"currentGroup"
]
},
"Event": {
"title": "Event",
"example": {
"author": {
"id": "mary.brown@email.com",
"name": "Mary+Brown",
"type": "client"
},
"date": "\"2018-03-02T13:51:30Z\"",
"is_private": false,
"message": "Hi,I+have a problem with my shoes. Could you please advise?",
"type": "message",
"source": {
"type": "lc2",
"url": "null"
}
},
"type": "object",
"properties": {
"author": {
"$ref": "#/definitions/Author"
},
"date": {
"description": "",
"example": "3/2/2018 1:51:30 PM",
"type": "string"
},
"is_private": {
"description": "",
"example": false,
"type": "boolean"
},
"message": {
"description": "",
"example": "Hi,I+have a problem with my shoes. Could you please advise?",
"type": "string"
},
"type": {
"description": "",
"example": "message",
"type": "string"
},
"source": {
"$ref": "#/definitions/Source"
}
},
"required": [
"author",
"date",
"is_private",
"message",
"type",
"source"
]
},
"Author": {
"title": "Author",
"example": {
"id": "mary.brown@email.com",
"name": "Mary+Brown",
"type": "client"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": "mary.brown@email.com",
"type": "string"
},
"name": {
"description": "",
"example": "Mary+Brown",
"type": "string"
},
"type": {
"description": "",
"example": "client",
"type": "string"
}
},
"required": [
"id",
"name",
"type"
]
},
"Source": {
"title": "Source",
"example": {
"type": "lc2",
"url": null
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "lc2",
"type": "string"
},
"url": {
"description": "",
"type": "string"
}
},
"required": [
"type",
"url"
]
},
"Requester": {
"title": "Requester",
"example": {
"mail": "mary.brown@email.com",
"name": "Mary+Brown",
"ip": "194.181.146.130"
},
"type": "object",
"properties": {
"mail": {
"description": "",
"example": "mary.brown@email.com",
"type": "string"
},
"name": {
"description": "",
"example": "Mary+Brown",
"type": "string"
},
"ip": {
"description": "",
"example": "194.181.146.130",
"type": "string"
}
},
"required": [
"mail",
"name",
"ip"
]
},
"Group": {
"title": "Group",
"example": {
"id": 0,
"name": "All operators"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"name": {
"description": "",
"example": "All operators",
"type": "string"
}
},
"required": [
"id",
"name"
]
},
"Source6": {
"title": "Source6",
"example": {
"type": "lc2",
"url": null,
"id": null
},
"type": "object",
"properties": {
"type": {
"description": "",
"example": "lc2",
"type": "string"
},
"url": {
"description": "",
"type": "string"
},
"id": {
"description": "",
"type": "string"
}
},
"required": [
"type",
"url",
"id"
]
},
"Opened": {
"title": "Opened",
"example": {
"from": "2018-03-02T13:51:30Z"
},
"type": "object",
"properties": {
"from": {
"description": "",
"example": "3/2/2018 1:51:30 PM",
"type": "string"
}
},
"required": [
"from"
]
},
"CurrentGroup": {
"title": "CurrentGroup",
"example": {
"id": 0,
"name": "All operators"
},
"type": "object",
"properties": {
"id": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"name": {
"description": "",
"example": "All operators",
"type": "string"
}
},
"required": [
"id",
"name"
]
}
}
}以上是关于json ID登录-的OpenAPI的主要内容，如果未能解决你的问题，请参考以下文章