Push-уведомления

• Авторизуйтесь в аккаунте Google;
• Перейдите на портал Firebase;
• Выберите необходимый проект, а если его нет, создайте его;
• На странице проекта в меню слева нажмите на значок шестерёнки и выберите из выпадающего списка Настройки проекта;

• Перейдите на вкладку Cloud Messaging и скопируйте токен из поля Ключ сервера.

Если у Вас несколько мобильных приложений, которые привязаны к аккаунту Webim и с которых Вы хотите получать push-уведомления, Вам не требуется создавать FCM-ключ для каждого. Ключ привязан к одному проекту Firebase, а к проекту, в свою очередь, может быть добавлено несколько приложений, в том числе на базе iOS.

Наверх

Для автоматической обработки и отображения push-уведомлений Ваше приложение должно быть осведомлено о возможных типах уведомлений и об аргументах, присылаемых в этих уведомлениях. Звёздочкой отмечены названия обязательных параметров.

Типы данных

Наверх

Уведомление

Возможные значения параметра loc-key (iOS) и type (Android)

• "P.CR" означает, что оператор прислал запрос контактных данных;
• "P.OA" означает, что оператор взял чат в обработку;
• "P.OF" означает, что оператор прислал файл;
• "P.OM" означает, что оператор прислал сообщение;
• «P.WM» означает, что оператор прислал виджет (для поддержки данного функционала необходимо обратиться в службу поддержки).

Значения массива аргументов — параметр loc-args (iOS) и params (Android)

• для "P.CR" – массив пустой;
• для "P.OA" – массив из одного элемента: имя оператора;
• для "P.OF" – массив из двух элементов: имя оператора, название файла;
• для "P.OM" – массив из двух элементов: имя оператора, текст сообщения.

Данные параметры приходят без названий, порядок в массиве важен.

Возможные значения параметра "event" (Android)

• "add" – push-уведомление необходимо показать;
• "del" – push-уведомление необходимо удалить.

Если push-уведомление имеет тип "P.OF" или "P.OM", то параметр "message" содержит в себе сообщение, в ином случае этого параметра нет.

Наверх

Message

Описание параметра text:

Наверх

Файл

Наверх

ImageItem

Наверх

ImageSizeItem

В уведомлениях в iOS используются в основном те же параметры. Среди специфических для этой платформы упомянем:

Наверх

Оператор взял чат в обработку:

{params=["Никита К"], type=P.OA, event=add}

Пришло сообщение:

{
            params=[
                "Никита К",
                "1232"
            ],
            type=P.OM,
            event=add,
            message={
                "kind": "operator",
                "clientSideId": "03ef89e10352b87809e67f74504c4bb6",
                "name": "Никита К",
                "avatar": "/webim/images/avatar/wmtest2_181510.png",
                "text": "1232",
                "ts": 1.531582962567873E9
            }
            }

Пришёл файл:

{
            params=   [
                "Никита К",
                "p.jpg"
            ],
            type=P.OF,
            event=add,
            message=   {
                "kind": "file_operator",
                "clientSideId": "a49529502be8482ba9134756c4a4a211",
                "name": "Никита К",
                "avatar": "/webim/images/avatar/wmtest2_181510.png",
                "text": {
                    "client_content_type": "image/jpeg",
                    "image": {
                        "size": {
                        "width": 300,
                        "height": 300
                        }
                    },
                    "visitor_id": "1b0c5d865529418a91f728c525b6d9fd",
                    "filename": "p.jpg",
                    "content_type": "image/jpeg",
                    "guid": "ac741895c19a47078bc54f722951957f",
                    "size": 53323
                },
                "ts": 1.531584932619524E9
            }
            }

Оператор запросил контактные данные:

{
            params=[

            ],
            type=P.CR,
            event=add,
            message={
                "kind": "cont_req",
                "clientSideId": "525a9cd6c49a46de90ca4c9016681b56",
                "name": "Никита К",
                "avatar": "/webim/images/avatar/wmtest2_181510.png",
                "text": "Please enter your contact information.",
                "ts": 1.531584937099446E9
            }
            }

Наверх

{
        "aps": {
            "alert": {
                "loc-key": "P.OM",
                "loc-args": ["Имя Оператора", "Сообщение"]
            },
            "sound": "default",
        },
        "webim": 1
      }

NB: в зависимости от типа сообщения, в коде push-уведомления для iOS изменяются только значения "loc-key" и "loc-args".

Наверх