获取渠道码列表
GET
/open-api/contact_way/list获取渠道码列表。可以通过调整 query 参数满足不同维度的筛选需求。 列表按照渠道码 id 从小到大进行排序。 列表可根据时间进行筛选。
错误码 | 说明 |
---|---|
20901 | staff_id 错误,找不到对应员工 |
20902 | order 不合法 |
调用此接口需购买基础席位。 |
请求参数
Query 参数
staff_id
string
可选
企业微信员工id。若填写则会返回该员工对应的渠道码信息
示例值:
YangGuang
order
string
可选
排序按照创建时间升序或降序。可选值是 asc(升序) 和 desc(降序),默认值是 asc
示例值:
asc
limit
string
可选
列表返回长度。默认值为30,最大值为100
示例值:
0
offset
string
可选
列表偏移。用于迭代获取所有数据,默认值为0
示例值:
0
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
contact_way_list
array [object {1}]
必需
渠道码信息数组,详细记载了与渠道码有关的信息。
group_name
string | null
渠道码分组名称
errcode
integer
必需
状态码,0为正常,非0代表错误。
errmsg
string
必需
错误信息,成功时为'ok',错误时会以中文方式显示错误原因
total
integer
员工关联渠道码总量
示例
{
"contact_way_list": [
{
"add_user_count": 0,
"auto_mark_tags": [
{
"id": 512,
"name": "特别重要"
}
],
"auto_reply": {
"image": {
"media_id": "3VNjhTeg9PX5w1Fg5QusROEjz894xq7dQ92ED9D52X20JYyZJRrv8D3ORt50g1xsm",
"url": "url"
},
"text": {
"content": "111"
}
},
"config_id": "00567c34bb096d987exc119291b2259a",
"created_at": 1582711304,
"creator_staff_id": "xxXxx",
"id": 132,
"party": null,
"qr_code": "https://wework.qpic.cn/wwpic/818587_ZekwgTTkC2jq6_1582711304/0",
"remark": "remark",
"scene": 2,
"skip_verify": true,
"staffs": [
{
"avatar": "http://wework.qpic.cn/wwhead/duc2TvpEgT9hicuyypLEKCsd54ibsxx28G0IVfwctLpb97PuPHDYDO9J99w316wWlDs/0",
"id": "xxx",
"name": "xxx"
}
],
"state": "weiban:1654076xxxx8099073:132",
"style": null,
"type": 2,
"group_name": "group1"
}
],
"errcode": 0,
"errmsg": "ok",
"total": 2
}
最后修改时间: 7 个月前