API for Amazon Connect Participant Service¶

ABAP Package	`/AWS1/API_CNP_IMPL`
ABAP SDK "TLA"	`CNP`
ABAP Interface	`/AWS1/IF_CNP`

The "TLA" is a Three Letter Abbreviation that appears in ABAP class names, data dictionary objects and other ABAP objects throughout the AWS SDK for SAP ABAP. The TLA for Amazon Connect Participant Service is CNP. This TLA helps squeeze ABAP objects into the 30-character length limit of the ABAP data dictionary.

Installation¶

To install the AWS SDK for SAP ABAP, import the Core transport, along with the transport for the ConnectParticipant module and other API modules you are interested in. A few modules are included in the Core transport itself. For more information, see the Developer Guide guide.

About The Service¶

Amazon Connect is an easy-to-use omnichannel cloud contact center service that enables companies of any size to deliver superior customer service at a lower cost. Amazon Connect communications capabilities make it easy for companies to deliver personalized interactions across communication channels, including chat.

Use the Amazon Connect Participant Service to manage participants (for example, agents, customers, and managers listening in), and to send messages and events within a chat contact. The APIs in the service enable the following: sending chat messages, attachment sharing, managing a participant's connection state and message events, and retrieving chat transcripts.

Using the SDK¶

In your code, create a client using the SDK module for Amazon Connect Participant Service, which is created with factory method /AWS1/CL_CNP_FACTORY=>create(). In this example we will assume you have configured an SDK profile in transaction /AWS1/IMG called ZFINANCE.

DATA(go_session)   = /aws1/cl_rt_session_aws=>create( 'ZFINANCE' ).
DATA(go_cnp)       = /aws1/cl_cnp_factory=>create( go_session ).

Your variable go_cnp is an instance of /AWS1/IF_CNP, and all of the operations in the Amazon Connect Participant Service service are accessed by calling methods in /AWS1/IF_CNP.

API Operations¶

For an overview of ABAP method calls corresponding to API operations in Amazon Connect Participant Service, see the Operation List.

Factory Method¶

`/AWS1/CL_CNP_FACTORY=>create( )`¶

Creates an object of type /AWS1/IF_CNP.

IMPORTING¶

Optional arguments:¶

`IV_PROTOCOL` `TYPE /AWS1/RT_PROTOCOL` `/AWS1/RT_PROTOCOL`¶

`IO_SESSION` `TYPE REF TO /AWS1/CL_RT_SESSION_BASE` `/AWS1/CL_RT_SESSION_BASE`¶

`IV_REGION` `TYPE /AWS1/RT_REGION_ID` `/AWS1/RT_REGION_ID`¶

`IV_CUSTOM_ENDPOINT` `TYPE /AWS1/RT_ENDPOINT` `/AWS1/RT_ENDPOINT`¶

RETURNING¶

`OO_CLIENT` `TYPE REF TO /AWS1/IF_CNP` `/AWS1/IF_CNP`¶

/AWS1/IF_CNP represents the ABAP client for the ConnectParticipant service, representing each operation as a method call. For more information see the API Page page.

Configuring Programmatically¶

DATA(lo_config) = DATA(go_cnp)->get_config( ).

lo_config is a variable of type /AWS1/CL_CNP_CONFIG. See the documentation for /AWS1/CL_CNP_CONFIG for details on the settings that can be configured.

Paginators¶

Paginators for Amazon Connect Participant Service can be created via get_paginator() which returns a paginator object of type /AWS1/IF_CNP_PAGINATOR. The operation method that is being paginated is called using the paginator object, which accepts any necessary parameters to provide to the underlying API operation. This returns an iterator object which can be used to iterate over paginated results using has_next() and get_next() methods.

Details about the paginator methods available for service Amazon Connect Participant Service can be found in interface /AWS1/IF_CNP_PAGINATOR.