getAgentInput()

Returns the string of text which is currently 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 retrieve the agent’s input text.
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
textStringThe text that is currently in an agent’s text input area.
successBooleantrue if getting the agent’s input was successful; false if getting the agent’s input wasn’t successful.