Контакты

put
Добавление контактов

https://api.lotinfo.ru/v1/CLIENTS/{id}/CONTACTS
Эта конечная точка позволяет добавлять новые контакты клиенту.
Request
Response
Request
Path Parameters
id
required
integer
ID клиента, которому нужно добавить контакты.
Query Parameters
token
required
string
Ваш токен.
Form Data Parameters
encoding
optional
integer
Кодировка. Значения: 0 - не кодировать, 1 - кодировать. По умолчанию: 0. Пример закодированных символов: "\u0423\u043a\u0430\u0436".
userId
required
integer
ID пользователя.
data
required
array
Массив с данными контактов, которые нужно добавить клиенту. Параметры данных: - type (string, required) - Тип контакта. Значения: "mobile" - мобильный телефон, "city" - городской телефон, "email" - email, "other" - другой. - value (string, required) - Значение контакта. Примечание: мобильный телефон должен начинаться с "7", городской телефон должен начинаться с "8". - general (integer) - Главный контакт в типе. Значения: 0 - не главный контакт, 1 - главный контакт. - comment (string) - Комментарий к контакту. - spy (integer) - Отслеживание активности по контакту. Значения: 0 - не отслеживать, 1 - отслеживать. Примечание: указывается только у контактов с типом "mobile" и "city".
Response
200: OK
Пример ответа.
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": [
{
"id": 2005,
"put": "ok"
},
{
"id": 2006,
"put": "ok"
}
]
}

Пример запроса

PUT https://api.lotinfo.ru/v1/CLIENTS/31341050/CONTACTS/?TOKEN={ваш_токен} HTTP/1.1
Content-Type: application/json
{
"userId": 123,
"data": [
{
"type": "mobile",
"value": 79998887766,
"comment": "Новый контакт 1",
"general": 1
},
{
"type": "mobile",
"value": 79998887765,
"comment": "Новый контакт 2"
}
]
}

post
Изменение контактов

https://api.lotinfo.ru/v1/CLIENTS/{id}/CONTACTS
Эта конечная точка позволяет изменять контакты добавленных клиентов.
Request
Response
Request
Path Parameters
id
required
integer
ID клиента, контакты которого нужно изменить. Примечание: клиент должен принадлежать пользователю.
Query Parameters
token
required
string
Ваш токен.
Form Data Parameters
encoding
optional
integer
Кодировка. Значения: 0 - не кодировать, 1 - кодировать. По умолчанию: 0. Пример закодированных символов: "\u0423\u043a\u0430\u0436".
userId
required
integer
ID пользователя.
data
required
array
Массив с данными контактов клиента, которые нужно изменить. Параметры данных: - contactId (integer, required) - ID контакта. Примечание: ID контактов можно узнать при получении данных о клиентах в разделе контактов. - value (string) - Значение контакта. Примечание: мобильный телефон должен начинаться с "7", городской телефон должен начинаться с "8". - general (integer) - Главный контакт в типе. Значения: 0 - не главный контакт, 1 - главный контакт. Примечание: В каждом типе должен быть только один контакт с general = 1. "Mobile" и "city" считаются одним типом для general. Если не указать general ни одному контакту, он будет указан автоматически первому. - comment (string) - Комментарий к контакту. - spy (integer) - Отслеживание активности по контакту. Значения: 0 - не отслеживать, 1 - отслеживать. Примечание: указывается только у контактов с типом "mobile" и "city".
Response
200: OK
Пример ответа.
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": [
{
"id": 2002,
"update": "ok"
}
]
}
404: Not Found
Пример ответа на запрос с ошибкой. (Код сервера будет с кодом 200.)
HTTP/1.1 200 OK
Content-Type: application/json
{
"errors": [
{
"error": 19,
"error_text": "У клиента с этим id (305) нет контакта с таким id: 2003.",
"error_field": "contactId",
"error_array": 0
}
]
}

Пример запроса

POST https://api.lotinfo.ru/v1/CLIENTS/305/CONTACTS/?TOKEN={ваш_токен} HTTP/1.1
Content-Type: application/json
{
"userId": 123,
"data": [
{
"contactId": 2002,
"value": 79998887766,
"comment": "Контакт 1",
"general": 1
}
]
}

delete
Удаление контактов

https://api.lotinfo.ru/v1/CLIENTS/{id}/CONTACTS
Эта конечная точка позволяет удалять контакты добавленных клиентов.
Request
Response
Request
Path Parameters
id
required
integer
ID клиента, контакты которого нужно удалить.
Query Parameters
token
required
string
Ваш токен.
Form Data Parameters
encoding
optional
integer
Кодировка. Значения: 0 - не кодировать, 1 - кодировать. По умолчанию: 0. Пример закодированных символов: "\u0423\u043a\u0430\u0436".
userId
required
integer
ID пользователя.
data
required
array
Массив с данными контактов клиента, которые нужно удалить. Параметры данных: -
Response
200: OK
Пример ответа.
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": [
{
"id": 2002,
"delete": "ok"
},
{
"id": 2003,
"delete": "ok"
}
]
}

Пример запроса

DELETE https://api.lotinfo.ru/v1/CLIENTS/31341050/CONTACTS/?TOKEN={ваш_токен} HTTP/1.1
Content-Type: application/json
{
"userId": 123,
"data": [
{
"contactId": 2002
},
{
"contactId": 2003
}
]
}