推送模板管理
大约 3 分钟
console
推送模板管理
推送模板主要用于服务器提供的默认离线推送配置不满足你的需求时,设置全局范围的推送标题和推送内容。例如,服务器提供的默认设置为中文和英文的推送标题和内容,你若需要使用韩语或日语的推送标题和内容,则可以设置对应语言的推送模板。
推送模板包括默认推送模板 default
、detail
和自定义推送模板。对于群组消息,你可以使用定向模板向某些用户推送与其他用户不同的离线通知。
开通服务
推送模板是离线推送服务的高级功能,使用前应先开通该功能,详见 开通文档。
使用默认推送模板
离线推送模板开通后,模板管理 页面默认添加两个模板,default
和 detail
。若未配置自定义推送模板,消息推送时自动使用默认模板,创建消息时无需传入模板名称。
default
:默认情况下,推送标题为 您有一条新消息,推送内容为 请点击查看。detail
:默认情况下,推送标题为 您有一条新消息,推送内容为为消息发送方的推送昵称和消息内容。
你可以在 操作 栏中选择 更多 > 编辑,修改默认推送模板的推送标题和推送内容,模板名称不能编辑。
参数 | 类型 | 描述 |
---|---|---|
标题/内容 | Array | 参数的设置方式如下: - 输入固定内容,例如,标题为 您好,内容为 您有一条新消息。 - 内置参数填充:1. {$dynamicFrom} :按优先级从高到底的顺序填充好友备注、群昵称(仅限群消息)和推送昵称。2. {$fromNickname} :推送昵称。 3. {$msg} :消息内容。- 自定义参数填充:模板输入数组索引占位符,格式为: {0} {1} {2} ... {n} |
对于推送标题和内容来说,前两种设置方式在创建消息时无需传入该参数,第三种设置方式则需要通过扩展字段传入。
推送模板参数在消息扩展 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"
}
}
}
添加自定义推送模板
即时通讯 IM 支持添加自定义推送模板。除了 调用 RESTful 接口 创建自定义推送模板,你还可以在 环信控制台 添加自定义推送模板。自定义推送模板的级别比默认模板高。
在 模板管理 页面,点击 添加推送模板 创建自定义推送模板。
参数 | 类型 | 描述 |
---|---|---|
模板名称 | String | 推送模板名称,最多可包含 64 个字符,支持以下字符集: - 26 个小写英文字母 a-z - 26 个大写英文字母 A-Z - 10 个数字 0-9 |
标题/内容 | Array | 详见 默认推送模板中的配置。 |
创建消息时需通过使用扩展字段传入模板名称、推送标题和推送内容,通知栏中的推送标题和内容分别使用模板中的格式。详见 消息扩展中的默认推送模板的参数。