api

package

Go to main page

Versions in this module

v0

v0.2.18

Mar 8, 2026

Changes in this version

+ func IsEventStreamDisconnect(err error) bool

type Chat

+ IsUnread bool

type Client

+ func (c *Client) BaseURL() string

+ func (c *Client) DeleteJSON(ctx context.Context, path string, body any) (*http.Response, error)

+ func (c *Client) OpenEventStream(ctx context.Context) (*EventStream, error)

+ func (c *Client) RetrieveInfo(ctx context.Context) (InfoResponse, error)

+ type EventEnvelope struct

+ ChatID string

+ ChatIDs []string

+ Code string

+ Entries []json.RawMessage

+ IDs []string

+ Message string

+ RequestID string

+ Seq int64

+ TS int64

+ Type string

+ Version int

+ func (e EventEnvelope) IsControl() bool

+ func (e EventEnvelope) Timestamp() time.Time

+ type EventStream struct

+ func (s *EventStream) Close() error

+ func (s *EventStream) Next(ctx context.Context) (EventEnvelope, error)

+ func (s *EventStream) SetSubscriptions(ctx context.Context, chatIDs []string, requestID string) error

+ type InfoApp struct

+ BundleID string

+ Name string

+ Version string

+ type InfoEndpoints struct

+ MCP string

+ Spec string

+ WSEvents string

+ type InfoPlatform struct

+ Arch string

+ OS string

+ Release string

+ type InfoResponse struct

+ App InfoApp

+ Endpoints InfoEndpoints

+ Platform InfoPlatform

+ Server InfoServer

+ type InfoServer struct

+ BaseURL string

+ Hostname string

+ MCPEnabled bool

+ Port int

+ RemoteAccess bool

+ Status string

type Message

+ LinkedMessageID string

type ReactionRequest

+ ReactionKey string

type ReminderRequest

+ DismissOnIncomingMessage bool

+ type SubscriptionSetRequest struct

+ ChatIDs []string

+ RequestID string

+ Type string

v0.2.17

Mar 5, 2026

v0.2.16

Feb 23, 2026

v0.2.15

Feb 22, 2026

v0.2.14

Feb 22, 2026

Changes in this version

type Client

+ func (c *Client) PostMultipart(ctx context.Context, path, fieldName, fileName string, file io.Reader, ...) (*http.Response, error)

+ func (c *Client) Put(ctx context.Context, path string, body any) (*http.Response, error)

+ type Contact struct

+ CannotMessage bool

+ Email string

+ FullName string

+ ID string

+ ImgURL string

+ IsSelf bool

+ PhoneNumber string

+ Username string

+ type CreateChatRequest struct

+ AccountID string

+ MessageText string

+ ParticipantIDs []string

+ Title string

+ Type string

+ type CreateChatResponse struct

+ ChatID string

+ type DownloadAssetRequest struct

+ URL string

+ type DownloadAssetResponse struct

+ Error string

+ SrcURL string

+ type EditMessageRequest struct

+ Text string

+ type EditMessageResponse struct

+ ChatID string

+ MessageID string

+ Success bool

+ type SearchContactsResponse struct

+ Items []Contact

+ type SendMessageAttachment struct

+ Duration int

+ FileName string

+ MimeType string

+ Size *AttachmentSize

+ Type string

+ UploadID string

type SendMessageRequest

+ Attachment *SendMessageAttachment

+ type UploadAssetBase64Request struct

+ Content string

+ FileName string

+ MimeType string

+ type UploadAssetResponse struct

+ Duration int

+ Error string

+ FileName string

+ FileSize int

+ Height int

+ MimeType string

+ SrcURL string

+ UploadID string

+ Width int

v0.2.13

Feb 18, 2026

v0.2.12

Feb 7, 2026

v0.2.11

Feb 7, 2026

v0.2.10

Feb 6, 2026

v0.2.9

Feb 6, 2026

v0.2.8

Feb 6, 2026

v0.2.7

Feb 6, 2026

v0.2.6

Feb 6, 2026

v0.2.5

Feb 2, 2026

v0.2.4

Feb 2, 2026

v0.2.3

Feb 2, 2026

v0.2.2

Jan 28, 2026

v0.2.1

Jan 28, 2026

v0.2.0

Jan 14, 2026

Changes in this version

+ type FlexibleEmoji string

+ func (fe *FlexibleEmoji) UnmarshalJSON(data []byte) error

+ func (fe FlexibleEmoji) String() string

v0.1.8

Jan 13, 2026

Changes in this version

+ type FlexibleString string

+ func (fs *FlexibleString) UnmarshalJSON(data []byte) error

+ func (fs FlexibleString) String() string

v0.1.7

Jan 13, 2026

Changes in this version

+ func DecodeJSON(resp *http.Response, out any) error

type ClientOption

+ func WithDebugWriter(w io.Writer) ClientOption

v0.1.6

