企微中台客户列表

更新时间:2022-11-15 10:23:24

接口说明

企微中台客户列表

基本信息

请求方式: GET

请求路径:

https://prod.open-api.mysre.cn/yxdccs/qw-nbd-api/get-customer-list

请求参数

参数名 参数位置 参数类型 必填 默认值 示例 描述
app_id query string 企微应用 Id
qw_user_ids query string 企微成员 ID
project_ids query string 项目 ID 列表
qw_tag_ids query string 企微标签 ID(空表示不过滤)
customer_tag_rule query string 标签过滤规则:1-任意满足(默认),2-所有满足,3-不包含
custom_condition query string 自定义参数
custom_condition.code query string 参数编码
custom_condition.values query string 参数值,多个用逗号分隔
is_page query string 是否需要分页
pager query string 分页参数
pager.page query string 页码
pager.page_size query string 分页行数

请求示例

get /qw-nbd-api/get-customer-list?key1=value1&key2=value2

返回成功示例

{
    "errcode": 0,
    "errmsg": "ok",
    "ext_user_list": [
        {
            "ext_user_id": "wm-TUtCAAAG07kKgnR-PwfYLXVqu4IOw",
            "name": "随風"
        },
        {
            "ext_user_id": "wm-TUtCAAAcAkqTbJLQBIzSsudI_-Faw",
            "name": "qx9"
        }
    ],
    "pager": {
        "page": 1,
        "page_size": 10,
        "total_rows": 2
    }
}

返回参数说明(成功)

参数名 参数类型 描述
errcode number
errmsg string
ext_user_list array
ext_user_list.ext_user_id string
ext_user_list.name string
pager object
pager.page number
pager.page_size number
pager.total_rows number

失败返回示例

{
    "errcode": 200,
    "errmsg": "ok"
}

返回参数说明(失败)

参数名 参数类型 描述

results matching ""

    No results matching ""