管理应用

优质
小牛编辑
131浏览
2023-12-01

管理应用


PDF版下载

查询应用可见范围

请求方式:POST(HTTPS)

请求地址https://qy.im.baidu.com/api/agent/getAllow?access_token=ACCESS_TOKEN

请求body

{
    "agentid": 22
}

参数说明

参数类型参数位置是否必须说明
agentidStringRequestBody应用ID,可在应用的设置页面查看

权限要求: 管理组须拥有指定应用的使用权限。

返回结果

{
    "errcode": 0,
    "errmsg": "ok",
    "userids": ["userid1"],
    "departmentids": [2],
    "tagids": [3]
}

参数说明

参数说明
errcode成功
errmsgok:成功
userids成员列表
departmentids部门列表
tagids标签列表

应用消息红点

请求方式:POST(HTTPS)

请求地址https://qy.im.baidu.com/api/appcenter/notify?access_token=ACCESS_TOKEN

请求body

{
    "touser": "UserID1|UserID2|UserID3",
    "agentid": "1"
}

参数说明

参数类型参数位置是否必须说明
access_tokenStringUrl参数调用接口凭证,参考 获取access_token
touserStringRequestBody成员列表,以竖线分隔
agentidStringRequestBody应用ID,可在应用的设置页面查看

权限要求: 管理组须拥有指定应用的使用权限,被提醒的接受者必须处于应用的可见范围内并已经关注应用。

返回结果: 如果无权限,则本次发送失败;如果收件人不存在或未关注,发送仍然执行,但返回无效的部分。

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

参数说明

参数说明
errcode成功
errmsgok:成功
invaliduser无效成员列表,以竖线分隔

批量查询用户是否关注该应用

请求方式:POST(HTTPS)

请求地址https://qy.im.baidu.com/api/agent/isFollow?access_token=ACCESS_TOKEN

请求body

{
    "agentid": 22,
    "userids": ["userId1", "userId2"]
}

参数说明

参数类型参数位置是否必须说明
access_tokenStringUrl参数调用接口凭证,参考 获取access_token
agentidIntegerRequestBody应用ID,可在应用的设置页面查看
useridsListRequestBody成员列表,最多100个

权限要求: 管理组须拥有指定应用的使用权限。

返回结果: 如果无权限,则本次发送失败;如果收件人不存在或未关注,发送仍然执行,但返回无效的部分。

{
    "errcode": 0,
    "errmsg": "ok",
    "userlist": [
        {
            "userid": "zhangsan",
            "followTime": "2016-06-27 17:33:47",
            "isFollow": true
        }
     ]
}

参数说明

参数说明
errcode成功
errmsgok:成功
userlist成员列表
userid成员UserID
followTime关注日期
isFollowtrue:已关注,false:未关注