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

Получить список переменных

GET https://watbot.ru/api/v1/getContactVariables

Этот метод позволяет получить список пользовательских переменных для определенного контакта.

Path Parameters

Name	Type	Description
contact_id*	integer	ID контакта.

200 Запрос успешно обработан.

{
  "data": [
    {
      "id": 16497876867449,
      "name": "Имя переменной",
      "value": "Значение переменной",
      "deletable": false,
      "variable": {
        "id": 16497876867449,
        "name": "Имя переменной"
      }
    },
    {
      "id": 16497893703850,
      "name": "Город",
      "value": "Москва",
      "deletable": false,
      "variable": {
        "id": 16497893703850,
        "name": "Город"
      }
    }
  ]
}

422 Переданные данные некорректны.

{
  "message": "The given data was invalid.",
  "errors": {
    "contact_id": [
      "Поле contact id обязательно для заполнения."
    ]
  }
}

Создать/обновить переменную

POST https://watbot.ru/api/v1/setContactVariable

Этот метод позволяет создать или обновить пользовательскую переменную. Если такой переменной не существует в боте, то она создастся и привяжется к пользователю.

Query Parameters

Name	Type	Description
contact_id*	integer	ID контакта.
name*	string	Имя переменной.
value*	string	Значение переменной.
deletable	integer	Возможные значения: 0 - переменная не должна удалиться после заявки 1 - переменная должна удалиться после заявки По умолчанию: 0

200 Переменная успешно создана/отредактирована.

{
  "data": {
    "id": 16498385181301,
    "name": "Имя переменной",
    "value": "Значение переменной",
    "deletable": false,
    "variable": {
      "id": 16498385181301,
      "name": "Имя переменной"
    }
  }
}

403 Доступ запрещен.

{
    "message": "Forbidden"
}

422 Переданы некорректные данные.

{
  "message": "The given data was invalid.",
  "errors": {
    "contact_id": [
      "Поле contact id обязательно для заполнения."
    ],
    "name": [
      "Поле Имя обязательно для заполнения."
    ],
    "value": [
      "Поле value обязательно для заполнения."
    ]
  }
}

Удалить переменную

POST https://watbot.ru/api/v1/deleteContactVariable

Этот метод позволяет удалить пользовательскую переменную по ее имени или ID.

Query Parameters

Name	Type	Description
id	integer	ID переменной. Обязательно когда name не передан.
contact_id*	integer	ID контакта
name	string	Имя переменной. Обязательно когда id не передан.

204 Переменная успешно удалена.

403 Доступ запрещен.

{
    "message": "Forbidden" 
}

422 Переданы некорректные данные.

{
  "message": "The given data was invalid.",
  "errors": {
    "id": [
      "Поле id обязательно для заполнения, когда Имя не указано."
    ],
    "contact_id": [
      "Поле contact id обязательно для заполнения, когда id не указано."
    ],
    "name": [
      "Поле Имя обязательно для заполнения, когда id не указано."
    ]
  }
}

Объект data.variable устарел и теперь передается в ответе только для совместимости старого API. Окончательно перестанет поддерживаться после 01.03.2023