Запрос

GET contact/search?project_id=[project_id]&phone=[phone]&email=[email]&max_bot_id=[max123_bot]&max_user_id=[1234567890]

Передаваемые параметры:

  • project_id - ID проекта, в котором будет осуществлён поиск
  • phone - Номер телефона (или массив номеров)
  • email - Адрес электронной почты (или массив адресов)
  • max_bot_id - Идентификатор бота в МАХ
  • max_user_id - Идентификатор пользователя в МАХ

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

curl -H "token: someToken" https://direct.lptracker.ru/contact/search?project_id=123&phone=71234567890

Пример ответа при успешном выполнении: 

{
  "status": "success",
  "result": [
    {
      "id": "contact_id",
      "project_id": 123,
      "details": [
        {
          "id": "contact_detail_id",
          "type": "email/phone",
          "data": "email@example.com/+71234567890"
        }
      ],
      "fields": [
        {
          "id": "12",
          "type": "string",
          "name": "fieldName",
          "value": "exampleText"
        }
      ],
      "created_at": "DD.MM.YY HH:MM:SS",
      "name": "user_name",
      "site": "example.com"
    }
  ]
}

Описание модели контакта

В случае если запросу не будет соответствовать ни один контакт - будет получен ответ:

{
    "status": "success",
    "result": []
}

Важные уточнения

  • Поле project_id обязательное в данном запросе
  • Поля phone, email, max_bot_id и max_user_id не обязательные, однако должно присутствовать хотя бы одно
  • Чтобы указать несколько номеров телефонов и/или адресов электронной почты - необходимо разделять их символом "&" (амперсанд)