RocketNet.Chat 1.2.0

<img src="https://raw.githubusercontent.com/ai-iskuzhin/RocketNet.Chat/main/assets/logo.png" width="128" alt="RocketNet.Chat logo" />

RocketNet.Chat

Unofficial .NET SDK for the Rocket.Chat REST API — find a user by username or email, open the private chat with them, and post a message.

Not affiliated with Rocket.Chat Technologies Corp.; developed independently.

Install

dotnet add package RocketNet.Chat

Targets netstandard2.0, net8.0 and net10.0.

Quick start

using RocketNet.Chat;

using var httpClient = new HttpClient();

var client = new RocketChatClient(httpClient, new RocketChatClientOptions
{
    BaseAddress = new Uri("https://chat.example.com/"),   // workspace root, not the API root
    UserId    = "rbAXPnMktTFbNpwtJ",                      // My Account → Personal Access Tokens
    AuthToken = "RScctEHSmLGZ..."                         // keep it in secrets
});

// Look the user up, open the private chat, post into it.
var posted = await client.SendDirectMessageAsync(
    RocketChatUserQuery.ByEmail("kim@example.com"),
    "Deploy finished ✅");

Console.WriteLine(posted.Message?.Id);

Supported methods

Reading a channel, including any uploaded media:

var page = await client.GetHistoryAsync(
    RocketChatRoomQuery.Channel("#channel_test"),
    new RocketChatHistoryOptions { Count = 50 });

foreach (var message in page.WithFiles)
    foreach (var attachment in message.FileAttachments)
        Console.WriteLine(client.BuildFileUri(attachment.FileUrl!));

A private channel is a group in the API — address it with RocketChatRoomQuery.PrivateChannel(...), not Channel(...).

Authenticate with a personal access token through RocketChatClientOptions, or exchange a password for a session with LoginAsync and pass it per call. Every method accepts an optional RocketChatSession that overrides the configured credentials.

Errors derive from RocketChatException: RocketChatValidationException (rejected locally), RocketChatTransportException (no response), RocketChatApiException (the workspace said no) and RocketChatProtocolException (unreadable response).

Full documentation: https://github.com/ai-iskuzhin/RocketNet.Chat.

License

MIT.