消息通知服务 SMN-订阅:请求参数
下载消息通知服务 SMN用户手册完整版
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
protocol |
是 |
String |
不同协议对应不同的endpoint（接受消息的接入点）。 目前支持的协议包括： “email”：邮件传输协议，endpoint为邮箱地址。 “sms”：短信传输协议，endpoint为手机号码。 “functionstage”：FunctionGraph（函数）传输协议，endpoint为一个函数。 “functiongraph”：FunctionGraph（工作流）传输协议，endpoint为由一组函数编排成的工作流。 “http”、“https”：HTTP/HTTPS传输协议，endpoint为URL。 “callnotify”：语音通知传输协议，endpoint为手机号码。 “wechat”：微信群机器人传输协议。 “dingding”：钉钉群机器人传输协议。 “feishu”：飞书群机器人传输协议。 “welink”：welink群机器人传输协议。 |
endpoint |
是 |
String |
说明： http协议，接入点必须以“http://”开头。 https协议，接入点必须以“https://”开头。 email协议，接入点必须是邮件地址。 sms协议，接入点必须是一个电话号码。 functionstage协议，接入点必须是一个函数。 functiongraph协议，接入点必须是一个函数工作流。 dms协议，接入点必须是一个消息队列。 application协议，接入点必须是一个应用平台的设备终端。 callnotify协议，接入点必须是一个电话号码。 dingding协议，接入点必须是一个钉钉群机器人的地址。 wechat协议，接入点必须是一个微信群机器人的地址。 feishu协议，接入点必须是一个飞书群机器人的地址。 welink协议，接入点必须是一个welink的群号。 |
remark |
否 |
String |
备注。最大支持128字节，约42个中文，必须是UTF-8编码的字符串，否则无法正常显示中文。 |
extension |
否 |
SubscriptionExtension object |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
client_id |
否 |
String |
该字段为welink订阅下的租户ID字段，由租户从welink方获取。当protocol值为welink时，该字段为必填字段。 |
client_secret |
否 |
String |
该字段为welink订阅下的租户获取的client secret字段，由租户从welink方获取。当protocol值为welink时，该字段为必填字段。 |
keyword |
否 |
String |
该字段为关键字字段。当protocol协议为feishu时，这里的keyword字段和sign_secret字段二者必选其一。当用户在飞书或钉钉机器人端添加关键字校验的安全策略时，这里的关键字必须是飞书或钉钉端所填写的关键字之一。 |
sign_secret |
否 |
String |
这是加签密钥字段。当protocol协议为feishu或dingding时，这个字段和keyword字段二者必选且只能选其一，密钥配置必须与客户在飞书或钉钉客户端的密钥配置完全一致。例如，如果在飞书端配置了密钥并且没有配置关键字，则在此处填入从飞书获取的密钥字段，如果在飞书端没有配置密钥并且配置了关键字，则不填写该字段。 |
