domain说明
序号 | 系统 | 环境 | 地址 | 备注 |
---|---|---|---|---|
1 | 卓易政企通 | 测试 | https://test-gateway.eazytec-cloud.com | 适用【园企通】【行业政企通】【乡镇政企通】【协会政企通】 |
2 | 卓易政企通 | 线上 | https://gateway.eazytec-cloud.com | 适用【园企通】【行业政企通】【乡镇政企通】【协会政企通】 |
3 | 宜兴政企通 | 测试 | https://test-gateway.eazytec-cloud.com/YX | 适用【宜兴政企通】 |
4 | 宜兴政企通 | 线上 | https://gateway.eazytec-cloud.com/YX | 适用【宜兴政企通】 |
5 | 宜兴政企通 | 线上-政务外网 | http://10.36.12.1:8000/YX(vpn) http://2.18.243.11:8000/YX(政务外网) | 适用【宜兴政企通-政务外网】 |
6 | 江苏政企通 | 测试 | https://test-gateway.eazytec-cloud.com/JS | 适用【江苏政企通】 |
7 | 江苏政企通 | 线上 | https://gateway.eazytec-cloud.com/JS | 适用【江苏政企通】 |
短信服务中心
Yapi: https://yapi.eazytec-cloud.com/project/67/interface/api/cat_935
接入短信服务完整流程
- 使用gitlab账号登录https://yun.eazytec-cloud.com(云管理平台)
- 创建团队(已有团队请忽略)
- 申请开通eMsg消息消息引擎(已申请请忽略)
- 团队下点击项目管理,创建项目(已有项目请忽略)
- 团队下点击应用管理,创建需要接入短信服务的应用(已存在该应用请忽略),查看该应用clientId,ClientSecret
- 在项目查看其应用列表并点击该应用进入eMsg消息引擎服务
- 选择短信管理--短信发送记录,查看本应用限流详情(因为首次进入会初始化限流情况,没有初始化的应用将无法使用短信发送功能)
- 申请模板,申请签名(功能开发中,暂时联系开发者申请)
- 此时通过调用下方短信发送接口即可发送短信
- 如果想使用非本公司的阿里云账号发送短信,需提供该账号的access_key及secret还有所用到的模板及签名联系开发者备案,否则无法成功发送
获取签名接口
基本信息
Path: /AGCS_zqc/v3/smslog/getSignName
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Authorization | Bearer token | 是 | ||
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
website | string | 非必须 | 域名(例:njsp.gov.zqtong.com)(第一优先级) | ||
labelId | string | 非必须 | 政府labelId(第二优先级) | ||
baseId | string | 非必须 | 企业baseId(第三优先级) | ||
type | number | 非必须 | 类型(1-政府,2-企业)(配合手机号使用) | ||
phone | string | 非必须 | 手机号(第四优先级) |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
data | string | 非必须 | 签名内容 | ||
msg | string | 非必须 | 用户层面的接口回执 | ||
status | number | 非必须 | 内部状态码 成功时返回200 |
通用短信发送接口
基本信息
Path: /AGCS_zqc/v3/smslog/send
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Authorization | Bearer token | 是 | ||
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
phoneList | string [] | 必须 | 电话号码组成的list | item 类型: string | |
├─ | 非必须 | ||||
code | string | 必须 | 短信模板code | ||
signName | string | 必须 | 签名 | ||
appId | string | 必须 | 应用clientId | ||
map | object | 必须 | 短信模板所需参数 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
data | string | 非必须 | 开发层面的接口回执 | ||
msg | string | 非必须 | 用户层面的接口回执 | ||
status | number | 非必须 | 内部状态码 成功时返回200 |
验证码类短信校验验证码接口
基本信息
Path: /AGCS_zqc/v3/smslog/validate
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Authorization | Bearer token | 是 | ||
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
phone | string | 必须 | 电话号码 | ||
code | string | 必须 | 短信模板code | ||
verificationCode | string | 必须 | 验证码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
data | string | 非必须 | 开发层面的接口回执 | ||
msg | string | 非必须 | 用户层面的接口回执 | ||
status | number | 非必须 | 内部状态码 成功时返回200 |
验证码类短信发送接口
基本信息
Path: /AGCS_zqc/v3/smslog/send/valid
Method: POST
接口描述:
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Authorization | Bearer token | 是 | ||
Content-Type | application/json | 是 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
phone | string | 必须 | 电话号码 | ||
code | string | 必须 | 短信模板code | ||
signName | string | 必须 | 签名 | ||
appId | string | 必须 | 应用clientId | ||
map | object | 必须 | 短信模板所需参数(一般定义验证码为code) | ||
├─ code | string | 必须 | 如果需要自己维护验证码,先自己生成验证码传过来,如果不需要可以不传,接口内会生成验证码 |
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
data | string | 非必须 | 开发层面的接口回执 | ||
msg | string | 非必须 | 用户层面的接口回执 | ||
status | number | 非必须 | 内部状态码 成功时返回200 |