message

get message mentions

Get mentions from a message

post/instances/{id}/client/action/get-message-mentions

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/get-message-mentions
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

messageIdstring required

The ID of the message to get mentions from

Example request

{
  "messageId": "true_123456789@c.us_ABC123DEF456"
}

Response

Returns mentions from the message

status'success' | 'error'

Example response

{
  "data": {
    "messageId": "true_123456789@c.us_ABC123DEF456",
    "mentions": [
      {
        "id": {
          "server": "c.us",
          "user": "123456789",
          "_serialized": "123456789@c.us"
        },
        "name": "John Doe",
        "pushname": "John",
        "shortName": "John D.",
        "isUser": true
      }
    ]
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/get-message-mentions"
  },
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.