/AWS1/CL_CNT=>STARTWEBRTCCONTACT()¶
About 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).
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_CONTACTFLOWID TYPE /AWS1/CNTCONTACTFLOWID /AWS1/CNTCONTACTFLOWID¶
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, Contact 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
IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID /AWS1/CNTINSTANCEID¶
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
IO_PARTICIPANTDETAILS TYPE REF TO /AWS1/CL_CNTPARTICIPANTDETAILS /AWS1/CL_CNTPARTICIPANTDETAILS¶
ParticipantDetails
Optional arguments:¶
IT_ATTRIBUTES TYPE /AWS1/CL_CNTATTRIBUTES_W=>TT_ATTRIBUTES TT_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.
IV_CLIENTTOKEN TYPE /AWS1/CNTCLIENTTOKEN /AWS1/CNTCLIENTTOKEN¶
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services 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.
IO_ALLOWEDCAPABILITIES TYPE REF TO /AWS1/CL_CNTALWEDCAPABILITIES /AWS1/CL_CNTALWEDCAPABILITIES¶
Information about the video sharing capabilities of the participants (customer, agent).
IV_RELATEDCONTACTID TYPE /AWS1/CNTCONTACTID /AWS1/CNTCONTACTID¶
The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.
IT_REFERENCES TYPE /AWS1/CL_CNTREFERENCE=>TT_CONTACTREFERENCES TT_CONTACTREFERENCES¶
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|ATTACHMENTis not a supported reference type during task creation.
IV_DESCRIPTION TYPE /AWS1/CNTDESCRIPTION /AWS1/CNTDESCRIPTION¶
A description of the task that is shown to an agent in the Contact Control Panel (CCP).