Отримати властивості облікового запису користувача за його UIN.

 

Синтаксис

{
  "cmd"       : "000D",
  "ServerKey" : "iddqd",
  "APIStype"  : "mydata",
  "context"   : "myfunc",
 
  "UIN"  : 6,
  "What" : "AuthType,DomainName,Nick,DisplayName,Email,Active,FirstName,MiddleName,LastName,BirthdayISO,Sex"
}


 Параметри

Параметр

Тип

Значення

cmd

string

"0006", номер команди MCIAPI_CS_GetUINByEmail;

ServerKey

string

ключ Integration API, задається у налаштуваннях сервера;

APIStype

string

тип інтеграції. Можна задавати довільний рядок;

context

string

необов'язковий параметр, будь-який текст, що повернеться у команді-відповіді;

UIN

integer

ідентифікатор облікового запису користувача, число більше нуля;

What

string

які дані потрібно отримати про користувача, параметри через кому. Якщо нічого не вказати або вказати "all", то функція поверне всі дані, що є. Параметри у відповіді завжди будуть "camel case", але у вихідному запиті можна використовувати будь-який регістр літер. Між комами в тексті параметра не повинно бути пробілів.


Список доступних полів користувача у параметрі "What"

Назва

Тип

Опис

Avatar

integer

CRC32 фотографії користувача;

Tag

string

текстовий тег, спеціальне поле, можна змінювати та читати через MSL;

DomainName

string

ім'я домену користувача;

Nick

string

нік користувача. Якщо користувач доменний — це його доменне ім'я;

DisplayName

string

ім'я користувача, що відображається у інтерфейсі. Стиль налаштовується на сервері;

Active

boolean

активний чи заблокований обліковий запис користувача;

FirstName

string

реальне ім'я користувача;

MiddleName

string

по-батькові користувача;

LastName

string

прізвище користувача;

Registered

double

дата і час створення облікового запису;

Role

integer

роль користувача (номер групи прав);

RoleName

string

назва групи прав користувача;

MaritalStatus

integer

сімейний стан:

-1 — не вказано;

0 — у серйозних відносинах;

1 — вдівець/вдова;

2 — одружений/заміжня;

3 — заручений(а)

4 — розлучений(а);

5 — розійшлись;

6 — холостяк/незаміжня;

HomePhone

string

домашній телефон;

HomeFax

string

домашній факс;

Birthday

double

дата народження;

BirthdayISO

string

дата народження у форматі ISO 8601 (yyyy-mm-dd);

Email

string

основна адреса електронної пошти;

HomeCellular

string

особистий мобільний;

HomeStreetAddress

string

домашня адреса;

HomeCity

string

місто проживання;

HomeState

string

штат/провінція/область/край проживання;

HomeZIP

string

домашня поштова адреса;

HomeCountry

integer

країна проживання;

HomeWWW

string

особиста WEB-сторінка;

WorkDept

string

робочий підрозділ;

WorkDeptIdx

integer

внутрішній індекс робочого підрозділу (число);

WorkPosition

string

посада;

WorkPositionIdx

integer

внутрішній індекс посади (число);

WorkCompanyName

string

назва компанії;

WorkOffice

string

робочий офіс;

WorkPhone

string

робочий телефон;

WorkFax

string

робочий факс;

WorkPager

string

робочий пейджер або номер месенджера;

WorkStreetAddress

string

робоча адреса;

WorkCity

string

робоче місто;

WorkState

string

робочий штат/провінція/область/край;

WorkZIP

string

робочий поштовий індекс;

WorkCountry

integer

робоча країна;

WorkWWW

string

робоча WEB-сторінка;

SpokenLang1

integer

володіння мовами, номер 1;

SpokenLang2

integer

, номер 2;

SpokenLang3

integer

володіння мовами, номер 3;

Interests1

integer

область інтересів, номер 1;

InterestsWords1

string

область інтересів, ключові слова, номер 1;

Interests2

integer

область інтересів, номер 2;

InterestsWords2

string