Jan 1, 2026

Changes in this version

+ type Attachment struct

+ Duration int

+ FileName string

+ FileSize int

+ IsGif bool

+ IsSticker bool

+ IsVoiceNote bool

+ MimeType string

+ PosterImg string

+ Size AttachmentSize

+ SrcURL string

+ Type string

+ type AttachmentSize struct

+ Height int

+ Width int

type Chat

+ Description string

+ LastReadMessageSortKey string

type ListChatsResponse

+ NewestCursor string

+ OldestCursor string

type Message

+ Attachments []Attachment

+ IsSender bool

+ IsUnread bool

+ Reactions []Reaction

+ SenderName string

+ SortKey string

+ type Reaction struct

+ Emoji string

+ ID string

+ ImgURL string

+ ParticipantID string

+ ReactionKey string

+ type ReactionRequest struct

+ Emoji string

v0.1.5

Dec 29, 2025

v0.1.4

Dec 29, 2025

Changes in this version

type Account

+ Network string

+ User *AccountUser

+ type AccountUser struct

+ DisplayText string

+ Email string

+ FullName string

+ ID string

+ ImgURL string

+ IsSelf bool

+ PhoneNumber string

+ Username string

type SendMessageResponse

+ ChatID string

+ PendingMessageID string

v0.1.3

Dec 28, 2025

v0.1.2

Dec 28, 2025

v0.1.1

Dec 28, 2025

v0.1.0

Dec 27, 2025

Changes in this version

+ const CircuitBreakerResetTime

+ const CircuitBreakerThreshold

+ const DefaultBaseURL

+ const DefaultHTTPTimeout

+ const Max5xxRetries

+ const MaxRateLimitRetries

+ const RateLimitBaseDelay

+ const ServerErrorRetryDelay

+ func IsNotFound(err error) bool

+ func IsUnauthorized(err error) bool

+ func ParseError(resp *http.Response) error

+ func ParseErrorWithContext(resp *http.Response, context string) error

+ func UserFriendlyError(err error) error

+ type APIError struct

+ Code string

+ Message string

+ StatusCode int

+ func (e *APIError) Error() string

+ type Account struct

+ ID string

+ NetworkIcon string

+ NetworkName string

+ ProfileEmail string

+ ProfileName string

+ ProfilePhone string

+ ProfileUsername string

+ type Chat struct

+ AccountID string

+ ID string

+ IsArchived bool

+ IsMuted bool

+ IsPinned bool

+ LastActivity time.Time

+ LocalChatID string

+ Network string

+ Participants *ParticipantList

+ Preview *MessagePreview

+ ReminderAt *time.Time

+ Title string

+ Type string

+ UnreadCount int

+ type Client struct

+ func NewClient(baseURL, token string, opts ...ClientOption) *Client

+ func (c *Client) Delete(ctx context.Context, path string) (*http.Response, error)

+ func (c *Client) Do(ctx context.Context, req *http.Request) (*http.Response, error)

+ func (c *Client) Get(ctx context.Context, path string) (*http.Response, error)

+ func (c *Client) Post(ctx context.Context, path string, body any) (*http.Response, error)

+ type ClientOption func(*Client)

+ func WithDebug(debug bool) ClientOption

+ type FocusRequest struct

+ ChatID string

+ DraftAttachmentPath string

+ DraftText string

+ MessageID string

+ type GetAccountsResponse struct

+ Accounts []Account

+ type ListChatsResponse struct

+ Cursor string

+ HasMore bool

+ Items []Chat

+ Total int

+ type ListMessagesResponse struct

+ Cursor string

+ HasMore bool

+ Items []Message

+ type Message struct

+ AccountID string

+ ChatID string

+ ID string

+ IsMe bool

+ ReplyTo *Message

+ Sender string

+ SenderID string

+ Text string

+ Timestamp time.Time

+ type MessagePreview struct

+ Sender string

+ Text string

+ Timestamp time.Time

+ type Participant struct

+ FullName string

+ ID string

+ ImgURL string

+ IsAdmin bool

+ IsSelf bool

+ IsVerified bool

+ PhoneNumber string

+ Username string

+ type ParticipantList struct

+ Items []Participant

+ type ReminderRequest struct

+ Reminder ReminderTime

+ type ReminderTime struct

+ RemindAtMs int64

+ func NewReminderTime(t time.Time) ReminderTime

+ type SearchMessagesResponse struct

+ Chats map[string]Chat

+ Cursor string

+ HasMore bool

+ Messages []Message

+ type SearchResponse struct

+ Chats []Chat

+ HasMore bool

+ Messages []Message

+ type SendMessageRequest struct

+ ReplyToMessageID string

+ Text string

+ type SendMessageResponse struct

+ Deeplink string

+ MessageID string

+ type ValidationError struct

+ Code string

+ Expected string

+ Message string

+ Path []string

+ Received string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL