环信IM即时通讯（服务端） - 离线推送设置

IM即时通讯

简介/价格/文档

文档简介：

本文展示如何调用环信即时通讯 RESTful API 实现离线推送，包括设置离线推送通知显示的昵称、推送通知方式及免打扰模式。调用以下方法前，请先参考接口频率限制了解即时通讯 RESTful API 的调用频率限制。

*此产品及展示信息均由环信官方提供。免费试用咨询热线：400-826-7010，为您提供专业的售前咨询，让您快速了解云产品，助您轻松上云！微信咨询

免费试用、价格特惠

文档详情

提示

若要使用离线推送的高级功能，即设置推送通知模式、免打扰模式和自定义推送模板，你需要在环信即时通讯云控制后台open in new window中点击你的应用后选择即时通讯 > 功能配置 > 功能配置总览开通离线推送高级功能。

#公共参数

以下表格列举了即时通讯 RESTful API 的公共请求参数和响应参数：

#请求参数

参数	类型	是否必需	描述
host	String	是	环信即时通讯 IM 分配的用于访问 RESTful API 的域名。详见获取环信即时通讯 IM 的信息。
org_name	String	是	环信即时通讯 IM 为每个公司（组织）分配的唯一标识。详见获取环信即时通讯 IM 的信息。
app_name	String	是	你在环信即时通讯云控制台创建应用时填入的应用名称。详见获取环信即时通讯 IM 的信息。
username	String	是	环信用户 ID。

#响应参数

参数	类型	描述
action	String	请求方式。
organization	String	环信即时通讯 IM 为每个公司（组织）分配的唯一标识，与请求参数 org_name 相同。
application	String	环信即时通讯服务分配给每个 app 的唯一内部标识，开发者无需关注。
uri	String	请求 URL。
timestamp	Long	HTTP 响应的 Unix 时间戳，单位为毫秒。
applicationName	String	你在环信即时通讯云控制台创建应用时填入的应用名称，与请求参数 app_name 相同。
duration	Int	从发送 HTTP 请求到响应的时长，单位为毫秒。

#认证方式

环信即时通讯 REST API 要求 Bearer HTTP 认证。每次发送 HTTP 请求时，必须在请求头部填入如下 Authorization 字段：

Authorization: Bearer YourAppToken

为提高项目的安全性，环信使用 Token（动态密钥）对即将登录即时通讯系统的用户进行鉴权。即时通讯 REST API 仅支持使用 App Token 的鉴权方式，详见使用 App Token 鉴权。

#设置离线推送时显示的昵称

设置离线推送时显示的昵称。

#HTTP 请求

PUT https://{host}/{org_name}/{app_name}/users/{username}

#路径参数

参数及说明详见公共参数。

参数	类型	描述	是否必需
Content-Type	String	内容类型。请填 application/json。	是
Accept	String	内容类型。请填 application/json。	是
Authorization	String	App 管理员的鉴权 token，格式为 Bearer YourAppToken，其中 Bearer 为固定字符，后面为英文空格和获取到的 app token。	是

#请求 body

请求包体为 JSON Object 类型，包含以下字段：

参数	类型	描述	是否必需
nickname	String	收到离线推送通知时显示的昵称，仅用在客户端推送通知栏显示。你可自定义该昵称，长度不能超过 100 个字符。支持以下字符集： - 26 个小写英文字母 a-z； - 26 个大写英文字母 A-Z； - 10 个数字 0-9； - 中文； - 特殊字符。该昵称可与用户信息中的昵称设置不同，不过我们建议这两种昵称的设置保持一致。因此，修改其中一个昵称时，也需调用相应方法对另一个进行更新，确保设置一致。更新用户信息中的昵称的方法，详见设置用户属性。	否

#HTTP 响应

#响应 body

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

参数	类型	描述
entities	JSON	用户在推送通知中显示的昵称以及用户相关信息。
entities.uuid	String	用户的 UUID。系统为该请求中的 app 或用户生成的唯一内部标识，用于生成用户权限 token。
entities.type	String	用户类型，即 user。
entities.created	Number	用户注册的 Unix 时间戳，单位为毫秒。
entities.modified	Number	最近一次修改用户信息的 Unix 时间戳，单位为毫秒。
entities.username	String	用户 ID。用户登录的唯一账号。
entities.activated	Boolean	用户是否为活跃状态： true：用户为活跃状态。 false：用户为封禁状态。如要使用已被封禁的用户账户，你需要调用解禁用户解除封禁。
entities.nickname	String	推送通知中显示的昵称。

