MyChat Integration API: MCIAPI_CS_SetUserInfoByUIN, изменить свойства учётной записи пользователя по его UIN
Изменить свойства учётной записи пользователя по его UIN.
Синтаксис
{
  "cmd"        : "001E",
  "ServerKey"  : "iddqd",
  "APIStype"   : "mydata",
 
  "UIN"        : 23,
  "What"       : "Email,AuthType,Active,Pass,RoleName,WorkDept,DomainName,Nick",
  "Email"      : "john.smith@fbi.com",
  "AuthType"   : 1,
  "Active"     : true,
  "Pass"       : "NewSecretPass",
  "RoleName"   : "Guests",
  "WorkDept"   : "AI engineers",
  "DomainName" : "fbi.com",
  "Nick"       : "john.smith"
}
Параметры
| 
    Параметр  | 
  
    Тип  | 
  
    Значение  | 
 
| 
    cmd  | 
  
    string  | 
  
    "001E", номер команды MCIAPI_CS_SetUINByEmail;  | 
 
| 
    ServerKey  | 
  
    string  | 
  
    ключ Integration API, задаётся в настройках сервера;  | 
 
| 
    APIStype  | 
  
    string  | 
  
    тип интеграции. Можно задавать произвольную строку;  | 
 
| 
    UIN  | 
  
    integer  | 
  
    идентификатор учётной записи пользователя, число больше нуля;  | 
 
| 
    What  | 
  
    string  | 
  
    какие данные пользователя нужно изменить. Строка с параметрами через запятую, без пробелов, регистр букв имеет значение.  | 
 
Список доступных полей пользователя в параметре "What"
| 
    Название  | 
  
    Тип  | 
  
    Описание  | 
 
| 
    Pass  | 
  
    string  | 
  
    новый пароль пользователя. Передаётся в открытом виде;  | 
 
| 
    Tag  | 
  
    string  | 
  
    текстовый тег, специальное поле, можно изменять и читать через MSL;  | 
 
| 
    DomainName  | 
  
    string  | 
  
    имя домена пользователя;  | 
 
| 
    Nick  | 
  
    string  | 
  
    ник пользователя. Если пользователь доменный — это его доменное имя;  | 
 
| 
    Active  | 
  
    boolean  | 
  
    активна или заблокирована учётная запись пользователя;  | 
 
| 
    FirstName  | 
  
    string  | 
  
    реальное имя пользователя;  | 
 
| 
    MiddleName  | 
  
    string  | 
  
    отчество пользователя;  | 
 
| 
    LastName  | 
  
    string  | 
  
    фамилия пользователя;  | 
 
| 
    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);  | 
 
| 
    | 
  
    string  | 
  
    основной адрес электронной почты;  | 
 
| 
    HomeCellular  | 
  
    string  | 
  
    личный мобильный;  | 
 
| 
    HomeStreetAddress  | 
  
    string  | 
  
    домашний адрес;  | 
 
| 
    HomeCity  | 
  
    string  | 
  
    город проживания;  | 
 
| 
    HomeState  | 
  
    string  | 
  
    штат/провинция/область/край проживания;  | 
 
| 
    HomeZIP  | 
  
    string  | 
  
    домашний почтовый индекс;  | 
 
| 
    HomeCountry  | 
  
    integer  | 
  
    страна проживания;  | 
 
| 
    HomeWWW  | 
  
    string  | 
  
    личная WEB-страница;  | 
 
| 
    WorkDept  | 
  
    string  | 
  
    рабочее подразделение, указывается в виде полного пути в дереве общего списка контактов, перечисленными через обратный слеш. Например: "Департамент продаж\Отдел маркетинга\Офис на Шевченка". Если указать пустую строку или неправильный путь — пользователь будет исключён из общего списка контактов;  | 
 
| 
    WorkDeptIdx  | 
  
    integer  | 
  
    внутренний индекс рабочего подразделения (число). Если указать неправильный индекс или -1, то система удалит пользователя из общего древовидного списка контактов компании;  | 
 
| 
    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;  | 
 
| 
    HelloMessage  | 
  
    string  | 
  
    сообщение-приветствие. Показывается всем пользователям, открывшим приват с этим человеком;  | 
 
| 
    AutoreplayMessage  | 
  
    string  | 
  
    сообщение-автоответчик;  | 
 
| 
    Autoreplay  | 
  
    boolean  | 
  
    включен или выключен автоответчик;  | 
 
| 
    Reputation  | 
  
    integer  | 
  
    репутация пользователя, целое число;  | 
 
| 
    About  | 
  
    string  | 
  
    информационное поле "О пользователе".  | 
 
Пример GET-запроса в адресной строке для браузера
http://192.168.10.1:8080/API/?data={"cmd":"001E","ServerKey":"iddqd","APIStype":"mydata","UIN":23,"What":"Email,AuthType,Active,Pass,RoleName,WorkDept,DomainName,Nick","Email":"john.smith@fbi.com","AuthType":1,"Active":true,"Pass":"NewSecretPass","RoleName":"Guests","WorkDept":"AI engineers","DomainName":"fbi.com","Nick":"john.smith"}
Результат работы
{
  "cmd" : "001E",
  "UIN" : 23 
}
| 
    Поле  | 
  
    Тип  | 
  
    Значение  | 
 
| 
    cmd  | 
  
    string  | 
  
    HEX-номер команды, которая была успешно выполнена;  | 
 
| 
    UIN  | 
  
    integer  | 
  
    уникальный идентификатор пользователя, информация о котором была обновлена.  | 
 
Возможные ошибки
#5, MCIAPI_Error_WrongIntegrationKey
#20, MCIAPI_Error_EmailNotFound
#23, MCIAPI_Error_EmailIsNotDefined
Ещё посмотреть
Created with the Personal Edition of HelpNDoc: Free EPub producer