Categories
General Information Chat Knowledge Base List of errors

Chat Classes

Chat configuration class - UsedeskChatConfiguration:
Property Type Description
urlChat String Chat server address
urlOfflineForm String Address for sending feedback form data (standard https://secure.usedesk.ru/)
urlToSendFile String Address for sending chat files (standard https://secure.usedesk.ru/uapi/v1/)
companyId String Company ID
clientEmail String Client Email
clientName String? Client name
clientPhoneNumber Long? Client phone number
clientAdditionalId Long? Additional client ID
clientInitMessage String? Message from a client when opening a chat

Abstract message class - UsedeskMessage:
Property Type Description
id Long Message ID
createdAt Calendar Date of message creation
type UsedeskMessage.Type Message type (TYPE_AGENT_TEXT, TYPE_AGENT_IMAGE, TYPE_AGENT_FILE, TYPE_CLIENT_TEXT, TYPE_CLIENT_IMAGE, TYPE_CLIENT_FILE)


Agent message interface - UsedeskMessageAgent:
Property Type Description
name String Agent's name
avatar String Link to the agent icon

Client message interface - UsedeskMessageClient:
Property Type Description
status UsedeskMessageClient.Status Message sending status (SENDING, SUCCESSFULLY_SENT, SEND_FAILED, RECEIVED)


Text message class - UsedeskMessageText: UsedeskMessage:
Property Type Description
text String Text message

File message class - UsedeskMessageFile: UsedeskMessage:
Property Type Description
file UsedeskFile Message file

Agent text message class - UsedeskMessageAgentText: UsedeskMessageText, UsedeskMessageAgent:
Property Type Description
type UsedeskMessage.Type Message type (TYPE_AGENT_TEXT)
buttons List Message action buttons
feedbackNeeded Boolean Waiting for user feedback flag
feedback UsedeskFeedback? Posted feedback from the user


Agent file message class - UsedeskMessageAgentFile: UsedeskMessageFile, UsedeskMessageAgent:
Property Type Description
type UsedeskMessage.Type Message Type (TYPE_AGENT_FILE)

The class of the message with the agent image is UsedeskMessageAgentImage: UsedeskMessageFile, UsedeskMessageAgent:
Property Type Description
type UsedeskMessage.Type Message Type (TYPE_AGENT_IMAGE)

Client Text Message Class - UsedeskMessageClientText: UsedeskMessageText, UsedeskMessageClient:
Property Type Description
type UsedeskMessage.Type Message Type (TYPE_CLIENT_TEXT)

Client file message class - UsedeskMessageClientFile: UsedeskMessageFile, UsedeskMessageClient:
Property Type Description
type UsedeskMessage.Type Message Type(TYPE_CLIENT_FILE)

Client image message class - UsedeskMessageClientImage: UsedeskMessageFile, UsedeskMessageClient:
Property Type Description
type UsedeskMessage.Type Message Type (TYPE_CLIENT_IMAGE)


Device file information class - UsedeskFileInfo:
Property Type Description
uri Uri Link to the file
type String MIME type of the file
name String File name

Server file information class - UsedeskFile:
Property Type Description
content String Link to the file
type String MIME type of the file
size StringFile size
name String File name


Feedback form class - UsedeskOfflineForm:
Property Type Description
clientName String Client name
clientEmail String Client Email
message String Client text message