管理通讯录

PDF版下载

管理成员

创建成员

请求方式：POST（HTTPS）

请求地址：https://api.im.baidu.com/api/user/create?access_token=ACCESS_TOKEN

请求body参数：

{
    "userid": "lili",
    "name": "丽丽",
    "department": [100],
    "mobile": "15913215421",
    "email": "lili4@baidu.com",
    "extattr": {
        "attrs": [
            {
                "name": "工位",
                "value": "工位"
            },
            {
                "name": "座机",
                "values": ["主机号", "分机号"]
            }
        ]
    }
}

参数说明：

权限要求： 应用需获得企业的通讯录读写授权，且指定部门在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "created"
}

参数说明：

更新成员

请求方式：POST（HTTPS）

请求地址：https://api.im.baidu.com/api/user/update?access_token=ACCESS_TOKEN

请求body：（如果非必须的字段未指定，则不更新该字段之前的设置值）

{
    "userid": "lili",
    "name": "丽丽",
    "department": [100],
    "mobile": "15913215421",
    "email": "lili4@baidu.com",
    "extattr": {
        "attrs": [
            {
                "name": "工位",
                "value": "工位"
            },
            {
                "name": "座机",
                "values": ["主机号","分机号"]
            }
        ]
    }
}

参数说明：

权限要求： 应用需获得企业的通讯录读写授权，且指定部门、成员在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "updated"
}

参数说明：

删除成员

请求方式：GET（HTTPS）

请求地址：https://api.im.baidu.com/api/user/delete?access_token=ACCESS_TOKEN&userid=lisi

参数说明：

权限要求： 应用需获得企业的通讯录读写授权，且指定成员在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "deleted"
}

参数说明：

批量删除成员

请求方式：POST（HTTPS）

请求地址：https://api.im.baidu.com/api/user/batchdelete?access_token=ACCESS_TOKEN

请求body：

{
    "useridlist": ["lili", "lucy"]
}

参数说明：

权限要求： 应用需获得企业的通讯录读写授权，且指定成员在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "deleted"
}

参数说明：

获取成员

请求方式：GET（HTTPS）

请求地址：https://api.im.baidu.com/api/user/get?access_token=ACCESS_TOKEN&userid=lisi

参数说明：

权限要求： 应用需获得企业的通讯录只读或读写授权，且指定成员在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "ok",
    "userid": "lili",
    "name": "丽丽",
    "department": [1],
    "mobile": "13500088888",
    "email": "lili4@gzdev.com",
    "imid": 40000318,
    "hiuname": "lili4",
    "status": 1,
    "extattr": {
        "attrs": [
            {
                "name": "爱好",
                "value": "旅游"
            },
            {
                "name": "卡号",
                "value": "1234567234"
            }
        ]
    },
    "lm" : 14236463257
}

参数说明：

上次获取后无更新：

{
    "errcode": 0,
    "errmsg": "ok"
}

获取部门成员

请求方式：GET（HTTPS）

请求地址：https://api.im.baidu.com/api/user/simplelist?access_token=ACCESS_TOKEN&department_id=1&fetch_child=0

参数说明：

权限要求： 应用需获得企业的通讯录只读或读写授权，且指定部门在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "ok",
    "userlist": [
        {
            "userid": "lili",
            "name": "丽丽"
        }
    ]
}

参数说明：

获取部门成员（详情）

请求方式：GET（HTTPS）

请求地址：https://api.im.baidu.com/api/user/list?access_token=ACCESS_TOKEN&department_id=1&fetch_child=0

参数说明：

权限要求： 应用需获得企业的通讯录只读或读写授权，且指定部门在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "ok",
    "userlist": [
        {
            "userid": "lili",
            "name": "丽丽",
            "department": [100],
            "mobile": "13508975421",
            "email": "lili4@baidu.com",
            "imid": "lili",
            "hiuname": "lilifordev",
            "status": 1,
            "extattr": {
                "attrs": [
                    {
                        "name": "爱好",
                        "value": "旅游"
                    },
                    {
                        "name": "卡号",
                        "value": "1234567234"
                    }
                ]
            }
        }
    ]
}

参数说明：

获取成员如流头像

请求方式：GET（HTTPS）

请求地址：https://api.im.baidu.com/api/user/headimage?access_token=ACCESS_TOKEN&imid=IMID&userid=lisi

参数说明：

权限要求： 应用需获得企业的通讯录只读或读写授权，且指定成员在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "ok",
    "headImage": base64(bytes)
    "lm": 5
}

参数说明：

获取成员所属标签

请求方式：GET（HTTPS）

请求地址：https://api.im.baidu.com/api/user/gettags?access_token=ACCESS_TOKEN&userid=11

参数说明：

权限要求： 应用需获得企业的通讯录只读或读写授权，且指定成员在应用被授权的可见范围内。

返回结果：

