CREATEPARTICIPANT()`¶

About CreateParticipant¶

Adds a new participant into an on-going chat contact or webRTC call. For more information, see Customize chat flow experiences by integrating custom participants or Enable multi-user web, in-app, and video calling.

Method Signature¶

IMPORTING¶

Required arguments:¶

`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.

`iv_contactid` `TYPE /AWS1/CNTCONTACTID` `/AWS1/CNTCONTACTID`¶

The identifier of the contact in this instance of Amazon Connect. Supports contacts in the CHAT channel and VOICE (WebRTC) channels. For WebRTC calls, this should be the initial contact ID that was generated when the contact was first created (from the StartWebRTCContact API) in the VOICE channel

`io_participantdetails` `TYPE REF TO /AWS1/CL_CNTPARTICIPANTDETST00` `/AWS1/CL_CNTPARTICIPANTDETST00`¶

Information identifying the participant.

The only valid value for ParticipantRole is CUSTOM_BOT for chat contact and CUSTOMER for voice contact.

Optional arguments:¶

`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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cntcreparticipantrsp` `/AWS1/CL_CNTCREPARTICIPANTRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_cnt~createparticipant(
  io_participantdetails = new /aws1/cl_cntparticipantdetst00(
    io_participantcapabilities = new /aws1/cl_cntparticipantcapab00(
      iv_screenshare = |string|
      iv_video = |string|
    )
    iv_displayname = |string|
    iv_participantrole = |string|
  )
  iv_clienttoken = |string|
  iv_contactid = |string|
  iv_instanceid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_participanttokencredent = lo_result->get_participantcredentials( ).
  IF lo_participanttokencredent IS NOT INITIAL.
    lv_participanttoken = lo_participanttokencredent->get_participanttoken( ).
    lv_iso8601datetime = lo_participanttokencredent->get_expiry( ).
  ENDIF.
  lv_participantid = lo_result->get_participantid( ).
ENDIF.

/AWS1/IF_CNT=>CREATEPARTICIPANT()¶