Переменные контакта#

Эти методы читают, записывают и удаляют переменные контакта — те же, что бот заполняет в сценарии и показывает в карточке контакта. Например, сайт может записать в переменную номер заказа, а бот — подставить его в сообщение как {{ $номер_заказа }} (подробнее — в разделе Автоподстановки).

Номер контакта (contact_id) показан в шапке карточки контакта и в первой колонке списка контактов.

getContactVariables#

Возвращает все переменные контакта.

curl -X POST "https://watbot.ru/api/v1/getContactVariables" \
  -H "Authorization: Bearer ВАШ_КЛЮЧ" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"contact_id": 678}'

{
  "data": [
    {
      "id": 17594321098765,
      "name": "город",
      "value": "Казань",
      "deletable": false,
      "variable": {
        "id": 17594321098765,
        "name": "Казань"
      }
    },
    {
      "id": 17594321112233,
      "name": "номер_заказа",
      "value": "A-1024",
      "deletable": false,
      "variable": {
        "id": 17594321112233,
        "name": "A-1024"
      }
    }
  ]
}

Переменные идут в порядке создания. Нет переменных — data будет пустым массивом.

setContactVariable#

Записывает значение в переменную контакта. Если переменной с таким именем нет — создаёт её, если есть — заменяет значение.

curl -X POST "https://watbot.ru/api/v1/setContactVariable" \
  -H "Authorization: Bearer ВАШ_КЛЮЧ" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"contact_id": 678, "name": "номер_заказа", "value": "A-1024"}'

{
  "data": {
    "id": 17594321112233,
    "name": "номер_заказа",
    "value": "A-1024",
    "deletable": false,
    "variable": {
      "id": 17594321112233,
      "name": "A-1024"
    }
  }
}

{
  "message": "У контакта уже 5000 переменных — новую добавить нельзя.",
  "error": "У контакта уже 5000 переменных — новую добавить нельзя.",
  "code": "variables_limit",
  "errors": {
    "name": ["У контакта уже 5000 переменных — новую добавить нельзя."]
  }
}

Особенности:

• Пустое значение записать нельзя: value обязателен. Чтобы очистить переменную, удалите её методом deleteContactVariable.
• При записи в существующую переменную deletable тоже перезаписывается: если параметр не передан, он станет false.
• Имя новой переменной добавляется в справочник «Подсказки по пользовательским переменным» бота — так она попадёт в подсказки кабинета и в выгрузку контактов. Если в справочнике уже 5000 имён, новое имя в него не добавляется, но переменная контакта всё равно записывается.
• У контакта может быть не больше 5000 переменных. Новую сверх этого метод не создаёт и отвечает 422 с code: "variables_limit". Запись в существующую переменную проходит всегда.
• Нет контакта, он удалён или удалён его бот — 404; контакт из чужого бота — 403.

deleteContactVariable#

Удаляет переменную контакта по номеру или по имени.

Если переданы оба, используется name, а если переменной с таким именем нет — id.

curl -X POST "https://watbot.ru/api/v1/deleteContactVariable" \
  -H "Authorization: Bearer ВАШ_КЛЮЧ" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"contact_id": 678, "name": "номер_заказа"}'

Ответ — код 204 без тела.

Особенности:

• Если такой переменной у контакта нет, метод всё равно отвечает 204.
• Имя из справочника подсказок бота не удаляется.
• Нет контакта, он удалён или удалён его бот — 404; контакт из чужого бота — 403.

Общие ошибки API — в разделе Ошибки.