mirror of
https://github.com/sochix/TLSharp.git
synced 2025-12-06 08:02:00 +01:00
Merge branch 'master' of https://github.com/ppanhoto78/TLSharp
This commit is contained in:
Paulo Rogerio Panhoto
commit
4ca8b9568c
493
README.md
493
README.md
|
|
@ -1,261 +1,258 @@
|
|||
TLSharp
|
||||
-------------------------------
|
||||
|
||||
<a href="https://www.paypal.me/IPirozhenko" title="Support project"><img src="https://img.shields.io/badge/Support%20project-paypal-brightgreen.svg"></a>
|
||||
[](https://gitter.im/TLSharp/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](https://ci.appveyor.com/project/sochix/tlsharp)
|
||||
[](https://badge.fury.io/nu/TLSharp)
|
||||
<a href="https://github.com/sochix/telegram-tools"><img src=https://img.shields.io/badge/Telegram%20Tools-1.0.0-blue.svg /></a>
|
||||
_Unofficial_ Telegram (http://telegram.org) client library implemented in C#. Please refer to (https://github.com/sochix/TLSharp) for the original version and further documentation.
|
||||
|
||||
_Unofficial_ Telegram (http://telegram.org) client library implemented in C#. Latest TL scheme supported, thanks to Afshin Arani
|
||||
|
||||
It's a perfect fit for any developer who would like to send data directly to Telegram users or write own custom Telegram client.
|
||||
|
||||
:star2: If you :heart: library, please star it! :star2:
|
||||
|
||||
# News
|
||||
* **JavaScript Telegram Client**
|
||||
|
||||
Hi everyone! I want to create JavaScript client for Telegram, it will have next features:
|
||||
|
||||
* send & receieve messages from users/groups/channels
|
||||
* easy installation with npm or yarn
|
||||
* latest Telegram Schema
|
||||
* examples and documentation
|
||||
|
||||
If you like this idea, please leave your email [here](http://eepurl.com/cBXX8n).
|
||||
|
||||
* **TLSharp GUI**
|
||||
|
||||
If you have difficulties with console or writing code, you can try [Telegram Tools](https://github.com/sochix/telegram-tools). It's a GUI for TLSharp.
|
||||
|
||||
# Table of contents
|
||||
|
||||
- [How do I add this to my project?](#how-do-i-add-this-to-my-project)
|
||||
- [Dependencies](#dependencies)
|
||||
- [Starter Guide](#starter-guide)
|
||||
- [Quick configuration](#quick-configuration)
|
||||
- [First requests](#first-requests)
|
||||
- [Working with files](#working-with-files)
|
||||
- [Available Methods](#available-methods)
|
||||
- [Contributing](#contributing)
|
||||
- [FAQ](#faq)
|
||||
- [Donations](#donations)
|
||||
- [License](#license)
|
||||
|
||||
# How do I add this to my project?
|
||||
|
||||
Install via NuGet
|
||||
|
||||
```
|
||||
> Install-Package TLSharp
|
||||
```
|
||||
|
||||
or build from source
|
||||
|
||||
1. Clone TLSharp from GitHub
|
||||
1. Compile source with VS2015 or MonoDevelop
|
||||
1. Add reference to ```TLSharp.Core.dll``` to your awesome project.
|
||||
|
||||
# Dependencies
|
||||
|
||||
TLSharp has a few dependenices, most of functionality implemented from scratch.
|
||||
All dependencies listed in [package.conf file](https://github.com/sochix/TLSharp/blob/master/TLSharp.Core/packages.config).
|
||||
|
||||
# Starter Guide
|
||||
|
||||
## Quick Configuration
|
||||
Telegram API isn't that easy to start. You need to do some configuration first.
|
||||
|
||||
1. Create a [developer account](https://my.telegram.org/) in Telegram.
|
||||
1. Goto [API development tools](https://my.telegram.org/apps) and copy **API_ID** and **API_HASH** from your account. You'll need it later.
|
||||
|
||||
## First requests
|
||||
To start work, create an instance of TelegramClient and establish connection
|
||||
|
||||
```csharp
|
||||
var client = new TelegramClient(apiId, apiHash);
|
||||
await client.ConnectAsync();
|
||||
```
|
||||
Now you can work with Telegram API, but ->
|
||||
> Only a small portion of the API methods are available to unauthorized users. ([full description](https://core.telegram.org/api/auth))
|
||||
|
||||
For authentication you need to run following code
|
||||
# Sample code
|
||||
```csharp
|
||||
var hash = await client.SendCodeRequestAsync("<user_number>");
|
||||
var code = "<code_from_telegram>"; // you can change code in debugger
|
||||
using System;
|
||||
using System.Threading.Tasks;
|
||||
using TeleSharp.TL;
|
||||
using TLSharp.Core;
|
||||
using System.Linq;
|
||||
using TeleSharp.TL.Messages;
|
||||
using System.Collections.Generic;
|
||||
|
||||
var user = await client.MakeAuthAsync("<user_number>", hash, code);
|
||||
```
|
||||
namespace TLSharpPOC
|
||||
{
|
||||
class MainClass
|
||||
{
|
||||
const int APIId = 0;
|
||||
const string APIHash = "???";
|
||||
const string phone = "???";
|
||||
public static void Main(string[] args)
|
||||
{
|
||||
new MainClass().MainAsync(args).Wait();
|
||||
}
|
||||
|
||||
Full code you can see at [AuthUser test](https://github.com/sochix/TLSharp/blob/master/TLSharp.Tests/TLSharpTests.cs#L70)
|
||||
|
||||
When user is authenticated, TLSharp creates special file called _session.dat_. In this file TLSharp store all information needed for user session. So you need to authenticate user every time the _session.dat_ file is corrupted or removed.
|
||||
|
||||
You can call any method on authenticated user. For example, let's send message to a friend by his phone number:
|
||||
|
||||
```csharp
|
||||
//get available contacts
|
||||
var result = await client.GetContactsAsync();
|
||||
|
||||
//find recipient in contacts
|
||||
var user = result.Users.lists
|
||||
.Where(x => x.GetType() == typeof (TLUser))
|
||||
.Cast<TLUser>()
|
||||
.FirstOrDefault(x => x.phone == "<recipient_phone>");
|
||||
|
||||
//send message
|
||||
await client.SendMessageAsync(new TLInputPeerUser() {user_id = user.id}, "OUR_MESSAGE");
|
||||
```
|
||||
|
||||
Full code you can see at [SendMessage test](https://github.com/sochix/TLSharp/blob/master/TLSharp.Tests/TLSharpTests.cs#L87)
|
||||
|
||||
To send message to channel you could use the following code:
|
||||
```csharp
|
||||
//get user dialogs
|
||||
var dialogs = await client.GetUserDialogsAsync();
|
||||
|
||||
//find channel by title
|
||||
var chat = dialogs.chats.lists
|
||||
.Where(c => c.GetType() == typeof(TLChannel))
|
||||
.Cast<TLChannel>()
|
||||
.FirstOrDefault(c => c.title == "<channel_title>");
|
||||
|
||||
//send message
|
||||
await client.SendMessageAsync(new TLInputPeerChannel() { channel_id = chat.id, access_hash = chat.access_hash.Value }, "OUR_MESSAGE");
|
||||
```
|
||||
Full code you can see at [SendMessageToChannel test](https://github.com/sochix/TLSharp/blob/master/TLSharp.Tests/TLSharpTests.cs#L107)
|
||||
## Working with files
|
||||
Telegram separate files to two categories -> big file and small file. File is Big if its size more than 10 Mb. TLSharp tries to hide this complexity from you, thats why we provide one method to upload files **UploadFile**.
|
||||
|
||||
```csharp
|
||||
var fileResult = await client.UploadFile("cat.jpg", new StreamReader("data/cat.jpg"));
|
||||
```
|
||||
|
||||
TLSharp provides two wrappers for sending photo and document
|
||||
|
||||
```csharp
|
||||
await client.SendUploadedPhoto(new TLInputPeerUser() { user_id = user.id }, fileResult, "kitty");
|
||||
await client.SendUploadedDocument(
|
||||
new TLInputPeerUser() { user_id = user.id },
|
||||
fileResult,
|
||||
"some zips", //caption
|
||||
"application/zip", //mime-type
|
||||
new TLVector<TLAbsDocumentAttribute>()); //document attributes, such as file name
|
||||
```
|
||||
Full code you can see at [SendPhotoToContactTest](https://github.com/sochix/TLSharp/blob/master/TLSharp.Tests/TLSharpTests.cs#L125) and [SendBigFileToContactTest](https://github.com/sochix/TLSharp/blob/master/TLSharp.Tests/TLSharpTests.cs#L143)
|
||||
|
||||
To download file you should call **GetFile** method
|
||||
```csharp
|
||||
await client.GetFile(
|
||||
new TLInputDocumentFileLocation()
|
||||
private async Task MainAsync(string[] args)
|
||||
{
|
||||
TelegramClient client = null;
|
||||
try
|
||||
{
|
||||
// -- if necessary, IP can be changed so the client can connect to the test network.
|
||||
Session session = null;
|
||||
// new Session(new FileSessionStore(), "session")
|
||||
//{
|
||||
// ServerAddress = "149.154.175.10",
|
||||
// Port = 443
|
||||
//};
|
||||
//Console.WriteLine($"{session.ServerAddress}:{session.Port} {phone}");
|
||||
client = new TelegramClient(APIId, APIHash, session);
|
||||
// subscribe an event to receive live messages
|
||||
client.Updates += Client_Updates;
|
||||
await client.ConnectAsync();
|
||||
Console.WriteLine($"Authorised: {client.IsUserAuthorized()}");
|
||||
TLUser user = null;
|
||||
// -- If the user has already authenticated, this step will prevent account from being blocked as it
|
||||
// -- reuses the data from last authorisation.
|
||||
if (client.IsUserAuthorized())
|
||||
user = client.Session.TLUser;
|
||||
else
|
||||
{
|
||||
access_hash = document.access_hash,
|
||||
id = document.id,
|
||||
version = document.version
|
||||
},
|
||||
document.size); //size of fileChunk you want to retrieve
|
||||
var registered = await client.IsPhoneRegisteredAsync(phone);
|
||||
var hash = await client.SendCodeRequestAsync(phone);
|
||||
Console.Write("Code: ");
|
||||
var code = Console.ReadLine();
|
||||
if (!registered)
|
||||
{
|
||||
Console.WriteLine($"Sign up {phone}");
|
||||
user = await client.SignUpAsync(phone, hash, code, "First", "Last");
|
||||
}
|
||||
Console.WriteLine($"Sign in {phone}");
|
||||
user = await client.MakeAuthAsync(phone, hash, code);
|
||||
}
|
||||
|
||||
var contacts = await client.GetContactsAsync();
|
||||
Console.WriteLine("Contacts:");
|
||||
foreach (var contact in contacts.Users.OfType<TLUser>())
|
||||
{
|
||||
var contactUser = contact as TLUser;
|
||||
Console.WriteLine($"\t{contact.Id} {contact.Phone} {contact.FirstName} {contact.LastName}");
|
||||
}
|
||||
|
||||
|
||||
var dialogs = (TLDialogs) await client.GetUserDialogsAsync();
|
||||
Console.WriteLine("Channels: ");
|
||||
foreach (var channelObj in dialogs.Chats.OfType<TLChannel>())
|
||||
{
|
||||
var channel = channelObj as TLChannel;
|
||||
Console.WriteLine($"\tChat: {channel.Title}");
|
||||
}
|
||||
|
||||
Console.WriteLine("Groups:");
|
||||
TLChat chat = null;
|
||||
foreach (var chatObj in dialogs.Chats.OfType<TLChat>())
|
||||
{
|
||||
chat = chatObj as TLChat;
|
||||
Console.WriteLine($"Chat name: {chat.Title}");
|
||||
var request = new TLRequestGetFullChat() { ChatId = chat.Id };
|
||||
var fullChat = await client.SendRequestAsync<TeleSharp.TL.Messages.TLChatFull>(request);
|
||||
|
||||
var participants = (fullChat.FullChat as TeleSharp.TL.TLChatFull).Participants as TLChatParticipants;
|
||||
foreach (var p in participants.Participants)
|
||||
{
|
||||
if (p is TLChatParticipant)
|
||||
{
|
||||
var participant = p as TLChatParticipant;
|
||||
Console.WriteLine($"\t{participant.UserId}");
|
||||
}
|
||||
else if (p is TLChatParticipantAdmin)
|
||||
{
|
||||
var participant = p as TLChatParticipantAdmin;
|
||||
Console.WriteLine($"\t{participant.UserId}**");
|
||||
}
|
||||
else if (p is TLChatParticipantCreator)
|
||||
{
|
||||
var participant = p as TLChatParticipantCreator;
|
||||
Console.WriteLine($"\t{participant.UserId}**");
|
||||
}
|
||||
}
|
||||
|
||||
var peer = new TLInputPeerChat() { ChatId = chat.Id };
|
||||
var m = await client.GetHistoryAsync(peer, 0, 0, 0);
|
||||
Console.WriteLine(m);
|
||||
if (m is TLMessages)
|
||||
{
|
||||
var messages = m as TLMessages;
|
||||
|
||||
|
||||
foreach (var message in messages.Messages)
|
||||
{
|
||||
if (message is TLMessage)
|
||||
{
|
||||
var m1 = message as TLMessage;
|
||||
Console.WriteLine($"\t\t{m1.Id} {m1.Message}");
|
||||
}
|
||||
else if (message is TLMessageService)
|
||||
{
|
||||
var m1 = message as TLMessageService;
|
||||
Console.WriteLine($"\t\t{m1.Id} {m1.Action}");
|
||||
}
|
||||
}
|
||||
}
|
||||
else if (m is TLMessagesSlice)
|
||||
{
|
||||
bool done = false;
|
||||
int total = 0;
|
||||
while (!done)
|
||||
{
|
||||
var messages = m as TLMessagesSlice;
|
||||
|
||||
foreach (var m1 in messages.Messages)
|
||||
{
|
||||
if (m1 is TLMessage)
|
||||
{
|
||||
var message = m1 as TLMessage;
|
||||
Console.WriteLine($"\t\t{message.Id} {message.Message}");
|
||||
++total;
|
||||
}
|
||||
else if (m1 is TLMessageService)
|
||||
{
|
||||
var message = m1 as TLMessageService;
|
||||
Console.WriteLine($"\t\t{message.Id} {message.Action}");
|
||||
++total;
|
||||
done = message.Action is TLMessageActionChatCreate;
|
||||
}
|
||||
}
|
||||
m = await client.GetHistoryAsync(peer, total, 0, 0);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// -- Wait in a loop to handle incoming updates. No need to poll.
|
||||
for (;;)
|
||||
{
|
||||
await client.WaitEventAsync();
|
||||
}
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
Console.WriteLine(e);
|
||||
}
|
||||
}
|
||||
|
||||
private void Client_Updates(TelegramClient client, TLAbsUpdates updates)
|
||||
{
|
||||
Console.WriteLine($"Got update: {updates}");
|
||||
if (updates is TLUpdateShort)
|
||||
{
|
||||
var updateShort = updates as TLUpdateShort;
|
||||
Console.WriteLine($"Short: {updateShort.Update}");
|
||||
if (updateShort.Update is TLUpdateUserStatus)
|
||||
{
|
||||
var status = updateShort.Update as TLUpdateUserStatus;
|
||||
Console.WriteLine($"User {status.UserId} is {status.Status}");
|
||||
if (status.Status is TLUserStatusOnline)
|
||||
{
|
||||
try
|
||||
{
|
||||
var peer = new TLInputPeerUser() { UserId = status.UserId };
|
||||
client.SendMessageAsync(peer, "Você está online.").Wait();
|
||||
} catch {}
|
||||
}
|
||||
}
|
||||
}
|
||||
else if (updates is TLUpdateShortMessage)
|
||||
{
|
||||
var message = updates as TLUpdateShortMessage;
|
||||
Console.WriteLine($"Message: {message.Message}");
|
||||
MarkMessageRead(client, new TLInputPeerUser() { UserId = message.UserId }, message.Id);
|
||||
}
|
||||
else if (updates is TLUpdateShortChatMessage)
|
||||
{
|
||||
var message = updates as TLUpdateShortChatMessage;
|
||||
Console.WriteLine($"Chat Message: {message.Message}");
|
||||
MarkMessageRead(client, new TLInputPeerChat() { ChatId = message.ChatId }, message.Id);
|
||||
}
|
||||
else if (updates is TLUpdates)
|
||||
{
|
||||
var allUpdates = updates as TLUpdates;
|
||||
foreach (var update in allUpdates.Updates)
|
||||
{
|
||||
Console.WriteLine($"\t{update}");
|
||||
if (update is TLUpdateNewChannelMessage)
|
||||
{
|
||||
var metaMessage = update as TLUpdateNewChannelMessage;
|
||||
var message = metaMessage.Message as TLMessage;
|
||||
Console.WriteLine($"Channel message: {message.Message}");
|
||||
var channel = allUpdates.Chats[0] as TLChannel;
|
||||
MarkMessageRead(client,
|
||||
new TLInputPeerChannel() { ChannelId = channel.Id, AccessHash = channel.AccessHash.Value },
|
||||
message.Id );
|
||||
}
|
||||
}
|
||||
|
||||
foreach(var user in allUpdates.Users)
|
||||
{
|
||||
Console.WriteLine($"{user}");
|
||||
}
|
||||
|
||||
foreach (var chat in allUpdates.Chats)
|
||||
{
|
||||
Console.WriteLine($"{chat}");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void MarkMessageRead(TelegramClient client, TLAbsInputPeer peer, int id)
|
||||
{
|
||||
// An exception happens here but it's not fatal.
|
||||
try
|
||||
{
|
||||
var request = new TLRequestReadHistory();
|
||||
request.MaxId = id;
|
||||
request.Peer = peer;
|
||||
client.SendRequestAsync<bool>(request).Wait();
|
||||
}
|
||||
catch {}
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
Full code you can see at [DownloadFileFromContactTest](https://github.com/sochix/TLSharp/blob/master/TLSharp.Tests/TLSharpTests.cs#L167)
|
||||
|
||||
# Available Methods
|
||||
|
||||
For your convenience TLSharp have wrappers for several Telegram API methods. You could add your own, see details below.
|
||||
|
||||
1. IsPhoneRegisteredAsync
|
||||
1. SendCodeRequestAsync
|
||||
1. MakeAuthAsync
|
||||
1. SignUpAsync
|
||||
1. GetContactsAsync
|
||||
1. SendMessageAsync
|
||||
1. SendTypingAsync
|
||||
1. GetUserDialogsAsync
|
||||
1. SendUploadedPhoto
|
||||
1. SendUploadedDocument
|
||||
1. GetFile
|
||||
1. UploadFile
|
||||
1. SendPingAsync
|
||||
1. GetHistoryAsync
|
||||
|
||||
**What if you can't find needed method at the list?**
|
||||
|
||||
Don't panic. You can call any method with help of `SendRequestAsync` function. For example, send user typing method:
|
||||
|
||||
```csharp
|
||||
|
||||
//Create request
|
||||
var req = new TLRequestSetTyping()
|
||||
{
|
||||
action = new TLSendMessageTypingAction(),
|
||||
peer = peer
|
||||
};
|
||||
|
||||
//run request, and deserialize response to Boolean
|
||||
return await SendRequestAsync<Boolean>(req);
|
||||
```
|
||||
|
||||
**Where you can find a list of requests and its params?**
|
||||
|
||||
The only way is [Telegram API docs](https://core.telegram.org/methods). Yes, it's outdated. But there is no other source.
|
||||
Latest scheme in JSON format you can find [here](https://gist.github.com/aarani/b22b7cda024973dff68e1672794b0298)
|
||||
|
||||
# Contributing
|
||||
|
||||
Contributing is highly appreciated! Donations required <a href="https://www.paypal.me/IPirozhenko" title="Support project"><img src="https://img.shields.io/badge/Support%20project-paypal-brightgreen.svg"></a>
|
||||
|
||||
## What things can I Implement (Project Roadmap)?
|
||||
|
||||
### Release 1.0.0
|
||||
|
||||
* [DONE] Add PHONE_MIGRATE handling
|
||||
* [DONE] Add FILE_MIGRATE handling
|
||||
* Add Updates handling
|
||||
* [DONE] Add NuGet package
|
||||
* [DONE] Add wrappers for media uploading and downloading
|
||||
* Store user session as JSON
|
||||
|
||||
# FAQ
|
||||
|
||||
#### What API layer is supported?
|
||||
The latest one - 66. Thanks to Afshin Arani for his TLGenerator
|
||||
|
||||
#### I get a xxxMigrationException or a MIGRATE_X error!
|
||||
|
||||
TLSharp library should automatically handle these errors. If you see such errors, please open a new Github issue with the details (include a stacktrace, etc.).
|
||||
|
||||
#### I get an exception: System.IO.EndOfStreamException: Unable to read beyond the end of the stream. All test methos except that AuthenticationWorks and TestConnection return same error. I did every thing including setting api id and hash, and setting server address.-
|
||||
|
||||
You should create a Telegram session. See [configuration guide](#sending-messages-set-up)
|
||||
|
||||
#### Why do I get a FloodException/FLOOD_WAIT error?
|
||||
It's likely [Telegram restrictions](https://core.telegram.org/api/errors#420-flood), or a bug in TLSharp (if you feel it's the latter, please open a Github issue). You can know the time to wait by accessing the FloodException::TimeToWait property.
|
||||
|
||||
#### Why does TLSharp lacks feature XXXX?
|
||||
|
||||
Now TLSharp is basic realization of Telegram protocol, you can be a contributor or a sponsor to speed-up developemnt of any feature.
|
||||
|
||||
#### Nothing helps
|
||||
Ask your question at gitter or create an issue in project bug tracker.
|
||||
|
||||
**Attach following information**:
|
||||
|
||||
* Full problem description and exception message
|
||||
* Stack-trace
|
||||
* Your code that runs in to this exception
|
||||
|
||||
Without information listen above your issue will be closed.
|
||||
|
||||
# Donations
|
||||
Thanks for donations! It's highly appreciated.
|
||||
<a href="https://www.paypal.me/IPirozhenko" title="Support project"><img src="https://img.shields.io/badge/Support%20project-paypal-brightgreen.svg"></a>
|
||||
|
||||
List of donators:
|
||||
* [mtbitcoin](https://github.com/mtbitcoin)
|
||||
|
||||
# Contributors
|
||||
* [Afshin Arani](http://aarani.ir) - TLGenerator, and a lot of other usefull things
|
||||
* [Knocte](https://github.com/knocte)
|
||||
|
||||
# License
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue