# 获取网页协同连接信息（V1.0.0）（getConnectionInfo）
#### 场景描述
获取网页协同连接信息。
#### 接口方法
POST
#### 接口URI
https://域名/apiaccess/api/cobrowse/getConnectionInfo，例如域名是service.besclouds.com
#### 请求说明
表1请求头参数 
| 序号 | 名称              | 参数类型   | 是否必选 | 说明                                                            |
|:---|:---|:---|:---|:---|
| 1  | x-app-key       | string | True | appKey字段，用户标识，在ApiFabric工具上配置                                 |
| 2  | Authorization   | string | True | 鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格） |
| 3  | X-TenantSpaceID | string | True | 租间ID                                                          |
   
表2请求体参数 
| 序号 | 名称       | 参数类型   | 是否必选  | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|:---|:---|
| 1  | roomId   | string | False | 网页协同房间号 （通常是会话ID，不传默认生成UUID，请确保两端的房间号一致）                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| 2  | userId   | string | False | 用户ID                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| 3  | userName | string | False | 用户名称                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| 4  | workNo   | string | False | 座席工号                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| 5  | role     | string | True  | 网页协同角色 - replayer：座席  - recorder：用户   |
   
#### 响应说明
- **响应状态码: 200**
  表3响应体参数 
  | 序号  | 名称           | 参数类型    | 是否必选  | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
  |:---|:---|:---|:---|:---|
  | 1   | success      | boolean | True  | 操作结果 - true：成功  - false：失败   |
  | 2   | data         | object  | False | 返回数据                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
  | 2.1 | roomId       | string  | False | 网页协同房间号 （通常是会话ID，不传默认生成UUID，请确保两端的房间号一致）                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
  | 2.2 | wssUrl       | string  | False | 内部访问地址                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
  | 2.3 | wssUrlOut    | string  | False | 外部访问地址（公网可访问）                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
  | 2.4 | connectParam | string  | False | 签名                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
  | 3   | errorCode    | number  | True  | 错误码                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
  | 4   | errorReason  | string  | True  | 错误原因                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
     
  
- **响应状态码: 401**
  鉴权失败时HTTP的响应码
  
- **响应状态码: 404**
  请求资源不存在时HTTP的响应码
  
- **响应状态码: 500**
  服务器内部异常时HTTP的响应码
  
 
#### 错误码
无。
#### 报文样例
请求头:
```
{
    "x-app-key": "****",
    "Authorization": "Bearer xxxx",
    "X-TenantSpaceID": "****"
}
```
请求参数:
```
{
    "roomId": "10***04",
    "workNo": "667",
    "role": "replayer"
}
```
响应参数:
```
{
    "success": true,
    "data": {
        "roomId": "10***04",
        "wssUrl": "wss://IP:PORT/ws/cobrowse/1",
        "wssUrlOut": "wss://IP:PORT/ws/cobrowse/1",
        "connectParam": "****"
    },
    "errorCode": null,
    "errorReason": null
}
```