Cписок клиентов

Получение списка клиентов Агентства

📘

Адрес для отправки запросов:

https://tdm4.adcloud.org/api/v2/?method=MethodName

В качестве get-параметра необходимо передавать название метода, что позволит динамически определить метод через URL-строку.

За предоставлением доступа к методам работы с клиентами агентства обратитесь к администратору.

Получение списка клиентов Агентства

"method": "Partner.getClients" позволяет пользователю получить список клиентов по xxhash Агентства. Для этого необходимо выполнить запрос, указав в качестве параметров "agency_xxhash" - xxhash агентства. Допустимо вызывать метод без параметров, в таком случае вернется список всех клиентов доступных вам агентств.

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

JSON

{
  "jsonrpc": "2.0",
  "method": "Partner.getClients",
  "params": {
    "agency_xxhash": "47111116A9D09E22"
  },
  "id": 1
}

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

JSON

{
    "jsonrpc": "2.0",
    "result": [
        {
            "title": "Test MS",
            "xxhash": "1BD7877D21F4444A",
            "internal_id": "tdm4#3434",
            "status": "ARCHIVE"
        },
        {
            "title": "Тестовый клиент",
            "xxhash": "11DC45200292222E",
            "internal_id": "tdm4#1111",
            "status": "ARCHIVE"
        },
        {
            "title": "Test client API2",
            "xxhash": "1B6150B4EA891111",
            "internal_id": "tdm4#2222",
            "status": "LAUNCHED"
        },
        {
            "title": "Новый клиент",
            "xxhash": "2AA79999A9A3C7C7",
            "internal_id": "tdm4#3333",
            "status": "ARCHIVE"
        }
    ],
    "id": 1
}

Метод возвращает в секции результатов информацию о каждом клиенте Агентства, содержащую следующие поля:

Поле	Описание	Пример значения
title	Название клиента	Тестовый клиент
xxhash	xxhash клиента	11DC45200292222E
internal_id	Внутренний идентификатор клиента	tdm4#1111
status	Статус клиента. Возможные значения: STOPPED - остановлен", "LAUNCHED - активен", "DELETED" - удален, "ARCHIVE - в архиве".	ARCHIVE