Amazon Chime SDK Chime Scope API
The Chime Scope API from Amazon Chime SDK — 3 operation(s) for chime scope.
The Chime Scope API from Amazon Chime SDK — 3 operation(s) for chime scope.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/amazon-chime:amazon-chime-scope-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: Amazon Chime SDK Meetings Scope API
version: '2021-07-15'
description: Generated from AWS's published Smithy model for Amazon Chime SDK Meetings. 3 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://messaging-chime.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/channels/{ChannelArn}?scope=app-instance-user-membership:
get:
operationId: DescribeChannelMembershipForAppInstanceUser
summary: Describe Channel Membership For App Instance User
description: Returns the details of a channel based on the membership of the specified AppInstanceUser or AppInstanceBot.
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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeChannelMembershipForAppInstanceUserResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/MessagingChimeBadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/MessagingChimeForbiddenException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/MessagingChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/MessagingChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeChannelMembershipForAppInstanceUserRequest'
tags:
- Scope
/channels/{ChannelArn}?scope=app-instance-user-moderated-channel:
get:
operationId: DescribeChannelModeratedByAppInstanceUser
summary: Describe Channel Moderated By App Instance User
description: Returns the full details of a channel moderated by the specified AppInstanceUser or AppInstanceBot. 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeChannelModeratedByAppInstanceUserResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/MessagingChimeBadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/MessagingChimeForbiddenException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/MessagingChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/MessagingChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeChannelModeratedByAppInstanceUserRequest'
tags:
- Scope
/channels/{ChannelArn}/messages/{MessageId}?scope=message-status:
get:
operationId: GetChannelMessageStatus
summary: Get Channel Message Status
description: Gets message status for a specified messageId. Use this API to determine the intermediate status of messages
going through channel flow processing. The API provides an alternative to retrieving message status if the event was
not received because a client wasn't connected to a websocket. Messages can have any one of these statuses. SENT Message
processed successfully PENDING Ongoing processing FAILED Processing failed DENIED Message denied by the processor
This API does not return statuses for denied messages, because we don't store them once the processor denies them.
Only the message sender can invoke this API. 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.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/GetChannelMessageStatusResponse'
'400':
description: BadRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/MessagingChimeBadRequestException'
'403':
description: ForbiddenException
content:
application/json:
schema:
$ref: '#/components/schemas/MessagingChimeForbiddenException'
'500':
description: ServiceFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/MessagingChimeServiceFailureException'
'503':
description: ServiceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/MessagingChimeServiceUnavailableException'
'429':
description: ThrottledClientException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottledClientException'
'401':
description: UnauthorizedClientException
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedClientException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetChannelMessageStatusRequest'
tags:
- Scope
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: chime
schemas:
AppInstanceUserMembershipSummary:
type: object
properties:
Type:
type: string
enum:
- DEFAULT
- HIDDEN
description: The type of ChannelMembership.
ReadMarkerTimestamp:
type: string
format: date-time
description: The time at which an AppInstanceUser last marked a channel as read.
SubChannelId:
type: string
description: The ID of the SubChannel that the AppInstanceUser is a member of.
ChannelMembershipForAppInstanceUserSummary:
type: object
properties:
ChannelSummary:
$ref: '#/components/schemas/ChannelSummary'
AppInstanceUserMembershipSummary:
$ref: '#/components/schemas/AppInstanceUserMembershipSummary'
ChannelMessageStatusStructure:
type: object
properties:
Value:
type: string
enum:
- SENT
- PENDING
- FAILED
- DENIED
description: The message status value.
Detail:
type: string
description: Contains more details about the message status.
ChannelModeratedByAppInstanceUserSummary:
type: object
properties:
ChannelSummary:
$ref: '#/components/schemas/ChannelSummary'
ChannelSummary:
type: object
properties:
Name:
type: string
description: The name of the channel.
ChannelArn:
type: string
description: The ARN of the channel.
Mode:
type: string
enum:
- UNRESTRICTED
- RESTRICTED
description: The mode of the channel.
Privacy:
type: string
enum:
- PUBLIC
- PRIVATE
description: The privacy setting of the channel.
Metadata:
type: string
description: The metadata of the channel.
LastMessageTimestamp:
type: string
format: date-time
description: The time at which the last persistent message visible to the caller in a channel was sent.
DescribeChannelMembershipForAppInstanceUserRequest:
type: object
properties:
ChannelArn:
type: string
description: The ARN of the channel to which the user belongs.
AppInstanceUserArn:
type: string
description: The ARN of the user or bot in a channel.
ChimeBearer:
type: string
description: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
required:
- ChannelArn
- AppInstanceUserArn
- ChimeBearer
DescribeChannelMembershipForAppInstanceUserResponse:
type: object
properties:
ChannelMembership:
$ref: '#/components/schemas/ChannelMembershipForAppInstanceUserSummary'
DescribeChannelModeratedByAppInstanceUserRequest:
type: object
properties:
ChannelArn:
type: string
description: The ARN of the moderated channel.
AppInstanceUserArn:
type: string
description: The ARN of the user or bot in the moderated channel.
ChimeBearer:
type: string
description: The ARN of the AppInstanceUser or AppInstanceBot that makes the API call.
required:
- ChannelArn
- AppInstanceUserArn
- ChimeBearer
DescribeChannelModeratedByAppInstanceUserResponse:
type: object
properties:
Channel:
$ref: '#/components/schemas/ChannelModeratedByAppInstanceUserSummary'
GetChannelMessageStatusRequest:
type: object
properties:
ChannelArn:
type: string
description: The ARN of the channel
MessageId:
type: string
description: The ID of the message.
ChimeBearer:
type: string
description: The AppInstanceUserArn of the user making the API call.
SubChannelId:
type: string
description: The ID of the SubChannel in the request. Only required when getting message status in a SubChannel
that the user belongs to.
required:
- ChannelArn
- MessageId
- ChimeBearer
GetChannelMessageStatusResponse:
type: object
properties:
Status:
$ref: '#/components/schemas/ChannelMessageStatusStructure'
MessagingChimeBadRequestException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
Message:
type: string
MessagingChimeForbiddenException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
Message:
type: string
MessagingChimeServiceFailureException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
Message:
type: string
MessagingChimeServiceUnavailableException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
Message:
type: string
ThrottledClientException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
Message:
type: string
UnauthorizedClientException:
type: object
properties:
Code:
type: string
enum:
- BadRequest
- Conflict
- Forbidden
- NotFound
- PreconditionFailed
- ResourceLimitExceeded
- ServiceFailure
- AccessDenied
- ServiceUnavailable
- Throttled
- Throttling
- Unauthorized
- Unprocessable
- VoiceConnectorGroupAssociationsExist
- PhoneNumberAssociationsExist
Message:
type: string
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/chime-sdk-messaging/service/2021-05-15/chime-sdk-messaging-2021-05-15.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)