menu

验证码接口

更新时间: 2019-12-24 18:10:38 · 编辑者:宇链科技

提供发送短信相关能力。

注意:本能力对发送频率有限制,请不要滥用,请使用图形验证码或其他有效手段防止用户随意频繁发送恶意验证码。

请保管好 AppSecret,不要明文在网络上传输该字段,并在服务端妥善保管,不要保存在 git 等代码库中

使用此接口必须带有 appid 的签名,签名算法见相关文档。

发送短信验证码

接口地址:

POST https://v1.api.tc.vastchain.ltd/sms/verificationCode

本请求需要携带签名。请参考 API 签名算法

发送一条短信验证码。

POST 内容请使用 JSON(请使用 Content-Type: application/json 头)。

body 例子及解释:

{
    "items": [                         // 目前只支持同时发送 1 条短信
        "phoneNumbers": "15951955195", // 国内短信:11位手机号码,例如15951955195; 国际/港澳台消息:国际区号+号码,例如85200000000
        "codeType": "integer",         // 验证码类型,目前只支持整数
        "code": "636247"               // 短信验证码
    ]
}

返回值例子及解释:

正确返回值:

{
    "status": "success",
    "version": "1",
    "data" : {
        "id": "al-sdv_098F098098092sdfvfaqSDE"
    }
}

错误返回值:

{
    "status": "fail",
    "version": "1",
    "msg": "Exceed count limitation of items."
}

如果返回值为 200 并且 statussuccess 代表发送成功,系统会在后台排队发送。

否则,返回值会带有 msg 字段并表示错误详情。请务必重复尝试直到成功。