Найти контакт

GET /contacts/search

Обновлено больше недели назад

Поиск контактов по различным критериям.

МЕТОД HTTP

GET

URL

ОБЯЗАТЕЛЬНЫЕ ПАРАМЕТРЫ

Отсутствуют.

ДОПОЛНИТЕЛЬНЫЕ ПАРАМЕТРЫ

  • contactIds[] — идентификатор контакта. Задается как массив.

  • tags[] — теги контактов. Набор тегов, по которым осуществляется поиск. Теги бывают 2 типов:
    - публичные isPublic значение true
    - непубличные - isPublic значение false

  • contactsData[] — данные контактов. Передается как массив данных:
    - name — имя;
    - secondName — фамилия;
    - company — компания;
    - email — электронная почта;
    - phoneMain — номер телефона;
    - position — должность.
    Можно уточнить поиск любым количеством данных.

  • userIds[] —  массив ID пользователей, контакты которых нужно
    получить. Можно передать несколько userID.

ПОЛЯ ОТВЕТА

В ответ приходит список участников вебинаров, подходящих под критерии поиска. По каждому участнику приходит следующая информация:

  • id — contactID;

  • userId — идентификатор сотрудника организации, в чьей адресной книге найден контакт;

  • name — имя;

  • secondName — фамилия;

  • company — компания;

  • position — должность в компании;

  • phoneMain — номер телефона;

  • email — адрес электронной почты;

  • tags — теги, присвоенные этому контакту.

ПРИМЕР ЗАПРОСА

url: https://userapi.webinar.ru/v3/contacts/search?contactsData[email]=viktor.kurushin@rambler.ru,
method: GET,
headers:
{
    x-auth-token: {Token},
    Content-Type: application/x-www-form-urlencoded
};

ПРИМЕР ОТВЕТА

[
{
"id": "148334859",
"userId": "37226409",
"name": "Viktor",
"secondName": "Viktorov",
"company": "Дом",
"position": "Тестировщик",
"phoneMain": "+799999999999",
"email": "viktor.kurushin@rambler.ru",
"tags": [
{
"id": "1360261",
"isPublic": false,
"name": "Обучение"
},
{
"id": "1367801",
"isPublic": true,
"name": "1"
}
]
}
]

Нашли ответ на свой вопрос?