其他参数及说明详见公共参数。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考错误码了解可能的原因。

#示例

#请求示例

curl -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Author

ization: Bearer <YourAppToken>' -d '{    "nickname": "testuser"   }' 'https://XXXX/XXXX/XXXX/users/user1'

#响应示例

{ "action": "put", "application": "8be024f0-XXXX-XXXX-XXXX-5d598d5f8402", "path": "/users",

"uri": "https://XXXX/XXXX/XXXX/users", "entities": [ { "uuid": "4759aa70-XXXX-XXXX-XXXX-6f

a0510823ba", "type": "user", "created": 1542595573399, "modified": 1542596083687, "username":

 "user1", "activated": true, "nickname": "testuser" } ], "timestamp": 1542596083685, "duration":

 6, "organization": "agora-demo", "applicationName": "testapp" }

#设置离线推送通知的展示方式

设置离线推送通知在客户端的展示方式，设置即时生效。服务端据此向用户推送离线消息。

#HTTP 请求

PUT https://{host}/{org_name}/{app_name}/users/{username}

#路径参数

参数及说明详见公共参数。

#请求 header

参数	类型	描述	是否必需
Content-Type	String	内容类型。请填 application/json。	是
Authorization	String	App 管理员的鉴权 token，格式为 Bearer YourAppToken，其中 Bearer 为固定字符，后面为英文空格和获取到的 app token。	是

#请求 body

请求包体为 JSON Object 类型，包含以下字段：

参数	类型	描述	是否必需
notification_display_style	Int	离线推送通知的展示方式：（默认）0：推送标题为“您有一条新消息”，推送内容为“请点击查看”； 1：推送标题为“您有一条新消息”，推送内容为发送人昵称和离线消息的内容。	是

#HTTP 响应

#响应 body

参数	类型	描述
entities	JSON	用户的离线推送通知的展示方式以及相关信息。
entities.uuid	String	用户的 UUID。系统为该请求中的 app 或用户生成的唯一内部标识，用于生成用户权限 token。
entities.type	String	用户类型，即 user。
entities.created	Long	用户创建的 Unix 时间戳，单位为毫秒。
entities.modified	Long	最近一次修改用户信息的 Unix 时间戳，单位为毫秒。
entities.username	String	用户 ID。用户登录的唯一账号。
entities.activated	Boolean	用户是否为活跃状态： true：用户为活跃状态。 false：用户为封禁状态。如要使用已被封禁的用户账户，你需要调用解禁用户解除封禁。
entities.notification_no_disturbing	Boolean	是否设置为免打扰模式： true：是； false：否。
entities.notification_no_disturbing_start	Int	免打扰时间段的开始时间。
entities.notification_no_disturbing_end	Int	免打扰时间段的结束时间。
entities.notification_display_style	Int	离线推送通知的展示方式。
entities.nickname	String	离线推送通知收到时显示的昵称。
entities.notifier_name	String	推送证书名称。

其他参数及说明详见公共参数。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考错误码了解可能的原因。

#示例

#请求示例

curl -X PUT -H "Authorization: Bearer <YourAppToken>" -i https://XXXX/XXXX

/XXXX/users/a -d '{"notification_display_style": "1"}'

#响应示例

{ "action": "put", "application": "17d59e50-XXXX-XXXX-XXXX-0dc80c0f5e99", "path": "/users",

"uri": "https://XXXX/XXXX/XXXX/users", "entities": [ { "uuid": "3b8c9890-XXXX-XXXX-XXXX-f50

bf55cafad", "type": "user", "created": 1530276298905, "modified": 1534407146060, "username":

 "user1", "activated": true, "notification_no_disturbing": false, "notification_no_disturbin

g_start": 1, "notification_no_disturbing_end": 3, "notification_display_style": 1, "nickname":

"testuser", "notifier_name": "2882303761517426801" } ], "timestamp": 1534407146058, "duration":

3, "organization": "1112171214115068", "applicationName": "testapp" }

#设置免打扰模式

设置离线推送免打扰模式，在免打扰期间，用户将不会收到离线消息推送。

该 API 为旧版接口，推荐使用新版的设置离线推送 API。

#HTTP 请求

PUT https://{host}/{org_name}/{app_name}/users/{username}

