简要描述:

  • 接口版本:

版本号 制定人 制定日期 修订日期
1.0.0 kevin 2021-10-15

请求URL:

  • ws://xx.com

请求方式:

  • websocket

请求头:

参数名 是否必须 类型 说明

请求参数:

参数名 是否必须 类型 说明
link_type string ws
module string unionchat
device_type string 设备类型【app=APP端,pc=PC端,h5=移动端,desktop=桌面端,wx_small=微信小程序】
action string recallMsgV1
token string 登录凭证,二取一
key string 登录凭证,二取一
msg_id string 信息id

返回示例:

正确时返回:

{
  "action": "recallMsgV1",
  "status": 200,
  "msg": "撤回成功",
  "data": {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOjI0LCJpc3MiOiJodHRwczovL2tmLnVuaW9uY21zLmNuL21vZHVsZS91bmlvbmNoYXQvbG9naW4iLCJpYXQiOjE2NDk4MjkwNDYsImV4cCI6MTY1MTAzODY0NiwibmJmIjoxNjQ5ODI5MDQ2LCJqdGkiOiJIUUQ4TXkydjUwQ0tYcWNUIn0.IypiapVK-JJpSLIEA_KiXbq0yNUz4k0Pr1CAAQ8Clag",
    "link_type": "ws",
    "module": "unionchat",
    "device_type": "pc",
    "uid_key": "24_3a6cc317e49e7fa7739e1f3dc4ae59cc",
    "group_type": "one",
    "send_name": "kevin01",
    "send_uid": "24",
    "send_avatar": "https://kf.unioncms.cn/uploads/preview/avatar/2021/10/19/616e3f2da878a.jpg",
    "to_uid": "3a6cc317e49e7fa7739e1f3dc4ae59cc",
    "to_name": "131****0001-8",
    "to_avatar": "http://yht.com/uploads/user/avatar/2021-08-14/61178f7a1ac2c.png",
    "type": 0,
    "content": "",
    "msg_id": "94"
  }
}

错误时返回:

{}

返回参数说明:

参数名 类型 说明
content string 内容
created_at string 时间
msg_id string 信息id
send_avatar string 发送者头像
send_nickname string 发送者昵称
send_uid string 发送者uid
to_uid string 接收者uid
type string 类型【1=文字,2=图片,3=语音,4=视频,5=文件】
uid_key string 会话唯一key

备注:

文档更新时间: 2022-04-14 15:01   作者:admin