智简魔方文档

GET 发送管理

接口概览

项目内容
文档类型后台接口
请求方式GET
接口地址/DIR_ADMIN/v1/notice/send
所属业务消息通知
来源模块/系统通知发送管理
认证方式Bearer Token(管理员令牌)

完整请求

请求

bash
正在加载示例…

失败请求

bash
正在加载示例…

接口说明

发送管理

请求参数

无请求参数。

成功响应

json
正在加载示例…

失败响应 400:请求参数或业务校验失败

json
正在加载示例…

失败响应 401:未认证或登录已失效

json
正在加载示例…

失败响应 403:无权执行当前操作

json
正在加载示例…

失败响应 404:接口或业务资源不存在

json
正在加载示例…

失败响应 500:服务器内部错误

json
正在加载示例…

响应状态

状态码状态码含义说明数据模型
200OK成功响应内联对象
400Bad Request请求参数或业务校验失败内联对象
401Unauthorized未认证或登录已失效内联对象
403Forbidden无权执行当前操作内联对象
404Not Found接口或业务资源不存在内联对象
500Internal Server Error服务器内部错误内联对象

响应参数

状态码 200

名称类型必选约束说明
statusinteger(int32)状态码
msgstring提示信息
dataobject
data.list[object]发送管理列表
data.list[].namestring动作名称
data.list[].sms_global_namestring短信国际接口名称
data.list[].sms_global_templateinteger(int32)短信国际接口模板ID
data.list[].sms_namestring短信国内接口名称
data.list[].sms_templateinteger(int32)短信国内接口模板ID
data.list[].sms_enableinteger(int32)短信启用状态 0禁用 1启用
data.list[].email_namestring邮件接口名称
data.list[].email_templateinteger(int32)邮件接口模板ID
data.list[].email_enableinteger(int32)邮件启用状态 0禁用 1启用
data.list[].typestring通知分类标识
data.list[].name_langstring
data.configuration[object] | object默认接口

可选数据结构 A:[object] — 默认接口

名称类型必选约束说明
data.configuration[].send_smsstring默认国内短信接口
data.configuration[].send_sms_globalstring默认国际短信接口
data.configuration[].send_emailstring默认邮件接口

可选数据结构 B:object

名称类型必选约束说明
data.configuration.send_smsstring
data.configuration.send_sms_globalstring
data.configuration.send_emailstring
名称类型必选约束说明
data.type[object]
data.type[].namestring分类标识
data.type[].name_langstring分类名称

失败状态码 400、401、403、404、500 共用以下结构:

名称类型必选约束说明
statusinteger(int32)错误状态码
msgstring错误提示