#路径参数

参数及说明详见公共参数。

#请求 header

参数	类型	描述	是否必需
Content-Type	String	内容类型。请填 application/json。	是
Authorization	String	App 管理员的鉴权 token，格式为 Bearer YourAppToken，其中 Bearer 为固定字符，后面为英文空格和获取到的 app token。	是

#请求 body

请求包体为 JSON Object 类型，包含以下字段：

参数	类型	描述	是否必需
notification_no_disturbing	Boolean	是否设置为免打扰模式： true：是； false：否。	否
notification_no_disturbing_start	String	免打扰时间段的开始时间，精确到小时，取值范围为 [0,23]。例如 “8” 表示每日 8:00 开启免打扰模式。	否
notification_no_disturbing_end	String	免打扰时间段的结束时间，精确到小时，取值范围为 [0,23]。例如 “18” 表示每日 18:00 关闭免打扰模式。	否

提示

免打扰时间段的设置，应注意以下几项：

开始时间和结束时间的设置立即生效，免打扰模式每天定时触发。例如，开始时间为 8，结束时间为 10，免打扰模式在每天的 8:00-10:00 内生效。若你在 11:00 设置开始时间为 8，结束时间为 12，则免打扰模式在当天的 11:00-12:00 生效，以后每天均在 8:00-12:00 生效。
若开始时间和结束时间相同，则全天免打扰。
若结束时间早于开始时间，则免打扰模式在每天的开始时间到次日的结束时间内生效。例如，开始时间为 10，结束时间为 8，则免打扰模式的在当天的 10:00 到次日的 8:00 生效。

#HTTP 响应

#响应 body

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

参数	类型	描述
entities	JSON	用户的免打扰模式的相关信息。
entities.uuid	String	用户的 UUID。系统为该请求中的 app 或用户生成的唯一内部标识，用于生成用户权限 token。
entities.type	String	用户类型，即 user。
entities.created	Long	用户创建的 Unix 时间戳，单位为毫秒。
entities.modified	Long	最近一次修改用户信息的 Unix 时间戳，单位为毫秒。
entities.username	String	用户 ID。用户登录的唯一账号。
entities.activated	Boolean	用户是否为活跃状态： true：用户为活跃状态。 false：用户为封禁状态。如要使用已被封禁的用户账户，你需要调用解禁用户解除封禁。
entities.notification_no_disturbing	Boolean	是否设置为免打扰模式： true：是； false：否。
entities.notification_no_disturbing_start	Int	免打扰时间段的开始时间。
entities.notification_no_disturbing_end	Int	免打扰时间段的结束时间。
entities.notification_display_style	Int	离线推送通知的展示方式。
entities.nickname	String	离线推送通知收到时显示的昵称。
entities.notifier_name	String	推送证书名称。

其他参数及说明详见公共参数。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考错误码了解可能的原因。

#示例

#请求示例

设置免打扰时间段

curl -X PUT -H "Authorization: Bearer <YourAppToken>" -i "https://XXXX/XXXX/XXXX/users/a

" -d '{"notification_no_disturbing": true,"notification_no_disturbing_start": "1","notification_no_disturbing_end": "3"}'

关闭免打扰模式

curl -X PUT -H "Authorization: Bearer <YourAppToken>" -i "https://XXXX/XXXX/XXXX/users/a "

 -d '{"notification_no_disturbing": false}'

#响应示例

