База знаний BotVsem ⤵

< Все темы
Печать

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

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

https://app.botvsem.ru/api/v1/getContactVariables

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

Path Parameters

contact_id
REQUIRED
string

 

ID контакта

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://app.botvsem.ru/api/v1/setContactVariable

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

Query Parameters

contact_id
REQUIRED
integer

 

ID контакта.

name
REQUIRED
string

 

Имя переменной.

value
REQUIRED
string

 

Значение переменной.

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://app.botvsem.ru/api/v1/deleteContactVariable

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

Query Parameters

id
REQUIRED
integer

 

ID переменной контакта.

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://app.botvsem.ru/api/v1/deleteContactVariable

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

Query Parameters

contact_id
REQUIRED
integer

 

ID контакта.

name
REQUIRED
string

 

Имя переменной.

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 не указано."
]}
}
Предыдущая Теги
Оглавление