×

Получите 5 готовых email-стратегий для любого бизнеса БЕСПЛАТНО!

После регистрации

меню
Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

Метод getUserInfo

Метод для получения информации о пользователе и состоянии его счёта.

Вы можете получить информацию о другом пользователе только являясь реселлером. Реселлер может получить информацию по своим пользователям, используя параметр 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Логин пользователя.
emailЭлектронная почта пользователя.
firstnameИмя пользователя.
middlenameОтчество пользователя.
lastnameФамилия пользователя.
reg_timeДата и время регистрации пользователя.
phoneТелефон пользователя.
companyКомпания, указанная пользователем.
channelКанал, через который был привлечён пользователь.
timezoneЧасовой пояс пользователя.
masterЕсли пользователь является «дополнительным», здесь указан логин основного пользователя, иначе это поле будет пустым.
balanceСумма на основном и бонусном счетах пользователя в валюте currency. Может быть и отрицательным.
balance_bonusВозвращается только если пользователь имеет статус реселлера. Бонусная часть счёта пользователя в валюте currency. Неотрицательная.
currencyВалюта пользователя, в которой указан баланс, одна из: RUB, USD, EUR или UAH.
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Массив объектов, описывающих включённые услуги. Каждый объект состоит из трёх полей:

  • id — целочисленный идентификатор услуги),
  • tariff — внутреннее имя тарифа, по которому тарифицируется услуга,
  • paidUntil — время, до которого включена услуга в формате YYYY-MM-DD hh:mm:ss в UTC.

Если никакие услуги не включены, массив будет пустой.

countryТрёхсимвольный код страны пользователя (RUS, GBR и т.п.).
languageДвухсимвольный код используемого языка пользователя (ru, en, de и т.п.).
rightsВозвращается значение «reseller», если пользователь имеет статус реселлера. Во всех остальных случаях возвращается пустое значение.
is_active1 или 0 — разрешен или запрещен доступ к сервису.
disable_sending1 или 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",
    "balance_bonus":10.52,
    "reg_ref":"https://www.facebook.com/", 
    "reg_url":"https://unisender.test.ru/ru/v5/two_step_register",
    "subscribers_total":500,
    "subscribers_used":5 
  }
}