Программные средства разработки (SDK) Pyrus для Android позволяют встроить удобный чат в ваше мобильное приложение. Встроенный чат помогает получать мгновенную обратную связь от пользователей вашего мобильного приложения.

Когда клиент пишет в чат, ваша служба поддержки автоматически получает тикет в Pyrus. Специалист отвечает на заявку прямо в Pyrus, а клиенту приходит пуш-уведомление на телефон и ответ в чат вашего мобильного приложения. Это позволяет специалистам поддержки оперативно решать вопросы клиентов.

• Внешний вид чата настраивается, поэтому чат может выглядеть как часть вашего приложения.
• Push-уведомления приходят клиенту, когда специалист отвечает на заявку.
• История переписки сохраняется в чате.
• Клиент может приложить к сообщению файлы, например фотографии, сделанные на камеру, или из галереи.

Встраиваемый чат для Android поможет решить две задачи:

• клиенты смогут обратиться в поддержку напрямую из приложения и оперативно решить свой вопрос,
• специалисты поддержки будут обрабатывать такие обращения в Pyrus аналогично заявкам из других источников.

Вы можете использовать внешний вид чата по умолчанию или настроить его так, чтобы он выглядел как органичная часть вашего приложения. Также мы предусмотрели возможность отправки файлов в чат и подписку на уведомления о новых сообщениях.

Вы можете встроить такой чат в приложение на базе Amdroid с помощью програмных средств разработки (SDK) Pyrus. Вот пошаговая инструкция.

Чтобы специалисты службы поддержки могли обрабатывать сообщения из чата в Pyrus, ваше приложение нужно подключить к форме, в которой ведётся работа с обращениями клиентов. Для начала работы вам понадобится аккаунт администратора в Pyrus с доступом к настройке формы, в которой обрабатываются обращения пользователей. Если у вас нет такого аккаунта, обратитесь к коллеге, у которого он есть.

1. Включите интеграцию в Pyrus. Убедитесь, что администратор формы в Pyrus включил интеграцию с чатом в приложении.
2. Получите AppID в настройке формы в Pyrus. Мы сгенерируем его автоматически, когда администратор формы включит интеграцию. AppID записан на странице настройки интеграции.

В файл build.gradle добавьте:

repositories {
   jcenter()
}

dependencies {
   ...
  implementation 'com.pyrus:servicedesk:1.3.5'

}

Чтобы пользователи могли прикреплять к сообщениям фотографии из галереи на устройстве или сфотографировать что-то, модуль запрашивает соответствующие доступы.

"android.permission.WRITE_EXTERNAL_STORAGE"
"android.permission.CAMERA"

При старте приложения вызовите метод init() класса PyrusServiceDesk.

Параметры метода init():

• application — объект класса Application, используемый вашим приложением.
• appId — идентификатор вашего приложения в Pyrus. Он записан в настройке формы, к которой подключён чат. Если у вас нет доступа, попросите администратора формы скопировать AppID, как описано в разделе «Получить идентификатор приложения (AppID)».

public class SampleApp extends Application {
   @Override
   public void onCreate() {
       super.onCreate();
       PyrusServiceDesk.init(
               application: this,
               appId: "your_app_id"
       );
   }
}

Чтобы запустить пользовательский интерфейс, вызовите метод start() класса PyrusServiceDesk:

• activity — объект класса Activity. Нужен для запуска пользовательского интерфейса.
• configuration — объект класса ServiceDeskConfiguration. Используется для настройки оформления чата. Может быть null для конфигурации по умолчанию.
• onStopCallback — объект интерфейса OnStopCallback. Используется для нотификации об остановке работы чата. Может быть null.

public class SampleActivity extends Activity implements OnStopCallback {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        ...
        findViewById(R.id.support).setOnClickListener(
            view -> PyrusServiceDesk.start(
            this,
	    serviceDeskConfigurationInstance,
            this
        );
    }
}

Для запуска пользовательского интерфейса используйте метод start(activity, configuration). Создать и настроить объект ServiceDeskConfiguration можно с помощью объекта класса ServiceDeskConfiguration.Builder.

Методы объекта ServiceDeskConfiguration.Builder:

