获取渠道活码列表

拥有此API的权限集
SCRM-查询

请求方式及url

• 请求方式：POST
• 请求头：Content-Type:application/json
• 接口地址：https://api.xiaoe-tech.com/xe.scrm.contact_card.contact_card_list/1.0.0
• 频率限制：1s/1次

接口调试

GETPOSTPUTDELETE

https://api-doc.xiaoe-tech.com/_agent/forward?url=https://api.xiaoe-tech.com/

请求参数

响应结果

暂无响应数据

请求参数

参数名	必选	类型	说明	备注
access_token	是	string	专属token	...
corp_id	是	string	企业微信企业 ID，单值传入	必须属于当前凭证对应应用的有效企业配置
card_name	否	string	渠道活码名称，按名称进行模糊搜索	...
card_state	否	int	活码状态	0-全部；-1-创建失败；1-创建成功；2-创建中；3-编辑中；4-编辑失败
card_group_id	否	int64	渠道活码分组 ID	不传或传 0 表示不按分组过滤
start_time	否	string	创建时间起点，查询 created_at >= start_time	时间格式以服务端支持的格式为准
end_time	否	string	创建时间终点，查询 created_at <= end_time	时间格式以服务端支持的格式为准
page	否	int	页码，从 1 开始	不传或传 0 默认为 1
page_size	否	int	每页数量	不传或传 0 默认为 20，取值范围 1-100

app_id 已包含在 access_token 凭证中，由服务端从凭证中解析，调用方无需单独传递。服务端固定按渠道活码查询，内部参数 card_from=1 不需要传入。列表接口不依赖 b_user_id；corp_id 仍必须属于当前凭证对应应用的有效企业配置。

请求示例

{
  "access_token": "xe_xxxxx",
  "corp_id": "corp_xxx",
  "card_name": "客服",
  "card_state": 1,
  "card_group_id": 12,
  "start_time": "2026-01-01 00:00:00",
  "end_time": "2026-01-31 23:59:59",
  "page": 1,
  "page_size": 20
}

返回参数

参数名	必选	类型	说明	备注
code	是	int	状态码，0 表示成功，非 0 表示失败	...
msg	是	string	状态信息	...
data	是	object	返回值	...
data.list	是	array	渠道活码列表	无数据时为空数组
data.page	是	object	分页信息	...
data.page.page	是	int	当前页码	...
data.page.page_size	是	int	每页数量	...
data.page.total	是	int64	符合条件的数据总数	...

data.list 渠道活码列表

参数名	类型	说明	备注
id	int64	渠道活码 ID	...
card_name	string	活码名称	...
card_state	int	活码状态	...
qr_code	string	活码二维码地址	...
rule_type	int	活码分配规则类型	...
card_group_id	int64	活码分组 ID	下游返回时提供
card_state_text	string	活码状态描述	下游返回时提供
rule_type_text	string	分配规则类型描述	下游返回时提供
group_name	string	活码分组名称	下游返回时提供
creator_name	string	创建人名称	下游返回时提供
created_at	string	创建时间	...
total_add_count	int64	累计添加客户数	下游返回时提供
total_churn_count	int64	累计流失客户数	下游返回时提供
logo_url	string	二维码 Logo 地址	下游返回时提供
original_qrcode	string	原始二维码地址	下游返回时提供

返回示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "list": [
      {
        "id": 10001,
        "card_name": "客服渠道活码",
        "card_state": 1,
        "qr_code": "https://example.com/qrcode/xxx",
        "rule_type": 1,
        "card_group_id": 12,
        "card_state_text": "创建成功",
        "rule_type_text": "随机",
        "group_name": "默认分组",
        "creator_name": "管理员",
        "created_at": "2026-01-01 12:00:00",
        "total_add_count": 128,
        "total_churn_count": 3
      }
    ],
    "page": {
      "page": 1,
      "page_size": 20,
      "total": 1
    }
  }
}

错误码

错误码	msg	说明
1005001	invalid request parameters	请求 JSON 格式错误，或 access_token、corp_id 缺失/为空
1005001	invalid pagination parameters	page 小于 1，或 page_size 不在 1-100 范围内
1005002	corp_id is not authorized	corp_id 不属于当前凭证对应应用，或未通过企业授权校验
1005002	contact card list request failed	渠道活码列表服务返回业务失败
1002	system error	服务请求失败、响应无法解析，或返回数据结构不符合要求

错误响应示例：

{
  "code": 1005001,
  "msg": "invalid pagination parameters",
  "data": {}
}