/AWS1/CL_CHE=>LISTCHANNELMESSAGES()

About ListChannelMessages

List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order.

Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message.

Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

This API is is no longer supported and will not be updated. We recommend using the latest version, ListChannelMessages, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Method Signature

IMPORTING

Required arguments:

IV_CHANNELARN TYPE /AWS1/CHECHIMEARN /AWS1/CHECHIMEARN

The ARN of the channel.

Optional arguments:

IV_SORTORDER TYPE /AWS1/CHESORTORDER /AWS1/CHESORTORDER

The order in which you want messages sorted. Default is Descending, based on time created.

IV_NOTBEFORE TYPE /AWS1/CHETIMESTAMP /AWS1/CHETIMESTAMP

The initial or starting time stamp for your requested messages.

IV_NOTAFTER TYPE /AWS1/CHETIMESTAMP /AWS1/CHETIMESTAMP

The final or ending time stamp for your requested messages.

IV_MAXRESULTS TYPE /AWS1/CHEMAXRESULTS /AWS1/CHEMAXRESULTS

The maximum number of messages that you want returned.

IV_NEXTTOKEN TYPE /AWS1/CHENEXTTOKEN /AWS1/CHENEXTTOKEN

The token passed by previous API calls until all requested messages are returned.

IV_CHIMEBEARER TYPE /AWS1/CHECHIMEARN /AWS1/CHECHIMEARN

The AppInstanceUserArn of the user that makes the API call.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_CHELISTCHANNELMSGSRSP /AWS1/CL_CHELISTCHANNELMSGSRSP