rhr.php¶

В этой статье

Методы API

rhr/add

rhr/chat

rhr/discard

rhr/list

Модуль управления запросами Remote Hands (RHR): создание, управление статусами, чат и история событий

Методы API¶

Метод	Действие	Описание
`add`	создание нового запроса RHR	Создает новый запрос на обслуживание (Remote Hands). Тип запроса может быть KVM, UNBLOCK или SERVICE.
`chat`	добавление сообщения в чат запроса	Добавляет видимое клиенту сообщение (историческую запись) к существующему запросу RHR.
`discard`	отмена запроса	Рекурсивно меняет статус запроса на отмену (CANCELED или CLOSED).
`list`	получение списка запросов	Возвращает список доступных задач RHR с возможностью фильтрации по локации, статусу и дате.

rhr/add¶

Создает новый запрос на обслуживание (Remote Hands). Тип запроса может быть KVM, UNBLOCK или SERVICE.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add`
token	✅	string	Токен авторизации
eq_id	✅	integer	ID оборудования (equipment ID)
type	✅	string	Тип запроса. Допустимые значения: KVM, UNBLOCK, SERVICE.
request_origin	✅	string	Источник запроса (например, CLIENT или ADMIN).
request	✅	string	Текст запроса на обслуживание.
customer_id	❌	integer	ID клиента (заполняется автоматически при авторизации)

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

curl -s "https://invapi.hostkey.ru/rhr.php" -X POST \
--data "action=add" \
--data "token=YOUR_TOKEN" \
--data "eq_id=456" \
--data "type=KVM" \
--data "request_origin=CLIENT" \
--data "request=Need help with OS installation"

Пример успешного ответа

{
"result": "OK",
"action": "add",
"requests": [
{
"id": 123,
"request": "Need help with OS installation",
"status": "pending",
"type": "KVM",
"eq_id": 456,
"created_at": "2024-05-20T12:00:00Z"
}
]
}

Примеры ошибок

{
"code": 400,
"message": "Please provide equipment ID, request type and origin to create a request"
}

rhr/chat¶

Добавляет видимое клиенту сообщение (историческую запись) к существующему запросу RHR.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `chat`
token	✅	string	Токен авторизации
id	✅	integer	ID запроса RHR
message	✅	string	Текст сообщения для чата

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

curl -s "https://invapi.hostkey.ru/rhr.php" -X POST \
--data "action=chat" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "message=Hello support!"

Пример успешного ответа

{
"history": [
{
"id": 789,
"message": "Hello support!",
"created_at": "2024-05-20T12:05:00Z",
"tags": {}
}
],
"requests": [
{
"id": 123,
"status": "active",
"request": "Need help with OS installation"
}
]
}

Примеры ошибок

{
"code": 400,
"message": "Invalid history message"
}

rhr/discard¶

Рекурсивно меняет статус запроса на отмену (CANCELED или CLOSED).

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `discard`
token	✅	string	Токен авторизации
id	✅	integer	ID запроса RHR
response	❌	string	Текст комментария при отмене (создает запись в истории)

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

curl -s "https://invapi.hostkey.ru/rhr.php" -X POST \
--data "action=discard" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "response=Reason for cancellation"

Пример успешного ответа

{
"result": "OK",
"action": "discard",
"requests": [
{
"id": 123,
"status": "canceled"
}
],
"history": null
}

Примеры ошибок

{
"code": 500,
"message": "Wrong final status detected"
}

rhr/list¶

Возвращает список доступных задач RHR с возможностью фильтрации по локации, статусу и дате.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации
location	❌	string	Фильтр по локации (DC)
status	❌	`array<string>`	Принимает несколько значений: status[]=val1&status[]=val2. Допустимые значения: PENDING, ACTIVE, SOLVED, CANCELED, CLOSED, FAILED.
date	❌	`array<string>`	Массив дат для фильтрации (date[]=val1&date[]=val2)
deleted	❌	boolean	Показывать удаленные запросы
date_issued	✅	string	Параметр date_issued (собирается из date_from и date_to)
date_from	✅	string	Дата начала периода фильтрации
date_to	✅	string	Дата окончания периода фильтрации

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

curl -s "https://invapi.hostkey.ru/rhr.php" -X POST \
--data "action=list" \
--data "token=YOUR_TOKEN" \
--data "location=DC1" \
--data "status[]=ACTIVE" \
--data "status[]=PENDING" \
--data "date[]=2023-01-01" \
--data "deleted=false" \
--data "date_issued=2023-01-01_2023-01-31" \
--data "date_from=2023-01-01" \
--data "date_to=2023-01-31"

Пример успешного ответа

{
"result": "OK",
"action": "list",
"requests": [
{
"id": 123,
"status": "active",
"request": "Install Ubuntu 22.04",
"eq_id": 55,
"tags": {}
}
],
"history": []
}

Примеры ошибок

{
"code": -1,
"message": "Permission denied"
}