Sign in

v1

latestOpenAPI 3.0.02026-07-14181255304.7 KB
Messages

Get message

The method returns a message from any chat by message id.

get/messages/{MessageID}

Path parameters

MessageIDstring required

Message ID

Message ID

Query parameters

resyncboolean

If set to true, the channel will resync its data.

Response

OK

idstring required

Message ID

type'text' | 'image' | 'video' | 'gif' | 'audio' | 'voice' | 'short' | 'document' | 'documentWithCaption' | 'link_preview' | 'location' | 'live_location' | 'contact' | 'contact_list' | 'sticker' | 'system' | 'call' | 'unknown' | 'action' | 'group_invite' | 'newsletter_invite' | 'admin_invite' | 'product' | 'catalog' | 'interactive' | 'reply' | 'poll' | 'quiz' | 'question' | 'hsm' | 'order' | 'story' | 'event' | 'buttons' | 'list' | 'pin' | 'carousel' | 'album' required

Message type

subtypestring

Message subtype

chat_idstring required

Chat ID

chat_namestring

Chat name

fromstring

WhatsApp ID of the sender

phonestring

Phone number of the sender

from_meboolean required

Is message from me

from_namestring

Pushname of the sender

source'web' | 'mobile' | 'api' | 'system' | 'business_api' | 'unknown'

Message source

timestampnumber required

Message timestamp

device_idnumber

Device ID, if the message was not sent through the app

status'failed' | 'pending' | 'sent' | 'delivered' | 'read' | 'played' | 'deleted'

Message ack status

starredboolean

Is message starred

Example response

{
  "question": {
    "body": "What do you think?",
    "total": 1,
    "responses": [
      {
        "text": "Some answer",
        "timestamp": 1675964377
      }
    ]
  },
  "action": {
    "edited_content": {
      "body": "What do you think?",
      "total": 1,
      "responses": [
        {
          "text": "Some answer",
          "timestamp": 1675964377
        }
      ]
    },
    "result": {
      "timestamp": 1675964377
    },
    "event_response": {
      "response": "JOING",
      "timestamp": 1675964377
    },
    "answer": {
      "text": "Some answer",
      "timestamp": 1675964377
    }
  },
  "context": {
    "quoted_content": {
      "body": "What do you think?",
      "total": 1,
      "responses": [
        {
          "text": "Some answer",
          "timestamp": 1675964377
        }
      ]
    }
  },
  "event": {
    "name": "Some name",
    "description": "Some description",
    "join_link": "https://call.whatsapp.com/voice/K5IFl19olpzTLsh52A0G9R",
    "start": 1675964377,
    "responses": [
      {
        "response": "JOING",
        "timestamp": 1675964377
      }
    ]
  },
  "labels": [
    {
      "count": 1
    }
  ]
}