# SOC_SMS Web API 接口文档


# 1. 变更记录
## 1.1. [v0.0.7] - 2024年3月18日
### 1.1.1. 新增
- 新增发送短信接口【3.1.1】


# 2. 概括
本文档详细定义SOC SMS的Web API，供第三方平台开发使用。   
API接口采用HTTP协议提供数据服务，数据使用JSON格式表示。

## 2.1. 数据编码
提交的复杂数据对象和返回结果使用JSON来描述，请求和返回的数据均为UTF-8编码，请求和返回结果中HTTP Header的Content-Type设置为“application/json; charsert=utf-8”。

## 2.3. 返回值
返回的结果有统一的样式    

|参数名|类型|是否必要|参数描述|
|----|----|----|----|
|code|string|否|编码，200：成功，500：内部异常，其它参见HTTP code(状态码)|
|msg|string|否|描述|
|data|string|否|数据|

## 2.4. 日期时间

本协议中的日期时间字符串使用`UTC`格式,日期和时间通过大写字母` `分隔。

> 示例:
>
> - `完整时间` 2021-03-16 16:35:56 +08:00
> - `仅日期` 2021-03-16
> - `仅时间` 16:35:45


## 2.4. 密钥文件配置

用于与ESB应用服务器交互的报文完整性校验。ESB将提供给渠道密钥文件XXXCommMasterKey.dat和XXXComm.keystore(XXX为各系统名称,以ESB发布为准，禁止盗用其它系统密钥文件，否则系统之间会密钥冲突，报文校验失败)，JVM增加启动参数 –DEAI_HOME=密钥文件路径.（注：密钥可在git仓库 http://10.87.21.221:8000/jzyd_yyds/soc.git 中\soc\soc-modules\soc-modules-sms\短信密钥，目录获取）

# 3. 接口说明

## 3.1. 短信
### 3.1.1. 发送短信
- 网关版本    0.0.7
- 服务地址:		`/api/sms/send`
- HTTP请求方式: `POST`
- 输入参数:	  

|名称|类型|是否必填|描述|取值范围|单位|备注|
|---|---|---|---|---|---|---|
|tranType|string|是|交易类型|854001(安保管理系统任务逾期提提醒),854002（安保管理系统告警提提醒）|-|-|
|branchId|string|否|机构号|-|-|-|
|consumerSeqNo|string|否|消费者系统流水号|-|-|-|
|custNo|string|否|客户号|-|-|-|
|custName|string|否|客户姓名|-|-|-|
|sex|string|否|性别|-|-|-|
|mobile|string|是|手机号|-|-|-|
|acctNo|string|否|帐号|-|-|-|
|occurDate|string|否|发生日期 格式：yyyy-MM-dd|-|-|-|
|occurTime|string|否|发生时间：格式：Hh:mm:ss|
|tranAmt1|string|否|交易金额1|-|-|-|
|tranAmt2|string|否|交易金额2|-|-|-|
|tranAmt3|string|否|交易金额3|-|-|-|
|payoutStoreBit1|string|否|支出/存入位1|-|-|-|
|payoutStoreBit2|string|否|支出/存入位2|-|-|-|
|payoutStoreBit3|string|否|支出/存入位3|-|-|-|
|tranRemark|string|否|交易摘要|-|-|-|
|acctStatus|string|否|帐户状态|-|-|-|
|channelType|string|否|渠道类型|-|-|-|
|bak1|string|否|备用1|-|-|-|
|bak2|string|否|备用2|-|-|-|
|bak3|string|否|备用3|-|-|-|

- 输出参数：恢复结果(成功/失败)
- 请求示例:	`http://10.87.21.14/api/sms/send`
```json
1、安保管理系统任务逾期提醒 
{
    "tranType":"854002",
    "branchId":"机构号",
    "mobile":"18113133729",
    "occurDate":"2024-03-18",
    "occurTime":"15:02:00",
    "bak3":"告警提醒内容"
}
```

```json
2、安保管理系统告警提醒
{
    "tranType":"854002",
    "branchId":"机构号",
    "mobile":"18113133729",
    "occurDate":"2024-03-18",
    "occurTime":"15:02:00",
    "bak3":"告警提醒内容"
}
```
- 成功返回:	

```json
{
    "code":200,
    "msg":''
}
 ```
- 失败返回:

```json
{
    "code": 500,
    "msg": "内部异常"
}
 ```