设置推送模板

大约 5 分钟

设置推送模板

推送模板主要用于服务器提供的默认配置不满足你的需求时，可使你设置全局范围的推送标题和推送内容。例如，服务器提供的默认设置为中文和英文的推送标题和内容，你若需要使用韩语或日语的推送标题和内容，则可以设置对应语言的推送模板。推送模板包括默认推送模板 default 和自定义推送模板。对于群组消息，你可以使用定向模板将离线通知只发送给特定用户，或向某些用户推送与其他用户不同的离线通知。

推送模板为推送的高级功能，若要设置，你需要在 声网控制台open in new window开通推送高级功能。

使用推送模板有以下优势：

  1. 自定义修改声网服务端默认推送内容。

  2. 接收方可以决定使用哪个模板。

  3. 按优先级选择模板使用方式：

    • 使用自定义推送模板的优先级高于默认推送模板。

    • 若发送方发消息时设置了推送模板，接收方即使设置了推送模板，收到推送通知后也按照发送方设置的推送模板显示。

提示

推送模板相关的数据结构，详见推送扩展字段。

配置推送模板

你可以通过以下两种方式设置：

  1. 调用 RESTful API 配置。

  2. 在声网控制台open in new window设置推送模板。

展开控制台左上角下拉框，选择需要开通即时通讯 IM 服务的项目。点击左侧导航栏的全部产品。在下拉列表中找到即时通讯 IM 并点击。 在即时通讯 IM 页面，进入功能配置标签页。在推送模板页签下，点击添加推送模板，配置相关参数，添加推送模板。

推送模板参数类型参数描述
模板名称String推送模板名称，默认模板为 default。
该参数必须填写。模板名称最多可包含 64 个字符，支持以下字符集：
- 26 个小写英文字母 a-z
- 26 个大写英文字母 A-Z
- 10 个数字 0-9
标题/内容Array推送标题/内容。该参数必须填写。这两个参数的设置方式如下：
- 输入固定的推送标题/内容，例如，标题为 “您好”，内容为“您有一条新消息”。
- 内置参数填充：1. {$dynamicFrom}：按优先级从高到底的顺序填充好友备注、群昵称（仅限群消息）和推送昵称。2. {$fromNickname}：推送昵称。3. {$msg}：消息内容。
- 自定义参数填充：模板输入数组索引占位符，格式为: {0} {1} {2} ... {n}
对于默认模板 default，参数的前两种设置方式在创建消息时无需传入该参数，第三种设置方式则需要通过扩展字段传入。使用自定义模板时，这两个参数无论通过哪种方式设置，创建消息时均需通过扩展字段传入。

img

推送模板参数在消息扩展 ext.em_push_template 中。推送模板参数的 JSON 结构如下：

{
    "ext":{
        "em_push_template":{
            "title_args":[
                "声网"
            ],
            "content_args":[
                "欢迎使用im-push",
                "加油"
            ]
        }
    }
}

# title: {0} = "声网"
# content: {0} = "欢迎使用im-push" {1} = "加油"

群昵称即群成员在群组中的昵称，群成员在发送群消息时通过扩展字段设置，JSON 结构如下：

  {
    "ext":{
            "em_push_ext":{
                "group_user_nickname":"Jane"
            }
        }
  }

发消息时使用推送模板

创建模板后，你可以在发送消息时选择此推送模板，分为以下三种情况：

提示

  1. 若使用默认模板 default，消息推送时自动使用默认模板，创建消息时无需传入模板名称。
  2. 使用自定义模板时，推送标题 和 推送内容 参数无论通过哪种方式设置，创建消息时均需通过扩展字段传入。
  1. 使用固定内容的推送模板，通过 ext 扩展字段指定推送模板名称。

这种情况下，创建消息时无需传入 titleArgs 和 contentArgs 参数。

// 下面以文本消息为例，其他类型的消息设置方法相同。

const option = {
  type: "txt",
  msg: "message content",
  to: "username",
  chatType: "singleChat",
};

// 设置推送模板。
option.ext = {
  em_push_template: {
    // 设置推送模板名称。设置前需在声网控制台或调用 REST 接口创建推送模板。
    //若为默认模板 `default`，无需传入模板名称。
    //若为自定义模板，需传入模板名称。
    name: "test7",
  },
};
  1. 使用自定义或者默认推送模板，模板中的推送标题和推送内容使用以下内置参数：
  • {$dynamicFrom}：服务器按优先级从高到底的顺序填充备注、群昵称（仅限群消息）和推送昵称。
  • {$fromNickname}：推送昵称。
  • {$msg}：消息内容。

群昵称即群成员在群组中的昵称，群成员在发送群消息时通过扩展字段设置，JSON 结构如下：

{
  "ext": {
    "em_push_ext": {
      "group_user_nickname": "Jane"
    }
  }
}

这种方式的示例代码与“使用固定内容的推送模板”的相同。

  1. 使用自定义推送模板，而且推送标题和推送内容为自定义参数：

例如，推送模板的设置如下图所示：

img

使用下面的示例代码后，通知栏中弹出的推送通知为：

img

// 下面以文本消息为例，其他类型的消息设置方法相同。

const option = {
  type: "txt",
  msg: "message content",
  to: "username",
  chatType: "singleChat",
};

// 设置推送模板。
option.ext = {
  em_push_template: {
    // 设置推送模板名称。若不指定，设置默认推送模板的信息。
    name: "push",
    // 设置填写模板标题的 value 数组。
    title_args: ["您", "消息"],
    // 设置填写模板内容的 value 数组。
    content_args: ["请", "查看"],
  },
};

// 创建文本消息。
const msg = ChatSDK.message.create(option);
// 发送消息
chatClint
  .send(msg)
  .then((res) => {
    console.log("Send message success", res);
  })
  .catch((e) => {
    console.log("Send message fail", e);
  });
上次编辑于: