擷取accessToken接口
- 請求位址:https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=ID&corpsecret=SECRET
- 請求方法:GET
-
請求參數解釋
- corpid:企業ID
- corpsecret:應用的憑證密鑰
- 響應資料
{
"errcode":0,
"errmsg":"",
"access_token": "accesstoken000001",
"expires_in": 7200 //accessToken過期時間
}
- 說明:本接口有調用限制,accessToken有過期時間,是以最好把accessToken緩存起來
擷取配置了客戶聯系功能的成員清單接口
- 請求位址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_follow_user_list?access_token=ACCESS_TOKEN
- 請求方法:GET
-
請求參數解釋
- access_token:access_token
- 響應資料
{
"errcode": 0,
"errmsg": "ok",
"follow_user":[ // 成員ID清單
"zhangsan",
"lissi"
]
}
擷取客戶清單
- 請求位址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list?access_token=ACCESS_TOKEN&userid=USERID
- 請求方法:GET
-
請求參數解釋
- userid:成員ID
- access_token:access_token
- 響應資料
{
"errcode": 0,
"errmsg": "ok",
"external_userid": // 客戶ID清單
[
"woAJ2GCAAAXtWyujaWJHDDGi0mACAAA",
"wmqfasd1e1927831291723123109rAAA"
]
}
擷取客戶詳情
- 請求位址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid=EXTERNAL_USERID&cursor=CURSOR
- 請求方法:GET
-
請求參數解釋
- external_userid:客戶ID
- access_token:access_token
- cursor:分頁辨別,不是必須的
- 響應資料
{
"errcode": 0,
"errmsg": "ok",
"external_contact":
{
"external_userid":"woAJ2GCAAAXtWyujaWJHDDGi0mACHAAA", // 客戶ID
"name":"李四",
"position":"Manager", // 外部聯系人的職位
"avatar":"http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
"corp_name":"騰訊",
"corp_full_name":"騰訊科技有限公司",
"type":2, // 外部聯系人的類型,1表示該外部聯系人是微信使用者,2表示該外部聯系人是企業微信使用者
"gender":1, // 外部聯系人性别 0-未知 1-男性 2-女性
"unionid":"ozynqsulJFCZ2z1aYeS8h-nuasdAAA", // unionid
"external_profile":
{
"external_attr":
[
{
"type":0,
"name":"文本名稱",
"text":
{
"value":"文本"
}
},
{
"type":1,
"name":"網頁名稱",
"web":
{
"url":"http://www.test.com",
"title":"标題"
}
},
{
"type":2,
"name":"測試app",
"miniprogram":
{
"appid": "wx8bd80126147df384",
"pagepath": "/index",
"title": "my miniprogram"
}
}
]
}
},
"follow_user":
[
{
"userid":"rocky",
"remark":"李部長",
"description":"對接采購事務",
"createtime":1525779812,
"tags":
[
{
"group_name":"标簽分組名稱",
"tag_name":"标簽名稱",
"tag_id":"etAJ2GCAAAXtWyujaWJHDDGi0mACHAAA",
"type":1
}
],
"remark_corp_name":"騰訊科技",
"remark_mobiles":
[
"13800000001",
"13000000002"
],
"oper_userid":"rocky",
"add_way":1
},
{
"userid":"tommy",
"remark":"李總",
"description":"采購問題咨詢",
"createtime":1525881637,
"state":"外聯二維碼1",
"oper_userid":"woAJ2GCAAAXtWyujaWJHDDGi0mACHAAA",
"add_way":3
}
],
"next_cursor":"NEXT_CUROSR"
}
批量擷取客戶詳情
- 請求位址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/batch/get_by_user?access_token=ACCESS_TOKEN
- 請求方法:POST
-
URL參數解釋
- access_token:access_token
-
Body請求參數解釋
- userid:成員ID
- cursor:分頁辨別,傳回為空說明已經沒有資料
- limit:傳回的數量
- 響應資料
{
"errcode": 0,
"errmsg": "ok",
"external_contact_list":
[
{
"external_contact":
{
"external_userid":"woAJ2GCAAAXtWyujaWJHDDGi0mACHAAA",
"name":"李四",
"position":"Manager",
"avatar":"http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
"corp_name":"騰訊",
"corp_full_name":"騰訊科技有限公司",
"type":2,
"gender":1,
"unionid":"ozynqsulJFCZ2z1aYeS8h-nuasdAAA",
"external_profile":
{
"external_attr":
[
{
"type":0,
"name":"文本名稱",
"text":
{
"value":"文本"
}
},
{
"type":1,
"name":"網頁名稱",
"web":
{
"url":"http://www.test.com",
"title":"标題"
}
},
{
"type":2,
"name":"測試app",
"miniprogram":
{
"appid": "wx8bd80126147df384",
"pagepath": "/index",
"title": "my miniprogram"
}
}
]
}
},
"follow_info":
{
"remark":"李部長",
"description":"對接采購事務",
"createtime":1525779812,
"tag_id":["etAJ2GCAAAXtWyujaWJHDDGi0mACHAAA"],
"remark_corp_name":"騰訊科技",
"remark_mobiles":
[
"13800000001",
"13000000002"
],
"oper_userid":"rocky",
"add_way":1
}
},
{
"external_contact":
{
"external_userid":"woAJ2GCAAAXtWyujaWJHDDGi0mACHBBB",
"name":"王五",
"position":"Engineer",
"avatar":"http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
"corp_name":"騰訊",
"corp_full_name":"騰訊科技有限公司",
"type":2,
"gender":1,
"unionid":"ozynqsulJFCZ2asdaf8h-nuasdAAA"
},
"follow_info":
{
"remark":"王助理",
"description":"采購問題咨詢",
"createtime":1525881637,
"tag_id":["etAJ2GCAAAXtWyujaWJHDDGi0mACHAAA"],
"state":"外聯二維碼1",
"oper_userid":"woAJ2GCAAAd1asdasdjO4wKmE8AabjBBB",
"add_way":3
}
}
],
"next_cursor":"r9FqSqsI8fgNbHLHE5QoCP50UIg2cFQbfma3l2QsmwI"
}
修改客戶備注資訊
- 請求位址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/remark?access_token=ACCESS_TOKEN
- 請求方法:GET
-
URL請求參數解釋
- access_token:access_token
-
Body請求參數解釋
- userid:成員ID
- external_userid:使用者ID
- remark:備注,最多20個字元
- description:職位描述,最多150個字元
- remark_company:所屬公司名稱,最多20個字元
- remark_mobiles:手機号
- remark_pic_mediaid:備注圖檔
- 響應資料
{
"errcode": 0,
"errmsg": "ok"
}