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

CreateAttendee

Creates a new attendee 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 SDK Developer Guide.

Important

This API is no longer supported and will not be updated. We recommend using the latest version, CreateAttendee, in the Amazon Chime SDK.

Using the latest version requires migrating to a dedicated namespace. For more information, refer to Migrating from the Amazon Chime namespace in the Amazon Chime SDK Developer Guide.

Request Syntax


POST /meetings/meetingId/attendees HTTP/1.1
Content-type: application/json

{
   "ExternalUserId": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

meetingId

The Amazon Chime SDK meeting ID.

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.

ExternalUserId

The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Required: Yes

Tags

The tag key-value pairs.

Type: Array of Tag objects

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

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "Attendee": { 
      "AttendeeId": "string",
      "ExternalUserId": "string",
      "JoinToken": "string"
   }
}

Response Elements

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

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

Attendee

The attendee information, including attendee ID and join token.

Type: Attendee object

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

NotFoundException

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

HTTP Status Code: 404

ResourceLimitExceededException

The request exceeds the resource limit.

HTTP Status Code: 400

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