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 Developer Guide.

Request Syntax


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

{
   "Capabilities": { 
      "Audio": "string",
      "Content": "string",
      "Video": "string"
   },
   "ExternalUserId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

MeetingId

The unique ID of the meeting.

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.

Capabilities

The capabilities (audio, video, or content) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.

Note

You use the capabilities with a set of values that control what the capabilities can do, such as SendReceive data. For more information about those values, see AttendeeCapabilities.

When using capabilities, be aware of these corner cases:

If you specify MeetingFeatures:Video:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Video will be rejected with ValidationError 400.
If you specify MeetingFeatures:Content:MaxResolution:None when you create a meeting, all API requests that include SendReceive, Send, or Receive for AttendeeCapabilities:Content will be rejected with ValidationError 400.
You can't set content capabilities to SendReceive or Receive unless you also set video capabilities to SendReceive or Receive. If you don't set the video capability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set your video capability to receive and you set your content capability to not receive.
When you change an audio capability from None or Receive to Send or SendReceive , and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants.
When you change a video or content capability from None or Receive to Send or SendReceive , and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.

Type: AttendeeCapabilities object

Required: No

ExternalUserId

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

Pattern: [-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

Values that begin with aws: are reserved. You can't configure a value that uses this prefix.

Type: String

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

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Attendee": { 
      "AttendeeId": "string",
      "Capabilities": { 
         "Audio": "string",
         "Content": "string",
         "Video": "string"
      },
      "ExternalUserId": "string",
      "JoinToken": "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.

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

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

ServiceFailureException

The service encountered an unexpected error.

HTTP Status Code: 500

ServiceUnavailableException

The service is currently unavailable.

HTTP Status Code: 503

ThrottlingException

The number of customer requests exceeds the request rate limit.

HTTP Status Code: 429

UnauthorizedException

The user isn't authorized to request a resource.

HTTP Status Code: 401

UnprocessableEntityException

The request was well-formed but was unable to be followed due to semantic errors.

HTTP Status Code: 422