• setUserName(name) задаёт имя пользователя (клиента поддержки), которое специалист службы поддержки увидит в Pyrus. Если пользователь авторизовался в приложении, вы можете передавать имя, почту и другие его данные в этот метод, чтобы оператор поддержки понимал, с кем общается, и быстрее решил вопрос.
• setChatTitle(title) задаёт заголовок в окне чата с поддержкой.
• setWelcomeMessage(message) задаёт приветственное сообщение, которое по умолчанию отображается первым в чате.
• setThemeColor(color) задаёт цвет основных элементов интерфейса.
• setAvatarForSupport(drawableResID) задаёт иконку, которая используется как аватар сотрудника службы поддержки. drawableResID — идентификатор ресурса, используемого в качестве аватара.
• build() создает объект класса ServiceDeskConfiguration.

new ServiceDeskConfiguration.Builder()
.setUserName("Иван Петров")
       .setChatTitle("Поддержка ИмяОрганизации")
       .setWelcomeMessage("Добрый день! Как я могу вам помочь?")
       .setThemeColor(Color.RED)
       .setAvatarForSupport(R.drawable.logo)
       .build())

Вы можете настроить отправку push-уведомлений, чтобы оповещать пользователя о новых сообщениях в чате. В этом разделе описан альтернативный вариант. Он проще в реализации, но уведомления будут приходить с задержкой и вы не увидите содержимое нового комментария. Настроить push-уведомления

Чтобы получать уведомления о новых сообщениях от сотрудника поддержки в чате, реализуйте интерфейс NewReplySubscriber и передайте реализацию интерфейса в метод subscribeToReplies() класса PyrusServiceDesk.

public class SampleActivity extends Activity implements NewReplySubscriber {
   @Override
   protected void onCreate(Bundle savedInstanceState) {
	  ...
       PyrusServiceDesk.subscribeToReplies(this);
	  ...
    }
@Override
protected void onDestroy() {
   ...
   PyrusServiceDesk.unsubscribeFromReplies(this);
   ...
}
   @Override
   public void onNewReply() {
       textView.setText("Есть непрочитанные сообщения");
   }
}

Вы можете настроить отправку push-уведомлений, чтобы пользователь узнавал, когда специалист поддержки отправит комментарий в чат. Общая схема оповещения выглядит так: специалист отвечает на обращение клиента в Pyrus, из Pyrus с помощью вебхука ответ специалиста и push-токен отправляется на ваш сервер. Затем push-сервер Google отправляет в приложение клиента push-уведомление о новом сообщении в чате.

Чтобы это работало, push-сервер Google должен знать токен, уникальный для устройства и вашего приложения. При запуске ваше приложение связывается с push-сервером Google и получает токен устройства, который записывается в Pyrus.

Чтобы подписаться на уведомления, зарегистрируйте пуш-токен с помощью вызова setPushToken(token, callback) класса PyrusServiceDesk.

Параметры метода setPushToken(token, callback):

• token — токен, который регистрируется в Pyrus. Используется для отправки push-уведомлений о новом сообщении в чате.
• callback — реализация интерфейса SetPushTokenCallback, метод onResult() которого будет вызван при завершении регистрации токена. Не гарантируется, что метод onResult() будет вызван в том же потоке, в котором был вызван setPushToken(token, callback).

SetPushTokenCallback имеет метод onResult(@Nullable Exception exception), параметр exception которого при успешной регистрации будет null, в противном случае exception будет содержать сообщение об ошибке.

Пример:

public class SampleApp extends Application {

   @Override
   public void onCreate() {
       super.onCreate();
       PyrusServiceDesk.init(
               this,
               "my_app_id"
       );

       PyrusServiceDesk.setPushToken(
               "my_push_token",
               exception -> {
                   Log.d("SAMPLE_APP", exception.getMessage());
               });

   }
}

На стороне сервера приложения нужно реализовать вебхук, который будет получать уведомления о новых комментариях в чате. И в настройке формы добавьте его URL.

При появлении нового ответа от поддержки на этот URL будет отправляться POST-запрос со следующим содержанием:

ticket_id — номер задачи, в которую добавлен комментарий.

token — идентификатор пользователя, включающий:

• user_id — идентификатор пользователя, который передается при каждом запросе;
• app_id — идентификатор мобильного приложения/веб-чата;
• device_id — идентификатор устройства;
• type — тип устройства: «Android».

comment — информация о новом комментарии:

• comment_id — номер нового комментария;
• body — текст комментария;
• is_inbound — всегда false, показывает, что комментарий исходящий, то есть ответ поддержки.

