获取渠道码列表 - 微伴助手OpenAPI

获取渠道码列表。可以通过调整 query 参数满足不同维度的筛选需求。列表按照渠道码 id 从小到大进行排序。列表可根据时间进行筛选。

错误码	说明
20901	staff_id 错误，找不到对应员工
20902	order 不合法
调用此接口需购买基础席位。

请求参数

Query 参数

staff_id

string

可选

企业微信员工id。若填写则会返回该员工对应的渠道码信息

示例值:

YangGuang

order

string

可选

排序按照创建时间升序或降序。可选值是 asc(升序) 和 desc(降序)，默认值是 asc

示例值:

asc

limit

string

可选

列表返回长度。默认值为30，最大值为100

示例值:

offset

string

可选

列表偏移。用于迭代获取所有数据，默认值为0

示例值:

access_token

string

调用接口凭证

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

contact_way_list

array [object {17}]

必需

渠道码信息数组，详细记载了与渠道码有关的信息。

add_user_count

integer

必需

通过该渠道码码添加的人数

auto_mark_tags

array[object (AutoMarkTag) {2}]

必需

自动打标签的信息数组，详细记载了与自动打标签有关的信息。

auto_reply

object | null

必需

添加客户后自动回复的消息

config_id

string

必需

新增联系方式的配置id

created_at

integer

必需

数据创建时间（微伴系统内时间）

creator_staff_id

string | null

必需

创建渠道码的员工id

integer

数据主键

必需

party

null

必需

使用该联系方式的部门id列表，只在type为2时有效

qr_code

string

必需

联系二维码的URL，仅在scene为2时不为null

remark

string

必需

渠道码名称，相当于state_name

scene

integer

必需

场景，1-在小程序中联系，2-通过二维码联系

skip_verify

boolean

必需

外部客户添加时是否无需验证，默认为true

state

string

必需

企业自定义的state参数，用于区分不同的添加渠道，不超过30个字符

style

integer | null

必需

在小程序中联系时使用的控件样式

type

integer

必需

联系方式类型,1-单人, 2-多人

staffs

array[object (Staff) {3}]

必需

渠道码指定的客服信息数组，详细记载了该渠道码指派的客服信息

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
}

🟢200正常返回