[关闭]
@myyzs 2018-04-26T08:27:28.000000Z 字数 2476 阅读 43

同步IM历史消息接口

IM历史消息

说明

  1. 测试域名地址:http://qy-ci.fdccloud.com
  2. 线上地址: http://fdccloud.com

1.获取access_token

根据corpid和corpsecret获取获取access_token

接口地址:

HOST/api/tenant-open/get-access-token

传参方式 :

POST

参数:

{
    "corpid":"corpid,租户的唯一标识",
    "corpsecret":"租户的secret" 
}

返回结果:

成功返回

{
    "errcode": 0,
    "errmsg": "ok",
    "data": "RVlaUnlHcHIyU0ZPTVozTUpQMlhRNkhkSnE"
}

失败返回

{"errcode":"错误code","errmsg":"错误信息","data":""}

2.获取一个小时内的历史消息

/api/tenant-open/get-im-message?access_token=ACCESS_TOKEN&time=2018042317&page=1

传参方式

GET

说明

  1. time 为年月日时的数字组成(YYmmddHH)
  2. 历史消息不是实时的,最好过一个小时来同步,列如要同步2018-04-23 09:00-10:00的消息 要在 2018-04-23 11:00之后来请求

返回结果

成功

{
  "errcode": 0,
  "data":{ 
        list:[
        //文本消息
            {
              "chat_type": "groupchat",
              "bodies": [
                  {
                    "msg": "消息标题",
                    "type": "txt",
                  }
                ]
              "from": "用户code",
              "to": "群id",
              "msg_id": "459147831010134080", //消息ID
              "send_time": 1524468485031,  //发送时间(毫秒)
            },
          // 图文消息
           {
              "chat_type": "groupchat",
              "bodies": [
                  {
                    "msg": "消息标题",
                    "type": "news",
                    "msg_url":"链接地址",
                    "msg_description":"消息描述",
                    "img":"img url"
                  }
                ]
              "from": "发送者名称",
              "to": "群名称",
              "msg_id": "459147831010134080", //消息ID
              "send_time": 1524468485031  //发送时间(毫秒)
            },
            //图片消息
            {
              "chat_type": "groupchat",
              "bodies": [
                  {
                    "filename": "image1810862248.jpg",
                    "size": {
                      "width": 540,
                      "height": 960
                    },
                    "file_length": 659997,
                    "secret": "ua3_GkbQEein-2tQdI6CGMyAyDQWeam5BdOR1zBkkhGNYXVf",
                    "thumbFilename": "Screenshot_20171013-112346.png",
                    "type": "img",
                    "url":"https:\/\/a1.easemob.com\/1145161101115662\/yunzhushoutest\/chatfiles\                             /b9adff10-46d0-11e8-9472-a3b3c781e2f5"
                  }
                ]
              "from": "发送者名称",
              "to": "群名称",
              "msg_id": "459147831010134080", //消息ID
               "send_time": 1524468485031  //发送时间(毫秒)
            },
            //语音消息
            {
              "chat_type": "groupchat",
              "bodies": [
                  {
                       "file_length":6630,//语音附件大小(单位:字节)
                       "filename":"test1.amr",//语音名称
                       "length":10, //语音时间(单位:秒)
                       "secret":"DRGM8OZrEeO1vafuJSo2IjHBeKlIhDp0GCnFu54xOF3M6KLr",//secret在上传文件后会返回  
                       "type":"audio",//语音消息类型
                       "url":"https://a1.easemob.com/easemob-demo/chatdemoui/chatfiles/0637e55a-f606-11e3-ba23-51f25fd1215b"
                  }
                ]
              "from": "发送者名称",
              "to": "群名称",
              "msg_id": "459147831010134080", //消息ID
              "send_time": 1524468485031  //发送时间(毫秒)
            }
        ]
    },
    "total_num": "2", //总数量
    "page_index": "1", //当前分页数
    "page_size": 100   //分页数量
  }

失败返回

{"errcode":"错误code","errmsg":"错误信息","data":""}

说明

3.获取群信息

/api/tenant-open/get-im-group-info?access_token=ACCESS_TOKEN&group_id=xxxx

传参方式

GET

说明

group_id: 群的消息id

返回结果

{
      "errcode": 0,
      "data": {
            "group_name":"群名称",
            "create_time":"创建时间",
            "work_sort":"工作项类别",
            "member":[
               {
                    "type": "member",
                    "user_code": "code1"
                },
                {
                    "type": "owner",
                    "user_code": "code2"
                }
            ],
            "business_id":"关联的工作项业务ID"
      }
   }

失败返回

{"errcode":"错误code","errmsg":"错误信息","data":""}

说明

1. 目前消息类型有四种 text,news,img,audio
2. img,audio中的图片或语音需要同步方自己下载保存,文件有效期3天
3. 消息为讨论组类型消息,暂不提供个人消息
4. 消息的有效期为7天,过期的消息不能同步

添加新批注
在作者公开此批注前,只有你和作者可见。
回复批注