即时通讯订阅 - 平台接口

websocket连接，连接时可以在头中包含token或者在路径参数中包含token。token无效将无法建立websocket连接。
该连接上行数据为发送消息，下行数据为服务器分发的信息。
默认1分钟没有数据传输会关闭连接，订阅端可以每20秒发送一个空的消息，用来保持连接！！！

js代码示例

var ws = new WebSocket("ws://localhost/bvcsp/v1/ws/im",[token]);

go后台

var upgrader = websocket.Upgrader{
        Subprotocols: []string{r.Header.Get("Sec-WebSocket-Protocol")},
}

消息内容格式：
text,custom: {textMsg:"xxxx"}
file,picture,audio,video,confaudio: {fileID:"xxx",fileSize:"121212",fileName:"xxx.jpg",duration:10000}；duration表示音视频文件时长，单位毫秒
gps: 同查询GPS数据接口中gps对象{lat:31.54512,lng:117.54545,height:6521,angle:2154,speed:212,startCount:3}；单位分别为：度，度，厘米，1/1000度，米/小时，个。
system: 系统消息

{
     "operate":"操作",
     "member":{"member_type":"成员类型", "member_id":"", "member_name":"成员名称"},
     "conf":{"conf_id":"会议id"}
 }
 operate类型如下
     "add_member": 添加成员，负载member
     "del_member"：删除成员，负载member
     "start_conf"：开始会议，负载conf
     "stop_conf"：停止会议，负载conf

请求参数

Query 参数

token

string

必需

登录后token信息，如果headers中没有，这里需要有。

示例值:

xxxxxx

Header 参数

Content-Type

string

必需

示例值:

application/json

Sec-WebSocket-Protocol

string

token

必需

示例值:

string

Body 参数application/json

发通讯消息

audience

string

接收者ID

必需

audienceType

enum<string>

接收者类型

必需

枚举值:

UserPUIMGroupPUGroupUserGroup

msgType

enum<string>

消息类型

必需

枚举值:

textgpsfilepictureaudiovideoconfaudionotifycontrolcustomsystem

msgContent

string

必需

消息内容: json

示例

{
    "audience": "string",
    "audienceType": "User",
    "msgType": "text",
    "msgContent": "string"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

成员信息

number

消息ID

必需

speaker

string

发送者ID

必需

speakerType

enum<string>

发送者类型

必需

枚举值:

UserPU

speakerName

string

发送者名称

可选

audience

string

接收者ID

必需

audienceType

enum<string>

接收者类型

必需

枚举值:

UserPUIMGroupPUGroupUserGroup

time

number

发送时间

必需

msgType

enum<string>

消息类型

必需

枚举值:

textgpsfilepictureaudiovideoconfaudionotifycontrolcustomsystem

msgContent

string

必需

消息内容: json

示例

{
    "id": 0,
    "speaker": "string",
    "speakerType": "User",
    "speakerName": "string",
    "audience": "string",
    "audienceType": "User",
    "time": 0,
    "msgType": "text",
    "msgContent": "string"
}