OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
mobile | String | Required | MIN: 11;MAX: 11 | 收件手机号,国内11位手机号,例如:13800138000 | |
sms_sign | String | Required | YesApi | MIN: 2;MAX: 16 | 短信签名,2-16 个字符,固定签名可用:【YesApi】、【YesDev】、或【果创云】。如若添加自己的签名,请先实名认证,再提交工单申请。 |
template_id | String | Required | MIN: 1 | 短信模板 ID,例如:pub_verif_short | |
template_data | String | Required | MIN: 1 | JSON格式,模板变量,可以在code中填入你的验证码,例如:{"code": "9153"} |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
mobile | *Required | |
sms_sign | *Required | |
template_id | *Required | |
template_data | *Required |
API Response
KEY | Type | Description |
---|---|---|
err_code | Int | 状态码,0发送成功,1发送失败,请核对手机号码 |
err_msg | String | 错误提示信息 |
send_status | String | 发送状态,如:sent |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | 表示客户端参数错误 |
Http Status = 404 | 表示接口服务不存在 |
Http Status = 500 | 表示服务端内部错误 |