首页
帮助中心
API
说明： 查询平台配置的收件人列表信息。
| 参数 | 说明 | 是否必填 | 类型 |
|---|---|---|---|
|
appId |
应用id（邮件-邮件应用） |
是 |
String |
|
receiversName |
收件人列表名称的关键字模糊查询 |
否 |
String |
https://api.onbuka.com/v3/email/getListReceivers?appId={appId}&receiversName={receiversName}
Request URL:
https://api.onbuka.com/v3/email/getListReceivers?appId=bDqJFiq9&receiversName=receiversName
Request Method:
GET
Request Headers:
Content-Type: application/json;charset=UTF-8
Sign: 05d7a50893e22a5c4bb3216ae3396c7c
Timestamp: 1630468800
Api-Key: bDqJFiq9
Request URL:
https://api.onbuka.com/v3/email/getListReceivers
Request Method:
POST
Request Headers:
Content-Type: application/json;charset=UTF-8
Sign: 05d7a50893e22a5c4bb3216ae3396c7c
Timestamp: 1630468800
Api-Key: bDqJFiq9
Request Body:
{
"appId":"bDqJFiq9",
"receiversName":"receiversName"
}
| 参数 | 说明 | 类型 |
|---|---|---|
|
status |
状态码，0成功，其他失败参见邮件状态码说明 |
String |
|
reason |
失败原因说明 |
String |
|
receiverData |
以下5个字段数组 |
Array |
|
receiverId |
收件人列表ID |
Int |
|
receiversName |
收件人列表名称 |
String |
|
count |
收件人地址总数 |
Int |
|
desc |
收件人列表描述。注意：此字段可能返回 null，表示取不到有效值。 |
String |
|
createTime |
创建时间 |
String |
{
"status":"0",
"reason":"success",
"templateContent":[
{
"receiverId":1000001,
"receiversName":"receiversName",
"count":0,
"createTime":"2023-03-20 09:34:58",
"desc":"描述信息"
}
]
}
