获取网页协同地址
接口功能
获取网页协同地址。
接口原型
|
请求方法 |
POST |
|
|---|---|---|
|
请求URL |
https://ip:port/service-cloud/rest/webadapter/v1/cobrowseSiteInfo/getCobrowseSiteById |
其中，ip:port为对外暴露的nslb的ip和port |
|
参数名称 |
选取原则 |
参数类型 |
默认值 |
说明 |
|---|---|---|---|---|
|
Content-Type |
必选 |
String |
无 |
固定填 application/json; charset=UTF-8。 |
|
Cookie |
必选 |
String |
无 |
集成页面的时候，ccmessaging通过请求响应，将ccmessaging-token写到集成页面浏览器的Cookie中。单独调用时需确保请求头的Cookie中含有ccmessaging-token=xxx，xxx为ccmessaging-token值。 |
请求参数
|
参数名称 |
选取原则 |
参数类型 |
说明 |
|---|---|---|---|
|
siteId |
必选 |
String |
网页协同ID。 |
响应参数
|
参数名称 |
选取原则 |
参数类型 |
说明 |
|---|---|---|---|
|
returnCode |
必选 |
String |
接口响应码，0:成功 |
|
description |
必选 |
String |
接口描述 |
|
data |
可选 |
Object |
网页协同的连接信息 |
|
参数名称 |
选取原则 |
参数类型 |
说明 |
|---|---|---|---|
|
id |
可选 |
String |
多媒体数据Id（长度：64字节） |
|
parentTypeId |
可选 |
String |
多媒体库类别id（长度：64字节） |
|
mediaUrl |
可选 |
String |
多媒体url（长度：1024字节） |
|
mediaType |
可选 |
String |
多媒体数据类型（固定值：COBROWSESITE） |
|
duration |
可选 |
String |
音视频文件的时长（长度：20字节） |
|
name |
可选 |
String |
多媒体数据名称（长度：200字节） |
|
description |
可选 |
String |
多媒体数据描述（长度：1000字节） |
|
latitude |
可选 |
String |
地址数据的纬度（长度：20字节） |
|
longitude |
可选 |
String |
地址数据的经度（长度：20字节） |
|
fileName |
可选 |
String |
文件名称（长度：100字节） |
|
fileSize |
可选 |
String |
文件大小（长度：4字节） |
|
sizeUnit |
可选 |
String |
文件大小单位，KB或MB |
|
mediaFileType |
可选 |
String |
媒体文件类型（本接口返回固定值NULL） |
接口示例
- 请求示例
POST /service-cloud/rest/webadapter/v1/cobrowseSiteInfo/getCobrowseSiteById host: 10.10.10.2:18446 connection: Keep-Alive x-forwarded-for: 10.10.10.3, 10.10.10.4 x-real-ip: 10.10.10.5 content-length: 401 remote-host: 10.10.10.6 user-agent: java/socket content-type: application/json; charset=utf-8 cookie: JSESSION*****#*#*****3 ccmessaging-token：******** accept: */* { "siteId":"xx" } - 响应示例
{ "returnCode": "0", "data": { "fileName": null, "parentTypeId": "1613009459437342721", "mediaUrl": "https://***", "latitude": null, "description": "", "mediaType": "COBROWSESITE", "duration": null, "fileSize": null, "name": "网页协同地址", "sizeUnit": null, "id": "1699621860646301698", "mediaFileType": null, "longitude": null }, "description": "success" }
