TelegramApiServer

https://github.com/xtrime-ru/telegramapiserver
Admin
TelegramApiServer is a fast, simple, and asynchronous PHP server that provides full access to the...
Tokens:2,614
Snippets:27
Trust Score:8.1
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Running WebSocket Client Example PHP

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

These PHP command-line snippets show how to run the provided example WebSocket client script (`examples/websocket-events.php`) to connect to the TelegramApiServer's event or log streams using the `--url` argument.

```PHP
php examples/websocket-events.php --url=ws://127.0.0.1:9503/events
```

```PHP
php examples/websocket-events.php --url=ws://127.0.0.1:9503/log
```

--------------------------------

### Installing TelegramApiServer with Docker

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

Clones the repository, changes the directory, copies the default Docker environment configuration file, and pulls the required Docker images to prepare for installation.

```shell
git clone https://github.com/xtrime-ru/TelegramApiServer.git TelegramApiServer
cd TelegramApiServer
cp .env.docker.example .env.docker
docker compose pull
```

--------------------------------

### Starting TelegramApiServer with Specific Env File PHP

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

These PHP command-line snippets show how to start the TelegramApiServer using a specific environment file for configuration via the `--env` argument. This allows different instances of the server to have unique settings.

```PHP
php server.php --env=.env
```

```PHP
php server.php --env=sessions/.env.session
```

--------------------------------

### Starting TelegramApiServer with Multiple Sessions PHP

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

This PHP command-line snippet demonstrates how to start the TelegramApiServer with multiple distinct sessions specified using the `--session` argument. Sessions are stored in `sessions/` folder with a `.madeline` extension. Nested folders and glob syntax are supported.

```PHP
php server.php --session=bot --session=users/xtrime --session=users/user1
```

```PHP
--session=*
--session=users/* --session=bots/*
```

--------------------------------

### Starting TelegramApiServer Container for Authorization (Docker)

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

Runs the 'api' service from the docker-compose configuration in interactive mode (--rm removes the container after exit) to perform the initial session authorization via the command line.

```shell
docker compose run --rm api
```

--------------------------------

### Session-Specific Settings Configuration JSON

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

This JSON snippet provides an example of a session-specific settings file (`%sessionName%.settings.json`) placed in the sessions folder. It demonstrates configuring proxies specifically for one session.

```JSON
{
    "connection": {
        "proxies": {
            "\\danog\\MadelineProto\\Stream\\Proxy\\SocksProxy": [
                {
                  "address": "127.0.0.1",
                  "port": 1234,
                  "username": "user",
                  "password": "pass"
                }
            ],
            "\\danog\\MadelineProto\\Stream\\Proxy\\HttpProxy": [
                {
                  "address": "127.0.0.1",
                  "port": 1234,
                  "username": "user",
                  "password": "pass"
                }
            ]
        }
    }
}
```

--------------------------------

### Updating TelegramApiServer with Git and Docker Compose

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

Updates the local Git repository, removes vendor dependencies, pulls the latest Docker images, stops and removes existing containers, and then starts new containers in the background.

```shell
git pull
rm -rf vendor/
docker compose pull
docker compose down
docker compose up -d
```

--------------------------------

### Running TelegramApiServer Containers in Background (Docker)

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

Starts the services defined in the docker-compose file in detached mode (-d), allowing them to run in the background without blocking the terminal after the initial authorization.

```shell
docker compose up -d
```

--------------------------------

### Adding Multiple Telegram Sessions (Docker Compose Override)

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

Shows an example docker-compose.override.yml file extending a base service to define two additional API service containers, configuring unique host ports and session names via the command parameter for each.

```yaml
services:
    api-2:
        extends:
            file: docker-compose.base.yml
            service: base-api
        ports:
            - "127.0.0.1:9512:9503"
        command:
            - "-s=session-2"
    api-3:
        extends:
            file: docker-compose.base.yml
            service: base-api
        ports:
            - "127.0.0.1:9513:9503"
        command:
            - "-s=session-3"
```

--------------------------------

### Setting Webhook URL for Updates (Curl)

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

Uses the curl command with the -g flag to send a GET request to the /api/setWebhook endpoint, providing a URL-encoded endpoint URL where Telegram updates should be sent.

