Метод для получения информации о пользователе и состоянии его счёта.
Вы можете получить информацию о другом пользователе только являясь реселлером. Реселлер может получить информацию по своим пользователям, используя параметр login.
Чтобы получить информацию о контактах, используйте метод exportContacts.
Принцип использования
| Синтаксис и URL для вызова метода |
| getUserInfo ([string login]) |
| https://api.unisender.com/ru/api/getUserInfo?format=json&api_key=KEY&login=LOGIN |
| Аргументы | |
| api_key * | Ключ доступа к API. |
| login | Логин пользователя, информацию по которому хочется получить. Игнорируется, если пользователь не имеет статуса реселлера. |
| Возвращаемое значение | |
| JSON-объект со следующими полями: | |
| login | Логин пользователя. |
| Электронная почта пользователя. | |
| firstname | Имя пользователя. |
| middlename | Отчество пользователя. |
| lastname | Фамилия пользователя. |
| reg_time | Дата и время регистрации пользователя. |
| phone | Телефон пользователя. |
| company | Компания, указанная пользователем. |
| channel | Канал, через который был привлечён пользователь. |
| timezone | Часовой пояс пользователя. |
| master | Если пользователь является «дополнительным», здесь указан логин основного пользователя, иначе это поле будет пустым. |
| balance | Сумма на основном и бонусном счетах пользователя в валюте currency. Может быть и отрицательным. |
| currency | Валюта пользователя, в которой указан баланс, одна из: RUB и BYN. |
| emails_paid | Количество e-mail сообщений по тарифу «Поштучно», оплаченных пользователем за всё время пользования сервисом. |
| emails_used | Количество e-mail сообщений по тарифу «Поштучно», отправленных пользователем за всё время пользования сервисом. |
| period_emails_paid | Количество e-mail сообщений, оплаченных пользователем в текущем периоде (месяце). |
| period_emails_used | Количество e-mail сообщений, отправленных пользователем в текущем периоде (месяце). |
| email_period_start | Начало текущего периода в формате «ГГГГ-ММ-ДД чч:мм:сс» в часовом поясе UTC. |
| email_period_end | Конец текущего периода в формате «ГГГГ-ММ-ДД чч:мм:сс» в часовом поясе UTC. |
| tariff_id | Идентификатор тарифа для текущего периода. |
| next_tariff_id | Идентификатор тарифа для следующего периода. |
| services | Массив объектов, описывающих включённые услуги. Каждый объект состоит из трёх полей:
Если никакие услуги не включены, массив будет пустой. |
| country | Трёхсимвольный код страны пользователя (RUS, GBR и т.п.). |
| language | Двухсимвольный код используемого языка пользователя (ru, en, de и т.п.). |
| rights | Возвращается значение "reseller", если пользователь имеет статус реселлера. Во всех остальных случаях возвращается пустое значение. |
| is_active | 1 или 0 - разрешен или запрещен доступ к сервису. |
| disable_sending | 1 или 0 - включен или выключен сервис рассылки сообщений. Поле возвращается, только если запрос выполнен пользователем с правом CRM. |
| user_reg_info_subscribers_approx_num | Словесное описание примерного количества контактов, указанное при регистрации. Поле возвращается, только если запрос выполнен пользователем с правом CRM. |
| user_reg_info_industry_info | Наименование отрасли, сферы деятельности, указанное при регистрации. Поле возвращается, только если запрос выполнен пользователем с правом CRM. |
| user_reg_info_city | Название города, указанное при регистрации. Поле возвращается, только если запрос выполнен пользователем с правом CRM. |
| reg_ref | Страница, с которой был осуществлен переход на страницу регистрации. |
| reg_url | Страница регистрации пользователя (URL реселлера, с которого произошла регистрация). |
| subscribers_total | Контактов в рамках тарифа. Если тариф не подразумевает ограничения по количеству контактов, возвращается значение NULL. |
| subscribers_used | Использовано контактов в рамках тарифа. |
Пример возвращемого значения:
{
"result":{
"login":"test_user_login",
"email":"test@test.com",
"firstname":"test name",
"middlename":"test name",
"lastname":"test name",
"reg_time":"2011-09-05 10:00:00",
"phone":"+70000000000",
"company":"test company",
"channel":"test channel",
"timezone":"Europe/Moscow",
"master":"test_main_login",
"balance":18.52,
"currency":"USD",
"emails_paid":0,
"emails_used":40734,
"period_emails_paid":1000,
"period_emails_used":0,
"email_period_start":"2011-01-03 00:46:02",
"email_period_end":"2011-02-03 00:46:02",
"tariff_id":1,
"next_tariff_id":10
"services": [{id:234, tariff:"bitrix24_premium_3m", paidUntil:"2017-04-28 10:51:33"}],
"country":"RUS",
"language":"ru",
"rights":"reseller",
"reg_ref":"https://www.facebook.com/",
"reg_url":"https://unisender.test.ru/ru/v5/two_step_register",
"subscribers_total":500,
"subscribers_used":5
}
}
|
|
