直达内容

消息类型

Mixin Messenger 支持文本、图片、贴纸、文件等多种消息类型。需要注意，机器人目前仅支持以 PLAIN_ 为前缀的消息类型。

发送图片、文件和视频前，需要先上传附件并获取 attachment_id。

文本​

{
  "id": "UUID",
  "action": "CREATE_MESSAGE",
  "params": {
    "conversation_id": "UUID",
    "category": "PLAIN_TEXT",
    "status": "SENT",
    "message_id": "UUID",
    "data": "Base64 encoded data"
  }
}

贴纸​

{
  "id": "UUID",
  "action": "CREATE_MESSAGE",
  "params": {
    "conversation_id": "UUID",
    "category": "PLAIN_STICKER",
    "status": "SENT",
    "message_id": "UUID",
    "data": "Base64 encoded data"
  }
}

// data structure
{
  "sticker_id": "UUID"
}

图片​

{
  "id": "UUID",
  "action": "CREATE_MESSAGE",
  "params": {
    "conversation_id": "UUID",
    "category": "PLAIN_IMAGE",
    "status": "SENT",
    "message_id": "UUID",
    "data": "Base64 encoded data"
  }
}

// data structure
{
  "attachment_id": "read From POST /attachments",
  "mime_type": "image/jpeg",
  "width": 1024,
  "height": 1024,
  "size": 1024,
  "thumbnail": "base64 encoded"
}

音频​


  {
    "id": "UUID",
    "action": "CREATE_MESSAGE",
    "params": {
      "conversation_id": "UUID",
      "category": "PLAIN_AUDIO",
      "status": "SENT",
      "message_id": "UUID",
      "data": "Base64 encoded data"
    }
  }

// data structure
{
  "attachment_id": "read From POST /attachments",
  "mime_type": "audio/ogg",
  "size": 1024,
  "waveform": "audio  waveform",
  "duration":1024,
  "created_at":"2021-12-17T12:51:53.252052226Z"
}

视频​

{
  "id": "UUID",
  "action": "CREATE_MESSAGE",
  "params": {
    "conversation_id": "UUID",
    "category": "PLAIN_VIDEO",
    "status": "SENT",
    "message_id": "UUID",
    "data": "Base64 encoded data"
  }
}

// data structure
{
  "attachment_id": "Read From POST /attachments",
  "mime_type": "video/mp4",
  "width": 1024,
  "height": 1024,
  "size": 1024,
  "duration": 60,
  "thumbnail": "base64 encoded"
}

联系人​

{
  "id": "UUID",
  "action": "CREATE_MESSAGE",
  "params": {
      "conversation_id": "UUID",
      "category": "PLAIN_CONTACT",
      "status": "SENT",
      "message_id": "UUID",
      "data": "Base64 encoded data"
  }
}

// data structure
{
  "user_id": "UUID"
}

卡片​

{
  "id": "UUID",
  "action": "CREATE_MESSAGE",
  "params": {
    "conversation_id": "UUID",
    "category": "APP_CARD",
    "status": "SENT",
    "message_id": "UUID",
    "data": "Base64 encoded data"
  }
}

// data structure
{
  "app_id": "7404c815-0393-4ea3-b9f2-b08efe4c72da",
  "icon_url": "https://mixin.one/assets/98b586edb270556d1972112bd7985e9e.png",  // deprecated
  "cover_url": "https://mixin.one/assets/98b586edb270556d1972112bd7985e9e.png", // 16:10
  "title": "Mixin", // 1 <= size(title) <= 36
  "description": "Hello World.", // 1 <= size(description) <= 1024
  "action": "https://mixin.one",   // deprecated
  "actions": [
	  {
	    "label": "Mixin Website",
	    "color": "#ABABAB",
	    "action": "https://mixin.one"
	  }
	  // ...
	]
  "shareable": true
}
提示

将 shareable 字段设置为 false 可以禁止转发卡片。该特性需要 Mixin Messenger 0.31.0 及以上版本，默认值为 true。

