Управление контактами

​

Что это такое

​

Перед началом работы

• Приведите номера телефонов к формату E.164.
• Определите, какая система является источником для каждого поля профиля.
• Создайте пользовательские атрибуты перед записью зависящих от них значений.
• Установите правила получения согласий и хранения клиентских данных.

​

Как это работает

1. Создайте контакт с уникальным номером телефона.
2. Сохраните возвращенный ID контакта.
3. Получайте или выводите списком контакты по идентификаторам и фильтрам.
4. Обновляйте профиль, теги, пользовательские атрибуты или ответственного.
5. Удаляйте контакт в соответствии с политикой хранения данных.

​

Запрос

curl --request POST https://api.ycloud.com/v2/contact/contacts \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "nickname": "Avery",
    "phoneNumber": "+16315551111",
    "countryCode": "US",
    "email": "avery@example.com",
    "tags": ["customer", "vip"],
    "customAttributes": [
      {
        "name": "plan",
        "value": "premium"
      }
    ],
    "ownerEmail": "sales@example.com"
  }'

​

Ответ

{
  "id": "1693364594105000000",
  "nickname": "Avery",
  "phoneNumber": "+16315551111",
  "countryCode": "US",
  "email": "avery@example.com",
  "tags": ["customer", "vip"],
  "sourceType": "API",
  "createTime": "2026-07-16T12:00:00.000Z"
}

​

Поиск и пагинация

​

Согласованность данных

• Выберите единую мастер-систему (system of record) для каждого поля.
• Относитесь к обновлениям из webhook как к событиям, а не гарантированно полным заменяющим записям.
• Обеспечьте идемпотентность операций импорта и обработчиков webhook.
• Не допускайте перезаписи более актуальных данных клиента запоздавшими событиями.

​

Ограничения и устранение неполадок

• Номера телефонов должны быть в формате E.164.
• Адреса электронной почты при их указании должны быть валидными и уникальными.
• Контакт поддерживает до 50 тегов с ограничениями по длине для конкретных полей.
• Используйте эндпоинт атрибутов контактов для получения списка доступных пользовательских атрибутов.
• Удаляйте персональные данные из общих логов и материалов для службы поддержки.