OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
PhoneNumbers | String | Required | 接收短信的手机号码。国内短信:11位手机号码,例如15951955195。国际/港澳台消息:国际区号+号码,例如85200000000。 | ||
SignName | String | Required | 短信签名名称。可在阿里云控制台签名管理页面签名名称一列查看。例如:阿里云 | ||
TemplateCode | String | Required | 短信模板ID。可在阿里云控制台模板管理页面模板CODE一列查看。例如:SMS_153055065 | ||
TemplateParam | ArrayJSON Format | Optaion | 短信模板变量对应的实际值,JSON格式。例如:{"code":"1111"} |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
PhoneNumbers | *Required | |
SignName | *Required | |
TemplateCode | *Required | |
TemplateParam | Option |
API Response
KEY | Type | Description |
---|---|---|
操作码,0成功,1失败 | err_code | |
BizId | String | 发送回执ID,可根据该ID在接口QuerySendDetails中查询具体的发送状态。 |
Code | String | 请求状态码。返回OK代表请求成功。其他错误码详见错误码列表。 |
Message | String | 状态码的描述。 |
RequestId | String | 请求ID。 |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | 表示客户端参数错误 |
Http Status = 404 | 表示接口服务不存在 |
Http Status = 500 | 表示服务端内部错误 |