Используйте этот метод для того, чтобы получить краткую информацию о клиентах, зарегистрированных в edna Chat Center, используя список номеров телефонов или внешних ID.
Необходимо указать либо
phones
, либо externalIds
. Разрешения
---- Permissions:INTEGRATOR,OPERATOR,SUPERVISOR ----
Пример curl
$ curl 'http://localhost:8080/api/v1/clients/short-info' -i -X POST \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer <integrator_token>' \ -d '{ "phones" : [ "78423493234", "78423493236" ], "externalIds" : null }'
Пример HTTP запроса
POST /api/v1/clients/short-info HTTP/1.1 Content-Type: application/json Authorization: Bearer <integrator_token> Content-Length: 73 Host: localhost: 8080 { "phones": [ "78423493234", "78423493236" ], "externalIds": null }
Поля тела запроса
Параметр | Тип | Описание |
phones | array of strings | Список номеров клиентов, по которым будет собрана краткая информация |
externalIds | array of strings | Список внешних идентификаторов клиентов, по которым будет собрана краткая информация |
Пример HTTP ответа
HTTP/1.1 200 OK Vary: Origin Vary: Access-Control-Request-Method Vary: Access-Control-Request-Headers Content-Type: application/json Content-Length: 215 [ { "id": 10, "externalId": "extClientId_1", "phone": "78423493234", "hasActiveThread": true }, { "id": 11, "externalId": "extClientId_2", "phone": "78423493236", "hasActiveThread": false } ]
Поля тела ответа
Параметр | Тип | Описание |
[].id | long | ID клиента в edna Chat Center |
[].externalId | string | Внешний ID клиента |
[].phone | string | Номер телефона клиента |
[].hasActiveThread | boolean | Параметр, указывающий, есть ли у клиента активный тред (true ) или нет (false ) |