邮件验证码记录查询 - nxtele/http-api-document-en GitHub Wiki
简要描述:
- 邮件验证码记录查询
请求URL:
http://api2.nxcloud.com/api/email/dr
请求方式:
- POST
参数:
Headers:
| 参数名 | 参数值 | 必选 | 类型 | 说明 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body:
| 参数名 | 类型 | 必选 | 说明 |
|---|---|---|---|
| appKey | string | 是 | 邮件应用appKey |
| secretKey | string | 是 | 邮件应用sercretKey |
| messageId | string | 否 | 邮件ID |
| startTime | string | 否 | 开始时间(yyyy-MM-dd HH:mm:ss) |
| endTime | string | 否 | 结束时间(yyyy-MM-dd HH:mm:ss) |
| current | number | 否 | 页码,默认1 |
| size | number | 否 | 单页条数,默认10,最大100 |
返回示例
{
"msg": "success",
"result": {
"records": [
{
"messageId": "7128fd39195d4e2faf85de7f054514e6",
"customerName": "NX00777-customer",
"appName": "name2",
"tplSubject": "123222",
"sender": "[email protected]",
"receiver": "[email protected]",
"sellPrice": 0.26500000,
"sendTime": "2021-02-23T15:39:51",
"msgResult": "DELIVRD"
}
],
"total": 1,
"size": 10,
"current": 1,
"orders": [],
"appKey": "appKey",
"secretKey": "secretKey",
"messageId": "7128fd39195d4e2faf85de7f054514e6",
"startTime": null,
"endTime": null,
"sortType": 0,
"searchCount": true,
"pages": 1
},
"code": 200
}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| msg | string | 返回信息 |
| result | object | 请求结果 |
| records | object | |
| messageId | string | 邮件ID |
| customerName | string | 名称 |
| appName | string | 应用名称 |
| tplSubject | string | 模板名称 |
| sender | string | 发件人邮箱 |
| receiver | string | 收件人邮箱 |
| sellPrice | string | 单价 |
| sendTime | string | 发送时间 |
| msgResult | string | 消息结果 |
| total | string | 总数 |
| size | string | 每页条数 |
| current | string | 当前页 |
| appKey | string | 邮件应用appKey |
| secretKey | string | 邮件应用secretKey |
| messageId | string | 邮件ID |
| startTime | string | 开始时间(yyyy-MM-dd HH:mm:ss) |
| endTime | string | 结束时间(yyyy-MM-dd HH:mm:ss) |
| sortType | string | 排序方式:默认倒序 |
| code | string | 返回码 |
错误码
| Code | 说明 |
|---|---|
| 0 | 请求成功 |
| 601001 | 账号状态异常 |
| 601002 | 账号余额不足 |
| 601101 | 应用状态异常,appKey/SecretKey不匹配 |
| 601102 | 应用无报价 |
| 601103 | 应用下无该域名配置 |
| 601104 | 域名未校验通过 |
| 601105 | 发件邮箱地址不存在 |
| 601106 | 邮件模板不存在 |
| 601107 | 邮件模板审核未通过 |
| 601201 | 提交失败 |