Skip to content

Types

Pydantic models returned by SDK methods. All fields map 1:1 to Chatwoot API response fields.

Common

common

Common types and enums used across resources.

ConversationStatus

Bases: str, Enum

Status of a conversation.

MessageType

Bases: str, Enum

Type of message.

MessageContentType

Bases: str, Enum

Content type of message.

AgentRole

Bases: str, Enum

Role of an agent in the account.

AvailabilityStatus

Bases: str, Enum

Availability status of an agent.

ConversationPriority

Bases: str, Enum

Priority of a conversation.

ChannelType

Bases: str, Enum

Type of inbox channel.

PaginationMeta

Bases: BaseModel

Metadata for paginated responses.


Conversation

conversation

Type definitions for conversations.

ConversationContact

Bases: BaseModel

Contact information in a conversation.

ConversationInbox

Bases: BaseModel

Inbox information in a conversation.

ConversationAssignee

Bases: BaseModel

Assignee information in a conversation.

ConversationTeam

Bases: BaseModel

Team information in a conversation.

ConversationMeta

Bases: BaseModel

Metadata for conversation.

Conversation

Bases: BaseModel

Conversation information.

ConversationToggleStatusResponse

Bases: BaseModel

Response from toggling conversation status.


Message

message

Type definitions for messages.

MessageAttachment

Bases: BaseModel

Message attachment information.

MessageSender

Bases: BaseModel

Message sender information.

Message

Bases: BaseModel

Message information.


Contact

contact

Type definitions for contacts.

ContactInbox

Bases: BaseModel

Contact's inbox association.

Contact

Bases: BaseModel

Contact information.

ContactCreateResponse

Bases: BaseModel

Response from creating a contact.


Profile

profile

Type definitions for user profile.

ProfileAccount

Bases: BaseModel

Account associated with user profile.

Profile

Bases: BaseModel

User profile information.


Agent

agent

Type definitions for agents.

Agent

Bases: BaseModel

Agent information.


Inbox

inbox

Type definitions for inboxes.

Inbox

Bases: BaseModel

Inbox information.


Label

label

Type definitions for labels.

Label

Bases: BaseModel

Label information.


Team

team

Type definitions for teams.

Team

Bases: BaseModel

Team information.