Пользователи¶

Примечание

Описание находится в разработке.

Получение информации о текущем пользователе¶

Наименование метода в API: user/about-me. В этот метод не требуется передавать параметры. Возвращает массив содержащий след. поля:

Параметр	Описание	Пример
id	ID пользователя в системе	1000
email	Email	my@email.ru
phone	Номер телефона	NULL
customer_id	ID клиента	10000
status	Статус пользователя	ACTIVE
rate_limit	Допустимое кол-во запросов в час	1000

Пример:

Запрос:
curl -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"jsonrpc":"2.0", "method":"user/about-me", "id":"1", "params":{}}' \
     -X POST https://api.plusofon.ru

Ответ:
{"jsonrpc":"2.0","id":"1","result":{"id":1000, ...}, "error":null}

Получение информации о пользователе¶

Наименование метода в API: user/about. Список передаваемых параметров:

Параметр	Описание	Пример
identifier	Email или телефон пользователя	my@email.ru

Возвращает массив содержащий след. поля:

Параметр	Описание	Пример
id	ID пользователя в системе	1000
email	Email пользователя	my@email.ru
phone	Номер телефона	NULL
customer_id	ID клиента	10000
status	Статус пользователя	ACTIVE
rate_limit	Допустимое кол-во запросов в час	1000

Пример:

Запрос:
curl -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"jsonrpc":"2.0", "method":"user/about", "id":"1", "params":{"identifier":"my@mail.ru"}}' \
     -X POST https://api.plusofon.ru

Ответ:
{"jsonrpc":"2.0","id":"1","result":{"id":1000, ...}, "error":null}

Получение списка пользователей¶

Наименование метода в API: user/list. В этот метод не требуется передавать параметры. Возвращает массив пользователей содержащий след. поля:

Параметр	Описание	Пример
id	ID пользователя в системе	1000
email	Email	my@email.ru
phone	Номер телефона пользователя	NULL
customer_id	ID клиента	10000
status	Статус пользователя	ACTIVE
rate_limit	Допустимое кол-во запросов в час	1000

Пример:

Запрос:
curl -H "Authorization: Bearer $TOKEN" \
     -H "Content-Type: application/json" \
     -d '{"jsonrpc":"2.0", "method":"user/list", "id":"1", "params":{}}' \
     -X POST https://api.plusofon.ru

Ответ:
{"jsonrpc":"2.0","id":"1","result":[{"id":1000, ...},{"id":1001, ...}],"error":null}

Роли пользователя¶

Значение	Описание
10	Может управлять любыми пользователями (ACCOUNT) внутри своего CUSTOMER
50	Может управлять только своим пользователем

Статусы пользователя¶

Значение	Описание
ACTIVE	Пользователь активен
BLOCKED	Пользователь заблокирован

Коды ошибок¶

Значение	Описание
-1	Пользователь не найден
-2	Пользователь не принадлежит данному клиенту

Получение баланса¶

Наименование метода в API: user/balance. В этот метод не требуется передавать параметры. Возвращает

Параметр	Описание	Пример
balance	Сколько денег на счету	99,5

Получение информации о списаниях и поступлениях¶

Наименование метода в API: user/xdrs. Список передаваемых параметров:

Параметр	Описание	Пример
i_service	Тип сервиса(таблица ниже)	2
from_date	Дата начала	2017-10-01 10:00:00
to_date	Дата окончания	2017-12-01 10:00:00

Возвращает массив (Ниже представленно описание некоторых его элементов)

Параметр	Описание	Пример
i_service	Тип сервиса(таблица ниже)	2
charged_amount	Сумма (при поступлениях отрицательное значение)	-2000.000
bill_time	время операции
connect_time	время начала операции
disconnect_time	время завершения операции
description	Описание

Коды сервисов¶

Код(i_service)	Описание
1	Разовые списания (например за покупку номеров)
2	Поступления денег на счет
4	Регулярные списания (абонентская плата)