dingtalk.oapi.cspace.auth.generate (获取isv钉盘授权码)

生成isv的授权码,授权码绑定了两个isv,对应的文件资源以及授权路径。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
duration Number 可选 12 授权码有效期,单位为日,为空则表示永久授权
path String 可选 / 授权访问的路径,如授权访问所有文件传"/",授权访问/doc文件夹传"/doc/",需要utf-8 urlEncode, type=add时必须传递
agent_id Number 必须 295400487 微应用的agentId
file_ids String [] 可选 12,23
  • 最大列表长度:20
  • 授权访问的文件id列表,id之间用英文逗号隔开,如"fileId1,fileId2", type=download时必须传递
    type String 必须 add 权限类型,目前支持上传和预览,上传请传add,预览请传download
    app_id Number 必须 321 被授权的应用appId

    响应参数

    名称 类型 示例值 描述
    result IsvAuthCodeResult result
    • └ isv_code
    • String
    • b370eedea7014b60bfa37e8fc043892d
    • isv访问授权码
    • └ expire_time
    • Date
    • 1570274767279
    • 授权码有效期,unix时间戳,单位ms
    success Boolean true 请求是否成功
    errcode Number 0 错误码
    errmsg String xx 错误信息

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    DingTalkClient client = new DefaultDingTalkClient("https://oapi.dingtalk.com/topapi/cspace/auth/generate");
    OapiCspaceAuthGenerateRequest req = new OapiCspaceAuthGenerateRequest();
    req.setDuration(12L);
    req.setPath("/");
    req.setAgentId(295400487L);
    req.setFileIds("12,23");
    req.setType("add");
    req.setAppId(321L);
    OapiCspaceAuthGenerateResponse rsp = client.execute(req, access_token);
    System.out.println(rsp.getBody());

    响应示例

    • JSON示例
    {
        "result":{
            "isv_code":"b370eedea7014b60bfa37e8fc043892d",
            "expire_time":"1570274767279"
        },
        "success":true,
        "errcode":0,
        "errmsg":"xx"
    }

    异常示例

    • JSON示例
    {
    	"errcode":88,
    	"errmsg":"ding talk error"
    }

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部