短信验证码

短信验证码开放API安全校验
面向开放 API 调用方的短信验证码发送与校验服务,支持调用方自传验证码和平台自动生成验证码两种模式。
接口ID:48
服务正常
由于测试id被频繁恶意利用,不再提供测试使用的app_id和app_secret,如需调试或者正式使用接口,请申请您专属的app_id和app_secret
  • 发送自传短信验证码
  • 发送平台短信验证码
  • 校验平台短信验证码
  • 接口请求地址: https://www.mxnzp.com/api/sms_verify_code/send/custom
  • 接口请求方式: POST
  • 请求参数格式: APPLICATION/X-WWW-FORM-URLENCODED
  • 接口返回格式: APPLICATION/JSON
  • 接口请求示例: https://www.mxnzp.com/api/sms_verify_code/send/custom?app_id=不再提供请自主申请&app_secret=不再提供请自主申请&phone=13800138000&code=123456&scene=login
  • 接口信息备注: 调用方自传 6 位数字验证码并发送短信。该模式不写入 Redis,也不提供平台校验能力;发送成功后扣减短信验证码次数。

请求参数说明:


名称类型说明
phone字符串接收验证码的手机号
code字符串调用方自传的 6 位数字验证码
scene字符串业务场景,可不传,默认 default

返回参数说明:


名称类型说明
success布尔值短信是否发送成功
checkResult布尔值校验结果;发送接口固定为 false
code字符串预留字段,不返回验证码明文
expireSeconds长整型有效期秒数;自传模式为 0
requestId字符串本次请求 ID
remainTimes整型当前剩余短信验证码次数
msg字符串处理结果说明

返回示例:

{"code":1,"msg":"数据返回成功","data":{"success":true,"checkResult":false,"code":"","expireSeconds":0,"requestId":"b2f7d56f0b5e4c16a2e3a27f91f2b8c0","remainTimes":99,"msg":"发送成功"}}

错误码说明

查看所有接口通用及业务错误码,快速定位 code 与 msg 对应含义。

查看错误码