Перейти к содержанию

Ссылка на SmartApp в карточке контакта

В клиенте "eXpress" можно осуществлять переход в SmartApp по ссылке из карточки контакта. Доступные ссылки отображаются в карточке контакта:

Рисунок_2

Настройка ссылок в карточке контакта

Для создания ссылки:

  1. Авторизуйтесь в консоли администратора CTS-сервера.
  2. Нажмите на пункт Боты в основном меню.
  3. В строке соответствующего чат-бота нажмите пиктограма.

  4. В блоке "Действия на карточке контакта" нажмите пиктограма:

    Рисунок_3

  5. Заполните поля:

    Поле Значение
    Название пункта Название пункта в карточке контакта
    Событие Событие, которое будет создано в SmartApp
    Icon Ссылка на иконку, которая отображается в названии пункта
    Scope Поле заполняется в формате JSON. Данные поля должны содержать свойство server_ids, в котором указывается список CTS серверов. Пользователям указанных ссерверов будет проставлено данное действие.
    Пример: { "server_ids": ["64c29495-cc3f-4d32-885a-54d4a2880160"]}

  6. Нажмите Сохранить.

Получение данных ссылки в SmartApp

При открытии SmartApp по ссылке из карточки контакта параметры ссылки и контакта будут доступны в ответе ready.

Пример:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import * as SDK from "@expressms/smartapp-sdk";


async function initApp() {
  const readyResponse = await SDK.ready();

  // проверка что данные поступают из меню карточки контакта
  if (readyResponse.initialData?.initiator == "profile_action") {
    const { action, profile } = readyResponse.initialData.meta;

    // обработать action, указывающий какой пункт меню контакта вызван
    console.log("action", action);

    // обработать данные профиля пользователя, в котором вызвана команда
    console.log("profile", profile);
  }
}

Свойство initialData.meta.action

Данное свойство имеет значение, введенное в поле "Событие" в консоли администратора.

Свойства объекта initialData.meta.profile

Параметр Тип данных Описание
userHuid string Huid контакта
name string Имя контакта
avatar string URL аватара контакта
avatarPreview string URL превью аватара контакта
company string Название компании контакта
companyPosition string Должность контакта
department string Отдел контакта
office string Номер офиса контакта
manager string Имя руководителя контакта
managerHuid string HUID руководителя контакта
email string Адрес электронной почты пользователя, в канале — null
description string Дополнительная информация о контакте
otherPhone string Телефон контакта
ipPhone string Номер IP телефона контакта
otherIpPhone string Дополнительный номер IP телефона контакта