Endpoint
Authentication
Include your project API password in every request header:Path Parameters
string
required
Your Convo project ID. You can find this in your Convo dashboard under Project Settings.
string
required
The Convo message ID or the WhatsApp message ID (
wamid...) returned when the message was sent. Both formats are accepted.Example Request
Response
200 OKResponse Fields
string
The WhatsApp-assigned message ID (starts with
wamid). This is the same ID returned in the Send Message response.string
The Convo project this message belongs to.
string
The contact’s WhatsApp phone number (with country code, no
+).string
The Convo internal ID of the contact associated with this message. Use this with the Get Contact endpoint.
string
Who sent the message. Possible values:
string
Current delivery status of the message.
string
The content type of the message. Possible values include:
TEXT, IMAGE, VIDEO, FILE, AUDIO, STICKER, LOCATION, CONTACT, QUICK_REPLY, and others.object
The actual content of the message. The structure varies by
message_type:- For
TEXT: contains atextfield (string) with the message body. - For
IMAGE,VIDEO,FILE,AUDIO: contains alinkfield (URL) and optionalcaption. - For
LOCATION: containslatitude,longitude, and optionalname.
boolean
true if this message was sent as a WhatsApp template (Highly Structured Message). false for session messages.object | null
If the message was sent as part of a broadcast campaign, this object contains:
name(string): The campaign name.campaign_id(string): The campaign’s unique ID.
null for messages not tied to a campaign.number
Unix timestamp in milliseconds when the message was sent.
number | null
Unix timestamp in milliseconds when the message was delivered to the recipient’s device.
null if not yet delivered.number | null
Unix timestamp in milliseconds when the recipient read the message.
null if not yet read (or if read receipts are disabled).integer
The number of Convo credits deducted for this message.
string
The billing model used for this message:
MAU— deducted under Monthly Active User pricing.WC— deducted under WhatsApp Conversation-based pricing.
object | null
Additional billing details when
deductionType is MAU. null for WC messages.object | null
Details about the WhatsApp conversation window this message belongs to:
type(string): Conversation category, e.g.,"service","marketing","utility","authentication".expiry(number): Unix timestamp in milliseconds when the conversation window closes.
null if conversation details are unavailable.