Amazon Chime SDK Messaging
The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The Amazon Chime SDK messaging APIs in this section allow software developers to send
and receive messages in custom messaging applications. These APIs depend on the frameworks
provided by the Amazon Chime SDK identity APIs. For more information about the messaging
APIs, see Amazon Chime SDK messaging .
Endpoints 42
- PUTAssociate channel flow
/channels/:ChannelArn/channel-flowAssociates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the… - GETList channel memberships
/channels/:ChannelArn/memberships?type=string&max-results=0&next-token=string&sub-channel-id=stringLists all channel memberships in a channel. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that… - POSTCreate channel membership
/channels/:ChannelArn/membershipsAdds a member to a channel. The InvitedBy field in ChannelMembership is derived from the request header. A channel member can: List messages Send messages… - GETDescribe channel moderated by app instance user
/channels/:ChannelArn?scope=app-instance-user-moderated-channel&app-instance-user-arn=stringReturns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot . The x-amz-chime-bearer request header is mandatory. Use… - PUTUpdate channel
/channels/:ChannelArnUpdate a channel's attributes. Restriction : You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the ARN of the… - POSTChannel flow callback
/channels/:ChannelArn?operation=channel-flow-callbackCalls back Amazon Chime SDK messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API. You can… - DELETEDelete channel
/channels/:ChannelArnImmediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process. The x-amz-chime-bearer request… - GETList channels moderated by app instance user
/channels?scope=app-instance-user-moderated-channels&app-instance-user-arn=string&max-results=0&next-token=stringA list of the channels moderated by an AppInstanceUser . The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or… - POSTSearch channels
/channels?operation=search&max-results=0&next-token=stringAllows the ChimeBearer to search channels by channel members. Users or bots can search across the channels that they belong to. Users in the AppInstanceAdmin… - GETList channel bans
/channels/:ChannelArn/bans?max-results=0&next-token=stringLists all the users and bots banned from a particular channel. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or… - POSTCreate channel ban
/channels/:ChannelArn/bansPermanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan , and then… - GETList channel flows
/channel-flows?app-instance-arn=string&max-results=0&next-token=stringReturns a paginated lists of all the channel flows created under a single Chime. This is a developer API. - POSTCreate channel flow
/channel-flowsCreates a channel flow, a container for processors. Processors are AWS Lambda functions that perform actions on chat messages, such as stripping out… - GETList channel moderators
/channels/:ChannelArn/moderators?max-results=0&next-token=stringLists all the moderators for a channel. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes… - POSTCreate channel moderator
/channels/:ChannelArn/moderatorsCreates a new ChannelModerator . A channel moderator can: Add and remove other members of the channel. Add and remove other moderators of the channel. Add and… - GETDescribe channel ban
/channels/:ChannelArn/bans/:MemberArnReturns the full details of a channel ban. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes… - DELETEDelete channel ban
/channels/:ChannelArn/bans/:MemberArnRemoves a member from a channel's ban list. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that… - GETDescribe channel flow
/channel-flows/:ChannelFlowArnReturns the full details of a channel flow in an Amazon Chime AppInstance . This is a developer API. - PUTUpdate channel flow
/channel-flows/:ChannelFlowArnUpdates channel flow attributes. This is a developer API. - DELETEDelete channel flow
/channel-flows/:ChannelFlowArnDeletes a channel flow, an irreversible process. This is a developer API. This API works only when the channel flow is not associated with any channel. To get… - GETDescribe channel membership
/channels/:ChannelArn/memberships/:MemberArn?sub-channel-id=stringReturns the full details of a user's channel membership. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or… - DELETEDelete channel membership
/channels/:ChannelArn/memberships/:MemberArn?sub-channel-id=stringRemoves a member from a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the… - GETGet channel message status
/channels/:ChannelArn/messages/:MessageId?scope=message-status&sub-channel-id=stringGets message status for a specified messageId . Use this API to determine the intermediate status of messages going through channel flow processing. The API… - PUTUpdate channel message
/channels/:ChannelArn/messages/:MessageIdUpdates the content of a message. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API… - POSTRedact channel message
/channels/:ChannelArn/messages/:MessageId?operation=redactRedacts message content and metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted. The… - DELETEDelete channel message
/channels/:ChannelArn/messages/:MessageId?sub-channel-id=stringDeletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions… - GETDescribe channel moderator
/channels/:ChannelArn/moderators/:ChannelModeratorArnReturns the full details of a single ChannelModerator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes… - DELETEDelete channel moderator
/channels/:ChannelArn/moderators/:ChannelModeratorArnDeletes a channel moderator. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or AppInstanceBot that makes the API call… - GETGet messaging streaming configurations
/app-instances/:AppInstanceArn/streaming-configurationsRetrieves the data streaming configuration for an AppInstance . For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide . - PUTPut messaging streaming configurations
/app-instances/:AppInstanceArn/streaming-configurationsSets the data streaming configuration for an AppInstance . For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide . - DELETEDelete messaging streaming configurations
/app-instances/:AppInstanceArn/streaming-configurationsDeletes the streaming configurations for an AppInstance . For more information, see Streaming messaging data in the Amazon Chime SDK Developer Guide . - DELETEDisassociate channel flow
/channels/:ChannelArn/channel-flow/:ChannelFlowArnDisassociates a channel flow from all its channels. Once disassociated, all messages to that channel stop going through the channel flow processor. Only… - GETGet channel membership preferences
/channels/:ChannelArn/memberships/:MemberArn/preferencesGets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. A user or a bot must be a member of the channel and own the… - PUTPut channel membership preferences
/channels/:ChannelArn/memberships/:MemberArn/preferencesSets the membership preferences of an AppInstanceUser or AppInstanceBot for the specified channel. The user or bot must be a member of the channel. Only the… - GETGet messaging session endpoint
/endpoints/messaging-session?network-type=stringThe details of the endpoint for the messaging session. - GETList channel messages
/channels/:ChannelArn/messages?sort-order=string¬-before=string¬-after=string&max-results=0&next-token=string&sub-channel-id=stringList all the messages in a channel. Returns a paginated list of ChannelMessages . By default, sorted by creation timestamp in descending order. Redacted… - POSTSend channel message
/channels/:ChannelArn/messagesSends a message to a particular channel that the member is a part of. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser… - GETList sub channels
/channels/:ChannelArn/subchannels?max-results=0&next-token=stringLists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels. - GETList tags for resource
/tags?arn=stringLists the tags applied to an Amazon Chime SDK messaging resource. - POSTUntag resource
/tags?operation=untag-resourceRemoves the specified tags from the specified Amazon Chime SDK messaging resource. - PUTPut channel expiration settings
/channels/:ChannelArn/expiration-settingsSets the number of days before the channel is automatically deleted. A background process deletes expired channels within 6 hours of expiration. Actual… - PUTUpdate channel read marker
/channels/:ChannelArn/readMarkerThe details of the time when a user last read messages in a channel. The x-amz-chime-bearer request header is mandatory. Use the ARN of the AppInstanceUser or…
API details
- Base URL
https://messaging-chime.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 42 operations on 21 pathsGET 17POST 9PUT 8DELETE 8
- Description format
- AWS Smithy model, API version
2021-05-15 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Chime SDK Messaging in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Chime SDK Messaging collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Associate channel flow” (PUT /channels/:ChannelArn/channel-flow), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Chime SDK Messaging?
The Amazon Chime SDK messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend… It is listed under Communication and has 42 endpoints.
Who publishes the Amazon Chime SDK Messaging?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Chime SDK Messaging?
Requests go to https://messaging-chime.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Chime SDK Messaging?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Chime SDK Messaging have?
42 operations on 21 paths (17 GET, 9 POST, 8 PUT, 8 DELETE).
Is forking the Amazon Chime SDK Messaging free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.