发送语音验证码 - nxtele/http-api-document GitHub Wiki
简要描述:
- 语音验证码接口
请求方式:
- URL:
http://api2.nxcloud.com/api/voiceSms/versend
- Method:
POST
- Content-Type:
application/x-www-form-urlencoded
- 请求示例参考 HTTP表单方式提交
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
appkey | 是 | string | 语音应用appkey |
secretkey | 是 | string | 语音应用secretkey |
phone | 是 | string | 手机号,只能提交单个,不能批量提交 |
country_code | 是 | string | 国码(不带+号,纯国码数字即可) |
show_phone | 是 | string | 想要显示的号码(填写任意位数的数字即可,实际显示号码可能会被修改) |
content | 是 | string | 文字内容;如需播报验证码则数字之间用'-'隔开,比如:1-2-3-4-5-6;内容需要做urlencode(utf-8) |
lang | 是 | string | 语言代码(参照下列表格), zh(Chinese),只传缩写英文如:zh、en |
ext | 否 | string | 自定义扩展字段,会跟随语音回执返回 |
请求示例:
curl --location --request POST 'http://api.nxcloud.com/api/voiceSms/versend' \
--data-urlencode 'appkey=asdf' \
--data-urlencode 'secretkey=qwer' \
--data-urlencode 'phone=6212345678' \
--data-urlencode 'country_code=62' \
--data-urlencode 'show_phone=123456' \
--data-urlencode 'content=asdfghjk' \
--data-urlencode 'lang=en' \
--data-urlencode 'ext=ext123'
请求成功返回示例
{
"code": "0",
"messageid": "69c057be1d984a5baf6d9e1384e5c456",
"message": "Success"
}
请求异常返回示例
{
"code": "23",
"messageid": "",
"message": "Country code error"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
message | string | 请求结果说明 |
messageid | string | 系统返回的语音ID |
code | string | 结果编码 |
备注
- 语言代码
code | 说明 |
---|---|
af | Afrikaans |
ar | Arabic |
bn | Bengali |
bs | Bosnian |
ca | Catalan |
cs | Czech |
cy | Welsh |
da | Danish |
de | German |
el | Greek |
en | English |
eo | Esperanto |
es | Spanish |
et | Estonian |
fi | Finnish |
fr | French |
gu | Gujarati |
hi | Hindi |
hr | Croatian |
hu | Hungarian |
hy | Armenian |
id | Indonesian |
is | Icelandic |
it | Italian |
ja | Japanese |
jw | Javanese |
km | Khmer |
kn | Kannada |
ko | Korean |
la | Latin |
lv | Latvian |
mk | Macedonian |
ml | Malayalam |
mr | Marathi |
my | Myanmar(Burmese) |
ne | Nepali |
nl | Dutch |
no | Norwegian |
pl | Polish |
pt | Portuguese |
ro | Romanian |
ru | Russian |
si | Sinhala |
sk | Slovak |
sq | Albanian |
sr | Serbian |
su | Sundanese |
sv | Swedish |
sw | Swahili |
ta | Tamil |
te | Telugu |
th | Thai |
tl | Filipino |
tr | Turkish |
uk | Ukrainian |
ur | Urdu |
vi | Vietnamese |
zh | Chinese |
zh-yue | Chinese-粤语 |
- 错误代码
code | message |
---|---|
0 | Success |
1 | APP unavailable |
2 | Request parameter error |
3 | Insufficient balance |
6 | Phone number error |
23 | Country code error |
27 | Phone tps 1h/5 |
28 | TPS limit |
30 | Voice content repeat between 1 and 5 |
88 | Failure |
99 | System error |
102 | Account unavailable |