富信 - 消息
1 发送接口
请求Url:
/v1/api/rich/sendMsg
Method: POST
接口描述：
1. 接口发送频率单次支持5000条
2. 使用动态模版时支持动态参数替换
3. 支持在一次请求中向多个不同的手机号码发送同样内容
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|
| Content-Type | application/json | Y | | |
| Authorization | 参见 Authorization生成规则 | Y | header参数用于接口鉴权 | 参见 Authorization生成规则 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
| appKey | string | Y | | app key | 访问 短信平台商户后台->业务配置->发送账号管理->APPID 中获取 |
| telephones | string [] | Y | | 手机号列表 | item 类型: string
手机号数量上限 5000条 |
| ├─ | | Y | | 11位手机号 | |
| timestamp | string | Y | | 时间戳yyyyMMddHHmmss | |
| nonce | string | Y | | 客户定义任意值 | |
| sign | string | Y | | 签名 MD5（Nonce + timestamp + AppKey + AppSecret） | |
| templateCode | string | Y | | 模板编码 | |
| templateParam | Map<String,String> | N | | 动态模版参数，根据占位符替换值 | 使用动态模版时必须，
示例：{"name":"张三","age":"30"} |
返回参数
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
| code | string | Y | | | |
| data | object [] | N | | | item 类型: object |
| ├─ phone | string | N | | 手机号 | |
| ├─ msgId | number | N | | 消息ID | |
| ├─ result | number | N | | 1 成功 0 失败 | |
| ├─ sendTime | string | N | | 发送时间 | |
| msg | string | N | | | |
| requestId | string | N | | | |
2 发送状态回执通知
回调设置路径:
卓鹰短信平台商户后台 平台设置-->系统设置-->数据推送 配置客户自定义
Method: POST
接口描述：
若回调失败，最多重试10次。
当因为回调失败缺失了发送状态时，可以调用发送状态查询接口查询发送结果和状态。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|
| Content-Type | application/json | Y | | |
Body
| 子名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
| | list[] | 是 | | | |
| ├─msgId | Long（21） | 是 | | | 消息ID（对应发送接口返回msgId） |
| ├─telephone | String | 是 | | | 回执手机号 |
| ├─status | String | 是 | | | 1-发送成功 0-发送失败 |
| ├─receiveTime | String | 是 | | | 时间格式（yyyy-MM-dd HH:mm:ss） |
返回参数
HTTP.STATUS.OK
3 发送状态查询
请求Url:
/v1/api/rich/sendMsg/status/query
Method: POST
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|
| Content-Type | application/json | Y | | |
| Authorization | 参见 Authorization生成规则 | Y | header参数用于接口鉴权 | 参见 Authorization生成规则 |
Body
| 名称 | 类型 | 是否必须 | 备注 | 其他信息 |
|---|
| msgId | List | Y | 消息唯一ID | |
| timestamp | string | Y | 时间戳yyyyMMddHHmmss | |
| nonce | string | Y | 客户定义任意值 | |
| sign | string | Y | 签名 MD5（Nonce + timestamp + AppKey + AppSecret） | |
| appKey | string | Y | APPID | 访问 短信平台商户后台->业务配置->发送账号管理->APPID 中获取 |
返回参数
| 子名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
| | list[] | 是 | | | |
| ├─msgId | Long（21） | 是 | | | 消息ID（对应发送接口返回msgId） |
| ├─telephone | String | 是 | | | 回执手机号 |
| ├─status | String | 是 | | | "0"- "待发送"
"1"- "发送中"
"2"- "已发送"
"3"- "发送失败"
"4"- "无可用通道"
"5"- "目标号码在黑名单中"
"6"- "短信内容含敏感词" |
| ├─receiveTime | String | 是 | | | 时间格式（yyyy-MM-dd HH:mm:ss） |
4 动态模板发送
请求Url:
/v1/api/rich/sendDynamicMsg
Method: POST
接口描述：
1.接口发送频率单次支持100条
2.使用动态模版时支持动态参数替换
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|
| Content-Type | application/json | Y | | |
| Authorization | 参见 Authorization生成规则 | Y | header参数用于接口鉴权 | 参见 Authorization生成规则 |
Body
| 名称 | 类型 | 是否必须 | 备注 | 其他信息 |
|---|
| appKey | string | Y | app key | 访问 短信平台商户后台->业务配置->发送账号管理->APPID 中获取 |
| timestamp | string | Y | 时间戳yyyyMMddHHmmss | |
| nonce | string | Y | 客户定义任意值 | |
| sign | string | Y | 签名 MD5（Nonce + timestamp + AppKey + AppSecret） | |
| dynamicSendList | object [] | Y | 发送信息列表 | item 类型: string
数量上限 200条 |
| ├─ phone | String | Y | 11位手机号 | |
| ├─ paramMap | map<String,String> | Y | 动态参数内容 | 例如：k--变量名称 v-内容 |
| templateCode | string | Y | 动态模板编码 | |
返回参数
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|
| code | string | Y | | | |
| data | object [] | N | | | item 类型: object |
| ├─ phone | string | N | | 手机号 | |
| ├─ msgId | number | N | | 消息ID | |
| ├─ result | number | N | | 1 成功 0 失败 | |
| ├─ sendTime | string | N | | 发送时间 | |
| msg | string | N | | | |
| requestId | string | N | | | |
