Получить список связей профиля

Описание

Запрос возвращает список всех существующих связей для указанного профиля из базы данных A, включая идентификаторы связанных профилей, типы связей и их свойства.

URL-адрес

Метод: POST.

https://example.com/api/v1.1/relations/get

Параметры запроса

Параметр	Тип	Пример	Обязательный	Описание
token	string	"abcdefghijklmnqrstuvwxyz"	Да	API токен
rel_id	int	3	Да	ID связи
profile_id	string	"669e6968ebf4ac52b623a997"	Да, если не указан другой тип поиска	Идентификатор профиля из базы данных А для поиска
Поиск профиля подписчика
email	string	"john@example.com"	"matching":"email" - по профилю и подпискам "matching":"email_profile" - только по профилю	Email-адрес
phone	string	"+79000000000"	"matching":"phone"	Номер телефона
profile_id	string	"abcdefghijklmnqrstuvwxyz"	"matching":"profile_id"	Идентификатор профиля
field_name	string	"CRM_ID"	"matching":"custom"	Название кастомного поля профиля для поиска.
field_value	int/string	"12345"	"matching":"custom"	Значение кастомного поля для поиска. подсказка Доступен поиск по сочетанию значений поля с типом "теги". Теги передаются в строке черз запятую: "тег_1, тег_2".
resource_id	int	24	Нет	Идентификатор ресурса для поиска по email и phone

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

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "rel_id": 2,
    "profile_id": "669e6968ebf4ac52b623a997"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <rel_id>2</rel_id>
  <profile_id>669e6968ebf4ac52b623a997</profile_id>
</xml>

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

JSON

{
    "data": [
        {
            "profile_id_a": "669e6968ebf4ac52b623a997",
            "xxh_a": "5af1023c84f66195",
            "profile_id_b": "6751b8f1c5e3db9bcb75befa",
            "xxh_b": "879cebbb0e6b6723",
            "db_b": 9,
            "props": {
                "exr": {
                    "value": 11323123
                }
            }
        }
    ],
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 1
}

XML

<xml>
    <data>
        <profile_id_a>abcdefghijklmnqrstuvwxyz</profile_id_a>
            <xxh_a>5af1023c84f66195</xxh_a>
            <profile_id_b>6751b8f1c5e3db9bcb75befa</profile_id_b>
            <xxh_b>879cebbb0e6b6723</xxh_b>
            <db_b>9</db_b>
            <props>
                <exr>
                    <value>11323123</value>
                </exr>
            </props>
        </relation>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <total_count>1</total_count>
    </data>
    <error>0</error>
    <error_text>Successful operation</error_text>
</xml>

Возвращаемые параметры

Параметр	Тип	Описание
error	int	Код ошибки
error_text	string	Текст ошибки
data	object	Информация о связях профиля
data.profile_id_a	string	Идентификатор профиля A (профиль, к которому направлена связь)
data.xxh_a	string	Хешированый идентификатор профиля A
data.profile_id_b	string	Идентификатор профиля Б (профиль, инициирующий связь)
data.xxh_b	string	Хешированый идентификатор профиля Б
data.db_b	int	Идентификатор базы, в которой находится профиль Б
data.props	object	Свойства связей
data.total_count	int	Количество связей c другими профилями