API文档

# 客户信息

# 客户信息

# 请求方式

项 值
URI /v1/wework/contact/contactInfo.json
描述 获取客户信息
请求方式 POST
注意事项 无
其他 无

# 请求参数

属性名 类型 备注 是否必须
contactId String 客户id 是

# 请求示例

{
    "contactId": "abc"
}

# 响应结果

{
    "code": 0,
    "msg": null,
    "data": {
        "contactId": "abc",       // 客户ID
        "name": "胡歌",            // 名字
        "avatar": "",             // 头像
        "gender":1,               // 性别   0-未定义，1-男性，2-女性
        "type": 1,                // 外部联系人的类型，1表示该外部联系人是微信用户，2表示该外部联系人是企业微信用户'
        "corpName": "027",        // 企业名 (仅当客户是企业微信用户时有值)
        "position": "研发"         // 职位信息 (仅当客户是企业微信用户时有值)
    }
}

# 获取客户所属成员和所在的群信息

# 请求方式

项 值
URI /v1/wework/contact/getWeworkUserAndChatRoom.json
描述 获取客户所属成员和所在的群信息
请求方式 POST
注意事项 无
其他 无

# 请求参数

属性名 类型 备注 是否必须
contactId String 客户id 是

# 请求示例

{
    "contactId": ""
}

# 响应结果

{
    "code": 0,
    "msg": null,
    "data": {
        "weworkRooms": [
            {
                "weworkRoomId": "",           //群id
                "name": ""                    //客户群名
            }
        ],
        "weworkUsers": [
            {
                "weworkUserId": "",           //成员id
                "nickname": "",               //昵称
                "avatar": "",                 //头像
                "addWayDesc": "",             //添加方式描述
                "addTime": 12137819738        //添加时间
            }
        ]
    }
}

# 获取客户所属成员和所在的群信息通过手机号

# 请求方式

项 值
URI /v1/wework/contact/getWeworkUserAndChatRoomByMobiles.json
描述 获取客户所属成员和所在的群信息
请求方式 POST
注意事项 无
其他 无

# 请求参数

属性名 类型 备注 是否必须
mobiles list 手机号列表 是

# 请求示例

{
    "mobiles": [       //限制了数组最长不超过100
       "", ""
    ]
}

# 响应结果

{
    "code": 0,
    "msg": null,
    "data": [
      {
          "contactId": "",                   //企微客户id
          "mobile": "",
          "weworkRooms": [
              {
                  "weworkRoomId": "",           //群id
                  "name": ""                    //客户群名
              }
          ],
          "weworkUsers": [
              {
                  "weworkUserId": "",           //成员id
                  "nickname": "",               //昵称
                  "avatar": "",                 //头像
                  "addWayDesc": "",             //添加方式描述
                  "addTime": 12137819738        //添加时间
              }
          ]
      }
    ]
}

# 获取unionid客户列表

# 请求方式

项 值
URI /v1/wework/contact/unionidList.json
描述 获取unionid客户列表
请求方式 POST
注意事项 无
其他 无

# 请求参数

属性名 类型 备注 是否必须
pageDto object 分页参数 否

# 请求示例

{
    "pageDto": {
        "pageNum": 1,
        "pageSize": 20
    }
}

# 响应结果

{
    "code": 0,
    "msg": null,
    "data": [{
        "unionid": "abc",         // unionid
        "contactId": "",          //企微客户id
        "name": "胡歌",            // 名字
        "avatar": "",             // 头像
        "gender":1,               // 性别   0-未定义，1-男性，2-女性
        "type": 1,                // 外部联系人的类型，1表示该外部联系人是微信用户，2表示该外部联系人是企业微信用户'
        "corpName": "027",        // 企业名 (仅当客户是企业微信用户时有值)
        "position": "研发"         // 职位信息 (仅当客户是企业微信用户时有值)
    }],
    "pageDto": {
        "pageNum": 1,
        "pageSize": 20
    }
}

# 获取客户信息根据unionid

# 请求方式

项 值
URI /v1/wework/contact/getByUnionid.json
描述 获取客户信息根据unionid
请求方式 POST
注意事项 无
其他 无

# 请求参数

属性名 类型 备注 是否必须
unionid String unionid 是

# 请求示例

{
    "unionid": "abc"
}

# 响应结果

{
    "code": 0,
    "msg": null,
    "data": {
        "unionid": "abc",         // unionid
        "contactId": "",          //企微客户id
        "name": "胡歌",            // 名字
        "avatar": "",             // 头像
        "gender":1,               // 性别   0-未定义，1-男性，2-女性
        "type": 1,                // 外部联系人的类型，1表示该外部联系人是微信用户，2表示该外部联系人是企业微信用户'
        "corpName": "027",        // 企业名 (仅当客户是企业微信用户时有值)
        "position": "研发"         // 职位信息 (仅当客户是企业微信用户时有值)
    }
}

← 上下游 →