{ "action": "put", "application": "17d59e50-XXXX-XXXX-XXXX-0dc80c0f5e99", "path": "/users",

 "uri": "https://XXXX/XXXX/XXXX/users", "entities": [ { "uuid": "3b8c9890-XXXX-XXXX-XXXX

-f50bf55cafad", "type": "user", "created": 1530276298905, "modified": 1534405429835,

"username": "User1", "activated": true, "notification_no_disturbing": true, "notificatio

n_no_disturbing_start": 1, "notification_no_disturbing_end": 3, "notification_display_styl

e": 0, "nickname": "testuser", "notifier_name": "2882303761517426801" } ], "timestamp":

1534405429833, "duration": 4, "organization": "1112171214115068", "applicationName": "testapp" }

#设置离线推送

你可以设置全局离线推送的通知方式和免打扰模式以及单个单聊或群聊会话的离线推送设置。

#HTTP 请求

PUT https://{host}/{org}/{app}/users/{username}/notification/{chattype}/{key}

#路径参数

参数	类型	描述	是否必需
chattype	String	对象类型，即会话类型： - user：用户，表示单聊； - chatgroup：群组，表示群聊。	是
key	String	对象名称： - 单聊时为对端用户的用户 ID； - 群聊时为群组 ID。	是

提示

如需设置 app 全局离线推送，chattype 需传 user，key 为当前用户 ID。

其他参数及说明详见公共参数。

#请求 header

参数	类型	描述	是否必需
Content-Type	String	内容类型。请填 application/json。	是
Authorization	String	App 管理员的鉴权 token，格式为 Bearer YourAppToken，其中 Bearer 为固定字符，后面为英文空格和获取到的 app token。	是

#请求 body

参数	类型	描述	是否必需
type	String	离线推送通知方式： - DEFAULT：默认值，采用全局配置； - ALL：接收全部离线消息的推送通知； - AT：只接收提及当前用户的离线消息的推送通知。该字段推荐在群聊中使用。若提及一个或多个用户，需在创建消息时对 ext 字段传 "em_at_list":["user1", "user2" ...]；若提及所有人，对该字段传 "em_at_list":"all"。 - NONE：不接收离线消息的推送通知。	否
ignoreInterval	String	离线推送免打扰时间段，精确到分钟，格式为 HH:MM-HH:MM，例如 08:30-10:00。该时间为 24 小时制，免打扰时间段的开始时间和结束时间中的小时数和分钟数的取值范围分别为 [00,23] 和 [00,59]。免打扰时段的设置仅针对 app 生效，对单聊或群聊不生效。该参数的设置说明如下： - 开始时间和结束时间的设置立即生效，免打扰模式每天定时触发。例如，开始时间为 08:00，结束时间为 10:00，免打扰模式在每天的 8:00-10:00 内生效。若你在 11:00 设置开始时间为 08:00，结束时间为 12:00，则免打扰模式在当天的 11:00-12:00 生效，以后每天均在 8:00-12:00 生效。 - 若开始时间和结束时间相同，则全天免打扰。 - 若结束时间早于开始时间，则免打扰模式在每天的开始时间到次日的结束时间内生效。例如，开始时间为 10:00，结束时间为 08:00，则免打扰模式的在当天的 10:00 到次日的 8:00 生效。 - 目前仅支持在每天的一个指定时间段内开启免打扰模式，不支持多个免打扰时间段，新的设置会覆盖之前的设置。 - 若不设置该参数，传空字符串。	否
ignoreDuration	Long	离线推送免打扰时长，单位为毫秒。该参数的取值范围为 [0,604800000]，0 表示该参数无效，604800000 表示免打扰模式持续 7 天。与ignoreInterval 的设置长久有效不同，该参数为一次有效。	否

#HTTP 响应

#响应 body

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

参数	类型	描述
data	JSON	离线推送的设置。
data.type	String	离线推送通知方式。
data.ignoreInterval	String	离线推送免打扰时间段。
data.ignoreDuration	Long	离线推送免打扰时长。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考错误码了解可能的原因。

#示例

#请求示例

curl -L -X PUT '{url}/{org_name}/{app_name}/users/{username}/notification/user/{key}' \ -

H 'Authorization: Bearer <YourAppToken>' \ -H 'Content-Type: application/json' \ --data-raw '{
    "type":"NONE",
    "ignoreInterval":"21:30-08:00",
    "ignoreDuration":86400000
}'

#响应示例

{ "path": "/users", "uri": "https://XXXX/XXXX/XXXX/users/notification/user/hxtest",

 "timestamp": 1647503749918, "organization": "hx", "application": "17fe201b-XXXX-XXXX-

XXXX-1ed1ebd7b227", "action": "put", "data": { "type": "NONE", "ignoreDuration": 1647

590149924, "ignoreInterval": "21:30-08:00" }, "duration": 20, "applicationName": "hxdemo" }

#查询离线推送设置

查询指定单聊、指定群聊或全局的离线推送设置。

#HTTP 请求

GET https://{host}/{org}/{app}/users/{username}/notification/{chattype}/{key}

#路径参数

参数	类型	描述	是否必需
chattype	String	对象类型，即会话类型： - user：用户，表示单聊； - chatgroup：群组，表示群聊。	是
key	String	对象名称： - 单聊时为对端用户的用户 ID； - 群聊时为群组 ID。	是

