主题
根据类型获取启用的通道列表 3.5.3.Beta2+
根据类型获取启用的通道列表
接口说明
请求URL:http[s]://{网关地址}/mp/restful/v2/getEnableChannelByType?channelType=
请求方式: POST
响应内容类型: application/json
请求说明
查询参数
| 字段名 | 参数名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 通道类型 | channelType | O | string | 默认不传是全部,INBOX 收件箱 SMS 短信 EMAIL 邮件 DINGTALK 钉钉 CAMPUSHOY 今日校园 WELINK 华为welink QYWECHAT 企业微信 WeChatService 微信服务号 |
请求示例
json
curl --location --request POST 'http://172.16.34.144:9000/mp/restful/v2/getEnableChannelByType?channelType=EMAIL' \
--header 'accessToken: c3912b9569e48b326139b5622edb15d3' \
--header 'appId: 1015259634421579776' \1
2
3
2
3
响应说明
响应体`
| 字段名 | 参数名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 状态 | code | 是 | String | 0000请求成功 |
| 信息 | data | 是 | List<ChannelInfo> | 通道列表 |
ChannelInfo
| 字段名 | 参数名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 通道wid | wid | 是 | String | |
| 通道名字 | channelName | 是 | String | |
| 类型 | type | 是 | String | |
| 类型名字 | pluginName | 是 | String |
响应示例
{
"code": "0000",
"data": [
{
"channelName": "zjs邮箱",
"pluginName": "SMTP方式发送邮件",
"type": "EMAIL",
"wid": "994238705339994112"
}
]
}1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
错误码
| 错误码 | 描述 |
|---|---|
| 0000 | 请求成功 |
| 其他 | 失败 |
Demo
java
Client client = new DefaultClient(BASE_URL, APP_ID, APP_SECRET);
GetEnableChannelByTypeRequest request = new GetEnableChannelByTypeRequest();
request.setChannelType(ChannelType_Constants.QYWECHAT);
GetEnableChannelByTypeResponse response = client.execute(request);
if (response.isSuccess()) {
System.out.println(JSONObject.toJSONString(response));
} else {
throw new Exception("获取启用通道异常:" + JSONObject.toJSONString(response));
}1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11

