主页 > API > 获取文档的评论列表


获取文档的评论列表

/v1/pages/:page_id/comments
  • URL

    https://api.worktile.com/v1/pages/:page_id/comments?pid=xxx

  • HTTP请求方式

    GET

  • 支持格式

    JSON

    Header参数

    {
       "Content-Type":"application/json",
       "access_token":"xxx"
    }
    

    示例

    curl -l https://api.worktile.com/v1/pages/xxx/comments?access_token=xxx&pid=xxx
    
  • HTTP请求参数

    参数 必选 类型 说明
    page_id true string 文档id
    access_token true string OAuth授权后获得,请求时可放在header中
    pid true string 项目pid
  • 返回数据

    示例

    HTTP/1.1 200 ok

    [ { "cid":"c2c09c378403418393298db989c2a6d8", "message":"1个附件,pic5.jpg", "raw_message":"1个附件,pic5.jpg", "type":1, "format":1, "fids":[ "b1f8f794c814492bb9e7618650548df7" ], "owner":{ "uid":"679efdf3960d45a0b8679693098135ff", "name":"gongmoumou", "display_name":"龚某某", "avatar":"default_avatar.png", "desc":"", "status":3, "online":0 }, "files":[ { "fid":"b1f8f794c814492bb9e7618650548df7", "name":"llll", "desc":"", "pid":"eda54f766b7f457ea7cdb5a93c6d892e", "size":"132113", "path":"eda54f766b7f457ea7cdb5a93c6d892e/179e09f2-27d4-4393-b589-152eb79d9622.jpg", "folder_id":"f05644d702ec47dc924ae1c3976764af" } ], "created_at":"2014-11-06T08:47:48.702Z" }, { "cid":"162f611dde0d46109eaa09eba0a24943", "message":"哈哈哈哈", "raw_message":"哈哈哈哈", "type":3, "format":1, "fids":[ ], "owner":{ "uid":"679efdf3960d45a0b8679693098135ff", "name":"gongmoumou", "display_name":"龚某某", "avatar":"default_avatar.png", "desc":"", "status":3, "online":0 }, "files":[ ], "created_at":"2015-03-23T08:49:38.519Z" } ]


    返回值字段 类型 说明
    162f611dde0d46109eaa09eba0a24943 string 评论id
    message string 评论内容
    raw_message string 评论内容(markdown)
    type number 评论类型, 1:text, 2:emotion, 3:audio
    format number 评论内容的格式,1:text, 2:html
    fids array 文件fid的集合
    owner object 评论用户 详情 收起
        uid string 评论用户uid
        name string 评论用户的用户名
        display_name string 评论用户的昵称
        avatar string 评论用户的头像
        desc string 评论用户说明
        status number 评论用户的状态:1:正常,2:邀请,3:需要邮件确认
        online number 评论用户的在线状态,0:离线,1:在线,2:忙碌,3:离开
    files array 文件集合 详情 收起
        fid string 文件fid
        name string 文件名称
        desc string 文件描述
        pid string 项目pid
        size string 文件大小
        path string 文件路径
        folder_id string 文件所在的文件夹id
    created_at string 评论时间
  • 异常结果

    示例

    HTTP/1.1 404 Not Found

    { "error_code":120004, "error_message":"文档不存在", "request":"/v1/pages/xxx/comments" }


    错误码(error_code) 错误信息(error_message) http状态码(statusCode)
    100005 未授权,请授权后再操作 401
    100006 access_token不正确 400
    120004 文档不存在 404
    200008 获取评论失败 500