область інтересів, ключові слова, номер 2;

Interests3

integer

область інтересів, номер 3;

InterestsWords3

string

область інтересів, ключові слова, номер 3;

Interests4

integer

область інтересів, номер 4;

InterestsWords4

string

область інтересів, ключові слова, номер 4;

Past1

integer

тип минулого місця роботи або навчання, номер 1;

PastWords1

string

тип минулого місця роботи чи навчання, ключові слова номер 1;

Past2

integer

тип минулого місця роботи чи навчання, номер 2;

PastWords2

string

тип минулого місця роботи чи навчання, ключові слова номер 2;

Past3

integer

тип минулого місця роботи чи навчання, номер 3;

PastWords3

string

тип минулого місця роботи чи навчання, ключові слова номер 3;

PastOrg1

integer

тип організації, минулого місця роботи, номер 1;

PastOrgWords1

string

тип організації, минулого місця роботи, ключові слова номер 1;

PastOrg2

integer

тип організації, минулого місця роботи, номер 2;

PastOrgWords2

string

тип організації, минулого місця роботи, ключові слова номер 2;

PastOrg3

integer

тип організації, минулого місця роботи, номер 3;

PastOrgWords3

string

тип організації, минулого місця роботи, ключові слова номер 3;

Sex

integer

стать користувача: 0 — не визначено, 1 — чоловічий, 2 — жіночий;

AuthType

integer

тип автентифікації клієнта: 0 — стандартний, 1 — Active Directory, 2 — без пароля, 3 — Transparent AD;

LastAccess

double

дата та час останнього доступу до сервера;

LastSpeakTime

double

дата та час останнього відправленого повідомлення;

State

integer

поточний мережевий статус користувача;

FavoriteChannelsExists

boolean

чи є у користувача список "улюблених" текстових конференцій;

UnreadedBroadcastsExists

boolean

наявність непрочитаних оповіщень;

HelloMessage

string

повідомлення-привітання, якщо є. Показується усім користувачам, які відкрили приват з цією людиною;

AutoreplayMessage

string

повідомлення-автовідповідач;

Autoreplay

boolean

чи увімкнений автовідповідач;

Reputation

integer

репутація користувача, число;

About

string

інформаційне поле "Про користувача".

 

Приклад GET-запиту в адресному рядку для браузера

http://192.168.10.1:8080/API/?data={"cmd":"000D","APIStype":"mydata","ServerKey":"iddqd","UIN":17,"What":"AuthType,DomainName,Nick,DisplayName,Email,Active,FirstName,MiddleName,LastName,BirthdayISO,Sex"}


Результат роботи
{
 "cmd"  : "000D",
 "UIN"  : 17,
 "What" : "AuthType,DomainName,Nick,DisplayName,Email,Active,FirstName,MiddleName,LastName,BirthdayISO,Sex",
 "context" : "myfunc",

 "AuthType"    : 0,
 "DomainName"  : "",
 "Nick"        : "johnronaldreueltolkien",
 "DisplayName" : "John Ronald Tolkien",
 "Email"       : "[email protected]",
 "Active"      : true,
 "FirstName"   : "John",
 "MiddleName"  : "Ronald Reuel",
 "LastName"    : "Tolkien",
 "BirthdayISO" : "1973-09-02",
 "Sex" : 1
}


Поле

Тип

Значення

cmd

string

HEX-номер команди, яка була успішно виконана;

context

string

довільний текст, що був переданий серверу в команді запиту;

UIN

integer

унікальний ідентифікатор користувача, інформація про якого було запитано;

What

string

параметри через кому, що присутні в даному JSON-об'єкті.

 

Можливі помилки

#5, MCIAPI_Error_WrongIntegrationKey

#9, MCIAPI_Error_API_Disabled

#19, MCIAPI_Error_UINNotFound

#21, MCIAPI_Error_WrongData

#24, MCIAPI_Error_UINIsNotDefined

#28, MCIAPI_Error_CannotWorkWithRobot


Дивитися ще

MCIAPI_CS_GetUINByNick