author — информация об авторе комментария:

• name — имя автора;
• avatar_id — идентификатор аватара автора;
• avatar_color — цвет аватара автора. Используется, если avatar_id не заполнено.

created_at — дата и время создания комментария.

attachments — описание приложенных файлов:

• id — идентификатор файла;
• name — имя файла;
• size — размер файла в байтах.

В уведомлении о закрытии заявки вы можете предложить пользователю оценить качество обслуживания с помощью смайликов, соответствующих оценке от пяти до одного.

Чтобы подключить оценку, зайдите в раздел Формы в левом меню и выберите форму, в которой работает PyrusServiceDesk.

На странице настройки формы в списке доступных расширений нажмите значок Оценка сервиса.

Установите переключатель в положение Включено.

По умолчанию пользователь может отправлять в чат фотографии, сделанные камерой, или выбирать изображения из галереи. Чтобы дать пользователю возможность отправлять другие типы файлов (например, техническую информацию, файлы конфигурации и т. д.), используйте метод registerFileChooser() класса PyrusServiceDesk.

PyrusServiceDesk.registerFileChooser(chooser), где chooser — реализация интерфейса FileChooser. Для того, чтобы перестать использовать настроенный FileChooser, в метод нужно передать null.

Методы FileChooser:

• getLabel() — заголовок пункта в меню выбора файлов.
• getIntent() — возвращает объект типа Intent, который будет использован для запуска activity, от которого ожидается получить результат. Пользовательское activity, которое будет вызвано с помощью intent, должно вернуть результат, содержащий Uri для доступа к файлу (добавьте Uri в результат методом intent.setData(uri)).

Важно: схема отправляемого Uri должна быть «content», в противном случае комментарий с файлом добавлен не будет.

public class SampleApp extends Application {
   @Override
   public void onCreate() {
       ...      
       PyrusServiceDesk.registerFileChooser(new FileChooser() {
           @NonNull
           @Override
           public String getLabel() {
               return "Отправить логи";
           }
           @NonNull
           @Override
           public Intent getIntent() {
               return new Intent(SampleApp.this, LogChooser.class);
           }
       });
   }
}

Главный класс для работы со встраиваемым чатом поддержки.

public static void init(@NonNull Application application, @NonNull String appId)

public static void registerFileChooser(@Nullable FileChooser fileChooser)

public static void setPushToken(@NonNull String token, @NonNull SetPushTokenCallback callback)

public static void start(@NonNull Activity activity)

 public static void start(@NonNull Activity activity, @NonNull ServiceDeskConfiguration configuration)

public static void subscribeToReplies(@NonNull NewReplySubscriber subscriber)

public static void unsubscribeFromReplies(@NonNull NewReplySubscriber subscriber)

 stop()

public interface OnStopCallback

Обратный вызов, который вызывается после остановки работы чата.

public class Builder

Конструктор для создания пользовательского чата [ServiceDeskConfiguration].

public ServiceDeskConfiguration build()

setAvatarForSupport

public Builder setAvatarForSupport(@DrawableRes int drawableResId)

Задаёт идентификатор ресурса с изображением, которое используется в качестве аватара специалиста службы поддержки. По умолчанию используется стандартная иконка, в качестве фона — цвет, который был настроен при вызове метода PyrusServiceDesk.start(). Если цвет на задан или не настроен, цвет фона — #008C8C.

Параметры

ID	Идентификатор изображения.

public Builder setChatTitle(@NonNull String title)

public Builder setThemeColor(@ColorInt int color)

public Builder setUserName(@NonNull String userName)

public Builder setWelcomeMessage(@NonNull String message)

public interface NewReplySubscriber

Реализация интерфейса может быть подписана на уведомления о новых сообщениях от поддержки с помощью метода subscribeToReplies() класса PyrusServiceDesk.

void onNewReply()

public interface FileChooser

Чтобы появилась возможность прикреплять файлы к сообщениям в чат, нужно реализовать интерфейс для передачи в [PyrusServiceDesk.registerFileChooser].

Intent getIntent()

String getLabel()

public interface SetPushTokenCallback

Обратный вызов, который вызывается когда регистрация push-токена завершена. Возврат без исключения означает, что токен успешно зарегистрирован.

public void onResult(@Nullable Exception exception)