其他参数及说明详见公共参数。

#请求 header

参数	类型	描述	是否必需
Authorization	String	App 管理员的鉴权 token，格式为 Bearer YourAppToken，其中 Bearer 为固定字符，后面为英文空格和获取到的 app token。	是

#HTTP 响应

#响应 body

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

参数	类型	描述
data	JSON	离线推送通知的设置。
data.type	String	离线推送通知方式。
data.ignoreInterval	String	离线推送免打扰时间段。
data.ignoreDuration	Long	离线推送免打扰时长。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考错误码了解可能的原因。

#示例

#请求示例

curl -L -X GET '{url}/{org}/{app}/users/{username}/notification/chatgroup/{key}' \ -H 'Authorization: Bearer <YourAppToken>'

#响应示例

{ "path": "/users", "uri": "https://XXXX/XXXX/XXXX/users/notification/chatgroup/1231

2312321", "timestamp": 1647503749918, "organization": "hx", "application": "17fe201b-

XXXX-XXXX-XXXX-1ed1ebd7b227", "action": "get", "data": { "type": "NONE", "ignoreDuration

": 1647590149924, "ignoreInterval": "21:30-08:00" }, "duration": 20, "applicationName": "hxdemo" }

#设置推送通知的首选语言

设置离线推送消息的首选语言。

#HTTP 请求

PUT https://{host}/{org}/{app}/users/{username}/notification/language

#路径参数

参数及说明详见公共参数。

#请求 header

参数	类型	描述	是否必需
Content-Type	String	内容类型。请填 application/json。	是
Authorization	String	App 管理员的鉴权 token，格式为 Bearer YourAppToken，其中 Bearer 为固定字符，后面为英文空格和获取到的 app token。	是

#请求 body

参数	类型	描述	是否必需
translationLanguage	String	用户接收的推送通知的首选语言的代码。如果设置为空字符串，表示无需翻译，服务器直接推送原语言的通知。	是

#HTTP 响应

#响应 body

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

参数	类型	描述
data	JSON	用户接收推送通知的首选语言。
data.language	String	用户接收推送通知的首选语言的代码。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考错误码了解可能的原因。

#示例

#请求示例

curl -L -X PUT '{url}/{org}/{app}/users/{username}/notification/language' \ -H 'Authorization:

 Bearer <YourAppToken>' \ -H 'Content-Type: application/json' \ --data-raw '{
    "translationLanguage":"EU"
}'

#响应示例

{ "path": "/users", "uri": "https://XXXX/XXXX/XXXX/users/notification/language", "timestamp":

1648089630244, "organization": "hx", "application": "17fe201b-XXXX-XXXX-XXXX-1ed1ebd7b227",

"action": "put", "data": { "language": "EU" }, "duration": 66, "applicationName": "hxdemo" }

#获取推送通知的首选语言

获取推送通知的首选语言。

#HTTP 请求

GET https://{host}/{org_name}/{app_name}/users/{username}/notification/language

#路径参数

参数及说明详见公共参数。

#请求 header

参数	类型	描述	是否必需
Content-Type	String	内容类型。请填 application/json。	是
Authorization	String	App 管理员的鉴权 token，格式为 Bearer YourAppToken，其中 Bearer 为固定字符，后面为英文空格和获取到的 app token。	是

#HTTP 响应

#响应 body

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

参数	类型	描述
data	JSON	用户接收推送通知的首选语言。
data.language	String	用户接收推送通知的首选语言的代码。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考错误码了解可能的原因。

#示例

#请求示例

curl -L -X GET '{url}/{org}/{app}/users/{username}/notification/language' \ -H 'Authorization: Bearer <YourAppToken>'

#响应示例

{ "path": "/users", "uri": "https://XXXX/XXXX/XXXX/users/notification/language", "timestamp":

1648089630244, "organization": "hx", "application": "17fe201b-XXXX-XXXX-XXXX-1ed1ebd7b227",

 "action": "put", "data": { "language": "EU" }, "duration": 66, "applicationName": "hxdemo" }

#创建离线推送模板

创建离线推送消息模板。

#HTTP 请求

POST https://{host}/{org_name}/{app_name}/notification/template

#路径参数

参数及说明详见公共参数。

#请求 header

参数	类型	描述	是否必需
Content-Type	String	内容类型。请填 application/json。	是
Authorization	String	App 管理员的鉴权 token，格式为 Bearer YourAppToken，其中 Bearer 为固定字符，后面为英文空格和获取到的 app token。	是

#请求 body

参数	类型	描述	是否必需
name	String	要添加的推送模板的名称。	是
title_pattern	String	自定义推送标题，例如：标题 {0}。	是
content_pattern	String	自定义推送内容，例如：内容 {0}, {1}。	是

#HTTP 响应

#响应 body

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

参数	类型	描述
data	JSON	推送模板的相关信息。
data.name	String	推送模板的名称。
data.createAt	Number	创建模板的 Unix 时间戳，单位为毫秒。
data.updateAt	Number	最近一次修改模板的 Unix 时间戳，单位为毫秒。
data.title_pattern	String	推送模板的自定义标题。
data.content_pattern	String	推送模板的自定义内容。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考错误码了解可能的原因。

#示例

#请求示例

curl -X POST '{url}/{org}/{app}/notification/template' \ -H 'Authorization: Bearer <YourAppToken>'

 \ -H 'Content-Type: application/json' \ --data-raw '{
    "name": "test7",
    "title_pattern": "你好,{0}",
    "content_pattern": "推送测试,{0}"
}'

