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

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

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

Наверх

NB:
Для выполнения следующих действий требуется действительный аккаунт разработчика Apple, устройство Mac c Xcode и действительный сертификат разработчика, установленный в Цепочку ключей (keychain).

Для получения сертификатов APNs выполните следующие действия:

1. Выполните вход в Apple developer center и выберите раздел Identifiers, затем нажмите на кнопку
2. Выберите App IDs и нажмите Continue
   
   
   
3. Заполните форму нового App ID: введите Description (описание) вашего App ID, в поле Bundle ID выберите Explicit и укажите в строке ввода Bundle ID в виде обратного доменного имени, например com.push.webim.test (т.е. test.webim.push.com в обратном порядке)
   
   
   
4. На этой же странице в списке Capabilities отметьте функционал, который вы реализуете в вашем приложении, а также Push Notifications, затем нажмите Continue
   
   
   

   NB: убедитесь, что вы создали App ID без подстановочного знака. Для идентификаторов с подстановочным знаком нельзя использовать службу push-уведомлений. Не путайте App ID и Bundle ID: Bundle ID имеет вид com.company.appname и определён в info.plist

5. Подтвердите настройки App ID, нажав Register
6. Вернитесь в раздел Identifiers и выберите только что созданный вами App ID
   
   
   
7. Прокрутите до Push Notifications и нажмите Configure
8. В секции Development SSL Certificate нажмите Create Certificate.
   
   
   
   Далее откроется форма создания сертификата. Для создания сертификата потребуется CSR-файл, сгенерированный на вашем устройстве Mac
9. Откройте на Mac сервис Keychain Access. В шапке приложения (полоска сверху) нажмите Keychain Access и перейдите в Create Assistant -> Request a Certificate From a Certificate Authority
   
   
   
10. В окне информации о сертификате заполните форму, указав ваш email и имя. Выберите сохранение на диске и нажмите Continue. CSR-файл будет создан и сохранён на устройстве Mac
    
    
    
11. Вернитесь на открытую страницу Apple developer center. В форме создания сертификата нажмите Choose File и загрузите с устройства созданный CSR-файл. Нажмите Continue
    
    
    
12. Далее появится страница, где будет отображена информация о новом APNs-сертификате (имя сертификата, дата окончания действия, тип сертификата и информация о создателе сертификата). Нажмите Download, чтобы загрузить его
    
    
    
13. Откройте Keychain Access в разделе login -> Certificates появится только что загруженный APNs-сертификат. Выберите его и нажмите Export
    
    
    
    
    
    
14. В форме экспорта укажите формат .p12
    
    
    
    Нажмите Save. Далее Mac OS попросит вас подтвердить сохранение: в первой форме просто нажмите Enter, в следующей введите ваш пароль администратора и нажмите Allow
15. Чтобы создать production-сертификат для вашего iOS-приложения, выполните пункты 6-14 этой инструкции, но в пункте 8 нажмите Create Certificate в секции Production SSL Certificate

NB: после создания сертификата(ов), также убедитесь, что в проекте вашего iOS-приложения в Xcode включено Automatic signing, а в разделе Capabilities вашего проекта включены push-уведомления.

В версии Webim 10.1 стало возможным добавлять сертификаты APNs через интерфейс Консоли управления (см. Сертификаты).

Наверх

Подключение нескольких Android-приложений

К одному проекту Firebase можно привязать несколько Android-приложений. Так как ключ FCM API KEY относится к проекту в целом, то все приложения, добавленные в проект, смогу получать push-уведомления по этому ключу. Чтобы привязать дополнительные Android-приложения, достаточно выполнить следующее:

1. Откройте страницу вашего проекта в Firebase
2. Рядом с уже созданным приложением нажмите кнопку Add app
   
   
   
3. Выберите платформу Android
   
   
   

NB:

• в рамках проекта Firebase можно добавить приложение в том числе и на платформе iOS, но в этом случае push-уведомления не будут приходить на устройства, где установлено такое приложение, так как сервис Webim не поддерживает данную функциональность. О добавлении дополнительного приложения на платформе iOS сказано в следующем подразделе.
• Все Android-приложения, которые подключены к одному аккаунту Webim, должны быть привязаны к одному проекту в Firebase. Получение push-уведомлений на приложения, привязанные к разным проектам Firebase, не предусмотрено.

Подключение нескольких iOS-приложений

Для подключения дополнительных iOS-приложений в Apple developer center требуется создать новый App ID и получить сертификаты APNs в формате .p12 (см. инструкцию) для каждого дополнительного приложения, после чего обратиться в техническую поддержку и предоставить эти сертификаты. Далее сотрудники Webim с помощью этих сертификатов настроят отправку push-уведомлений для всех дополнительно привязанных приложений на вашем аккаунте.

Для автоматической обработки и отображения 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".

Наверх