Overview: Chat UI

We've listed the available Chat UI API reference for the iOS SDK below. Each entry links to a page that provides code samples for the individual entry.

Show chat availability

Is Chat available?

Returns the current chat availability for an organization.

Open chat conversations

Open new conversation

Opens a new conversation, or opens a new conversation with a message.

Open conversation by id

Opens a conversation based on the conversationId.

Open conversational assistants (chatbots) from the chat

Open conversational assistant by id

Opens a conversational assistant based on the assistant id.

Open Knowledge Base articles from the chat

Open Knowledge Base article by id

Opens a Knowledge Base article based on the article id.

Update information about a customer or conversation

Describe Customer

Updates information about a Customer object in Kustomer.

Describe Conversation

Updates information about a Conversation object in Kustomer.

Show the number of unread, active, and open conversations

Observe unread count

Shows the count of unread messages.

Observe active conversation ids

Shows the count of active conversations.