短信服务集成

短信推送为营销必备能力，易企秀支持企业使用自有的短信通道。

使用步骤

根据接口规范适配发送接口
配置发送接口

接口开发说明

短信发送

接口描述：发送短信
请求方式：POST
数据格式：json

接口入参（加密）

参数名	是否必须	参数类型	参数说明
nonce	必须	String	随机字符串，一般为UUID
timestamp	必须	Long	当前 UNIX 时间戳，可记录发起 API 请求的时间。例如1529223702
signature	否	String	请求签名，防止请求数据被篡改，如果需要更高的安全等级，请添加此参数。
msgEncrypt	必须	String	加密的数据明细，明文参数见下文

msgEncrypt明文参数

参数名必须参数类型参数说明

type 是 String 业务类型，form:表单中使用

corpOpenId 否 String 用于平台区分企业

args 是 Map 短信参数

args参数

参数名	必须	参数类型	参数说明
requestId	是	String	易企秀标识
opt	是	String	操作:send:发送
phone	是	String	手机号
answer	否	String	图形验证答案（生物验证码使用）
bizType	是	String	业务类型。mobile_auth：授权验证码；win_prize：中奖通知； not_win_prize：未中奖通知；form_notification：表单通知
creationId	否	Long	作品id
creationUrl	否	String	作品访问的url

请求参数示例

{
  "msgEncrypt": "qguoHOFLPNPuUBIMwd+DJXzZzU0npUmwsdNpOthzir8mbql0uPEuBps873GSIc6Z",
  "nonce": "8d1e06d655df433bb8363877ad35fc70",
  "signature": "f6f8b7088037ec7fa06c42965c0efaf8a19f9c14",
  "timestamp": "1625486567366"
}

接口出参

参数名	必须	参数类型	参数说明
code	是	String	200，成功
msg	是	String	非200时提示信息，例如：一分钟只能发送一次
obj	否	Map	发送短信后的其他参数对象（作为短信验证接口入参）

obj字段说明

字段类型说明

externalId String 外部订单ID

接口出参示例

{
  "success": true,
  "code": "200",
  "msg": "ok",
  "obj": null,
  "map": null,
  "list": []
}

短信验证

接口描述：验证短信
请求方式：POST
数据格式：json

接口入参（加密）

参数名	是否必须	参数类型	参数说明
nonce	必须	String	随机字符串，一般为UUID
timestamp	必须	Long	当前 UNIX 时间戳，可记录发起 API 请求的时间。例如1529223702
signature	否	String	请求签名，防止请求数据被篡改，如果需要更高的安全等级，请添加此参数。
msgEncrypt	必须	String	加密的数据明细，明文参数见下文

msgEncrypt明文参数

参数名必须参数类型参数说明

type 是 String 业务类型，form:表单中使用

corpOpenId 否 String 用于平台区分企业

args 是 Map 短信参数

args参数

参数名	必须	参数类型	参数说明
requestId	是	String	易企秀标识
opt	是	String	操作:send:发送 check:验证
phone	是	String	手机号
code	是	String	短信验证码，用于短信验证，或者非自定义用户时，替换短信内容
externalId	是	String	外部发送形成

请求参数示例

{
  "msgEncrypt": "qguoHOFLPNPuUBIMwd+DJXzZzU0npUmwsdNpOthzir8mbql0uPEuBps873GSIc6Z",
  "nonce": "8d1e06d655df433bb8363877ad35fc70",
  "signature": "f6f8b7088037ec7fa06c42965c0efaf8a19f9c14",
  "timestamp": "1625486567366"
}

接口出参

参数名	必须	参数类型	参数说明
code	是	String	200，成功
msg	是	String	非200时提示信息，例如：一分钟只能发送一次
obj	是	Map	发送短信后的其他参数对象

接口出参示例

{
  "success": true,
  "code": "200",
  "msg": "ok",
  "obj": null,
  "map": null,
  "list": []
}

获取生物验证码

接口描述：获取生物验证码
请求方式：POST
数据格式：json

接口入参（加密）

参数名	是否必须	参数类型	参数说明
nonce	必须	String	随机字符串，一般为UUID
timestamp	必须	Long	当前 UNIX 时间戳，可记录发起 API 请求的时间。例如1529223702
signature	否	String	请求签名，防止请求数据被篡改，如果需要更高的安全等级，请添加此参数。
msgEncrypt	必须	String	加密的数据明细，明文参数见下文

msgEncrypt明文参数

参数名必须参数类型参数说明

creationId 是 Long 作品ID

type 是 Integer 验证码类型（目前只有图形验证）

请求参数示例

{
  "msgEncrypt": "qguoHOFLPNPuUBIMwd+DJXzZzU0npUmwsdNpOthzir8mbql0uPEuBps873GSIc6Z",
  "nonce": "8d1e06d655df433bb8363877ad35fc70",
  "signature": "f6f8b7088037ec7fa06c42965c0efaf8a19f9c14",
  "timestamp": "1625486567366"
}

接口出参

参数名必须参数类型参数说明

code 是 String 200，成功

msg 是 String 非200时提示信息

obj 是 Map 发送短信后的其他参数对象

接口出参示例

{
  "success": true,
  "code": "200",
  "obj":{
      "base64Img": "", // base64图片
      "externalJson": {
          "imageCodeId": "12312" // 其他业务字段，可以随意定义，后面的图形验证接口会带入这些字段
      }
  }
}

配置说明

企业配置说明

【集成管理】-【短信推送服务】-【添加】

平台配置说明

【开放管理】–【选择对应平台】–【配置】–【集成配置】–【短信推送服务】-【添加】

配置项

需要配置短信发送和短信校验两个url。

生物验证码配置（目前只需要配置图片获取接口）

配置项	配置说明
短信发送	用于发送短信
短信校验	用于短信验证码校验
是否开启图形验证	图形验证码的安全校验

参数名	必须	参数类型	参数说明
type	是	String	业务类型，form:表单中使用
corpOpenId	否	String	用于平台区分企业
args	是	Map	短信参数