Команды вызываются по их пути. Разделителем пути является символ точки. Путь соответсвует классам в их иерархии, описание классов доступно
здесь.
Как видим, команда получения или поиска абонентов находится непосредственно в классе API, значит вызов будет выглядеть так:
$Api->Process('API.GetClients');
Результатом будет JSON вида:
{"return":[...], "code":0}
В поле return массив ID абонентов. Поле code = 0 показывает отсутствие ошибок. Любое другое число сигнализирует о проблеме, тогда в return будет описание.
Чтобы обратиться к свойству абонента, в пути команды необходимо указать ID абонета:
// Получаем имя абонента
$Api->Process("API.Clients.$ClientGUID.AutorizeInfo.Name");
Результат:
{"return":"UserName", "code":0}
Ещё пример. Установим новый IP абоненту. Для этого нужно вначале получить все аккаунты абонента:
$Api->Process("API.Clients.$ClientGUID.AutorizeInfo.Accounts");
Результатом будет массив GUID аккаунтов:
{"return":[...], "code":0}
Теперь обратимся к нужному аккаунту, чтобы получить свойство "IP".
$Api->Process("API.Clients.$ClientGUID.AutorizeInfo.Accounts.$AccountGUID.IP");
Ответ:
{"return":"IP_клиента", "code":0}
Для установки значения необходимо добавить второй аргумент в функцию Process:
$Api->Process("API.Clients.$ClientGUID.AutorizeInfo.Accounts.$AccountGUID.IP", "192.168.10.25");
Если функция требует несколько входящих аргументов, то их нужно передавать в виде массива.
Напоминаем, описание входных аргументов Вы можете найти в описании классов
здесь.
// Добавляем аккаунт абоненту
$Api->Process("API.Clients.$ClientGUID.AutorizeInfo.Accounts.AddAccount",["120.10.53.234","","Login","Password"]);
Если операция прошла успешно, вы получит сообщение вида:
{"return":"OK", "code":0}