tencent cloud

文档反馈

快速接入

最后更新时间:2025-01-02 14:17:28

    步骤1: 集成消息推送插件

    本插件在 pub.dev 的包名为: tencent_cloud_chat_push ,您可以收到将其引入 pubspec.yaml 依赖目录中,也可以执行下列命令,自动安装。
    flutter pub add tencent_cloud_chat_push

    步骤2: 推送参数配置

    iOS
    Android
    请将您在厂商配置步骤中,获取到的 iOS APNs 推送证书,上传至 IM 控制台。
    IM 控制台会为您分配一个证书 ID,见下图:
    
    
    
    注册推送需要将此证书 ID(apnsCertificateID)传入:
    TencentCloudChatPush().registerPush(apnsCertificateID: 您配置的证书 ID);
    完成控制台厂商推送信息填写后,下载并添加配置文件到工程。将下载的 timpush-configs.json 文件添加到项目的 android/app/src/main/assets 目录下,如果该目录不存在,请手动创建.
    1.选择下载配置文件 timpush-configs.json
    2.添加到工程
    
    
    
    
    
    

    步骤3: 客户端代码配置

    本步骤需要编写若干原生代码,例如:Swift、 Java、XML 等。
    请不要担心,您可直接根据说明,复制我们提供的代码到指定文件即可。
    iOS
    Android
    您可使用 Xcode 编辑,也可直接在 Visual Studio Code 或 Android Studio 中编辑。
    打开 ios/Runner/AppDelegate.swift 文件,将下列圈出的代码粘贴进入,效果如图所示。代码附在图片后。
    
    
    
    import UIKit
    import Flutter
    
    // Add these two import lines
    import TIMPush
    import tencent_cloud_chat_push
    
    // Add `, TIMPushDelegate` to the following line
    @UIApplicationMain
    @objc class AppDelegate: FlutterAppDelegate, TIMPushDelegate {
    override func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {
    GeneratedPluginRegistrant.register(with: self)
    return super.application(application, didFinishLaunchingWithOptions: launchOptions)
    }
    // To be deprecated
    @objc func offlinePushCertificateID() -> Int32 {
    return TencentCloudChatPushFlutterModal.shared.offlinePushCertificateID();
    }
    
    // Add this function
    @objc func businessID() -> Int32 {
    return TencentCloudChatPushFlutterModal.shared.businessID();
    }
    
    // Add this function
    @objc func applicationGroupID() -> String {
    return TencentCloudChatPushFlutterModal.shared.applicationGroupID()
    }
    // Add this function
    @objc func onRemoteNotificationReceived(_ notice: String?) -> Bool {
    TencentCloudChatPushPlugin.shared.tryNotifyDartOnNotificationClickEvent(notice)
    return true
    }
    }
    建议使用 Android Studio 完成本部分编辑。
    在您项目 android 路径下 MainActivity 同级目录中,新建一个新的 Application 文件类,例如可命名为 MyApplication.java
    如果您已经自定义了一个 Application 类,则可直接复用,不需要再次创建。
    
    将下列代码粘贴到该文件中如上图所示:
    package 替换成您自己的, 一般 Android Studio 会自动生成; import com.tencent.chat.flutter.push.tencent_cloud_chat_push.application.TencentCloudChatPushApplication; public class MyApplication extends TencentCloudChatPushApplication { @Override public void onCreate() { super.onCreate(); } }
    说明:
    如果您已经创建了自己的 Application 为了其他用途,请直接 extends TencentCloudChatPushApplication 并保证 onCreate() 函数中,调用了 super.onCreate(); 即可。
    打开 android/app/src/main/AndroidManifest.xml 文件,为 <application> 标签,新增指定一个 android:name 参数即可,指向刚制作的自定义 Application 类。如图所示:
    

    步骤4: 客户端厂商配置

    iOS
    Android
    iOS 端无需进行此步骤。
    打开 android/app/build.gradle 文件,在最后,新增 dependencies 配置,并根据需要,引入下列全部或部分厂商的推送包。只有引入对应厂商的推送包,才能启用该厂商的原生推送能力。
    dependencies {
    // 版本号 “VERSION” 请前往 更新日志 中获取配置。
    // Huawei
    implementation 'com.tencent.timpush:huawei:VERSION'
    // XiaoMi
    implementation 'com.tencent.timpush:xiaomi:VERSION'
    // OPPO
    implementation 'com.tencent.timpush:oppo:VERSION'
    // vivo
    implementation 'com.tencent.timpush:vivo:VERSION'
    // Honor
    implementation 'com.tencent.timpush:honor:VERSION'
    // Meizu
    implementation 'com.tencent.timpush:meizu:VERSION'
    // Google Firebase Cloud Messaging (Google FCM)
    implementation 'com.tencent.timpush:fcm:VERSION'
    }
    Vivo 和荣耀适配 根据 vivo 和荣耀厂商接入指引,需要将 APPID 和 APPKEY 添加到清单文件中。
    方法1
    方法2
    // android/app/build.gradle
    
    android {
    ...
    defaultConfig {
    ...
    manifestPlaceholders = [
    "VIVO_APPKEY" : "您应用分配的证书 APPKEY",
    "VIVO_APPID" : "您应用分配的证书 APPID",
    "HONOR_APPID" : "您应用分配的证书 APPID"
    ]
    }
    }
    // android/app/src/main/AndroidManifest.xml
    
    // Vivo begin
    <meta-data tools:replace="android:value"
    android:name="com.vivo.push.api_key"
    android:value="您应用分配的证书 APPKEY" />
    <meta-data tools:replace="android:value"
    android:name="com.vivo.push.app_id"
    android:value="您应用分配的证书 APPID" />
    // Vivo end
    
    // Honor begin
    <meta-data tools:replace="android:value"
    android:name="com.hihonor.push.app_id"
    android:value="您应用分配的证书 APPID" />
    // Honor end
    华为、荣耀和 Google FCM 适配
    按照厂商方法,集成对应的 plugin 和 json 配置文件。
    注意:
    以下荣耀的适配仅 7.7.5283 及以上版本需要配置。
    1.1 下载配置文件添加到工程根目录/Android/app。
    华为
    荣耀
    Google FCM
    操作路径
    
    
    
    
    
    
    
    
    
    
    
    
    1.2 在项目级 build.gradle 文件中 buildscript -> dependencies 下添加以下配置:
    Gradle 7.1 及以上版本
    Gradle 7.0 版本
    Gradle 7.0 以下版本
    在项目级 build.gradle 文件中 buildscript -> dependencies 下添加以下配置:
    buildscript {
    dependencies {
    ...
    classpath 'com.huawei.agconnect:agcp:1.6.0.300' classpath 'com.hihonor.mcs:asplugin:2.0.1.300' classpath 'com.google.gms:google-services:4.4.0'
    }
    }
    在项目级 settings.gradle 文件中 buildscript -> repositories 和 allprojects -> repositories 下添加以下仓库配置:
    pluginManagementbuildscript {
    repositories {
    gradlePluginPortal() mavenCentral() maven { url "https://mirrors.tencent.com/nexus/repository/maven-public/" } // 配置HMS Core SDK的Maven仓地址。 maven {url 'https://developer.huawei.com/repo/'} maven {url 'https://developer.hihonor.com/repo'}
    }
    }
    allprojects {
    ...
    repositories {
    mavenCentral() maven { url "https://mirrors.tencent.com/nexus/repository/maven-public/" } // 配置HMS Core SDK的Maven仓地址。 maven {url 'https://developer.huawei.com/repo/'} maven {url 'https://developer.hihonor.com/repo'}
    }
    }
    }
    在项目级 build.gradle 文件中 buildscript 下添加以下配置:
    buildscript {
    repositories {
    mavenCentral() maven { url "https://mirrors.tencent.com/nexus/repository/maven-public/" } // 配置HMS Core SDK的Maven仓地址。 maven {url 'https://developer.huawei.com/repo/'} maven {url 'https://developer.hihonor.com/repo'}
    }
    dependencies {
    ...
    classpath 'com.google.gms:google-services:4.2.0'
    classpath 'com.huawei.agconnect:agcp:1.4.1.300'
    classpath 'com.hihonor.mcs:asplugin:2.0.1.300'
    }
    }
    在项目级 settings.gradle 文件中 allprojects -> repositories 下添加以下仓库配置:
    allprojects {
    ...
    repositories {
    mavenCentral() maven { url "https://mirrors.tencent.com/nexus/repository/maven-public/" } // 配置HMS Core SDK的Maven仓地址。 maven {url 'https://developer.huawei.com/repo/'} maven {url 'https://developer.hihonor.com/repo'}
    }
    }
    在项目级 build.gradle 文件中 buildscript 和 allprojects 下添加以下配置:
    buildscript {
    repositories {
    mavenCentral() maven { url "https://mirrors.tencent.com/nexus/repository/maven-public/" } // 配置HMS Core SDK的Maven仓地址。 maven {url 'https://developer.huawei.com/repo/'} maven {url 'https://developer.hihonor.com/repo'}
    }
    dependencies {
    ...
    classpath 'com.google.gms:google-services:4.2.0'
    classpath 'com.huawei.agconnect:agcp:1.4.1.300'
    classpath 'com.hihonor.mcs:asplugin:2.0.1.300'
    }
    }
    
    allprojects {
    repositories {
    mavenCentral() maven { url "https://mirrors.tencent.com/nexus/repository/maven-public/" } // 配置HMS Core SDK的Maven仓地址。 maven {url 'https://developer.huawei.com/repo/'} maven {url 'https://developer.hihonor.com/repo'}
    }
    }
    1.3 在应用级 build.gradle 文件中添加下方配置:
    apply plugin: 'com.google.gms.google-services'
    apply plugin: 'com.huawei.agconnect'
    apply plugin: 'com.hihonor.mcs.asplugin'

    步骤5: 处理消息点击回调,并解析参数

    如果您需要自定义解析收到的远程推送,您可按照如下方法实现:
    自定义点击跳转实现
    自定义点击跳转实现(旧方案)
    TIMPushListener timPushListener = TIMPushListener(
    onNotificationClicked: (String ext) {
    debugPrint("ext: $ext");
    // 获取 ext 自定义跳转
    }
    );
    tencentCloudChatPush.addPushListener(listener: timPushListener);
    请定义一个函数,用于接受推送消息点击回调事件.
    该函数请定义成 {required String ext, String? userID, String? groupID} 的入参形式。
    其中,ext字段,为该消息所携带的完整 ext 信息,由发送方指定,如果未指定,则有默认值。您可根据解析该字段,跳转至对应页面。
    userID 和 groupID 字段,为本插件,自动尝试解析 ext Json String, 获取里面携带的单聊对方 userID 和 群聊 groupID 信息。如果您未自定义 ext 字段,ext 字段由 SDK 或 UIKit 默认指定,则可使用此处的默认解析。如果尝试解析失败,则为 null 空。
    您可定义一个函数来接收该回调,并据此跳转至对应会话页面或您的业务页面。
    示例如下:
    void _onNotificationClicked({required String ext, String? userID, String? groupID}) {
    print("_onNotificationClicked: $ext, userID: $userID, groupID: $groupID");
    if (userID != null || groupID != null) {
    // 根据 userID 或 groupID 跳转至对应 Message 页面.
    } else {
    // 根据 ext 字段, 自己写解析方式, 跳转至对应页面.
    }
    }

    步骤6: 注册推送插件

    请在 IM 登录完成后,且在其他插件 (如 CallKit) 使用前,立即注册推送插件。请注意,不要在 Flutter 程序入口的 main 方法中调用。
    调用 TencentCloudChatPush().registerPush 方法成功后,就可以收到离线推送通知了。
    TencentCloudChatPush().registerPush(
    onNotificationClicked: _onNotificationClicked,
    sdkAppId: 您的sdkAppId,
    appKey: "客户端密钥"
    apnsCertificateID: 您配置的证书 ID);

    步骤7: 消息推送触达统计

    如果您需要统计触达数据,请按照如下完成配置:
    华为
    荣耀
    vivo
    魅族
    iOS
    
    回执地址:
    新加坡: https://apisgp.im.qcloud.com/v3/offline_push_report/huawei
    韩 国: https://apikr.im.qcloud.com/v3/offline_push_report/huawei
    美 国: https://apiusa.im.qcloud.com/v3/offline_push_report/huawei
    德 国: https://apiger.im.qcloud.com/v3/offline_push_report/huawei
    印 尼: https://apiidn.im.qcloud.com/v3/offline_push_report/huawei
    中 国: https://api.im.qcloud.com/v3/offline_push_report/huawei
    注意:
    华为推送证书 ID <= 11344 ,使用华为推送 v2 版本接口,不支持触达和点击回执,请重新生成更新证书 ID。
    
    回执地址:
    新加坡: https://apisgp.im.qcloud.com/v3/offline_push_report/honor
    韩 国: https://apikr.im.qcloud.com/v3/offline_push_report/honor
    美 国: https://apiusa.im.qcloud.com/v3/offline_push_report/honor
    德 国: https://apiger.im.qcloud.com/v3/offline_push_report/honor
    印 尼: https://apiidn.im.qcloud.com/v3/offline_push_report/honor
    中 国: https://api.im.qcloud.com/v3/offline_push_report/honor
    回调地址配置
    回执 ID 配置 IM 控制台
    
    
    
    回执地址:
    新加坡:https://apisgp.im.qcloud.com/v3/offline_push_report/vivo
    韩 国:
    https://apikr.im.qcloud.com/v3/offline_push_report/vivo
    美 国: https://apiusa.im.qcloud.com/v3/offline_push_report/vivo
    德 国: https://apiger.im.qcloud.com/v3/offline_push_report/vivo
    印 尼: https://apiidn.im.qcloud.com/v3/offline_push_report/vivo
    中 国:
    https://api.im.qcloud.com/v3/offline_push_report/vivo
    
    
    
    打开回执开关
    配置回执地址
    
    
    
    
    
    
    回执地址:
    新加坡: https://apisgp.im.qcloud.com/v3/offline_push_report/meizu
    韩 国: https://apikr.im.qcloud.com/v3/offline_push_report/meizu
    美 国: https://apiusa.im.qcloud.com/v3/offline_push_report/meizu
    德 国: https://apiger.im.qcloud.com/v3/offline_push_report/meizu
    印 尼: https://apiidn.im.qcloud.com/v3/offline_push_report/meizu
    中 国: https://api.im.qcloud.com/v3/offline_push_report/meizu
    注意:
    打开回执开关后,请务必确保回执地址正确配置。不配置或者配置地址错误,都会影响推送功能。
    iOS 端推送触达统计配置,请参见 统计推送抵达率
    其余支持厂商不需要配置,FCM 暂不支持推送统计功能。
    恭喜您已经完成了推送插件的接入,需要提醒您:推送插件试用或购买到期后,将自动停止提供推送服务(包括普通消息离线推送、全员/标签推送等服务)。为避免影响您业务正常使用,请提前购买/续费
    说明:
    接入完成收不到推送,请先自助使用 排查工具 查看下具体原因,也需要关注 厂商消息分类机制
    推送指标数据查看,请使用 数据统计 查询。
    全员/标签推送功能请参见:REST API 接口 - 发起全员/标签推送
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持