OkayAPI Docs
API Params
Parameter | Type | Required | Default | Note | Description |
---|---|---|---|---|---|
HTTP_APPKEY | String | Required | MIN: 32 | Common Put Your APPKEY | |
CurrentPage | Int | Optaion | 1 | MIN: 1 | 分页查看发送记录,指定发送记录的的当前页码。 |
PageSize | Int | Optaion | 10 | MIN: 1;MAX: 50 | 分页查看发送记录,指定每页显示的短信记录数量。取值范围为1~50。 |
PhoneNumber | String | Required | 接收短信的手机号码。格式:
| ||
SendDate | String | Required | 短信发送日期,支持查询最近30天的记录。格式为yyyyMMdd,例如20181225。 |
API Debug
KEY | REQUIRED | VALUE |
---|---|---|
app_key | *Required | |
CurrentPage | Option | |
PageSize | Option | |
PhoneNumber | *Required | |
SendDate | *Required |
API Response
KEY | Type | Description |
---|---|---|
操作码,0成功,1失败 | err_code | |
Code | String | 请求状态码。返回OK代表请求成功。其他错误码详见错误码列表。 |
Message | String | 状态码的描述。 |
RequestId | String | 请求ID。 |
SmsSendDetailDTOs | Object | 短信发送明细。 |
TotalCount | String | 短信发送总条数。 |
HTTP Response Code
HTTP Status Code | Description |
---|---|
Http Status = 200 | Success |
Http Status = 400 | 表示客户端参数错误 |
Http Status = 404 | 表示接口服务不存在 |
Http Status = 500 | 表示服务端内部错误 |