Message (Subscribe) - Amazon IVS
FormatFields

Message (Subscribe)

Messages from other clients that are sent to the room.

Format

{
  "Attributes": { "string": "string" },
  "Content": "string",
  "Id": "string",
  "RequestId": "string",
  "Sender": {
    "Attributes": { "string": "string" },
    "UserId": "string"
  },
  "SendTime": "string::date-time",
  "Type": "MESSAGE"
}

Fields

Field Description

Attributes

Attributes included in the message.

Content

Message received by another user.

Id

An identifier generated by Amazon IVS Chat.

RequestId

The message identifier optionally specified by your application (in the corresponding SendMessage (Publish) operation) for tracking purposes

Sender

Information about the sender. This includes two fields:

  • Sender.Attributes is metadata about the sender established during authentication. This can be used to give the client more information about the sender; e.g., avatar URL, badges, font, and color.

  • Sender.UserId is an application-specified identifier of the viewer (end user) who sent this message. This can be used by the client application to refer to the user in either the messaging API or application domains.

SendTime

 Timestamp of when the message was received by Amazon IVS Chat.

Type

MESSAGE