/AWS1/CL_CHS=>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
ARN of the AppInstanceUser
or AppInstanceBot
that makes the API call as the value in
the header.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_CHANNELARN
TYPE /AWS1/CHSCHIMEARN
/AWS1/CHSCHIMEARN
¶
The ARN of the channel.
IV_CHIMEBEARER
TYPE /AWS1/CHSCHIMEARN
/AWS1/CHSCHIMEARN
¶
The ARN of the
AppInstanceUser
orAppInstanceBot
that makes the API call.
Optional arguments:¶
IV_SORTORDER
TYPE /AWS1/CHSSORTORDER
/AWS1/CHSSORTORDER
¶
The order in which you want messages sorted. Default is Descending, based on time created.
IV_NOTBEFORE
TYPE /AWS1/CHSTIMESTAMP
/AWS1/CHSTIMESTAMP
¶
The initial or starting time stamp for your requested messages.
IV_NOTAFTER
TYPE /AWS1/CHSTIMESTAMP
/AWS1/CHSTIMESTAMP
¶
The final or ending time stamp for your requested messages.
IV_MAXRESULTS
TYPE /AWS1/CHSMAXRESULTS
/AWS1/CHSMAXRESULTS
¶
The maximum number of messages that you want returned.
IV_NEXTTOKEN
TYPE /AWS1/CHSNEXTTOKEN
/AWS1/CHSNEXTTOKEN
¶
The token passed by previous API calls until all requested messages are returned.
IV_SUBCHANNELID
TYPE /AWS1/CHSSUBCHANNELID
/AWS1/CHSSUBCHANNELID
¶
The ID of the SubChannel in the request.
Only required when listing the messages in a SubChannel that the user belongs to.
RETURNING¶
OO_OUTPUT
TYPE REF TO /AWS1/CL_CHSLISTCHANNELMSGSRSP
/AWS1/CL_CHSLISTCHANNELMSGSRSP
¶
Domain /AWS1/RT_ACCOUNT_ID Primitive Type NUMC