```shell
curl "127.0.0.1:9503/api/setWebhook?url=http%3A%2F%2Fexample.com%2Fsome_webhook" -g 
```

--------------------------------

### Accessing Specific Session via HTTP API HTTP

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

These HTTP API examples show how to send requests to specific sessions when running TelegramApiServer with multiple sessions. The session name is included in the URL path before the API method name.

```HTTP
http://127.0.0.1:9503/api/bot/getSelf
```

```HTTP
http://127.0.0.1:9503/api/users/xtrime/getSelf
```

```HTTP
http://127.0.0.1:9503/api/users/user1/getSelf
```

--------------------------------

### Performing Long Polling Request for Updates (Curl)

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

Uses the curl command with the -g flag (to allow curly braces in the URL) to send a GET request to the /api/getUpdates endpoint, specifying limits, offset, and a timeout for the long polling mechanism.

```shell
curl "127.0.0.1:9503/api/getUpdates?limit=3&offset=0&timeout=10.0" -g
```

--------------------------------

### Adding Session with Settings via HTTP API HTTP

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

This HTTP API endpoint demonstrates adding a new session and providing initial settings as query parameters. These settings are saved to a JSON file and applied after the server restarts.

```HTTP
http://127.0.0.1:9503/system/addSession?session=users/xtrime&settings[app_info][app_id]=xxx&&settings[app_info][app_hash]=xxx
```

--------------------------------

### Expected Server Ready Logs (Text)

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

Displays the log messages indicating that the TelegramApiServer has initialized successfully and is ready to accept requests, showing the number of active sessions.

```text
TelegramApiServer ready. 
Number of sessions: 1.
```

--------------------------------

### Downloading File to Response (Curl POST JSON)

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

Shows how to use curl to send a POST request with a JSON payload (--data-raw) containing the media details (like messageMediaDocument) to the /api/downloadToResponse endpoint to download the specified file.

```shell
curl --location --request POST '127.0.0.1:9503/api/downloadToResponse' \
--header 'Content-Type: application/json' \
--data-raw '{
    "media": {
        "_": "messageMediaDocument",
        "document": {
            "_": "document",
            "id": 5470079466401169993,
            "access_hash": -6754208767885394084,
            "file_reference": {
                "_": "bytes",
                "bytes": "AkKdqJkAACnyXshwzMhdzeC5RkdVZeh58sAB/UU="
            },
            "date": 1551713685,
            "mime_type": "video/mp4",
            "size": 400967,
            "dc_id": 2,
            "attributes": [
                {
                    "_": "documentAttributeFilename",
                    "file_name": "одолдол.mp4"
                }
            ]
        }
    }
}'
```

--------------------------------

### Uploading File via Local Path (Curl POST JSON)

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

Shows how to use curl to send a POST request with a JSON payload (--data-raw) specifying the peer, file details using the LocalUrl constructor and path, parse mode, and caption to the /api/sendDocument endpoint.

```shell
curl --location --request POST 'http://127.0.0.1:9503/api/sendDocument' \
--header 'Content-Type: application/json' \
--data-raw '{
    "peer": "me",
    "file": {
        "_": "LocalUrl",
        "file": "faust.txt"
    },
    "parseMode":  "HTML",
    "caption": "<b>caption text</b>"
}'
```

--------------------------------

### Uploading File via Remote URL (Curl POST JSON)

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

Demonstrates using curl to send a POST request with a JSON payload (--data-raw) specifying the peer, file details using the RemoteUrl constructor, parse mode, and caption to the /api/sendVideo endpoint.

```shell
curl --location --request POST 'http://127.0.0.1:9503/api/sendVideo' \
--header 'Content-Type: application/json' \
--data-raw '{
    "peer": "me",
    "file": {
        "_": "RemoteUrl",
        "url": "https://domain.site/storage/video.mp4"
    },
    "parseMode": "HTML",
    "caption": "<b>caption text</b>"
}'
```

--------------------------------

### Uploading File via Stream (Curl POST)

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

Shows how to use curl with a POST request (--request POST) and location following (--location) to upload a file (-F file=@screenshot.png) along with other form fields (-F peer=me, -F caption=key) to the /api/sendDocument endpoint.

