Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListMeetings

Lists up to 100 active Amazon Chime SDK meetings.

Important

ListMeetings is not supported in the Amazon Chime SDK Meetings Namespace. Update your application to remove calls to this API.

For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

Request Syntax


GET /meetings?max-results=MaxResults&next-token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

MaxResults

The maximum number of results to return in a single call.

Valid Range: Minimum value of 1. Maximum value of 99.

NextToken

The token to use to retrieve the next page of results.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Meetings": [ 
      { 
         "ExternalMeetingId": "string",
         "MediaPlacement": { 
            "AudioFallbackUrl": "string",
            "AudioHostUrl": "string",
            "EventIngestionUrl": "string",
            "ScreenDataUrl": "string",
            "ScreenSharingUrl": "string",
            "ScreenViewingUrl": "string",
            "SignalingUrl": "string",
            "TurnControlUrl": "string"
         },
         "MediaRegion": "string",
         "MeetingId": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Meetings

The Amazon Chime SDK meeting information.

Type: Array of Meeting objects

NextToken

The token to use to retrieve the next page of results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input parameters don't match the service's restrictions.

HTTP Status Code: 400

ForbiddenException

The client is permanently forbidden from making the request.

HTTP Status Code: 403

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottledClientException

The client exceeded its request rate limit.

HTTP Status Code: 429

UnauthorizedClientException

The client is not currently authorized to make the request.

HTTP Status Code: 401