Пользовательские переменные
Как правильно сформировать запрос?! Смотрим в основах
Получить список переменных
GET https://app.cleverapp.pro/api/v1/getContactVariables
Этот метод позволяет получить список пользовательских переменных для определенного контакта.
Path Parameters
contact_id*
integer
ID контакта.
{
"data": [
{
"id": 16497876867449,
"name": "Имя переменной",
"value": "Значение переменной",
"deletable": false,
"variable": {
"id": 16497876867449,
"name": "Имя переменной"
}
},
{
"id": 16497893703850,
"name": "Город",
"value": "Москва",
"deletable": false,
"variable": {
"id": 16497893703850,
"name": "Город"
}
}
]
}{
"message": "The given data was invalid.",
"errors": {
"contact_id": [
"Поле contact id обязательно для заполнения."
]
}
}Создать/обновить переменную
POST https://app.cleverapp.pro/api/v1/setContactVariable
Этот метод позволяет создать или обновить пользовательскую переменную. Если такой переменной не существует в боте, то она создастся и привяжется к пользователю.
Query Parameters
contact_id*
integer
ID контакта.
name*
string
Имя переменной.
value*
string
Значение переменной.
deletable
integer
Возможные значения:0 - переменная не должна удалиться после заявки1 - переменная должна удалиться после заявки По умолчанию: 0
{
"data": {
"id": 16498385181301,
"name": "Имя переменной",
"value": "Значение переменной",
"deletable": false,
"variable": {
"id": 16498385181301,
"name": "Имя переменной"
}
}
}{
"message": "Forbidden"
}{
"message": "The given data was invalid.",
"errors": {
"contact_id": [
"Поле contact id обязательно для заполнения."
],
"name": [
"Поле Имя обязательно для заполнения."
],
"value": [
"Поле value обязательно для заполнения."
]
}
}Удалить переменную
POST https://app.cleverapp.pro/api/v1/deleteContactVariable
Этот метод позволяет удалить пользовательскую переменную по ее имени или ID.
Query Parameters
contact_id*
integer
ID контакта
id
integer
ID переменной. Обязательно когда name не передан.
name
string
Имя переменной. Обязательно когда id не передан.
{
// Response
}{
"message": "Forbidden"
}{
"message": "The given data was invalid.",
"errors": {
"id": [
"Поле id обязательно для заполнения, когда Имя не указано."
],
"contact_id": [
"Поле contact id обязательно для заполнения, когда id не указано."
],
"name": [
"Поле Имя обязательно для заполнения, когда id не указано."
]
}
}Last updated