/AWS1/CL_IVR=>LISTPARTICIPANTS()
¶
About ListParticipants¶
Lists all participants in a specified stage session.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_STAGEARN
TYPE /AWS1/IVRSTAGEARN
/AWS1/IVRSTAGEARN
¶
Stage ARN.
IV_SESSIONID
TYPE /AWS1/IVRSTAGESESSIONID
/AWS1/IVRSTAGESESSIONID
¶
ID of the session within the stage.
Optional arguments:¶
IV_FILTERBYUSERID
TYPE /AWS1/IVRUSERID
/AWS1/IVRUSERID
¶
Filters the response list to match the specified user ID. Only one of
filterByUserId
,filterByPublished
,filterByState
, orfilterByRecordingState
can be provided per request. AuserId
is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.
IV_FILTERBYPUBLISHED
TYPE /AWS1/IVRPUBLISHED
/AWS1/IVRPUBLISHED
¶
Filters the response list to only show participants who published during the stage session. Only one of
filterByUserId
,filterByPublished
,filterByState
, orfilterByRecordingState
can be provided per request.
IV_FILTERBYSTATE
TYPE /AWS1/IVRPARTICIPANTSTATE
/AWS1/IVRPARTICIPANTSTATE
¶
Filters the response list to only show participants in the specified state. Only one of
filterByUserId
,filterByPublished
,filterByState
, orfilterByRecordingState
can be provided per request.
IV_NEXTTOKEN
TYPE /AWS1/IVRPAGINATIONTOKEN
/AWS1/IVRPAGINATIONTOKEN
¶
The first participant to retrieve. This is used for pagination; see the
nextToken
response field.
IV_MAXRESULTS
TYPE /AWS1/IVRMAXPARTICIPANTRESULTS
/AWS1/IVRMAXPARTICIPANTRESULTS
¶
Maximum number of results to return. Default: 50.
IV_FILTERBYRECORDINGSTATE
TYPE /AWS1/IVRPARTICIPANTRCINGFIL00
/AWS1/IVRPARTICIPANTRCINGFIL00
¶
Filters the response list to only show participants with the specified recording state. Only one of
filterByUserId
,filterByPublished
,filterByState
, orfilterByRecordingState
can be provided per request.