Документация Сотбит: REST API. Роутинг. Техническая поддержка
Техническая поддержка
Доступные действия над обращениями в службу технической поддержки
Модуль позволяет производить нижеперечисленные действия. С более подробным описанием вы можете ознакомиться ниже.
- GET /v1/support
Получение списка заказов - POST /v1/support/tickets (params = title, message, [files, category, criticality, mark])
Получение заказа по ID - POST /v1/support/messages/ticket/{id} (params = message, [files[], criticality, mark])
Получение статуса заказа по ID - POST /v1/support/tickets/close (params = id)
Получение статусов заказов - POST /v1/support/tickets/open (params = id)
Отмена заказа по ID - GET /v1/support/tickets [?filter]
Получение списка доставок - GET /v1/support/tickets/{id}
Получение списка платежных систем - GET /v1/support/messages/ticket/{id} [?filter]
Получение списка типов плательщиков - GET /v1/support/messages/{id}
Получение списка типов плательщиков - GET /v1/support/file/{hash}
Получение списка типов плательщиков
| ID | Идентификатор обращения |
| SITE_ID | Идентификатор сайта на котором было создано обращение |
| DATE_CREATE | Дата создания обращения |
| DAY_CREATE | День создания обращения |
| TIMESTAMP_X | Временная метка создания обращения |
| DATE_CLOSE | Дата закрытия обращения |
| AUTO_CLOSED | Пометка об автоматическом закрытии обращения |
| AUTO_CLOSE_DAYS | Количество дней прошедшее после автоматического закрытия обращения |
| SLA_ID | |
| NOTIFY_AGENT_ID | |
| EXPIRE_AGENT_ID | |
| OVERDUE_MESSAGES | |
| IS_NOTIFIED | |
| IS_OVERDUE | |
| CATEGORY_ID | Идентификатор категории обращения |
| CRITICALITY_ID | Идентификатор критичности обращения |
| STATUS_ID | Идентификатор статуса обращения |
| MARK_ID | Идентификатор пометки обращения |
| SOURCE_ID | |
| DIFFICULTY_ID | Идентификатор сложности обращения |
| TITLE | Заголовок обращения |
| MESSAGES | Массив сообщений |
| IS_SPAM | Пометка о спаме |
| OWNER_USER_ID | Идентификатор владельца обращения для зарегистрированных пользователей |
| OWNER_GUEST_ID | Идентификатор владельца обращения для незарегистрированных пользователей |
| OWNER_SID | Идентификатор сайта на котором было создано обращение |
| CREATED_USER_ID | Идентификатор создателя обращения для зарегистрированных пользователей |
| CREATED_GUEST_ID | Идентификатор создателя обращения для незарегистрированных пользователей |
| CREATED_MODULE_NAME | Название модуля инициирующего создание обращение |
| RESPONSIBLE_USER_ID | Идентификатор пользователя ответственного за обращение |
| MODIFIED_USER_ID | Идентификатор пользователя изменившего обращение |
| MODIFIED_GUEST_ID | Идентификатор незарегистрированного пользователя изменившего обращение |
| MODIFIED_MODULE_NAME | Название модуля инициирующего изменение обращения |
| LAST_MESSAGE_USER_ID | Идентификатор пользователя отправившего последнее сообщение |
| LAST_MESSAGE_GUEST_ID | Идентификатор незарегистрированного пользователя отправившего последнее сообщение |
| LAST_MESSAGE_SID | Идентификатор сайта с которого было отправлено последнее сообщение |
| LAST_MESSAGE_BY_SUPPORT_TEAM | Отметка, об отправки последнего сообщения командой тех. поддержки |
| LAST_MESSAGE_DATE | Дата отправки последнего сообщения |
| SUPPORT_COMMENTS | Комментарий службы тех. поддержки к обращению |
| PROBLEM_TIME | Время решения обращения |
| HOLD_ON | Отметка о паузе обращения |
| REOPEN | Отметка о повторном открытии обращения |
| COUPON | Купон обращения |
| SUPPORT_DEADLINE | Крайний срок решения обращения |
| SUPPORT_DEADLINE_NOTIFY | Заметка по крайнему сроку решения обращения |
| D_1_USER_M_AFTER_SUP_M | |
| ID_1_USER_M_AFTER_SUP_M | |
| DEADLINE_SOURCE_DATE | Крайний срок решения обращения |
| LID | Идентификатор сайта на котором было создано обращение |
| DATE_CREATE_SHORT | |
| TIMESTAMP_X_SHORT | |
| DATE_CLOSE_SHORT | |
| AUTO_CLOSE_DATE | |
| TICKET_TIME | |
| AUTO_CLOSE_DAYS_LEFT | |
| USERS_ONLINE | |
| IS_SUPER_TICKET | |
| LAMP | |
| OWNER_LOGIN | |
| OWNER_EMAIL | |
| OWNER_NAME | |
| RESPONSIBLE_LOGIN | |
| RESPONSIBLE_EMAIL | |
| RESPONSIBLE_NAME | |
| MODIFIED_BY_LOGIN | |
| MODIFIED_BY_EMAIL | |
| MODIFIED_BY_NAME | |
| MODIFIED_LOGIN | |
| MODIFIED_EMAIL | |
| MODIFIED_NAME | |
| LAST_MESSAGE_LOGIN | |
| LAST_MESSAGE_EMAIL | |
| LAST_MESSAGE_NAME | |
| CREATED_LOGIN | |
| CREATED_EMAIL | |
| CREATED_NAME | |
| B2BMOBILE_READ |
| GET | /v1/support |
|
Получение настроек технической поддержки |
|
GET /v1/support
{
"code": 200,
"status": "success",
"message": {
"CATEGORY": {
"1": {
"ID": "1",
"NAME": "Ошибки",
"SORT": "100"
},
"2": {
"ID": "2",
"NAME": "Оплата заказа",
"SORT": "200"
},
"3": {
"ID": "3",
"NAME": "Доставка заказа",
"SORT": "300"
}
},
"CRITICALITY": {
"4": {
"ID": "4",
"NAME": "Низкая",
"SORT": "100"
},
"5": {
"ID": "5",
"NAME": "Средняя",
"SORT": "200"
},
"6": {
"ID": "6",
"NAME": "Высокая",
"SORT": "300"
}
},
"MARK": {
"11": {
"ID": "11",
"NAME": "Ответ устраивает",
"SORT": "100"
},
"12": {
"ID": "12",
"NAME": "Недостаточно полно",
"SORT": "200"
},
"13": {
"ID": "13",
"NAME": "Ответ не устраивает",
"SORT": "300"
}
}
},
"timestamp": 1617183909
}
|
|
| POST | /v1/support/tickets |
|
Создает обращений в службу технической поддержки Обязательное поля:
Не обязательное поле:
|
|
POST /v1/support/tickets
{
"code": 201,
"status": "success",
"message": 269,
"timestamp": 1617184733
}
|
|
| POST | /v1/support/messages/ticket/{id} |
|
Создает новое сообщение в обращении
Обязательное поля:
Не обязательное поле:
|
|
POST /v1/support/messages/ticket/{id}
{
"code": 200,
"status": "success",
"message": {
"data": {
"3": {
"ID": "3",
"TIMESTAMP_X": "19.10.2020 16:20:44",
"DATE_CREATE": "19.10.2020 16:20:44",
"DAY_CREATE": "2020-10-19",
"C_NUMBER": "1",
"TICKET_ID": "2",
"IS_HIDDEN": "N",
"IS_LOG": "N",
"IS_OVERDUE": "N",
"CURRENT_RESPONSIBLE_USER_ID": null,
"NOTIFY_AGENT_DONE": "N",
"EXPIRE_AGENT_DONE": "N",
"MESSAGE": "Текст сообщения",
"MESSAGE_SEARCH": "ТЕКСТ СООБЩЕНИЯ",
"IS_SPAM": null,
"EXTERNAL_ID": null,
"EXTERNAL_FIELD_1": null,
"OWNER_USER_ID": "1",
"OWNER_GUEST_ID": null,
"OWNER_SID": "",
"SOURCE_ID": "0",
"CREATED_USER_ID": "1",
"CREATED_GUEST_ID": "180",
"CREATED_MODULE_NAME": "support",
"MODIFIED_USER_ID": "1",
"MODIFIED_GUEST_ID": "180",
"MESSAGE_BY_SUPPORT_TEAM": "Y",
"TASK_TIME": null,
"NOT_CHANGE_STATUS": "N",
"SLA_ID": "1",
"SOURCE_NAME": null,
"OWNER_EMAIL": "mail@example.com",
"OWNER_LOGIN": "admin",
"OWNER_NAME": "Анастасия Иванова",
"LOGIN": "admin",
"NAME": "Анастасия Иванова",
"CREATED_EMAIL": "mail@example.com",
"CREATED_LOGIN": "admin",
"CREATED_NAME": "Анастасия Иванова",
"MODIFIED_EMAIL": "mail@example.com",
"MODIFIED_LOGIN": "admin",
"MODIFIED_NAME": "Анастасия Иванова",
"FILES": {}
}
...
},
"info": {
"count_all": 4,
"count_no_log_all": 2,
"count_select": 4
}
},
"timestamp": 1617192223
}
|
|
| POST | /v1/support/tickets/close |
|
Закрывает обращений в службу технической поддержки Обязательное поля:
|
|
POST /v1/support/tickets/close
{
"code": 200,
"status": "success",
"message": {
"0": 141
},
"timestamp": 1617202037
}
|
|
| POST | /v1/support/tickets/open |
|
Открывает обращений в службу технической поддержки Обязательное поля:
|
|
POST /v1/support/tickets/open
{
"code": 200,
"status": "success",
"message": {
"0": 141
},
"timestamp": 1617202080
}
|
|
| GET | /v1/support/tickets |
|
Возвращает список обращений пользователя по фильтру Не обязательное поле:
|
|
GET /v1/support/tickets
{
"code": 200,
"status": "success",
"message": {
"data": {
"270": {
"ID": "270",
"SITE_ID": "s1",
"DATE_CREATE": "31.03.2021 17:55:25",
"DAY_CREATE": "2021-03-31",
"TIMESTAMP_X": "31.03.2021 17:55:25",
"DATE_CLOSE": null,
"AUTO_CLOSED": "N",
"AUTO_CLOSE_DAYS": "7",
"SLA_ID": "1",
"NOTIFY_AGENT_ID": "0",
"EXPIRE_AGENT_ID": "0",
"OVERDUE_MESSAGES": "0",
"IS_NOTIFIED": "N",
"IS_OVERDUE": "N",
"CATEGORY_ID": "0",
"CRITICALITY_ID": "0",
"STATUS_ID": "0",
"MARK_ID": "0",
"SOURCE_ID": "0",
"DIFFICULTY_ID": "0",
"TITLE": "Тестовое обращение",
"MESSAGES": "1",
"IS_SPAM": null,
"OWNER_USER_ID": "1",
"OWNER_GUEST_ID": "0",
"OWNER_SID": "mail@example.com",
"CREATED_USER_ID": "1",
"CREATED_GUEST_ID": "0",
"CREATED_MODULE_NAME": "sotbit.restapi",
"RESPONSIBLE_USER_ID": "0",
"MODIFIED_USER_ID": "0",
"MODIFIED_GUEST_ID": "0",
"MODIFIED_MODULE_NAME": "",
"LAST_MESSAGE_USER_ID": "1",
"LAST_MESSAGE_GUEST_ID": "0",
"LAST_MESSAGE_SID": "test@test.tt",
"LAST_MESSAGE_BY_SUPPORT_TEAM": "Y",
"LAST_MESSAGE_DATE": "31.03.2021 17:55:25",
"SUPPORT_COMMENTS": "",
"PROBLEM_TIME": "0",
"HOLD_ON": "N",
"REOPEN": "N",
"COUPON": "",
"SUPPORT_DEADLINE": null,
"SUPPORT_DEADLINE_NOTIFY": null,
"D_1_USER_M_AFTER_SUP_M": null,
"ID_1_USER_M_AFTER_SUP_M": null,
"DEADLINE_SOURCE_DATE": "2021-03-31 17:55:25",
"LID": "s1",
"DATE_CREATE_SHORT": "31.03.2021",
"TIMESTAMP_X_SHORT": "31.03.2021",
"DATE_CLOSE_SHORT": null,
"AUTO_CLOSE_DATE": "07.04.2021 17:55:25",
"TICKET_TIME": null,
"AUTO_CLOSE_DAYS_LEFT": "7",
"USERS_ONLINE": "0",
"IS_SUPER_TICKET": "1",
"LAMP": "green_s",
"OWNER_LOGIN": "admin",
"OWNER_EMAIL": "mail@example.com",
"OWNER_NAME": "Анастасия Иванова",
"RESPONSIBLE_LOGIN": null,
"RESPONSIBLE_EMAIL": null,
"RESPONSIBLE_NAME": "",
"MODIFIED_BY_LOGIN": null,
"MODIFIED_BY_EMAIL": null,
"MODIFIED_BY_NAME": "",
"MODIFIED_LOGIN": null,
"MODIFIED_EMAIL": null,
"MODIFIED_NAME": "",
"LAST_MESSAGE_LOGIN": "admin",
"LAST_MESSAGE_EMAIL": "mail@example.com",
"LAST_MESSAGE_NAME": "Анастасия Иванова",
"CREATED_LOGIN": "admin",
"CREATED_EMAIL": "mail@example.com",
"CREATED_NAME": "Анастасия Иванова",
"B2BMOBILE_READ": "Y"
}
...
},
"info": {
"count_all": 187,
"count_select": 50
}
},
"timestamp": 1617202537
}
|
|
Вступайте в сообщество Сотбит!
Задавайте вопросы, делитесь опытом и находите ответы вместе с другими участниками.
Свяжитесь с нами
Заполните простую форму, чтобы обсудить ваш проект