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

Создание группы агентов

Синхронный метод создания новой Группы агентов в Лайнере. В случае успеха возвращает идентификатор созданной группы.

Адрес и метод

POST /v2/agent-group/create/

Параметры

names object
Объект, в котором содержаться названия группы агентов на разных языках.

names.ru string
Название группы агентов на русском языке.

names.gb string
Название группы агентов на английском языке.

agentIds array<int>
Массив, содержащий идентификаторы агентов, который привязаны к группе.

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

curl -X POST "https://YOUR_LINER_API_HOST/v2/agent-group/create/" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_TOKEN" \
  -d '{
    "names": {
      "ru": "{{nameRu}}",
      "gb": "{{nameGb}}"
    },
    "agentIds": [{{agentId}}, ...]
  }'

<?php

$host = 'https://YOUR_LINER_API_HOST';
$token = 'YOUR_API_TOKEN';

$payload = [
    'names' => [
        'ru' => $nameRu,
        'gb' => $nameGb,
    ],
    'agentIds' => [$agentId, ...],
];

$ch = curl_init($host . '/v2/agent-group/create/');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'X-Api-Key: ' . $token,
    ],
    CURLOPT_POSTFIELDS => json_encode($payload, JSON_UNESCAPED_UNICODE),
    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 payload = {
  names: {
    ru: nameRu,
    gb: nameGb
  },
  agentIds: [agentId, ...]
};

const res = await fetch(`${host}/v2/agent-group/create/`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": token
  },
  body: JSON.stringify(payload)
});

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

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

{
  "success": true,
  "message": "",
  "data": {
    "id": 100200300
  }
}

Структура ответа

Поле Тип Описание
id int Идентификатор созданной группы агентов.

Примечание

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