Method
Clear the message history of a Deployment Conversation.
REQUIRED |
KEY |
TYPE |
DESCRIPTION |
No |
deploymentConversationId |
str |
A unique string identifier associated with the deployment conversation.
|
No |
externalSessionId |
str |
The external session id associated with the deployment conversation.
|
No |
deploymentId |
str |
The deployment this conversation belongs to. This is required if not logged in.
|
No |
userMessageIndices |
list |
Optional list of user message indices to clear. The associated bot response will also be cleared. If not provided, all messages will be cleared.
|
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.
KEY |
TYPE |
DESCRIPTION |
success |
Boolean |
true if the call succeeded, false if there was an error |
TYPE |
WHEN |
DataNotFoundError |
`deploymentConversationId` is not found. |
DataNotFoundError |
`externalSessionId` is not found. |
DataNotFoundError |
`deploymentId` is not found. |