组件介绍
引入第三方平台极光，提供短信验证，APP 消息推送等功能。
API 参考
API 列表（共5个）
| 序号 | 接口名称 | 接口描述 | 版本 |
| 1 | 指定应用发送模板短息 | POST： /public/sendMessage | V1.00 |
| 2 | 指定应用校验验证码 | POST： /public/sendVerifyCode | V1.00 |
| 3 | 指定应用校验验证码 | POST： /public/compareVerifyCode | V1.00 |
| 4 | 新增短信服务方配 | POST： /public/smsServiceConfig | V1.00 |
| 5 | 获取短信服务配置列表 | GET： /public/smsServiceConfigs | V1.00 |
指定应用发送模板短息
基本信息
Path： /public/sendMessage
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| appPrefix | string | 必须 | 应用前缀 | ||
| mobile | string | 必须 | 手机号 | ||
| smsTemplateId | string | 必须 | 模板Id | ||
| tempPara | object | 非必须 |
返回参数
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
指定应用校验验证码
基本信息
Path： /public/sendVerifyCode
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| appPrefix | string | 必须 | 应用前缀 | ||
| mobile | string | 必须 | 应用前缀 |
返回参数
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
指定应用校验验证码
基本信息
Path： /public/compareVerifyCode
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| appPrefix | string | 必须 | 应用前缀 | ||
| messageId | string | 必须 | 短信验证码Id | ||
| userVerifyCode | string | 必须 | 短信验证码 |
返回参数
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| boolean | 非必须 |
新增短信服务方配基本信息
Path：/public/smsServiceConfig
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| appKey | string | 必须 | 短信平台appKey | ||
| appName | string | 必须 | 应用名称 | ||
| appPrefix | string | 必须 | 应用前缀 | ||
| appSecret | string | 必须 | 短信平台appSecret | ||
| id | integer | 非必须 | format: int64 | ||
| region | string | 必须 |
返回参数
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| boolean | 非必须 |
获取短信服务配置列表
请求参数
Path： /public/smsServiceConfigs
Method： GET
接口描述：
请求参数
返回参数
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| object [] | 非必须 | item 类型: object | |||
| ├─ appKey | string | 必须 | 短信平台appKey | ||
| ├─ appName | string | 非必须 | 应用名称 | ||
| ├─ appPrefix | string | 必须 | 应用前缀 | ||
| ├─ appSecret | string | 必须 | 短信平台appSecret | ||
| ├─ id | integer | 非必须 | format: int64 | ||
| ├─ region | string | 非必须 | 短信平台区域 |
产品版本
短信服务
| 日期 | 修改描述 | 作者 |
| 2019-8-28 | 初版发布 | 平台产品部 |
| 2020-4-23 | 新特性：增加对新的电话号码段的支持 | 平台产品部 |
| 2020-4-28 | 新特性：技术部要求统一异常改造，简化客户端的异常处理方式 | 平台产品部 |
| 2020-4-28 | 优化：增加接口的必填参数校验 | 平台产品部 |
更新日志
| 日期 | 修改描述 |
| 2019-8-28 | 发布短信服务，创建短信服务的用户使用手册 |
| 2020-4-28 | 短信服务优化接口的必填参数校验 受影响接口：指定应用发送模板短息、指定应用发送验证码、指定应用校验验证码 |
