php-SDK 下载

java-SDK 下载

签名认证方式

"Authorization: wis " + AccessId + ":" + Signature
"AD-Expire: expire"
'Content-Type: application/json' 

Signature = base64(hmac-sha1(AccessKey,
        VERB + "\n” 
        + REQUESTURI+"\n"
        + EXPIRE + "\n" 
        + Content-MD5 + "\n"))

AccessKey表示签名所需的秘钥

VERB表示HTTP 请求的Method，主要有PUT，GET，POST，HEAD，DELETE等

"\n"表示换行符

REQUESTURI 请求的URI 包含请求参数

Content-MD5表示请求内容数据的MD5值，对消息内容（不包括头部）计算MD5值获得128比特位数字，对该数字进行16进制字符串编码而得到。

EXPIRE表示此次操作的有效期 服务器时间的秒数

接口地址:http://api.dms.aodianyun.com

创建白板服务

REQUESTURI "/v1/wis/auto" 
METHOD POST
CONTENT-DATA 
{
    "desc":"desc",
    "lssApp":"你的lss实例",    //可选，默认不关联
    "authKey":""    //可选，默认随机生成
}

lssApp 你的lss实例

desc 白板的描述

authKey 可选，默认随机生成

返回json

{
    "wisId":"白板id值"

}

开启关闭白板

REQUESTURI "/v1/wis/{wisId}/op" 例如"/v1/wis/ca16ca84c1889f3a0e5f31b6378fb386/op"
METHOD POST
CONTENT-DATA
{
    "state":0
}

wisId 白板服务中的白板ID

state 0 关闭，1 开启

获取白板服务信息

REQUESTURI "/v1/wis/{wisId}" 例如"/v1/wis/ca16ca84c1889f3a0e5f31b6378fb386"
METHOD GET

wisId 白板服务中的白板ID

返回json{
    "subKey"://白板使用的dms subkey

    "topic"://白板使用的dms topic

    "docId"://白板当前选择的 文档ID

    "desc"://描述

    "ts"://创建时间

    "type"://类型

    "userDoc"://是否是语音实例

    "recordId"://录制视屏的id

    "lssApp"://白板使用的app名称

    "lssStream"://白板使用的stream名称

    "userId"://用户uin号

}

获取文档列表

REQUESTURI "/v1/wis/docs?skip=0&num=10" 例如"/v1/wis/docs?skip=0&num=10&wisId="
METHOD GET

skip 跳过多少记录

num 获取多少记录

wisId 可选，代表查询和这个白板实例关联的文档列表

获取文档信息

REQUESTURI "/v1/wis/docs/{docId}" 例如"/v1/wis/docs/0935a9d7ac68a73a2a981bc3a33063ab"
METHOD GET

docId 白板服务文档列表中的文档ID

关联白版和文档

REQUESTURI "/v1/wis/{wisId}/chose" 例如"/v1/wis/ca16ca84c1889f3a0e5f31b6378fb386/chose"
METHOD POST
CONTENT-DATA
{
    "docId":""// 文档id 必选
"recordId":""// 录制id 可选
}

删除文档

REQUESTURI "/v1/wis/docs/{docId}" 例如"/v1/wis/docs/0935a9d7ac68a73a2a981bc3a33063ab"
METHOD DELETE

docId 白板服务文档列表中的文档ID

若出现

 {"code":400,"error":"当前文档正在被使用"}

调用上方关联白版和文档接口，替换当前与白板关联的文档。

绘制的历史数据

REQUESTURI "/v1/wis/{wisId}/history" 例如"/v1/wis/ca16ca84c1889f3a0e5f31b6378fb386/history"
METHOD GET

wisId 白板服务中的白板ID

页码信息

REQUESTURI "/v1/wis/docs/{docId}/pages/{page}?wisId={wisId}" 例如"/v1/wis/docs/acd6deadfbfc07a4c5add8f599b9e3cd/pages/1?wisId=94956435843a380a35df812baa2ce899
METHOD GET

docId 白板服务文档列表中的文档ID

page 页码 （从1开始)

wisId 白板实例ID

同步绘制信息

REQUESTURI "/v1/wis/{wisId}/draw" 例如"/v1/wis/ca16ca84c1889f3a0e5f31b6378fb386/draw"
METHOD POST
CONTENT-DATA {body:"draw data"}

wisId 白板服务中的白板ID

body 绘制的数据

同步翻页

REQUESTURI "/v1/wis/{wisId}/syncPage" 例如"/v1/wis/ca16ca84c1889f3a0e5f31b6378fb386/syncPage"
METHOD POST
CONTENT-DATA {page:<your page>}

wisId 白板服务中的白板ID

page 页码

clientid dms的clientid

上传文档

REQUESTURI "/v1/wis/docs/auto"
METHOD POST
CONTENT-DATA {fileName:"draw data",data:base64(<file-data>),wisId:"xxx"}

fileName 文件名称

fileData 文件内容进行base64编码之后的

wisId 白板实例Id, 可选，代表这个文档和这个白板实例关联。

返回json

{
    "docId":"文档id值",

    "processor": "async"(文档异步转化时返回字段，同步时无此字段)

}

获取白板实例列表

REQUESTURI "/v1/wis?skip=&num=&state="
METHOD GET

skip 跳过多少记录

num 查询多少条记录

state 实例状态（0:关闭，1：开启；不传值：获取所有）

返回json

[{

"id": 白板ID

"desc": 白板描述

"time": 创建时间

"docId": 当前使用的文档id

}]