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:
- Drag and drop the Update conversation node from the Node palette from the left side of the screen.
- Double-click the Update conversation node to view the configuration settings.
- Choose Fetch transcript from the Method Name drop-down list.
- 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. - In the Conversation ID field, enter an appropriate variable that contains WxEngage's conversation ID (e.g.$(n6.conversationId)).
Pagination
- 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.
- 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.
- Click Save.
Output variables
Variable | Description |
---|---|
transcriptJsonEsc | An escaped JSON payload containing array of messages |
countOfRecords | Refers to the total number of messages currently held against the conversation ID. Use this to fetch all records by calculating Pagination fields. |
status | Status enum - Success / Failure |
apiStatus | HTTP status code from the underlying response received from WxEngage's REST API |
code | Numeric code received from WxEngage's API response |
description | Description received from WxEngage's API response |
responsePayload | Raw WxEngage's API response payload (JSON string) |
Node outcomes
Category | Outcome | Description |
---|---|---|
Success | success | Node execution successful |
Errors | onTimeout | Could not receive an API response from WxEngage within the agreed time-out |
onInvalidData | Invalid data configured in WxConnect node | |
onError | Error in WxConnect's middleware services | |
onInvalidChoice | Invalid choice | |
onauthorizationfail | Failed to Authorize successfully. We recommend you to recheck your Node Authorization configurations in the Authorize Integration section | |
Failure | Any other run time failures |
Updated 16 days ago