Перейти к содержанию

Детали группы агентов

Метод получения детальной информации о Группе агентов в Лайнере по её идентификатору.

Адрес и метод

GET /v2/agent-group/{id}/

id
Идентификатор группы агентов в Лайнере. Значение > 0

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

curl -X GET "https://YOUR_LINER_API_HOST/v2/agent-group/{id}/" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_TOKEN"

<?php

$host = 'https://YOUR_LINER_API_HOST';
$token = 'YOUR_API_TOKEN';
$id = (int)$id;

$ch = curl_init($host . '/v2/agent-group/' . $id . '/');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'X-Api-Key: ' . $token,
    ],
    CURLOPT_TIMEOUT => 15,
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);

if ($response === false) {
    throw new RuntimeException('cURL error: ' . curl_error($ch));
}

curl_close($ch);

echo "HTTP {$httpCode}\n";
echo $response;

const host = "https://YOUR_LINER_API_HOST";
const token = "YOUR_API_TOKEN";
const id = Number(id);

const res = await fetch(`${host}/v2/agent-group/${id}/`, {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": token
  }
});

const data = await res.json();
console.log("HTTP", res.status, data);

Пример ответа

{
  "success": true,
  "message": "",
  "data": {
    "id": "{{id}}",
    "names": {
      "ru": "{{names.ru}}",
      "gb": "{{names.gb}}"
    },
    "agentIds": "{{agentIds}}",
    "createdAt": "{{createdAt}}",
    "updatedAt": "{{updatedAt}}"
  }
}

Поля ответа

Поле Тип Описание
id int Идентификатор группы агентов в Лайнере.
names object Объект, содержащий названия группы агентов на разных языках.
names.ru string Название группы агентов на русском языке.
names.gb string Название группы агентов на английском языке.
agentIds array<int> Массив идентификаторов агентов, которые привязаны к группе.
createdAt string Дата и время создания (ISO 8601).
updatedAt string Дата и время обновления (ISO 8601).

Примечание

Выше описана структура поля data. Общий формат ответа API см. в разделе Схема запросов