4.2.4.3. Получение информации о пользователях

Краткие сведения


Типы запросов
GET 
ОписаниеПолучение информации о пользователях
Название

GetSubscribers

URL/v1/line/subscribers/

Описание

Метод возвращает информацию о пользователях

Запрос к серверу

Параметры URL

ПолеТипОписание
user_idUUID?ID пользователя
client_idUUID?ID клинта
counterpart_owner_idUUID?ID контрагента, владелец пользователя (создавший клиента)
line_idUUID?ID линии поддержки
loginString?Логин пользователя
emailString?Email пользователя
is_verifiedBoolean?Флаг подтвержден email или нет
Если параметр опущен, но задан email, считается что is_verified = true

Пример

Информация о пользователе

GET /v1/line/subscribers/ HTTP/1.1
Host: push.1c-connect.com
accept: application/json
authorization: Basic dGVzdDp0ZXN0

Curl

curl -X GET "https://push.1c-connect.com/v1/line/subscribers/" \
-H "accept: application/json" \
-u test:test

Информация о пользователях без подтверждения email

GET /v1/line/subscribers/?is_verified=false HTTP/1.1
Host: push.1c-connect.com
accept: application/json
authorization: Basic dGVzdDp0ZXN0

Curl

curl -X GET "https://push.1c-connect.com/v1/line/subscribers/?is_verified=false" \
-H "accept: application/json" \
-u test:test

Информация о пользователe с подтвержденным email sovsem@pisem.net

GET /v1/line/subscribers/?email=sovsem%40pisem.net HTTP/1.1
Host: push.1c-connect.com
accept: application/json
authorization: Basic dGVzdDp0ZXN0

Curl

curl -X GET "https://push.1c-connect.com/v1/line/subscribers/?email=sovsem%40pisem.net" \
-H "accept: application/json" \
-u test:test

Информация о пользователях с email sovsem@pisem.net, кроме подтвержденного

GET /v1/line/subscribers/?email=sovsem%40pisem.net&is_verified=false HTTP/1.1
Host: push.1c-connect.com
accept: application/json
authorization: Basic dGVzdDp0ZXN0

Curl

curl -X GET "https://push.1c-connect.com/v1/line/subscribers/?email=sovsem%40pisem.net&is_verified=false" \
-H "accept: application/json" \
-u test:test

Ответ сервера

Название объекта

Users

Описание объекта

Пользователи

Данные

Поле

Тип

Описание

user_id

UUID

ID пользователя

counterpart_id

UUID

Контрагент, к которому относится пользователь (клиент)

counterpart_owner_id

UUID

Контрагент, владелец пользователя (создавший клиента)

name

String

Имя пользователя

surname

String

Фамилия пользователя

patronymic

String

Отчество пользователя

avatar_url

String?

Ссылка на аватар

avatar_small_url

String?

Ссылка на превью аватара

email

String

Email пользователя

post

String

Должность пользователя

phone

String

Телефон пользователя

Пример

[
    {
        "user_id": "eeb0ac90-5f95-4761-afab-58932b1b8d34",
        "counterpart_id":"ae052c9a-307c-11eb-3b94-00505601495b",
        "counterpart_owner_id":"6dd05738-1464-11e3-93b5-7054d21ab6ff",
        "name": "Финик",
        "surname": "Изюмин",
        "patronymic": "Курагович",
        "avatar_url": "https://develop-filetransfer.1c-connect.com/avatars/0/08d13b6a55c9fde5229626159204b7bf-131629626.png",
        "avatar_small_url": "https://develop-filetransfer.1c-connect.com/avatars/0/08d13b6a55c9fde5229626159204b7bf-131629626.png",
        "post": "Сушитель овощей и фруктов",
        "phone": "+71231231231",
        "email": "noreply@1c-connect.com"
    },
    {
        "user_id": "64091d15-0b13-496f-9331-30796ccf6cc6",
        "counterpart_id":"ae052c9a-307c-11eb-3b94-00505601495b",
        "counterpart_owner_id":"6dd05738-1464-11e3-93b5-7054d21ab6ff",
        "name": "Имя",
        "surname": "Фамилия",
        "patronymic": "Отчество",
        "post": "Менеджер отдела по работе с клиентами",
        "phone": "",
        "email": ""
    }
]

Ошибки

КодОписание
400Запрос содержит ошибку
401Пользователь не авторизован
403Недостаточно прав

Related pages