OkayAPI Docs


API Path: /api/Supplier/YesApi/SendSmsCode

API Description: 适用于验证码等场景所发送的短信,多套模板可选,初创企业最佳选择,无门槛零负担。

免费
3次

1
API Traffic
HTTP/HTTPS
Protocol
GET/POST
Method
UTF-8
Charset
JSON
Response
供应商
已认证

API Debug   


API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
mobileStringRequiredMIN: 11;MAX: 11收件手机号,国内11位手机号,例如:13800138000
sms_signStringRequiredYesApiMIN: 2;MAX: 16短信签名,2-16 个字符,固定签名可用:【YesApi】、【YesDev】、或【果创云】。如若添加自己的签名,请先实名认证,再提交工单申请。
template_idStringRequiredMIN: 1短信模板 ID,例如:pub_verif_short
template_dataStringRequiredMIN: 1JSON格式,模板变量,可以在code中填入你的验证码,例如:{"code": "9153"}

API Debug

KEYREQUIREDVALUE
app_key *Required
mobile *Required
sms_sign *Required
template_id *Required
template_data *Required

API Response

KEYTypeDescription
err_codeInt状态码,0发送成功,1发送失败,请核对手机号码
err_msgString错误提示信息
send_statusString发送状态,如:sent

HTTP Response Code

HTTP Status CodeDescription
Http Status = 200Success
Http Status = 400表示客户端参数错误
Http Status = 404表示接口服务不存在
Http Status = 500表示服务端内部错误