Контакты

addContact

iOS 2.22Android 2.22Web 2.22

Метод добавления контакта в телефонную книгу на мобильных устройствах. В веб-клиенте скачается файл в формате "vcf".

Аргументы

Аргументом метода является объект, содержащий параметры:

Параметр	Тип данных	Описание
phone	string	Номер телефона
name	string	Имя контакта

Возвращаемое значение

Возвращаемое значение содержит Promise, который будет исполнен.

Пример:

import * as SDK from "@expressms/smartapp-sdk";

async function test() {
  try {
    const name = "Ivan Ivanov";
    const phone = "+79876543210"

    await SDK.addContact({ name, phone });
  } catch(error) {
    console.log(error);
  }
}

getContact

iOS 2.22Android 2.22Web 2.22

Метод поиска контакта в телефонной книге. Применим только на мобильных устройствах.

Аргументы

Аргументом метода является объект, содержащий параметр:

Параметр	Тип данных	Описание
phone	string	Номер телефона

Возвращаемое значение

Возвращаемое значение содержит Promise, который после исполнения вернет объект с атрибутом payload. Объект содержажит следующие свойства:

Свойство	Тип данных	Описание
phone	string	Номер телефона
name	string	Имя контакта

Пример:

import * as SDK from "@expressms/smartapp-sdk";

async function test() {
  try {
    const phone = "+79876543210"

    const { payload } = await SDK.getContact({ phone });

    console.log(payload.name)
  } catch(error) {
    console.log(error);
  }
}

openContactCard

iOS 3.2Android 3.2Web 3.2

Метод отображения карточки контакта по HUID.

Аргументы

Аргументом метода является объект, содержащий параметр:

Параметр	Тип данных	Описание
userHuid	string	HUID контакта

Возвращаемое значение

Возвращаемое значение содержит Promise, который будет исполнен.

Пример:

import * as SDK from "@expressms/smartapp-sdk";

async function test() {
  try {
    const userHuid = "123e4567-e89b-12d3-a456-426655440000";

    await SDK.openContactCard({ userHuid });
  } catch(error) {
    console.log(error);
  }
}

requestSelfProfile

iOS 3.4Android 3.4Web 3.4

Метод получения данных текущего пользователя.

Возвращаемое значение

Возвращаемое значение содержит Promise, который после исполнения вернет объект с атрибутом payload. Объект содержит следующие свойства:

Свойство	Тип данных	Описание
userHuid	string	HUID пользователя
name	string	Имя пользователя
avatar	string	Аватар (опционально)
avatarPreview	string	Превью аватара (опционально)
company	string	Наименование компании (опционально)
department	string	Наименование департамента (опционально)
office	string	Адрес офиса (опционально)
manager	string	Имя менеджера (опционально)
managerHuid	string	HUID менеджера (опционально)
email	string	Email пользователя (опционально)
phone	string	Телефон пользователя
otherPhone	string	Дополнительный телефон пользователя (опционально)
ipPhone	string	Номер SIP (опционально)
otherIpPhone	string	Дополнительный номер SIP (опционально)
description	string	Дополнительное описание (опционально)

Пример:

import * as SDK from "@expressms/smartapp-sdk";

async function test() {
  try {
    const { payload } = await SDK.requestSelfProfile();

    console.log(`Username = ${payload.name}`);
  } catch(error) {
    console.log(error);
  }
}

searchCorporatePhonebook

iOS 3.0Android 3.0Web 3.0

Метод поиска корпоративных пользователей. В результате поиска выводятся также найденные пользователи с трастовых серверов.

Аргументы

Аргументом метода является объект, содержащий параметр:

Параметр	Тип данных	Описание
filter	string	Строка поиска

Возвращаемое значение

Возвращаемое значение содержит Promise, который после исполнения вернет объект с атрибутом payload. Объект содержит следующие свойства:

Свойство	Тип данных	Описание
corpPhonebookEntries	array	Список найденных корпоративных пользователей
trustSearchEntries	array	Список найденных трастовых пользователей

Списки corpPhonebookEntries и trustSearchEntries содержат следующие свойства:

Свойство	Тип данных	Описание
avatar	string	Аватар (опционально)
name	string	Имя пользователя
company	string	Наименование компании (опционально)
companyPosition	string	Должность (опционально)
office	string	Адрес офиса (опционально)
department	string	Наименование департамента (опционально)
serverName	string	Наименование сервера (опционально)
contacts	array	Список контактов
- active	boolean	Признак активности
- contactType	string	Тип контакта "phone" | "email"
- contact	string	Значение
- userHuid	string	HUID контакта
- userKind	string	Тип подключения "rts_user" | "cts_user" | "botx"

Пример:

import * as SDK from "@expressms/smartapp-sdk";

async function test() {
  try {
    const filter = "ivan";

    const { payload } = await SDK.searchCorporatePhonebook({ filter });

    payload.corpPhonebookEntries.forEach((entry) => {
      console.log(`Corp user name = ${entry.name}`);
    });

    payload.trustPhonebookEntries.forEach((entry) => {
      console.log(`Trust user name = ${entry.name}`);
    });
  } catch(error) {
    console.log(error);
  }
}