{
    "errcode"：0,
    "errmsg"："ok",
    "taglist"：[
        {
            "tagid"：1,
            "tagname"："标签1"
        },
        {
            "tagid"：2,
            "tagname"："标签2"
        }
    ]
}

参数说明：

管理部门

创建部门

请求方式：POST（HTTPS）

请求地址：https://api.im.baidu.com/api/department/create?access_token=ACCESS_TOKEN

请求body：

{
    "name": "人力资源部",
    "parentid": 4,
    "order": 1,
    "id": "100"
}

参数说明：

权限要求： 应用需获得企业的通讯录读写授权，且指定父部门在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "created",
    "id": 100
}

参数说明：

更新部门

请求方式：POST（HTTPS）

请求地址：https://api.im.baidu.com/api/department/update?access_token=ACCESS_TOKEN

请求body：（如果非必须的字段未指定，则不更新该字段之前的设置值）

{
    "id": 100,
    "name": "人力资源部",
    "parentid": 4,
    "order": "1"
}

参数说明：

权限要求： 应用需获得企业的通讯录读写授权，且指定部门在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "updated"
}

参数说明：

删除部门

请求方式：GET（HTTPS）

请求地址：https://api.im.baidu.com/api/department/delete?access_token=ACCESS_TOKEN&id=ID

参数说明：

权限要求： 应用需获得企业的通讯录读写授权，且指定部门在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "deleted"
}

参数说明：

获取部门列表

请求方式：GET（HTTPS）

请求地址：https://api.im.baidu.com/api/department/list?access_token=ACCESS_TOKEN&id=ID

参数说明：

权限要求： 应用需获得企业的通讯录只读或读写授权，且指定部门在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "ok",
    "department": [
        {
            "id": 2,
            "name": "人力资源部",
            "pid": 1
        },
        {
            "id": 3
            "name": "邮箱产品部",
            "pid": 2
        }
    ]
}

参数说明：

管理标签

创建标签

请求方式：POST（HTTPS）

请求地址：https://api.im.baidu.com/api/tag/create?access_token=ACCESS_TOKEN

请求body：

{
    "tagname": "设计"
}

参数说明：

权限要求： 创建的标签将属于应用，但企业在管理后台不可见。

返回结果：

{
    "errcode": 0,
    "errmsg": "created",
    "tagid": "1"
}

参数说明：

更新标签名字

请求方式：POST（HTTPS）

请求地址：https://api.im.baidu.com/api/tag/update?access_token=ACCESS_TOKEN

请求body：

{
    "tagid": "1",
    "tagname": "设计小组"
}

参数说明：

权限要求： 应用需获得企业的通讯录读写授权，且指定标签在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "updated"
}

参数说明：

删除标签

请求方式：GET（HTTPS）

请求地址：https://api.im.baidu.com/api/tag/delete?access_token=ACCESS_TOKEN&tagid=1

参数说明：

权限要求： 应用需获得企业的通讯录读写授权，且指定标签在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "deleted"
}

参数说明：

获取标签成员

请求方式：GET（HTTPS）

请求地址：https://api.im.baidu.com/api/tag/get?access_token=ACCESS_TOKEN&tagid=1

参数说明：

权限要求： 应用需获得企业的通讯录只读或读写授权，且指定标签在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "ok",
    "userlist": [
        {
            "userid": "lili",
            "name": "丽丽"
        }
    ],
    "partylist": [2]
}

参数说明：

增加标签成员

请求方式：POST（HTTPS）

请求地址：https://api.im.baidu.com/api/tag/addtagmember?access_token=ACCESS_TOKEN

请求body：

{
   "tagid": "1",
   "userlist": ["user1", "user2"],
   "partylist": [100]
}

参数说明：

权限要求： 应用需获得企业的通讯录读写授权，且指定标签在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "invalid userlist and partylist faild",
    "invalidlist"："usr1|usr2|usr",
    "invalidparty"：[2,4]
}

参数说明：

删除标签成员

请求方式：POST（HTTPS）

请求地址：https://api.im.baidu.com/api/tag/deltagmember?access_token=ACCESS_TOKEN

请求body：

{
    "tagid": "1",
    "userlist": ["user1", "user2"],
    "partylist": [100]
}

参数说明：

权限要求： 应用需获得企业的通讯录读写授权，且指定标签在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "invalid userlist and partylist faild",
    "invalidlist": "usr1|usr2|usr",
    "invalidparty": [2,4]
}

参数说明：

获取标签列表

请求方式：GET（HTTPS）

请求地址：https://api.im.baidu.com/api/tag/list?access_token=ACCESS_TOKEN

参数说明：

权限要求： 应用需获得企业的通讯录只读或读写授权，且指定标签在应用被授权的可见范围内。

返回结果：

{
    "errcode": 0,
    "errmsg": "ok",
    "taglist": [
        {
            "tagid": 2,
            "tagname": "k"
        },
        {
            "tagid": 3,
            "tagname": "h"
        }
    ]
}

参数说明：