发送语音验证码

最近更新时间:2020-08-11 15:17:11

发送语音验证码(CallVerify)

描述

给指定手机号发送语音验证码

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

公共参数列表 详情

名称 类型 必须 长度限制 参数格式 描述 备注
Action String 确定值 [a-zA-Z]+ 操作接口名,系统规定参数,取值:CallVerify
Version String 确定值 版本号,系统规定参数,取值:2020-05-01
Mobile String [0-9]+ 仅支持中国大陆手机号: 11位数字,例如 1xxxxxxxx
Caller String [0-9]+ 号显号码,被叫终端上显示的主叫号码
TplId Int [0-9]+ 语音验证码模板ID,注:使用系统固定模板,无需自己创建
Code String 4~8位数字 [0-9]+ 验证码内容,例如:123456
PlayTimes Int 数字 播放次数,取值范围1~2,默认为2
ExtId String 最多50个字符 [0-9a-zA-Z]+ 客户自定义流水号,在状态报告中返回
验证码系统模板
模板ID 模板内容
100001 您的验证码为{code},如非本人操作,请忽略!
100002 您的注册验证码是{code},请不要把验证码泄漏给其他人。
100003 您本次登录的验证码为{code},如非本人操作,请勿泄露!
100004 您正在找回密码,验证码为{code}, 请勿泄露。
100005 您正在进行支付确认,验证码是{code},切勿泄露给他人!
返回结果

通过指定 Accept:application/json,返回的数据格式为json

名称 类型 描述 备注
CallId String 语音消息记录唯一标识
ExtId String 客户自定义流水号
RequestId String 请求唯一标识
示例(调用成功)
请求示例
curl -X POST \
  'http://voice.api.ksyun.com/' \
  -H 'Authorization: AWS4-HMAC-SHA256 xxx' \
  -H 'accept: application/json' \
  -H 'content-type: application/x-www-form-urlencoded' \
  -H 'host: voice.api.ksyun.com' \
  -d 'Mobile=1xxxx&TplId=1xxx&Code=123456&Action=CallVerify&Version=2020-05-01&Signature=xxxx&SignatureVersion=1.0&Timestamp=2020-08-13T17:18:36Z&Service=voice&Accesskey=xxx'
返回示例
{
    "CallId": "fbdad845962b1586960833",
    "ExtId": "",
    "RequestId": "7de19b5e-0791-4269-872b-c3e05b53c3c8"
}
调用失败返回示例
{
    "RequestId": "7e9a59c5-2e20-4aa8-bd0f-9cef8d42961f",
    "Error": {
        "Type": "server",
        "Message": "The Account do not call voice service",
        "Code": "AccountVoiceServiceUnavailable"
    }
}

访问API错误码查看更多错误码

金山云,开启您的云计算之旅

免费注册