标签推送

获取access_token

创建标签

更新标签名字

删除标签

获取标签成员

增加标签成员

删除标签成员

获取标签列表

应用端(与SID对接的应用)开发人员需实现标签推送相关接口,与SID进行节点同步。

标签推送接口调用步骤:

获取access_token—>携带access_token调用标签推送接口

获取access_token

access_token是SID后台去应用端的后台获取信息时的重要票据,由corpid和secret产生。所有接口在通信时都需要携带此信息用于验证接口的访问权限。

应用端开发人员向锐捷开发人员索要获取corpid和secret。

请求⽅式:GET(HTTPS或HTTP

请求地址:http://{server}/cgi-bin/gettoken?corpid=ID&corpsecret=SECRET

注:(1)此处标注大写的单词ID和SECRET,为需要替换的变量,根据实际获取值更新。其它接口也采用相同的标注,不再说明;

(2)https方式类似。

参数说明:

参数 是否必须 说明
corpid 应用(如SID)的唯一标识,用于接口区分不同应用
corpsecret 用于获取access_token,相当于登录密码

返回结果:

{
   "errcode":0,
   "errmsg":"",
   "access_token": "accesstoken000001",
   "expires_in": 7200
}

参数说明:

参数 说明
access_token 获取到的凭证,最长为512字节
expires_in 凭证的有效时间(秒),正常情况下为7200秒(2小时)
errcode 返回码,成功为0
errmsg 对返回码的文本描述内容

出错返回示例:

{
   "errcode":40091,
   "errmsg":"secret is invalid"
}

特别说明:

标签推送的所有接口,返回包里都有errcode、errmsg。errcode为0时代表调用成功。 而errmsg仅作参考,后续可能会有变动,因此不可作为是否调用成功的判据。 后面不再赘述。

创建标签

请求⽅式:POST(HTTPS或HTTP

请求地址:http://{server}/app/tag/create?access_token=ACCESS_TOKEN

注:https方式类似。

请求头:

header: Content-Type: application/json

请求参数:

{
    "tagname": "UI", 
    "tagid": 12
}

参数说明:

参数 是否必须 说明
access_token 调用接口凭证
tagname 标签名称,长度限制为 32 个字以内(汉字或英文字母),标签
名不可与其他标签重名
tagid 标签 id ,非负整型,指定此参数时新增的标签会生成对应的标
签 id ,不指定时则以目前最大的 id 自增

权限说明: 创建的标签属于该应用,只有该应用的secret才可以增删成员。 注意,标签总数不能超过3000个

返回结果:

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

参数说明:

参数 说明
errcode 返回码,成功为0
errmsg 对返回码的文本描述内容
tagid 标签 id

更新标签名字

请求⽅式:POST(HTTPS或HTTP

请求地址:http://{server}/app/tag/update?access_token=ACCESS_TOKEN

注:https方式类似。

请求头:

header: Content-Type: application/json

请求参数:

{
    "tagid": 12,
    "tagname": "UI design"
}

参数说明:

参数 是否必须 说明
access_token 调用接口凭证
tagid 标签 ID
tagname 标签名称,长度限制为 32 个字(汉字或英文字母),标签不可
与其他标签重名

权限说明: 调用的应用必须是指定标签的创建者。

返回结果:

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

参数说明:

参数 说明
errcode 返回码,成功为0
errmsg 对返回码的文本描述内容

删除标签

请求⽅式:GET(HTTPS或HTTP

请求地址:http://{server}/app/tag/delete?access_token=ACCESS_TOKEN&tagid=TAGID

注:https方式类似。

参数说明:

参数 是否必须 说明
access_token 调用接口凭证
tagid 标签 ID

权限说明: 调用的应用必须是指定标签的创建者。

返回结果:

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

参数说明:

参数 说明
errcode 返回码,成功为0
errmsg 对返回码的文本描述内容

获取标签成员

请求⽅式:GET(HTTPS或HTTP

请求地址:http://{server}/app/tag/get?access_token=ACCESS_TOKEN&tagid=TAGID

注:https方式类似。

参数说明:

参数 是否必须 说明
access_token 调用接口凭证
tagid 标签 ID

权限说明: 无限制,但返回列表仅包含应用可见范围的成员。

返回结果:

{
    "errcode": 0,
    "errmsg": "ok",
    "tagname": "乒乓球协会", 
    "userlist": [ 
        { 
            "userid": "zhangsan", 
            "name": "李四" 
        } 
       ], 
   "partylist": [2]
}

参数说明:

参数 说明
errcode 返回码,成功为0
errmsg 对返回码的文本描述内容
tagname 标签名
userlist 标签中包含的成员列表
userid 成员账号
name 成员名称
partylist 标签中包含的部门 id 列表

增加标签成员

请求⽅式:POST(HTTPS或HTTP

请求地址:http://{server}/app/tag/addtagusers?access_token=ACCESS_TOKEN

注:https方式类似。

请求头:

header: Content-Type: application/json

请求参数:

{
    "tagid": 12, 
    "userlist":["user1","user2"],
    "partylist": [4]
}

参数说明:

参数 是否必须 说明
access_token 调用接口凭证
tagid 标签 ID
userlist 成员 ID 列表,注意: userlist 、 partylist 不能同时为空,单
次请求个数不超过 1000
partylist 部门 ID 列表,注意: userlist 、 partylist 不能同时为空,单
次请求个数不超过 100

权限说明: 调用的应用必须是指定标签的创建者;成员属于应用的可见范围。 注意,每个标签下部门、人员总数不能超过3万个。

返回结果:

a)正确时返回

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

b)若部分userid、partylist非法,则返回

{
    "errcode": 0, 
    "errmsg": "ok",
    "invalidlist":"usr1|usr2|usr",
    "invalidparty":[2,4]
}

c)当包含userid、partylist全部非法时返回

{
    "errcode": 40070,
    "errmsg": "all list invalid"
}

参数说明:

参数 说明
errcode 返回码,成功为0
errmsg 对返回码的文本描述内容
invalidlist 非法的成员账号列表
invalidparty 非法的部门 id 列表

删除标签成员

请求⽅式:POST(HTTPS或HTTP

请求地址:http://{server}/app/tag/deltagusers?access_token=ACCESS_TOKEN

注:https方式类似。

请求头:

header: Content-Type: application/json

请求参数:

{
    "tagid": 12, 
    "userlist":[ "user1","user2"],
    "partylist": [2,4]
}

参数说明:

参数 是否必须 说明
access_token 调用接口凭证
tagid 标签 ID
userlist 成员 ID 列表,注意: userlist 、 party list 不能同时为空,单
次请求个数不超过 1000
partylist 部门 ID 列表,注意: userlist 、 partylist 不能同时为空,单
次请求个数不超过 100

权限说明: 调用的应用必须是指定标签的创建者;成员属于应用的可见范围。

返回结果:

a)正确时返回

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

b)若部分userid、partylist非法,则返回

{
    "errcode": 0, 
    "errmsg": "deleted",
    "invalidlist":"usr1|usr2|usr",
    "invalidparty":[2,4]
}

c)当包含userid、partylist全部非法时返回

{
    "errcode": 40031,
    "errmsg": "all list invalid"
}

参数说明:

参数 说明
errcode 返回码,成功为0
errmsg 对返回码的文本描述内容
invalidlist 非法的成员账号列表
invalidparty 非法的部门 id 列表

获取标签列表

请求⽅式:GET(HTTPS或HTTP

请求地址:http://{server}/app/tag/list?access_token=ACCESS_TOKEN

注:https方式类似。

参数说明:

参数 是否必须 说明
access_token 调用接口凭证

权限说明: 调用的应用必须是指定标签的创建者;成员属于应用的可见范围。

返回结果:

{
   "errcode": 0, 
   "errmsg": "ok", 
   "taglist":[
       {"tagid":1,"tagname":"a"}, 
       {"tagid":2,"tagname":"b"} 
       ]
}

参数说明:

参数 说明
errcode 返回码,成功为0
errmsg 对返回码的文本描述内容
taglist 标签列表
tagid 标签 id
tagname 标签名
©2020 锐捷网络股份有限公司 all right reserved,powered by Gitbook该文章修订时间: 2025-02-18 14:26:08

results matching ""

    No results matching ""