mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2024-12-25 02:42:28 +02:00
Документация CLI
This commit is contained in:
Anton
parent
542410392a
commit
6aef4afbe5
@ -881,7 +881,7 @@
|
||||
// Параметры:
|
||||
// Токен - Строка - Токен - token
|
||||
// IDЧата - Строка,Число - ID чата темы - forum
|
||||
// Заголовок - Строка - Новое имя главной темы - name
|
||||
// Заголовок - Строка - Новое имя главной темы - title
|
||||
//
|
||||
// Возвращаемое значение:
|
||||
// Соответствие Из КлючИЗначение - сериализованный JSON ответа от Telegram
|
||||
|
||||
@ -26,3 +26,11 @@ sidebar_position: 1
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram Бан --token "%token%" --chat %channelid% --user %user%
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
@ -25,6 +25,12 @@ sidebar_position: 4
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ОткрепитьСообщение --token "%token%" --chat %channelid% --message 10
|
||||
|
||||
```
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
{
|
||||
|
||||
@ -24,6 +24,12 @@ sidebar_position: 5
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ПолучитьЧислоУчастников --token "%token%" --chat %channelid%
|
||||
|
||||
```
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
{
|
||||
|
||||
@ -26,3 +26,10 @@ sidebar_position: 2
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram Разбан --token "%token%" --chat %channelid% --user %user%
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
@ -24,29 +24,36 @@ sidebar_position: 6
|
||||
Токен = "111111111:AACccNYOAFbuhAL5GAaaBbbbOjZYFvLZZZZ";
|
||||
ДатаИстечения = ТекущаяДатаСеанса() + 60 * 60 * 24;
|
||||
|
||||
Ответ = OPI_Telegram.СоздатьСсылкуПриглашение(Токен, "@testsichee", "Приглашение", ДатаИстечения); //Соответствие
|
||||
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
|
||||
Ответ = OPI_Telegram.СоздатьСсылкуПриглашение(Токен, "@testsichee", "Приглашение 1", ДатаИстечения, 10); //Соответствие
|
||||
Ответ = OPI_Инструменты.JSONСтрокой(Ответ); //JSON строка
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram СоздатьСсылкуПриглашение --token "%token%" --chat %channelid% --title "Приглашение 1" --expire "2024-04-14T23:55:04+03:00" --limit 10
|
||||
|
||||
```
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
{
|
||||
"ok": true,
|
||||
"result": {
|
||||
"creates_join_request": false,
|
||||
"is_revoked": false,
|
||||
"expire_date": 1704646618,
|
||||
"is_primary": false,
|
||||
"invite_link": "https://t.me/+84-I7DsjOYBlYTYy",
|
||||
"name": "Приглашение 1",
|
||||
"creator": {
|
||||
"username": "sicheebot",
|
||||
"first_name": "Sichee",
|
||||
"id": 6129457865,
|
||||
"is_bot": true,
|
||||
"id": 0987654321
|
||||
"first_name": "Бот Виталий",
|
||||
"username": "sicheebot"
|
||||
},
|
||||
"name": "Приглашение",
|
||||
"invite_link": "https://t.me/+rGwUa7PARLcwM112"
|
||||
},
|
||||
"ok": true
|
||||
"expire_date": 1713135304,
|
||||
"member_limit": 10,
|
||||
"creates_join_request": false,
|
||||
"is_primary": false,
|
||||
"is_revoked": false
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
@ -25,6 +25,12 @@ sidebar_position: 3
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ЗакрепитьСообщение --token "%token%" --chat %channelid% --message 10
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -24,6 +24,12 @@ sidebar_position: 1
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ПолучитьИнформациюБота --token "%token%"
|
||||
|
||||
```
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"result": {
|
||||
|
||||
@ -24,6 +24,12 @@ sidebar_position: 1
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ПолучитьОбновления --token "%token%"
|
||||
|
||||
```
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"result": [
|
||||
|
||||
@ -25,6 +25,12 @@ sidebar_position: 1
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram УстановитьWebhook --token "%token%" --url "https://opi.neocities.org"
|
||||
|
||||
```
|
||||
|
||||
```json title="Результат"
|
||||
{
|
||||
"description": "Webhook was set",
|
||||
|
||||
@ -31,6 +31,12 @@ sidebar_position: 5
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ОтправитьАудио --token "%token%" --chat %channelid% --text "Крутая песня" --audio "C:\song.mp3"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -31,6 +31,12 @@ sidebar_position: 6
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ОтправитьДокумент --token "%token%" --chat %channelid% --text "Очень важный документ" --doc "C:\1.docx"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -31,6 +31,12 @@ sidebar_position: 4
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ОтправитьГифку --token "%token%" --chat %channelid% --text "Классная гифка" --gif "C:\2.gif"
|
||||
|
||||
```
|
||||
|
||||
<img src={require('./img/7.gif').default} width='256px' />
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -33,6 +33,23 @@ sidebar_position: 7
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
Структура JSON данных медиагруппы (параметр --media):
|
||||
{
|
||||
"ПутьКФайлу": "ТипМедиа",
|
||||
"ПутьКФайлу": "ТипМедиа",
|
||||
...
|
||||
}
|
||||
|
||||
Варианты типов медиа: audio, document, photo, video
|
||||
|
||||
-------------------------------------
|
||||
|
||||
oint telegram ОтправитьМедиагруппу --token "%token%" --chat %channelid% --text "Группа картинок" --media "C:\media.json"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -31,6 +31,12 @@ sidebar_position: 2
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ОтправитьКартинку --token "%token%" --chat %channelid% --text "Это рисунок альпаки" --picture "C:\alpaca.png"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -29,6 +29,12 @@ sidebar_position: 9
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ОтправитьКонтакт --token "%token%" --chat %channelid% --name "Петр" --surname "Петров" --phone "123123123"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -28,6 +28,12 @@ sidebar_position: 8
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ОтправитьМестоположение --token "%token%" --chat %channelid% --lat "48.87373649724122" --long "2.2954639195323967"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -32,6 +32,12 @@ sidebar_position: 10
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ОтправитьОпрос --token "%token%" --chat %channelid% --question "Какой ваш любимый цвет?" --options "['Красный','Желтый','Синий']"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -34,6 +34,13 @@ sidebar_position: 1
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram СформироватьКлавиатуруПоМассивуКнопок --buttons "['Отлично','Нормально','Плохо']" --under true --out keyboard.json
|
||||
oint telegram ОтправитьТекстовоеСообщение --token "%token%" --chat %user% --text "Привет, как у тебя дела?" --keyboard keyboard.json
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -31,6 +31,12 @@ sidebar_position: 3
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ОтправитьВидео --token "%token%" --chat %channelid% --text "Природа" --video "C:\video.mp4"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -27,6 +27,12 @@ sidebar_position: 11
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ПереслатьСообщение --token "%token%" --message 211 --from %channelid% --to %user%
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -27,7 +27,11 @@ sidebar_position: 12
|
||||
Клавиатура = OPI_Telegram.СформироватьКлавиатуруПоМассивуКнопок(МассивКнопок, Истина, Истина);
|
||||
|
||||
```
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram СформироватьКлавиатуруПоМассивуКнопок --buttons "['Отлично','Нормально','Плохо']" --under true --out keyboard.json
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -11,8 +11,8 @@ sidebar_position: 9
|
||||
| Параметр | CLI опция | Тип | Назначение |
|
||||
|-|-|-|-|
|
||||
| Токен | --token | Строка | Токен бота |
|
||||
| IDЧата | --chat | Строка/Число | ID целевого чата |
|
||||
| Заголовок | --name | Строка | Новое имя главной темы |
|
||||
| IDЧата | --forum | Строка/Число | ID целевого чата |
|
||||
| Заголовок | --title | Строка | Новое имя главной темы |
|
||||
|
||||
Вовзращаемое значение: Соответствие - сериализованный JSON ответа от Telegram
|
||||
|
||||
@ -27,6 +27,12 @@ sidebar_position: 9
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ИзменитьИмяГлавнойТемыФорума --token "%token%" --forum %forum% --title "Новое имя главной темы"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -22,6 +22,7 @@ sidebar_position: 3
|
||||
|
||||
Токен = "6129457325:BWDF...";
|
||||
Чат = "-10019711...";
|
||||
Тема = 83;
|
||||
НовоеИмя = "Новый тестовый заголовок";
|
||||
НовяИконка = "5310132165583840589";
|
||||
|
||||
@ -30,6 +31,12 @@ sidebar_position: 3
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ИзменитьТемуФорума --token "%token%" --forum %forum% --topic %topic% --title "Новый тестовый заголовок" --icon 5310132165583840589
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
@ -26,6 +26,12 @@ sidebar_position: 10
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ОчиститьСписокЗакрепленныхСообщенийТемы --token "%token%" --forum %forum% --topic %topic%
|
||||
|
||||
```
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
{
|
||||
|
||||
@ -25,6 +25,12 @@ sidebar_position: 8
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ОткрытьТемуФорума --token "%token%" --forum %forum%
|
||||
|
||||
```
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
{
|
||||
|
||||
@ -22,6 +22,12 @@ sidebar_position: 1
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ПолучитьСписокИконокАватаров --token "%token%"
|
||||
|
||||
```
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
|
||||
@ -25,6 +25,12 @@ sidebar_position: 7
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram СкрытьГлавнуюТемуФорума --token "%token%" --forum %forum%
|
||||
|
||||
```
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
{
|
||||
|
||||
@ -26,6 +26,12 @@ sidebar_position: 6
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram УдалитьТемуФорума --token "%token%" --forum %forum% --topic %topic%
|
||||
|
||||
```
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
{
|
||||
|
||||
@ -26,6 +26,12 @@ sidebar_position: 4
|
||||
|
||||
```
|
||||
|
||||
```sh title="Пример команд CLI"
|
||||
|
||||
oint telegram ЗакрытьТемуФорума --token "%token%" --forum %forum% --topic %topic%
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
```json title="Результат"
|
||||
|
||||
Loading…
Reference in New Issue
Block a user