v1

latestOpenAPI 3.0.02026-07-14362240.2 KB

messages

Delete a message

Deletes a single message from a chat. Only the message author or chat administrators can delete messages.

delete/messenger/v1/messages/{id}

Path parameters

idstring required

The unique identifier of the message to delete

Response

The deleted message

idstring

Message id

timestampnumber

Timestamp of message

messagestring required

Message text

type'MESSAGE' | 'AUDIO' | 'VIDEO' | 'GIF' | 'SYSTEM'

Message type

chatIdstring required

Chat id

readBynumber[]

Members ids

externalAuthorIdstring

External author id

externalIdstring

External id

Example response

{
  "id": "76bfc2ff-207c-4b5a-8543-f7009b7f8872",
  "timestamp": 1709043064088,
  "message": "Hello, world!",
  "type": "MESSAGE",
  "chatId": "76bfc2ff-207c-4b5a-8543-f7009b7f8872",
  "readBy": [
    1,
    2,
    3,
    4
  ],
  "externalLine": {
    "id": "659ff121fd62e43063340f2f",
    "name": "Main line",
    "icon": "https://example.com/icon.png",
    "externalId": "externalId",
    "timestamp": 1620211200000,
    "portal": "portal",
    "phoneNumber": "+1234567890"
  },
  "attachedFiles": [
    {
      "entityId": "659ff121fd62e43063340f2f",
      "entityType": "chat_message",
      "lastModified": 1613491200000,
      "originalFilename": "file.jpg",
      "size": "1024",
      "url": "https://example.com/file.jpg"
    }
  ],
  "relations": [
    {
      "action": "create",
      "service": "crm",
      "entity": "contact",
      "name": "659ff121fd62e43063340f2f",
      "pictureUrl": "https://example.com/picture.jpg",
      "entityId": "659ff121fd62e43063340f2f"
    }
  ],
  "externalAuthorId": "123456",
  "externalId": "123456",
  "ref": {
    "chatId": "76bfc2ff-207c-4b5a-8543-f7009b7f8872",
    "authorId": 1,
    "messageId": "76bfc2ff-207c-4b5a-8543-f7009b7f8872"
  },
  "meta": {
    "body": [
      {
        "text": "Hello, world!",
        "url": "https://www.instagram.com"
      }
    ]
  }
}