第三方应用开发 服务端API 自建应用代开发 ID转换接口
ID转换接口

目录

  • corpid的转换
  • userid的转换
  • external_userid的转换
  •       转换客户external_userid
  •       转换客户群成员external_userid
  • 代开发应用或第三方应用可以调用以下接口,将企业主体下的corpid、userid和external_userid,转换为第三方服务商主体下的corpid、userid和external_userid。

    若服务商已有系统与企业微信代开发或第三方应用对接,可使用以下接口建立帐号的匹配:

    1. 通过手机号获取第三方服务商主体下的userid
    2. 通过邮箱获取第三方服务商主体下的userid

     

    corpid的转换

    用于将企业主体的明文corpid转换为服务商主体的密文corpid。

    请求方式:POST(HTTPS
    请求地址:https://qyapi.weixin.qq.com/cgi-bin/service/corpid_to_opencorpid?provider_access_token=ACCESS_TOKEN

    请求参数:

    {
      "corpid":"xxxxx"
    }

    参数说明:

    参数必须说明
    provider_access_token应用服务商的provider_access_token,获取方法参见服务商的凭证
    corpid待获取的企业ID

     

    权限说明:

    仅限第三方服务商,转换已授权企业的corpid

    返回结果:

    
     "errcode":0,
     "errmsg":"ok",
     "open_corpid":"AAAAAA"
    

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    open_corpid该服务商第主体下的密文corpid

     

    userid的转换

    将企业主体下的明文userid转换为服务商主体下的密文userid。

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

    请求参数:

    {
      "userid_list":["aaa", "bbb"]
    }

    参数说明:

    参数必须说明
    access_token代开发自建应用或第三方应用的接口凭证,服务商可通过“获取企业access_token”获得此调用凭证
    userid_list获取到的成员ID列表,最多不超过1000个

     

    权限说明:

    仅代开发应用或第三方应用可调用
    成员需要在应用的可见范围内
    请确保传入userid的正确性,若出错的次数较多,会导致1天不可调用,(具体限制阈值由授权企业的员工规模决定)。

    返回结果:

    {
        "errcode": 0,
        "errmsg": "",
        "open_userid_list": [
            {
                "userid": "aaa",
                "open_userid": "xxxxx",
            }
        ],
        "invalid_userid_list":["bbb"]
    }

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    open_userid_list该服务商主体下的密文userid
    open_userid_list.userid转换成功的userid
    open_userid_list.open_userid转换成功的userid对应的服务商主体下的密文userid

    external_userid的转换

    将企业主体下的external_userid转换为服务商主体下的external_userid。

    转换客户external_userid

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

    请求参数:

    {
      "external_userid_list":["xxxxx","yyyyyy"]
    }

    参数说明:

    参数必须说明
    access_token代开发自建应用或第三方应用的接口凭证,服务商可通过“获取企业access_token”获得此调用凭证
    external_userid_list企业主体下的external_userid列表,建议200个,最多不超过1000个

    权限说明:

    仅代开发自建应用或第三方应用可调用
    客户联系和家校场景中,external_userid对应的跟进人需要在应用可见范围内
    微信客服场景中,仅支持48小时内客服会话的external_userid

    返回结果:

    
     "errcode":0,
     "errmsg":"ok",
     "items":[
     	{
     		"external_userid":"xxxxx",
     		"new_external_userid":"AAAA"
     	},
     	{
     		"external_userid":"yyyyy",
     		"new_external_userid":"BBBB"
     	}
     ]
    
    如果传入了服务商主体下的external_userid,则原样返回。

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    new_external_userid服务商主体下的external_userid

    转换客户群成员external_userid

    转换客户external_userid接口不支持客户群的场景,如果需要转换客户群中无好友关系的群成员external_userid,需要调用本接口,调用时需要传入客户群的chat_id。

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

    请求参数:

    {
      "chat_id":"wrOgQhDgAAMYQiS5ol9G7gK9JVAAAA",
      "external_userid_list":["xxxxx","yyyyyy"]
    }

    参数说明:

    参数必须说明
    access_token代开发自建应用或第三方应用的接口凭证,服务商可通过“获取企业access_token”获得此调用凭证
    chat_id客户群ID
    external_userid_list企业主体下的external_userid列表,建议200个,最多不超过1000个

    权限说明:

    仅代开发自建应用或第三方应用可调用
    客户群的群主需要在应用可见范围内

    返回结果:

    
     "errcode":0,
     "errmsg":"ok",
     "items":[
     	{
     		"external_userid":"xxxxx",
     		"new_external_userid":"AAAA"
     	},
     	{
     		"external_userid":"yyyyy",
     		"new_external_userid":"BBBB"
     	}
     ]
    
    如果传入了新的external_userid,则原样返回。

    参数说明:

    参数说明
    errcode返回码
    errmsg对返回码的文本描述内容
    new_external_userid服务商主体下的external_userid
    上一篇
    与自建应用接口的差异
    下一篇
    获取带参授权链接