Messages

Send and manage messages within conversations.

MessagesResource

MessagesResource(http: HTTPClient)

Bases: BaseResource

Synchronous messages resource.

list

list(
    account_id: int, conversation_id: int
) -> list[Message]

List messages in a conversation.

Parameters:

Name	Type	Description	Default
account_id	int	The account ID	required
conversation_id	int	The conversation ID	required

Returns:

Type	Description
list[Message]	List of Message objects

Examples:

>>> messages = client.messages.list(account_id=1, conversation_id=42)
... for msg in messages:
... print(msg.content)

create

create(
    account_id: int,
    conversation_id: int,
    content: str,
    message_type: str = "outgoing",
    private: bool = False,
    attachments: list[str] | None = None,
    **kwargs: Any,
) -> Message

Create/send a message in a conversation.

Parameters:

Name	Type	Description	Default
account_id	int	The account ID	required
conversation_id	int	The conversation ID	required
content	str	Message content	required
message_type	str	Type of message ('outgoing', 'incoming') (default: 'outgoing')	'outgoing'
private	bool	Whether message is private/internal (default: False)	False
attachments	list[str] | None	List of file paths to attach (optional)	None
**kwargs	Any	Additional message attributes	{}

Returns:

Type	Description
Message	Created Message object

Examples:

>>> message = client.messages.create(
... account_id=1,
... conversation_id=42,
... content="Hello, how can I help?",
... message_type="outgoing",
... private=False
... )

update

update(
    account_id: int, message_id: int, content: str
) -> Message

Update message content.

Parameters:

Name	Type	Description	Default
account_id	int	The account ID	required
message_id	int	The message ID	required
content	str	New message content	required

Returns:

Type	Description
Message	Updated Message object

Examples:

>>> message = client.messages.update(
... account_id=1,
... message_id=123,
... content="Updated message content"
... )

delete

delete(account_id: int, message_id: int) -> None

Delete a message.

Parameters:

Name	Type	Description	Default
account_id	int	The account ID	required
message_id	int	The message ID	required

Examples:

>>> client.messages.delete(account_id=1, message_id=123)

---

AsyncMessagesResource

AsyncMessagesResource(http: AsyncHTTPClient)

Bases: AsyncBaseResource

Asynchronous messages resource.

list async

list(
    account_id: int, conversation_id: int
) -> list[Message]

List messages in a conversation (async).

Parameters:

Name	Type	Description	Default
account_id	int	The account ID	required
conversation_id	int	The conversation ID	required

Returns:

Type	Description
list[Message]	List of Message objects

create async

create(
    account_id: int,
    conversation_id: int,
    content: str,
    message_type: str = "outgoing",
    private: bool = False,
    attachments: list[str] | None = None,
    **kwargs: Any,
) -> Message

Create/send a message in a conversation (async).

Parameters:

Name	Type	Description	Default
account_id	int	The account ID	required
conversation_id	int	The conversation ID	required
content	str	Message content	required
message_type	str	Type of message	'outgoing'
private	bool	Whether message is private	False
attachments	list[str] | None	List of file paths to attach	None
**kwargs	Any	Additional message attributes	{}

Returns:

Type	Description
Message	Created Message object

update async

update(
    account_id: int, message_id: int, content: str
) -> Message

Update message content (async).

Parameters:

Name	Type	Description	Default
account_id	int	The account ID	required
message_id	int	The message ID	required
content	str	New message content	required

Returns:

Type	Description
Message	Updated Message object

delete async

delete(account_id: int, message_id: int) -> None

Delete a message (async).

Parameters:

Name	Type	Description	Default
account_id	int	The account ID	required
message_id	int	The message ID	required