```shell
curl --location --request POST 'http://127.0.0.1:9503/api/sendDocument' -g \
-F peer=me \
-F caption=key \
-F file=@screenshot.png
```

--------------------------------

### Connecting to WebSocket Logs HTTP

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

These WebSocket URLs allow connecting to the server's real-time log stream. The base `/log` endpoint provides all logs, while `/log/%level%` filters logs by minimum level (e.g., `alert`, `debug`, `info`).

```HTTP
ws://127.0.0.1:9503/log[/%level%]
```

```HTTP
ws://127.0.0.1:9503/log/alert
```

--------------------------------

### Making API Requests with Basic Authentication (Curl)

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

Shows two methods for including basic authentication credentials (username and password) in curl commands when making HTTP requests to the Telegram API server endpoint.

```shell
curl --user username:password "http://127.0.0.1:9503/getSelf"
```

```shell
curl "http://username:password@127.0.0.1:9503/getSelf"
```

--------------------------------

### Saving Session Immediately via HTTP API HTTP

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

This HTTP API endpoint triggers the immediate serialization and saving of the current session's state to its corresponding `.madeline` file. This is useful after initial authorization.

```HTTP
http://127.0.0.1:9503/api/bot/serialize
```

--------------------------------

### Connecting to WebSocket Events HTTP

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

These WebSocket URLs are used to connect to the server's event handler updates. The base `/events` endpoint provides events from all sessions, while `/events/{sessionName}` filters events for a specific session.

```HTTP
ws://127.0.0.1:9503/events
```

```HTTP
ws://127.0.0.1:9503/events/users/xtrime
```

--------------------------------

### Managing Session Settings via HTTP API HTTP

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

These HTTP API endpoints allow saving or unlinking session-specific settings files remotely. The `saveSessionSettings` method takes settings as query parameters to be saved into a JSON file for the specified session.

```HTTP
http://127.0.0.1:9503/system/saveSessionSettings?session=session&settings[app_info][app_id]=xxx&settings[app_info][app_hash]=xxx
```

```HTTP
http://127.0.0.1:9503/system/unlinkSessionSettings?session=session
```

--------------------------------

### Basic Session Management HTTP API HTTP

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

These HTTP API endpoints provide basic session management functionality. You can list currently loaded sessions, add a new session, or remotely shut down the TelegramApiServer process.

```HTTP
http://127.0.0.1:9503/system/getSessionList
```

```HTTP
http://127.0.0.1:9503/system/addSession?session=users/xtrime
```

```HTTP
http://127.0.0.1:9503/system/exit
```

--------------------------------

### Remote User Session Authorization HTTP

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

These HTTP API endpoints provide a way to authorize a user session remotely by performing phone login steps: initiating login with a phone number, completing with the received code, and optionally completing 2FA or signup if required.

```HTTP
http://127.0.0.1:9503/api/users/xtrime/phoneLogin?phone=%2B7123...
```

```HTTP
http://127.0.0.1:9503/api/users/xtrime/completePhoneLogin?code=123456
```

```HTTP
http://127.0.0.1:9503/api/users/xtrime/complete2falogin?password=123456
```

```HTTP
http://127.0.0.1:9503/api/users/xtrime/completeSignup?firstName=MyExampleName
```

--------------------------------

### Remote Bot Session Authorization HTTP

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

This HTTP API endpoint allows authorizing a bot session remotely using the bot's API token. This is a simple way to add and authorize a bot.

```HTTP
http://127.0.0.1:9503/api/bot/botLogin?token=34298141894:aflknsaflknLKNFS
```

--------------------------------

### Deprecated Session Removal HTTP API HTTP

Source: https://github.com/xtrime-ru/telegramapiserver/blob/master/README.md

These HTTP API endpoints were intended for removing sessions from memory and deleting session files. However, due to underlying issues, their use is cautioned as instances might remain in memory. It is recommended to log out and call removeSession before unlinking the file.

```HTTP
http://127.0.0.1:9503/system/removeSession?session=users/xtrime
```

```HTTP
http://127.0.0.1:9503/system/unlinkSessionFile?session=users/xtrime
```
Tokens:
Raw