语音验证码接口


功能说明:

  • 通过电话直呼到用户手机并语音播放验证码,海外号码默认最多播放 2 次,国内(+86)号码播放 2 次。如:您的验证码是 1234。 系统已提供的默认模板。


特别说明:验证码短信,请在手机验证环节,加入图片验证码, 以免被恶意攻击。

为防止骚扰用户,国内(+86号码段)每天22:00至次日7:30禁止发送语音验证码。


HTTP 头信息:


Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;


请求


URL:https://voice.yunpian.com/v2/voice/send.json
访问方式:POST


请求参数

参数名

类型

是否必须

描述

示例

apikey

string

用户唯一标识,在"账号设置"-"子帐号管理"中查看

9b11127a9701975c734b8aee81ee3526

mobile

string

接收的手机号,国际号码需包含国际地区前缀号码,国内号码可直接传号码

国内号码15205201314

国际号码

+93701234567

code

string

验证码,支持 4~6 位阿拉伯数字

1234

language

string

播放语言,非中国大陆地区,默认值为en,其中:

zh:中文;

en:英文;

id:印尼语;

vi:越南语;

tr:土耳其语;

ru:俄语;

de:德语;

fr:法语;

it:意大利语;

pt:葡萄牙语;

(中国大陆地区,固定为中文播放,参数无效)

en

uid

string

该条短信在您业务系统内的 ID,如订单号或者短信发送记录流水号。默认不开放,如有需要请联系客服申请。

10001

callback_url

string

本条语音验证码状态报告推送地址。 如推送地址固定,建议在"数据推送与获取”做批量设置。

http://your_receive_url_address


附注:该接口加密时,需对手机号和验证码同时加密。


响应

名称

类型

描述

count

integer

成功发送的语音呼叫次数

fee

integer

扣费金额,一次语音验证码呼叫扣一条短信

sid

string

记录 id,不超过32 位的唯一字符串


Json 返回示例:


调用成功的返回示例:


{
  "count": 1,
  "fee": 1,
  "sid": "3375655611"
}


调用失败的返回示例:


{
    "http_status_code": 400,
    "code": 22,
    "msg": "验证码类短信1小时内同一手机号发送次数不能超过3次",
    "detail": "验证码类短信1小时内同一手机号 15841153871 发送次数不能超过3次"
}


防骚扰过滤


过滤规则:同一个手机号码,30 秒内最多发送 1 次,1小时内最多发送 3 次,24小时内最多发送 5次。


语言对照表

language

语言

播放内容

zh

中文

您的验证码是1-2-3-4

en

英文

Your verification code is 1-2-3-4

id

印尼语

Kode verifikasi Anda adalah 1-2-3-4

vi

越南语

Mã xác minh của bạn là 1-2-3-4

tr

土耳其语

Doğrulama kodunuz 1-2-3-4

ru

俄语

Ваш проверочный код 1-2-3-4

de

德语

Ihr Bestätigungscode lautet 1-2-3-4

fr

法语

Votre code de vérification est 1-2-3-4

it

意大利语

Il tuo codice di verifica è 1-2-3-4

pt

葡萄牙语

O seu código de verificação é 1-2-3-4