/AWS1/CL_IVREXCHGDPARTICTOKEN¶
Object specifying an exchanged participant token in a stage, created when an original participant token is updated.
Important: Treat tokens as opaque; i.e., do not build functionality based on token contents. The format of tokens could change in the future.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
it_capabilities TYPE /AWS1/CL_IVRPARTICIPANTTOKCA00=>TT_PARTICIPANTTOKCAPABILITIES TT_PARTICIPANTTOKCAPABILITIES¶
Set of capabilities that the user is allowed to perform in the stage.
it_attributes TYPE /AWS1/CL_IVRPARTICIPANTTOKAT00=>TT_PARTICIPANTTOKENATTRIBUTES TT_PARTICIPANTTOKENATTRIBUTES¶
Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
iv_userid TYPE /AWS1/IVRPARTICIPANTTOKUSERID /AWS1/IVRPARTICIPANTTOKUSERID¶
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. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
iv_expirationtime TYPE /AWS1/IVRPARTICIPANTTOKEXPTIME /AWS1/IVRPARTICIPANTTOKEXPTIME¶
ISO 8601 timestamp (returned as a string) for when this token expires.
Queryable Attributes¶
capabilities¶
Set of capabilities that the user is allowed to perform in the stage.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CAPABILITIES() |
Getter for CAPABILITIES, with configurable default |
ASK_CAPABILITIES() |
Getter for CAPABILITIES w/ exceptions if field has no value |
HAS_CAPABILITIES() |
Determine if CAPABILITIES has a value |
attributes¶
Application-provided attributes to encode into the token and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ATTRIBUTES() |
Getter for ATTRIBUTES, with configurable default |
ASK_ATTRIBUTES() |
Getter for ATTRIBUTES w/ exceptions if field has no value |
HAS_ATTRIBUTES() |
Determine if ATTRIBUTES has a value |
userId¶
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. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_USERID() |
Getter for USERID, with configurable default |
ASK_USERID() |
Getter for USERID w/ exceptions if field has no value |
HAS_USERID() |
Determine if USERID has a value |
expirationTime¶
ISO 8601 timestamp (returned as a string) for when this token expires.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EXPIRATIONTIME() |
Getter for EXPIRATIONTIME, with configurable default |
ASK_EXPIRATIONTIME() |
Getter for EXPIRATIONTIME w/ exceptions if field has no valu |
HAS_EXPIRATIONTIME() |
Determine if EXPIRATIONTIME has a value |