#响应示例

{ "uri": "https://XXXX/XXXX/XXXX/notification/template", "timestamp": 1646989584108, "organization":

"hx", "application": "17fe201b-XXXX-XXXX-XXXX-1ed1ebd7b227", "action": "post", "data": { "name": "

test7", "createAt": 1646989584124, "updateAt": 1646989584124, "title_pattern": "你好,{0}", "

content_pattern": "推送测试,{0}" }, "duration": 26, "applicationName": "hxdemo" }

#查询离线推送模板

查询离线推送消息使用的模板。

#HTTP 请求

GET https://{host}/{org_name}/{app_name}/notification/template/{name}

#路径参数

参数	类型	描述	是否必需
name	String	要查询的推送模板的名称。	是

其他参数及说明详见公共参数。

#请求 header

参数	类型	描述	是否必需
Content-Type	String	内容类型。请填 application/json。	是
Authorization	String	App 管理员的鉴权 token，格式为 Bearer YourAppToken，其中 Bearer 为固定字符，后面为英文空格和获取到的 app token。	是

#HTTP 响应

#响应 body

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

参数	类型	描述
data	JSON	推送模板的相关信息。
data.name	String	推送模板的名称。
data.createAt	Number	创建模板时的 Unix 时间戳，单位为毫秒。
data.updateAt	Number	最近一次修改模板时的 Unix 时间戳，单位为毫秒。
data.title_pattern	String	推送模板的自定义标题。
data.content_pattern	String	推送模板的自定义内容。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考错误码了解可能的原因。

#示例

#请求示例

curl -X GET '{url}/{org}/{app}/notification/template/{name}' \ -H 'Authorization: Bearer <YourAppToken>'

#响应示例

{ "uri": "https://XXXX/XXXX/XXXX/notification/template/test7", "timestamp": 1646989686393,

"organization": "hx", "application": "17fe201b-XXXX-XXXX-XXXX-1ed1ebd7b227", "action": "get",

"data": { "name": "test7", "createAt": 1646989584124, "updateAt": 1646989584124, "title_pattern":

 "你好,{0}", "content_pattern": "推送测试,{0}" }, "duration": 11, "applicationName": "hxdemo" }

#删除离线推送模板

删除离线消息推送模板。

#HTTP 请求

DELETE https://{host}/{org_name}/{app_name}/notification/template/{name}

#路径参数

参数	类型	描述	是否必需
name	String	要删除的推送模板的名称。	是

其他参数及说明详见公共参数。

#请求 header

参数	类型	描述	是否必需
Content-Type	String	内容类型。请填 application/json。	是
Authorization	String	App 管理员的鉴权 token，格式为 Bearer YourAppToken，其中 Bearer 为固定字符，后面为英文空格和获取到的 app token。	是

#HTTP 响应

#响应 body

如果返回的 HTTP 状态码为 200，表示请求成功，响应包体中包含以下字段：

参数	类型	描述
data	JSON	删除的推送模板的相关信息。
data.name	String	推送模板的名称。
data.createAt	Number	推送模板的创建时间戳，单位为毫秒。
data.updateAt	Number	最近一次修改模板时的 Unix 时间戳，单位为毫秒。
data.title_pattern	String	推送模板的自定义标题。
data.content_pattern	String	推送模板的自定义内容。

如果返回的 HTTP 状态码非 200，表示请求失败。你可以参考错误码了解可能的原因。

#示例

#请求示例

curl -X DELETE '{url}/{org}/{app}/notification/template' \ -H 'Authorization: Bearer {YourAppToken}'

#响应示例

{ "uri": "https://XXXX/XXXX/XXXX/notification/template", "timestamp": 1646989686393, "organization":

"hx", "application": "17fe201b-XXXX-XXXX-XXXX-1ed1ebd7b227", "action": "delete", "data": { "name": "

test7", "createAt": 1646989584124, "updateAt": 1646989584124, "title_pattern": "你好,{0}", "

content_pattern": "推送测试,{0}" }, "duration": 11, "applicationName": "hxdemo" }

相似文档

环信IM即时通讯（服务端） - 消息管理
本文展示如何调用环信 IM REST API 在服务端实现全类型消息，包括文本消息、图片消息、语音消息、视频消息、透传消息和自定义消息的发送与接收、消息附件上传和下载、获取历史消息记录、服务端消息撤回、服务端单向删除会话等。
环信IM即时通讯（服务端） - 管理用户属性
用户属性指实时消息互动用户的信息，如用户昵称、头像、邮箱、电话、性别、签名、生日等。例如，在招聘场景下，利用用户属性功能，可以存储性别、邮箱、用户类型（面试者）、职位类型（web 研发）等。当查看用户信息时，可以直接查询服务器存储的用户属性信息。
环信IM即时通讯（服务端） - 管理用户关系
环信即时通讯 IM 支持通过 RESTful API 管理用户之间的关系，包括添加和移除联系人以及将用户添加至或移除黑名单。前提条件：要调用环信即时通讯 RESTful API，请确保满足以下要求：已在环信即时通讯控制台开通配置环信即时通讯 IM 服务。了解环信 IM REST API 的调用频率限制，详见接口频率限制。
环信IM即时通讯（服务端） - 群组管理
环信即时通讯 IM 提供了 RESTful API 管理 App 中的群组。单个 App 创建群组数量有限制，而且单个用户可加入群组的数量视版本而定，详见使用限制。前提条件：要调用环信即时通讯 RESTful API，请确保满足以下要求：已在环信即时通讯 IM 管理后台开通配置环信即时通讯 IM 服务。了解环信 IM RESTful API 的调用频率限制，详见接口频率限制。
环信IM即时通讯（服务端） - 聊天室管理
环信即时通讯 IM 提供了 RESTful API 管理 App 中的群组。单个 App 创建群组数量有限制，而且单个用户可加入群组的数量视版本而定，详见使用限制。前提条件：要调用环信即时通讯 RESTful API，请确保满足以下要求：已在环信即时通讯 IM 管理后台开通配置环信即时通讯 IM 服务。了解环信 IM RESTful API 的调用频率限制，详见接口频率限制。

文档中心

全民上云·上云补贴申领

免费试用（限企业）

#公共参数

#请求参数

#响应参数

#认证方式

#设置离线推送时显示的昵称

#HTTP 请求

#路径参数

#请求 header

#请求 body

#HTTP 响应

#响应 body

#示例

#请求示例

#响应示例

#设置离线推送通知的展示方式

#HTTP 请求

#路径参数

#请求 header

#请求 body

#HTTP 响应

#响应 body

#示例

#请求示例

#响应示例

#设置免打扰模式

#HTTP 请求

#路径参数

#请求 header

#请求 body

#HTTP 响应

#响应 body

#示例

#请求示例

#响应示例

#设置离线推送

#HTTP 请求

#路径参数

#请求 header

#请求 body

#HTTP 响应

#响应 body

#示例

#请求示例

#响应示例

#查询离线推送设置

#HTTP 请求

#路径参数

#请求 header

#HTTP 响应

#响应 body

#示例

#请求示例

#响应示例

#设置推送通知的首选语言

#HTTP 请求

#路径参数

#请求 header

#请求 body

#HTTP 响应

#响应 body

#示例

#请求示例

#响应示例

#获取推送通知的首选语言

#HTTP 请求

#路径参数

#请求 header

#HTTP 响应

#响应 body

#示例

#请求示例

#响应示例

#创建离线推送模板

#HTTP 请求

#路径参数

#请求 header

#请求 body