Skip to content
On this page

[Conversation] Send Message

  • Endpoint Path: /api/v2/conversation/send-message
  • Method: POST
  • Request: application/json

Headers Optional Parameter

Parameter NamePublic Mode (Required)Private Mode (Required)
X-Fresns-Aidrequiredrequired
X-Fresns-Aid-Tokenrequiredrequired
X-Fresns-Uidrequiredrequired
X-Fresns-Uid-Tokenrequiredrequired

Body Params

Parameter NameTypeRequiredDescription
uidOrUsernameStringrequired用户 uid 或者 username
messageStringoptional消息内容
fidStringoptional文件 FID

Request Description

  • messagefid 二选一传参,不可全部留空,不可全部传参。
  • 发送文件,先使用文件上传接口,上传后获得 fid 传参。
  • 上传参数例子:
    • tableName = conversation_messages
    • tableColumn = message_file_id
    • tableKey = 对方的 uidusername

Return

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "id": "Number / Message ID",
        "user": {
            // 发信用户信息
            // Common Data Structure -> User Info
        },
        "isMe": "Boolean / 是否为自己发的",
        "type": "Number / 1.文本消息 2.文件消息",
        "content": "String / 消息内容",
        "file": {
            // 文件消息专用
            // Common Data Structure -> File Info
        },
        "datetime": "String / 发送时间",
        "datetimeFormat": "String / 格式化的发送时间",
        "readStatus": "Boolean / 阅读状态"
    }
}

Released under the Apache-2.0 License