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

get
Получить список переменных
https://watbot.ru/api/v1/getContactVariables
Этот метод позволяет получить список пользовательских переменных для определенного контакта.
Request
Response
Request
Path Parameters
contact_id
required
string
ID контакта.
Response
200: OK
Запрос успешно обработан.
{
  "data": [
    {
      "id": 1,
      "value": "Значение переменной",
      "created_at": "2019-10-22T20:54:20+00:00",
      "updated_at": "2019-10-22T20:54:31+00:00",
      "variable": {
        "id": 14,
        "name": "Имя переменной",
        "created_at": "2019-10-22T20:54:20+00:00",
        "updated_at": "2019-10-22T20:54:20+00:00"
      }
    },
    {
      "id": 2,
      "value": "Москва",
      "created_at": "2019-10-22T20:54:20+00:00",
      "updated_at": "2019-10-22T20:54:31+00:00",
      "variable": {
        "id": 25,
        "name": "Город",
        "created_at": "2019-10-22T20:54:20+00:00",
        "updated_at": "2019-10-22T20:54:20+00:00"
      }
    }
  ],
  "links": {
    "first": "https:\/\/watbot.ru\/api\/v1\/getContactVariables?page=1",
    "last": "https:\/\/watbot.ru\/api\/v1\/getContactVariables?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https:\/\/watbot.ru\/api\/v1\/getContactVariables",
    "per_page": 100,
    "to": 2,
    "total": 2
  }
}
422: Unprocessable Entity
Переданные данные некорректны.
{
  "message": "The given data was invalid.",
  "errors": {
    "contact_id": [
      "Поле contact id обязательно для заполнения."
    ]
  }
}
post
Создать/обновить переменную
https://watbot.ru/api/v1/setContactVariable
Этот метод позволяет создать или обновить пользовательскую переменную. Если такой переменной не существует в боте, то она создастся и привяжется к пользователю.
Request
Response
Request
Query Parameters
contact_id
required
integer
ID контакта.
name
required
string
Имя переменной.
value
required
string
Значение переменной.
Response
200: OK
Переменная успешно создана/отредактирована.
{
  "data": {
    "id": 2,
    "value": "Значение переменной",
    "created_at": "2019-10-23T11:46:15+00:00",
    "updated_at": "2019-10-23T11:46:28+00:00",
    "variable": {
      "id": 1,
      "name": "Имя переменной",
      "created_at": "2019-10-23T11:46:15+00:00",
      "updated_at": "2019-10-23T11:46:15+00:00"
    }
  }
}
403: Forbidden
Доступ запрещен.
{
    "message": "Forbidden"
}
422: Unprocessable Entity
Переданы некорректные данные.
{
  "message": "The given data was invalid.",
  "errors": {
    "contact_id": [
      "Поле contact id обязательно для заполнения."
    ],
    "name": [
      "Поле Имя обязательно для заполнения."
    ],
    "value": [
      "Поле value обязательно для заполнения."
    ]
  }
}
post
 Удалить переменную по ID
https://watbot.ru/api/v1/deleteContactVariable
Этот метод позволяет удалить пользовательскую переменную по ID переменной контакта.
Request
Response
Request
Query Parameters
id
required
integer
ID переменной контакта.
Response
204: No Content
Переменная успешно удалена.
​
403: Forbidden
Доступ запрещен.
{
    "message": "Forbidden" 
}
422: Unprocessable Entity
Переданы некорректные данные.
{
  "message": "The given data was invalid.",
  "errors": {
    "id": [
      "Поле id обязательно для заполнения, когда Имя не указано."
    ],
    "contact_id": [
      "Поле contact id обязательно для заполнения, когда id не указано."
    ],
    "name": [
      "Поле Имя обязательно для заполнения, когда id не указано."
    ]
  }
}
Обратите внимание! Нужно передавать ID переменной контакта, а не ID переменной бота. 
{    
    "id": 1, // ID переменной контакта
    "value": "Значение переменной",
    "created_at": "2019-10-22T20:54:20+00:00",
    "updated_at": "2019-10-22T20:54:31+00:00",
    "variable": {
        "id": 2, // ID переменной бота
        "name": "Имя переменной",
        "created_at": "2019-10-22T20:54:20+00:00", 
        "updated_at": "2019-10-22T20:54:20+00:00"
    }
}
post
Удалить переменную по ее имени и ID контакта
https://watbot.ru/api/v1/deleteContactVariable
Этот метод позволяет удалить пользовательскую переменную по ID контакта и имени переменной.
Request
Response
Request
Query Parameters
contact_id
required
integer
ID контакта.
name
required
string
Имя переменной.
Response
204: No Content
Переменная успешно удалена.
​
403: Forbidden
Доступ запрещен.
{
    "message": "Forbidden" 
}
422: Unprocessable Entity
Переданы некорректные данные.
{
  "message": "The given data was invalid.",
  "errors": {
    "id": [
      "Поле id обязательно для заполнения, когда Имя не указано."
    ],
    "contact_id": [
      "Поле contact id обязательно для заполнения, когда id не указано."
    ],
    "name": [
      "Поле Имя обязательно для заполнения, когда id не указано."
    ]
  }
}
Теги
Next - Работа с API
Списки
Last updated 8 months ago
Пользовательские переменные

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

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

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

postУдалить переменную по ее имени и ID контакта

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

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

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

post
Удалить переменную по ее имени и ID контакта
