Chat App Message Service:ChatAppStatus

Parameter

Type

Required

Description

MessageId

String

Yes

Unique message identifier.

From

String

Yes

Sender's phone number.

To

String

Yes

Recipient's phone number.

FromUserId

String

No

BSUID

FromParentUserId

String

No

Parent BSUID (if any)

FromUserName

String

No

User account (if any)

Timestamp

Long

Yes

Unix timestamp when the message was sent, in milliseconds.

Status

String

Yes

Message delivery status. Valid values:

• Sent: Message sent.

• Delivered: Message delivered to the recipient's device.

• Read: Message read by the recipient.

• Failed: Message delivery failed.

• Deleted: Message deleted.

  Note

  Unavailable. WhatsApp does not push the Deleted status to Chat App Message Service.

• unsubscribe: The user has blocked the business account.

• subscribe: The user has unblocked the business account.

  Note

  Applies to Viber channels only.

StatusDescription

String

Yes

Status description.

ErrorCode

String

No

Error code for delivery failure.

ErrorDescription

String

No

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

ConversationType

String

No

Conversation type. Valid values:

• service: User-initiated conversation.

• utility: Transactional message.

• marketing: Marketing message.

• authentication: Authentication message.

ConversationId

String

No

Unique conversation identifier.

ConversationExpirationTime (deprecated)

Long

No

Conversation expiration time.

MsgFrameType

String

Yes

Message type. Valid values:

• message: Free-form message. Can only be sent within 24 hours of the user's last message.

• template: Pre-approved message template from the console. Can be sent at any time.

Type

String

No

Media type of the message content. Valid values:

• image

• video

• document

• audio

• none: Plain text

TaskId

String

No

Custom task ID.

OriginPhoneNumber

String

No

Original sender phone number.

TemplateCode

String

No

Message template code.