Пример curl-запроса на получение обращений от пользователей с темой «Неисправность камеры»:
curl --location --requestGET 'http://cloud.dvor24.com/api/v2/support/tickets?tags[]=1' --header 'X-Vsaas-Api-Key: КЛЮЧ-API' --header 'X-Vsaas-Session: ТОКЕН-АВТОРИЗАЦИИ'
GET/api/v2/support/tickets
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| search | string | поиск по вхождению |
| offset | integer | указывает число строк, которое необходимо пропустить в общем массиве данныx |
| limit | integer | ограничивает количество выходных данных |
| tags | array | идентификаторы тэгов обращений |
Ответ:| Ключ | Тип | Описание |
|---|
| result | object | объект,содержащий ответ от сервера |
| ticket_id | integer | идентификатор обращения |
| ticket_topic_id | integer | идентификатор темы обращения |
| creation_time | integer | время создания обращения |
| user_id | integer | идентфикатор пользователя |
| message | string | cообщение |
| contact_phone_number | integer | контактный номер телефона |
| topic | string | тема обращения |
| theme | string | заголовок обращения |
| position | string | состояние обработки обращения |
| comment | string | комментарий |
| count | integer | количество обращений |
| success | boolean | состояние запроса |
GET/api/v2/support/tickets/{id}
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| id | integer | идентификатор обращения |
Ответ:| Ключ | Тип | Описание |
|---|
| result | object | объект,содержащий ответ от сервера |
| ticket_id | integer | идентификатор обращения |
| creation_time | integer | дата создания UNIX |
| topic | object | тема обращения |
| id | integer | идентификатор темы |
| theme | string | заголовок обращения |
| title | string | наименование выбранной темы |
| user | object | пользователь |
| id | integer | идентификатор пользователя |
| login | string | логин пользователя |
| contactPhoneNumber | string | контактный номер телефона пользователя |
| status | string | статус обращения |
| message | string | сообщение |
| success | boolean | состояние запроса |
GET/api/v2/support/tickets/{id}/messages
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| id | integer | идентификатор обращения |
Ответ:| Ключ | Тип | Описание |
|---|
| result | object | объект,содержащий ответ от сервера |
| message_id:integer | идентификатор комментария |
| user_id | integer | идентификатор пользователя |
| phone | string | номер телефона пользователя |
| login | string | логин пользователя |
| sid | string | тип пользователя |
| time | integer | время когда оставлен комментарий |
| message | string | текст комментария |
| success | boolean | состояние запроса |
POST/api/v2/support/ticket/add
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| phone | string | номер телефона |
| errors | string | причины неисправности |
| message | string | cообщение |
| subjectId | integer | категория неисправности |
Ответ:| Ключ | Тип | Описание |
|---|
| success | boolean | состояние запроса |
POST/api/v2/support/tickets/{id}/messages
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| message | string | сообщение |
Ответ:| Ключ | Тип | Описание |
|---|
| success | boolean | состояние запроса |
POST/api/support/tickets/{id}/change-status
Заголовки:| Ключ | Тип | Описание |
|---|
| x-vsaas-api-key | string | Api Key пользователя |
| x-vsaas-session | string | Session key, для авторизованных пользователей |
| (ИЛИ) x-vsaas-service-api-key | string | Token, сгенерированный в личном кабинете |
Параметры:| Ключ | Тип | Описание |
|---|
| status | string | статус обращения, возможные значения - new, work, close |
Ответ:| Ключ | Тип | Описание |
|---|
| success | boolean | состояние запроса |