Fetch conversation transcript

While configuring flows in the Webex Connect, you may use this node to read a conversation history. This node utilizes the Fetch conversation API from Webex Engage to read the respective conversation's transcript.

Configure

To configure a Fetch conversation transcript node, follow these steps:

  1. Drag and drop the Update conversation node from the Node palette from the left side of the screen.
  2. Double-click the Update conversation node to view the configuration settings.
  1. Choose Fetch transcript from the Method Name drop-down list.
  2. Choose Authorization from the Node Runtime Authorization drop-down list.
    We recommend you set Authorization to a Default Authentication configured in WxEngage's Integrations screen under WxConnect's Integrations. Once you re-authenticate from the Integrations screen, all your nodes across flows will pick up the updated token.
  3. In the Conversation ID field, enter an appropriate variable that contains WxEngage's conversation ID (e.g.$(n6.conversationId)).

Pagination

  1. In the Offset field, enter an offset value to skip the configured number of records in the response. This is useful when parsing a paginated response and looping through this node.
  2. In the Offset field, enter a limit value to control the number of records in the response. This is especially useful when parsing a paginated response and iterating through this node. The maximum value allowed for this field is 500, while the default value is 10.
  3. Click Save.

Output variables

VariableDescription
transcriptJsonEscAn escaped JSON payload containing array of messages
countOfRecordsRefers to the total number of messages currently held against the conversation ID. Use this to fetch all records by calculating Pagination fields.
statusStatus enum - Success / Failure
apiStatusHTTP status code from the underlying response received from WxEngage's REST API
codeNumeric code received from WxEngage's API response
descriptionDescription received from WxEngage's API response
responsePayloadRaw WxEngage's API response payload (JSON string)

Node outcomes

CategoryOutcomeDescription
SuccesssuccessNode execution successful
ErrorsonTimeoutCould not receive an API response from WxEngage within the agreed time-out
onInvalidDataInvalid data configured in WxConnect node
onErrorError in WxConnect's middleware services
onInvalidChoiceInvalid choice
onauthorizationfailFailed to Authorize successfully. We recommend you to recheck your Node Authorization configurations in the Authorize Integration section
FailureAny other run time failures