API reference
Errors
RTVIError
Base RTVIClient
error type. status:number
: unique identifier (or HTTP code
if applicable) message:string
: explanation of error
ConnectionTimeoutError
Bot did not enter a ready state within the specified timeout
constructor
param.
StartBotError
Invalid response from the provided params.baseUrl
route. This may be due to the base URL being unavailable, or failure to parse the provided configuration.
Any error text returned by the base URL endpoint will be referenced in the message
property.
status:number
returned HTTP status codemessage:string
Verbose error message (if provided viainfo
response)error:string
Error type (defaults toinvalid-request-error
)
TransportStartError
Transport was not able to connect. Check the auth bundle returned by the baseUrl is valid.
BotNotReadyError
Client attempted an action or method that requires the bot to be in a ready
state. You must call connect
first and wait for the bot to be ready.
ConfigUpdateError
Bot was unable to parse provided configuration properties.