setAgentInput()

Sets the string of text in the agent’s text input area in the chat log of a chat with a specific chat key.Available in API version 29.0 or later.

NameTypeDescription
chatKeyStringThe chatKey associated with the chat for which to set the agent’s input text.
textStringThe string of text which you want to set into an agent’s input.
callbackfunctionJavaScript method called upon completion of the method.

This method is asynchronous so it returns its response in an object in a callback method. The response object contains the following properties:

NameTypeDescription
successBooleantrue if setting the agent’s input was successful; false if setting the agent’s input wasn’t successful.