BatchCreateAttendee - Amazon Chime

BatchCreateAttendee

Creates up to 100 attendees for an active Amazon Chime SDK meeting. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime Developer Guide.

Request Syntax

POST /meetings/MeetingId/attendees?operation=batch-create HTTP/1.1 Content-type: application/json { "Attendees": [ { "ExternalUserId": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.

MeetingId

The Amazon Chime SDK ID of the meeting to which you're adding attendees.

Pattern: [a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

Attendees

The attendee information, including attendees' IDs and join tokens.

Type: Array of CreateAttendeeRequestItem objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Attendees": [ { "AttendeeId": "string", "ExternalUserId": "string", "JoinToken": "string" } ], "Errors": [ { "ErrorCode": "string", "ErrorMessage": "string", "ExternalUserId": "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.

Attendees

The attendee information, including attendees' IDs and join tokens.

Type: Array of Attendee objects

Errors

If the action fails for one or more of the attendees in the request, a list of the attendees is returned, along with error codes and error messages.

Type: Array of CreateAttendeeError objects

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

LimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

NotFoundException

One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: