企业内部开发 服务端API 上下游 获取上下游信息
获取上下游信息

目录

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

    请求方式: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"
    }

    参数说明 :

    参数必须说明
    access_token调用接口凭证。上游企业应用access_token
    chain_id上下游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.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,
        "fetch_child":0
    }

    参数说明 :

    参数必须说明
    access_token调用接口凭证。上游企业应用access_token
    chain_id上下游id
    groupid分组id。如果不填,表示根目录
    fetch_child递归获取指定分组及其子分组的所有企业。1表示递归获取该分组下所有企业,0表示指定分组下所有企业,默认为0

    权限说明:

    • 自建应用可调用,仅返回应用可见范围内的企业列表
    • 上下游应用可调用,返回全部的企业列表

     

    返回结果:

    {
        "errcode": 0,
        "errmsg": "ok",
        "group_corps": [
            {
                "groupid": 2,
                "corpid": "wwxxxx",
                "corp_name":"美馨粮油公司",
                "custom_id":"custom_id",
                "invite_userid":"zhangsan"
            }
        ]
    }
    

    参数说明:

    参数说明
    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,仅上下游应用调用时返回
    上一篇
    获取下级/下游企业小程序session
    下一篇
    上下游企业应用获取微信用户的external_userid