Chat App Message Service:ChatAppStatus

Parameter

Type

Required

Description

MessageId

String

Yes

The unique identifier of the message.

From

String

Yes

The sender's phone number.

To

String

Yes

The recipient's phone number.

Timestamp

Long

Yes

The Unix timestamp when the message was sent, in milliseconds.

Status

String

Yes

The delivery status of the message. Valid values:

• Sent: The message was sent.

• Delivered: The message was delivered to the recipient's device.

• Read: The message was read by the recipient.

• Failed: Message delivery failed.

• Deleted: The message was deleted.

  Note

  The Deleted status is unavailable. WhatsApp does not push this status to Chat App Message Service.

StatusDescription

String

Yes

The description of the status.

ErrorCode

String

No

The error code for a delivery failure.

ErrorDescription

String

No

The description of the error code. For details, see Error codes.

ConversationType

String

No

The type of conversation. Valid values:

• service: A user-initiated conversation.

• utility: A transactional message.

• marketing: A marketing message.

• authentication: An authentication message.

ConversationId

String

No

The unique identifier of the conversation.

ConversationExpirationTime (deprecated)

Long

No

The time when the conversation expires.

MsgFrameType

String

Yes

The message type. Valid values:

• message: A free-form message. You can send this type of message only within 24 hours of the last message from the user.

• template: A pre-approved message template from the console. You can send this type of message at any time.

Type

String

No

The media type of the message content. Valid values:

• image

• video

• document

• audio

• none: Plain text

TaskId

String

No

The custom task ID.

OriginPhoneNumber

String

No

The original phone number of the sender.

TemplateCode

String

No

The code of the message template.