提示

数据结构新增了 cover_url 与 actions 字段。如果结构中仍包含 action 字段，客户端会使用旧版卡片样式并忽略与新版样式相关的其它参数。新版卡片样式（包含 cover_url 与 actions）需要 Mixin Messenger 1.9.0 及以上版本支持。

文件​

{
  "id": "UUID",
  "action": "CREATE_MESSAGE",
  "params": {
    "conversation_id": "UUID",
    "category": "PLAIN_DATA",
    "status": "SENT",
    "message_id": "UUID",
    "data": "Base64 encoded data"
  }
}

// data structure
{
  "attachment_id": "Read From POST /attachments",
  "mime_type": "application/pdf",
  "size": 1024,
  "name": "2020-12-12.pdf"
}

直播​

{
  "id": "UUID",
  "action": "CREATE_MESSAGE",
  "params": {
    "conversation_id": "UUID",
    "category": "PLAIN_LIVE",
    "status": "SENT",
    "message_id": "UUID",
    "data": "Base64 encoded data"
  }
}

// data structure
{
  "width": 650,
  "height": 366,
  "thumb_url": "https://mixin.one/logo.png",
  "url": "https://mixin.one/live.m3u8"
}

位置​

{
  "id": "UUID",
  "action": "CREATE_MESSAGE",
  "params": {
    "conversation_id": "UUID",
    "category": "PLAIN_LOCATION",
    "status": "SENT",
    "message_id": "UUID",
    "data": "Base64 encoded data"
  }
}

// data structure
{
  "longitude": 126.5893955829421,
  "latitude": 53.47845177824066,
  "name": "China",
  "address": "China Beijing"
}

动态​

{
  "id": "UUID" // generated by client,
  "action": "CREATE_MESSAGE",
  "params": {
    "conversation_id": "UUID",
    "category": "PLAIN_POST",
    "status": "SENT",
    "message_id": "UUID",
    "data": "Base64 encoded data"
  }
}

按钮​

{
  "id": "UUID",
  "action": "CREATE_MESSAGE",
  "params": {
    "conversation_id": "UUID",
    "category": "APP_BUTTON_GROUP",
    "status": "SENT",
    "message_id": "UUID",
    "data": "Base64 encoded data"
  }
}

// data structure
[
  {
    "label": "Mixin Website", 1 <= size(label) <= 36
    "color": "#ABABAB",
    "action": "https://mixin.one"
  }
  ... // 1 <= size(msg_buttons) <= 6
]

转账​

{
  "id": "UUID",
  "action": "CREATE_MESSAGE",
  "params": {
    "conversation_id": "UUID",
    "category": "SYSTEM_ACCOUNT_SNAPSHOT",
    "status": "SENT",
    "message_id": "UUID",
    "data": "Base64 encoded data"
  }
}

// data structure
{
  "type": "transfer",
  "snapshot_id": "ab56be4c-5b20-41c6-a9c3-244f9a433f35",
  "opponent_id": "a465ffdb-4441-4cb9-8b45-00cf79dfbc46",
  "asset_id": "43d61dcd-e413-450d-80b8-101d5e903357",
  "amount": "-10",
  "trace_id": "7c67e8e8-b142-488b-80a3-61d4d29c90bf",
  "memo": "hello",
  "created_at": "2018-05-03T10:08:34.859542588Z"
}

置顶消息​

{
  "id": "UUID",
  "action": "CREATE_MESSAGE",
  "params": {
    "conversation_id": "UUID",
    "category": "MESSAGE_PIN",
    "status": "SENT",
    "message_id": "UUID",
    "data": "Base64 encoded data"
  }
}

// data structure
{
  "action": "PIN", // PIN or UNPIN
  "message_ids": ["ab56be4c-5b20-41c6-a9c3-244f9a433f35","ab56be4c-5b20-41c6-a9c3-244f9a433f35"]
}