顾客-留言列表
Customer Get Contacts List API 文档
接口信息
- 接口地址:
{your-site-url}/api/skill/customer/get-contacts-list
- 基础 URL:
{your-site-url} 需替换为你自己的独立站 URL 地址,如 https://your-domain.com/apimanager666
- 请求方式:
GET
- 说明: 此接口用于获取客户留言列表
认证
请求头中需要携带 skill-access-token:
| Header |
值 |
skill-access-token |
{your-skill-access-token} (请替换为你自己的 token) |
请求参数 (Query String)
| 字段 |
类型 |
必填 |
说明 |
email |
string |
选填 |
客户邮箱 |
created_at_begin |
string |
选填 |
创建时间区间 - 开始,如 2026-05-01 00:00:00 |
created_at_end |
string |
选填 |
创建时间区间 - 结束,如 2026-05-25 23:59:59 |
pageNum |
int |
选填 |
第几页,不填写则默认第 1 页 |
pageSize |
int |
选填 |
每页的数据个数,不填写则使用系统默认值 |
请求示例
cURL
curl --location --request GET '{your-site-url}/api/skill/customer/get-contacts-list' \
--header 'skill-access-token: {your-skill-access-token}' \
--data-raw ''
返回结果
code 为 200 表示调用成功;code 不为 200 表示调用失败。
成功响应
{
"code": 200,
"data": {
"list": [
{
"id": 166,
"shop_id": 15,
"name": "3232",
"telephone": "32323",
"email": "fecify@126.com",
"created_at": "2026-03-26 06:51:39",
"updated_at": "2026-05-01 08:47:42",
"status": 2,
"custom_attrs": [
{
"attr_name": "文本输入框",
"attr_value": "3232"
},
{
"attr_name": "下拉选项",
"attr_value": "11"
}
]
}
],
"total": 141,
"pageSize": 20,
"totalPage": 8
},
"message": "success"
}
返回字段说明
| 字段 |
类型 |
说明 |
code |
Number |
状态码,200 表示成功 |
message |
String |
执行结果的文字描述 |
data |
Object |
返回数据 |
data 顶层字段
| 字段 |
类型 |
说明 |
total |
int |
留言总数 |
pageSize |
int |
每页的数据个数 |
totalPage |
int |
总页数 |
list |
Array[Object] |
留言列表 |
list 子项字段
| 字段 |
类型 |
说明 |
id |
int |
留言 ID |
shop_id |
int |
店铺 ID |
name |
string |
留言人名称 |
telephone |
string |
电话 |
email |
string |
邮箱 |
created_at |
string |
创建时间 |
updated_at |
string |
更新时间 |
status |
int |
状态。1 = 未读,2 = 已读 |
custom_attrs |
Array[Object] |
顾客留言表单的自定义属性列表。顾客填写提交的自定义表单字段值,内容取决于店铺后台自定义属性配置,可能为空数组 [] |
custom_attrs 子项字段
| 字段 |
类型 |
说明 |
attr_name |
string |
自定义属性名称 |
attr_value |
string |
自定义属性值 |
注意事项
- 所有参数均为选填
status 为 1 表示未读留言,2 表示已读留言
custom_attrs 为可变数组,内容取决于店铺后台自定义属性配置,可能为空数组 []