企业内部开发 服务端API 上下游 上下游通讯录管理 获取上下游信息
获取上下游信息
最后更新:2023/11/29
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
获取上下游信息
最后更新:2023/11/29

目录

  • 获取上下游列表
  • 获取上下游通讯录分组
  • 获取企业上下游通讯录分组下的企业详情列表
  • 获取企业上下游通讯录下的企业信息
  • 获取上下游列表

    请求方式:GET(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/corpgroup/corp/get_chain_list?access_token=ACCESS_TOKEN

    参数说明:

    参数必须类型说明
    access_tokenstring调用接口凭证。上游企业应用access_token

    权限说明:

    返回结果:

    {
        "errcode": 0,
        "errmsg": "ok",
        "chains": [
            {
                "chain_id": "chainid1",
                "chain_name": "能源供应链"
            },
            {
                "chain_id": "chainid2",
                "chain_name": "原材料供应链"
            }
        ]
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    chains企业上下游列表
    chains.chain_id上下游id
    chains.chain_name上下游名称

    获取上下游通讯录分组

    自建应用/代开发应用可通过该接口获取企业上下游通讯录分组详情
    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/corpgroup/corp/get_chain_group?access_token=ACCESS_TOKEN

     

    请求示例

    {
        "chain_id":"Chxxxxxx",
        "groupid":1
    }

    参数说明 :

    参数必须说明
    access_token调用接口凭证。上游企业应用access_token
    chain_id上下游id
    groupid分组id。填写此参数返回指定分组,不填则返回全部分组

    权限说明:

    • 自建应用/代开发应用可调用,仅可指定或返回应用可见范围内的分组列表
    • 上下游- 可调用接口的应用」调用,可指定或返回全部的分组列表

     

    返回结果:

    {
        "errcode": 0,
        "errmsg": "ok",
        "groups": [
            {
                "groupid": 2,
                "group_name": "一级经销商",
                "parentid": 1,
                "order": 1
            },
            {
                "groupid": 3,
                "group_name": "二级经销商",
                "parentid": 2,
                "order": 3
            }
        ]
    }
    

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    groups分组列表数据。
    groups.groupid分组id
    groups.group_name分组名称
    groups.parentid父分组id。根分组id为1
    groups.order父部门中的次序值。order值大的排序靠前。值范围是[0, 2^32)

    获取企业上下游通讯录分组下的企业详情列表

    自建应用/代开发应用可通过该接口获取企业上下游通讯录的某个分组下的企业列表

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/corpgroup/corp/get_chain_corpinfo_list?access_token=ACCESS_TOKEN

    请求示例

    {
        "chain_id":"Chxxxxxx",
        "groupid":1,
        "need_pending":false,
        "cursor": "",
        "limit": 0
    }

    参数说明 :

    参数必须说明
    access_token调用接口凭证。上游企业应用access_token
    chain_id上下游id
    groupid分组id。如果不填,表示根目录
    need_pending是否需要返回未加入的企业。默认不返回
    cursor开启分页使用,传入返回值next_cursor
    limit>0开启分页功能。
    如需获取该分组及其子分组的所有企业详情,需先获取该分组下的所有子分组,然后再获取子分组下的企业,逐层递归获取。

    权限说明:

     

    返回结果:

    {
        "errcode": 0,
        "errmsg": "ok",
        "has_more": false,
        "next_cursor": "xxx",
        "group_corps": [
            {
                "groupid": 2,
                "corpid": "wwxxxx",
                "corp_name":"美馨粮油公司",
                "custom_id":"custom_id",
                "invite_userid":"zhangsan",
                "pending_corpid":"wwxxxx",
                "is_joined":1
            }
        ]
    }
    

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    group_corps分组列表数据。
    group_corps.groupid企业所属上下游的分组id
    group_corps.corpid企业id,最多64个字节,已加入的企业返回
    group_corps.corp_name企业名称
    group_corps.custom_id上下游企业自定义id,返回批量导入上下游联系人时指定的企业自定义id,如未指定则该字段为空
    group_corps.invite_userid该上下游的邀请人的userid,仅 上下游- 可调用接口的应用」应用调用时返回,切成员需在应用的可见范围内
    group_corps.pending_corpid未加入企业id,未加入的企业返回
    group_corps.is_joined企业是否已加入
    next_cursor下次请求时应传入的cursor
    has_more开启分页时告知是否还有更多记录

     

    获取企业上下游通讯录下的企业信息

    自建应用/代开发应用可通过该接口获取企业上下游通讯录的某个企业的自定义id和所属分组的分组id
    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/corpgroup/corp/get_chain_corpinfo?access_token=ACCESS_TOKEN

     

    请求示例

    {
        "chain_id":"Chxxxxxx",
        "corpid":"xxxxx",
        "pending_corpid":"xxxxx"
    }

    参数说明 :

    参数必须说明
    access_token调用接口凭证。上游企业应用access_token
    chain_id上下游id
    corpid已加入企业id
    pending_corpid待加入企业id(corpid和pending_corpid至少填一个,同时填corpid生效

    权限说明:

     

    返回结果:

    {
        "errcode": 0,
        "errmsg": "ok",
        "corp_name":"美馨粮油公司",
        "qualification_status":1,
        "custom_id": "xxxxx",
        "groupid": 1,
        "is_joined": false
    }
    

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    corp_name企业名称
    qualification_status企业是否验证或认证,1表示未验证,2表示已验证,3表示已认证,已加入的企业返回
    custom_id上下游企业自定义id,返回批量导入上下游联系人时指定的企业自定义id,如未指定则该字段为空
    groupid企业所属上下游的分组id
    is_joined企业是否已加入

     

    上一篇
    上下游关联客户信息-未添加客户
    下一篇
    批量导入上下游联系人