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

StartWebRTCContact

Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId).

Request Syntax


PUT /contact/webrtc HTTP/1.1
Content-type: application/json

{
   "AllowedCapabilities": { 
      "Agent": { 
         "ScreenShare": "string",
         "Video": "string"
      },
      "Customer": { 
         "ScreenShare": "string",
         "Video": "string"
      }
   },
   "Attributes": { 
      "string" : "string" 
   },
   "ClientToken": "string",
   "ContactFlowId": "string",
   "Description": "string",
   "InstanceId": "string",
   "ParticipantDetails": { 
      "DisplayName": "string"
   },
   "References": { 
      "string" : { 
         "Arn": "string",
         "Status": "string",
         "StatusReason": "string",
         "Type": "string",
         "Value": "string"
      }
   },
   "RelatedContactId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

AllowedCapabilities

Information about the video sharing capabilities of the participants (customer, agent).

Type: AllowedCapabilities object

Required: No

Attributes

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, -, and _ characters.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 32767.

Value Length Constraints: Minimum length of 0. Maximum length of 32767.

Required: No

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

Type: String

Length Constraints: Maximum length of 500.

Required: No

ContactFlowId

The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

Type: String

Length Constraints: Maximum length of 500.

Required: Yes

Description

A description of the task that is shown to an agent in the Contact Control Panel (CCP).

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Required: No

InstanceId

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

ParticipantDetails

The customer's details.

Type: ParticipantDetails object

Required: Yes

References

A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL. ATTACHMENT is not a supported reference type during task creation.

Type: String to Reference object map

Key Length Constraints: Minimum length of 1. Maximum length of 4096.

Required: No

RelatedContactId

The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ConnectionData": { 
      "Attendee": { 
         "AttendeeId": "string",
         "JoinToken": "string"
      },
      "Meeting": { 
         "MediaPlacement": { 
            "AudioFallbackUrl": "string",
            "AudioHostUrl": "string",
            "EventIngestionUrl": "string",
            "SignalingUrl": "string",
            "TurnControlUrl": "string"
         },
         "MediaRegion": "string",
         "MeetingFeatures": { 
            "Audio": { 
               "EchoReduction": "string"
            }
         },
         "MeetingId": "string"
      }
   },
   "ContactId": "string",
   "ParticipantId": "string",
   "ParticipantToken": "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.

ConnectionData

Information required for the client application (mobile application or website) to connect to the call.

Type: ConnectionData object

ContactId

The identifier of the contact in this instance of Amazon Connect.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

ParticipantId

The identifier for a contact participant. The ParticipantId for a contact participant is the same throughout the contact lifecycle.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

ParticipantToken

The token used by the contact participant to call the CreateParticipantConnection API. The participant token is valid for the lifetime of a contact participant.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Errors

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

InternalServiceException

Request processing failed because of an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

LimitExceededException

The allowed limit for the resource has been exceeded.

HTTP Status Code: 429

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404