# npe-project2

**Repository Path**: li-binlang/npe-project2

## Basic Information

- **Project Name**: npe-project2
- **Description**: 王道程序员训练营47期，项目二代码仓库
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-03-31
- **Last Updated**: 2023-04-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# npe-project2

#### 介绍
王道程序员训练营47期，项目二代码仓库

#### 创建分支

如果你要在已有的分支基础上创建新分支，可以使用 `git branch` 命令：

```
git branch <new_branch_name> <base_branch_name>
```

其中，`new_branch_name` 是新分支的名称，`base_branch_name` 是新分支要基于哪个分支创建。创建新分支后，工作目录继续停留在当前分支上。

如果想要同时创建并切换到新分支，可以使用以下命令：

```
git checkout -b <new_branch_name> <base_branch_name>
```

其中，`new_branch_name` 是新分支的名称，`base_branch_name` 是新分支要基于哪个分支创建。执行该命令后，工作目录将切换到新分支上。

新分支名：`名字后两位拼音全小写`  例：张伟：zhangwei ；曾小贤：xiaoxian

# 接口名称：短信通知

> 描述：发送短信通知(注册、找回密码等发送验证码通知等)
> 注意：该接口限制70个字

**请求地址**：https://api.shumaidata.com/sms/send
**请求方式**：POST

#### 参数

| 名称       | 类型    | 是否必填 | 说明                                                         |
| ---------- | ------- | -------- | ------------------------------------------------------------ |
| appid      | varchar | 是       | 服务商分配的唯一标识                                         |
| timestamp  | number  | 是       | 当前时间的毫秒数                                             |
| sign       | varchar | 是       | 签名                                                         |
| templateId | varchar | 是       | 短信模板ID                                                   |
| receive    | varchar | 是       | 短信接收人号码                                               |
| tag        | varchar | 是       | 短信发送的变量值，多个tag变量用竖线‘\|’分隔 ，格式如 1234\|1234 |

#### 签名算法说明

> 商户分配的appid、当前时间毫秒数timestamp、商户分配的app_security、 三者通过&符号拼接成字符串进行md5加密得到。
> 如：appid=xyzxyzxyz，timestamp=1555378976238，app_security=efcefcefcefcefc;
> 拼接后的字符串：str=xyzxyzxyz&1555378976238&efcefcefcefcefc;
> 加密后得到sign = md5(str) = 4e7e1974b79f3656aeaf03f1158f5d5d;

#### 正确返回

```
{
    "msg": "成功",
    "success": true,
    "code": 200, //200为收费
    "data": {
        "taskId": "2020040211442081fffd9b",//短信发送任务ID
        "orderNo": "695237182989930496" //订单号
    }
}
```

#### 错误返回

```
{
    "msg": "templateId 无效",
    "success": false,
    "code": 400,
    "data": {}
}
```

# 接口名称：短信发送状态查询

> 描述：查询短信送达情况

**请求地址**：https://api.shumaidata.com/sms/detail
**请求方式**：GET

#### 参数

| 名称      | 类型    | 是否必填 | 说明                 |
| --------- | ------- | -------- | -------------------- |
| appid     | varchar | 是       | 服务商分配的唯一标识 |
| timestamp | number  | 是       | 当前时间的毫秒数     |
| sign      | varchar | 是       | 签名                 |
| taskId    | varchar | 是       | 短信任务编号         |

#### 正确返回

```
{
    "msg": "成功",
    "success": true,
    "code": 200, 
    "data": {
        "result": "执行中",//result为SUCCESS 发送成功,FAILE 发送失败
        "taskId": "st200630172301394aaa7c6"
    }
}
```

#### 错误返回

```
{
    "msg": "未查询到该taskId对应的记录",
    "success": false,
    "code": 400,
    "data": {}
}
```

#### 签名算法说明

> 服务商分配的appid、当前时间毫秒数timestamp、商户分配的app_security、 三者通过&符号拼接成字符串进行md5加密得到。
> 如：appid=xyzxyzxyz，timestamp=1555378976238，app_security=efcefcefcefcefc;
> 拼接后的字符串：str=xyzxyzxyz&1555378976238&efcefcefcefcefc;
> 加密后得到sign = md5(str) = 4e7e1974b79f3656aeaf03f1158f5d5d;

#### code错误码说明

| code | 说明                       |
| ---- | -------------------------- |
| 200  | 成功                       |
| 400  | 参数错误                   |
| 404  | 请求资源不存在             |
| 500  | 系统内部错误，请联系服务商 |
| 501  | 第三方服务异常             |
| 601  | 服务商未开通接口权限       |
| 602  | 账号停用                   |
| 603  | 余额不足请充值             |
| 604  | 接口停用                   |
| 1001 | 其他，以实际返回为准       |