Create a new message in message feed

Create a new message

POST /api/v5/messages

Create a new message in message feed

cURL

curl --request POST \
  --url https://apix.us.amity.co/api/v5/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messageFeedId": "507f191e810c19729de860ea",
  "referenceId": "1530b11ec8df87da22b06b27",
  "dataType": "text",
  "parentId": "abc665afd7dbb8d036037eea",
  "data": {
    "text": "test"
  },
  "fileId": "76bfe68974157a114053364d",
  "metadata": {
    "refId": "d601c27c0675baa2103ec573"
  },
  "tags": [
    "tag1",
    "tag2"
  ],
  "mentionedUsers": [
    {
      "type": "user",
      "userIds": [
        "3cac302ab992aa17b215ba21",
        "adb34ec2aeedca03a38e1d54"
      ]
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z"
}
'

200

{
  "messages": [
    {
      "referenceId": "1530b11ec8df87da22b06b27",
      "messageId": "a85dca058f5b585f86a29f14",
      "networkId": "9530b11ec8de87db22b06b27",
      "channelId": "abc665aed9dbb8d036037eed",
      "channelType": "community",
      "messageFeedId": "507f191e810c19729de860ea",
      "segment": 123,
      "dataType": "text",
      "data": {
        "text": "test"
      },
      "fileId": "76bfe68974157a114053364d",
      "thumbnailFileId": "76bfe68974157a114053364e",
      "metadata": {
        "refId": "d601c27c0675baa2103ec573"
      },
      "tags": [
        "tag1",
        "tag2"
      ],
      "creatorId": "5349b4ddd2781d08c09890f4",
      "mentionedUsers": [
        {
          "type": "user",
          "userIds": [
            "3cac302ab992aa17b215ba21",
            "adb34ec2aeedca03a38e1d54"
          ]
        }
      ],
      "reactions": {
        "like": 1,
        "love": 2
      },
      "reactionCount": 123,
      "parentId": "abc665afd7dbb8d036037eea",
      "path": "12cba9779cc479e1fcefd1de/chat/f00ab16cbd27d4a9525aea6d/32b468ae0b1bd0cc7976719d/0a003482f0ac53a71e7c9239",
      "flagCount": 123,
      "childCount": 123,
      "isDeleted": false,
      "editedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "myReactions": [
        "like",
        "love"
      ]
    }
  ],
  "messageFeeds": [
    {
      "messageFeedId": "a85dca058f5b585f86a29f14",
      "channelId": "abc665aed9dbb8d036037eeb",
      "channelPublicId": "abc665aed9dbb8d036037eeb",
      "channelType": "community",
      "name": "text",
      "creatorId": "8aa313c8dbb00af911b07672",
      "path": "12cba9779cc479e1fcefd1de/chat/f00ab16cbd27d4a9525aea6d/32b468ae0b1bd0cc7976719d/0a003482f0ac53a71e7c9239",
      "childCount": 123,
      "isDeleted": false,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "lastMessageId": "9530b11ec8de87db22b06b21",
      "lastMessageTimestamp": "2023-11-07T05:31:56Z",
      "editedAt": "2023-11-07T05:31:56Z",
      "messagePreviewId": "<string>"
    }
  ],
  "files": [
    {
      "fileId": "<string>",
      "fileUrl": "<string>",
      "accessType": "public",
      "altText": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "attributes": {
        "name": "<string>",
        "extension": "<string>",
        "size": 123,
        "mimeType": "<string>",
        "metadata": {
          "exif": {},
          "gps": {},
          "height": 123,
          "width": 123,
          "isFull": true
        }
      }
    }
  ],
  "users": [
    {
      "userId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "_id": "<string>",
      "path": "<string>",
      "roles": [
        "<string>"
      ],
      "displayName": "<string>",
      "flagCount": 123,
      "hashFlag": {
        "bits": 123,
        "hashes": 123,
        "hash": [
          "<string>"
        ]
      },
      "metadata": {},
      "isDeleted": true
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Message object that needs to be added

messageFeedId · string · required

Message feed id of message

Maximum string length: 30

Example:

"507f191e810c19729de860ea"

referenceId · string · required

A reference ID

Maximum string length: 30

Example:

"1530b11ec8df87da22b06b27"

dataType · string · required

Type of data

Maximum string length: 20

Example:

"text"

parentId · string

Parent id of message

Maximum string length: 30

Example:

"abc665afd7dbb8d036037eea"

data · object

A custom object for storing message. The size of this object must be less than 10 kb.

Example:

{ "text": "test" }

fileId · string

File id

Maximum string length: 30

Example:

"76bfe68974157a114053364d"

metadata · object

A custom object for storing the other data. The size of this object must be less than 20 kb.

Example:

{ "refId": "d601c27c0675baa2103ec573" }

tags · string[]

List of tags for searching

Maximum array length: 10

Maximum string length: 30

Example:

["tag1", "tag2"]

mentionedUsers · object[]

List of mentioned users

Show child attributes

createdAt · string<date-time>

A created date/time of message

Response

200

application/json

Create message payload

The returned payload of created message(s)

messages · object[]

The list of created message

Show child attributes

messageFeeds · object[]

List of message feeds

Show child attributes

files · object[]

The list of file

Show child attributes

users · object[]

The list of user

Show child attributes