Перейти к основному содержимому

Получить короткую информацию о клиенте по номеру телефона или внешнему ID

Используйте этот метод для того, чтобы получить короткую информацию о клиентах, зарегистрированных в edna, используя список номеров телефонов или внешних ID.

к сведению

Необходимо указать либо phones, либо externalIds

    ----
Permissions:INTEGRATOR,OPERATOR,SUPERVISOR
----
Поля тела запроса
ПараметрТипОписание

phones

Array of strings

Список номеров клиентов, по которым будет собрана краткая информация

externalIds

Array of strings

Список внешних идентификаторов клиентов, по которым будет собрана краткая информация

Пример curl

$ curl 'http://localhost:8080/api/v1/clients/short-info' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <integrator_token>' \
-H 'X-Tenant-Name: local' \
-d '{
"phones" : [ "78423493234", "78423493236" ],
"externalIds" : null
'

Пример HTTP запроса

POST /api/v1/clients/short-info HTTP/1.1
Content-Type: application/json
Authorization: Bearer <integrator_token>
X-Tenant-Name: local
Content-Length: 73
Host: localhost:8080

{
"phones" : [ "78423493234", "78423493236" ],
"externalIds" : null

Пример HTTP ответа

Поля тела ответа
ПараметрТипОписание

[].id

Long

ID клиента в edna Chat Center

[].externalId

String

Внешний ID клиента

[].phone

String

Номер телефона клиента

[].hasActiveThread

Boolean

Параметр, указывающий, есть ли у клиента активный тред (true) или нет (false)

HTTP/1.1 200 OK
X-Request-Id: 9eb12e91-cdff-495e-943b-29f4143a3532
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 215

[ {
"id" : 10,
"externalId" : "extClientId_1",
"phone" : "78423493234",
"hasActiveThread" : true
, {
"id" : 11,
"externalId" : "extClientId_2",
"phone" : "78423493236",
"hasActiveThread" : false
]