-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmisc_paths.html
208 lines (181 loc) · 11.4 KB
/
misc_paths.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<!DOCTYPE html>
<html class="writer-html5" lang="ru" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Остальные пути — документация Tdproto docs </title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.svg"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/translations.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Алфавитный указатель" href="genindex.html" />
<link rel="search" title="Поиск" href="search.html" />
<link rel="next" title="Документация Websocket" href="websocket.html" />
<link rel="prev" title="Пути относящиеся к группам" href="group_paths.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Tdproto docs
<img src="_static/logo.svg" class="logo" alt="Логотип"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Поиск в документации" aria-label="Поиск в документации" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Меню навигации">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="basics.html">Основы</a></li>
<li class="toctree-l1"><a class="reference internal" href="bot_howto.html">Как создать бота</a></li>
<li class="toctree-l1"><a class="reference internal" href="team_paths.html">Пути относящиеся к командам</a></li>
<li class="toctree-l1"><a class="reference internal" href="chat_paths.html">Пути относящиеся в чатам</a></li>
<li class="toctree-l1"><a class="reference internal" href="task_paths.html">Пути относящиеся к задачам</a></li>
<li class="toctree-l1"><a class="reference internal" href="group_paths.html">Пути относящиеся к группам</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Остальные пути</a></li>
<li class="toctree-l1"><a class="reference internal" href="websocket.html">Документация Websocket</a></li>
<li class="toctree-l1"><a class="reference internal" href="events.html">События клиента</a></li>
<li class="toctree-l1"><a class="reference internal" href="events.html#server-events">События сервера</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html">Индекс Enum</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html#type-aliases">Псевдонимы типов</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html#json-objects-index">Индекс JSON объектов</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_index.html#http-queries">HTTP Queries</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Меню навигации для мобильных устройств" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Tdproto docs</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Навигация по страницам">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Остальные пути</li>
<li class="wy-breadcrumbs-aside">
<a style="color:red;font-size:36px;" href="https://tada-team.github.io/tdproto-docs-en/misc_paths">🇺🇸</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="miscellaneous-paths">
<h1>Остальные пути<a class="headerlink" href="#miscellaneous-paths" title="Permalink to this heading"></a></h1>
<dl class="http get">
<dt class="sig sig-object http" id="get--api-v4-addr">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/v4/addr</span></span><a class="headerlink" href="#get--api-v4-addr" title="Ссылка на это определение"></a></dt>
<dd><p>Возвращает адрес клиента для отладки.</p>
<p><a class="reference external" href="https://tada-team.github.io/td-swagger-ui/#/default/get_api_v4_addr">🔍 Попробуйте!</a></p>
<dl class="field-list simple">
<dt class="field-odd">Ответный JSON объект<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ok</strong> (<em>boolean</em>) – True если не было ошибки</p></li>
<li><p><strong>result</strong> (<em>string</em>) – Адрес сервера.</p></li>
</ul>
</dd>
<dt class="field-even">Код статуса<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – Без ошибки</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="http get">
<dt class="sig sig-object http" id="get--api-v4-ping">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/v4/ping</span></span><a class="headerlink" href="#get--api-v4-ping" title="Ссылка на это определение"></a></dt>
<dd><p>Пинг запрос на сервер</p>
<p><a class="reference external" href="https://tada-team.github.io/td-swagger-ui/#/default/get_api_v4_ping">🔍 Попробуйте!</a></p>
<dl class="field-list simple">
<dt class="field-odd">Ответный JSON объект<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ok</strong> (<em>boolean</em>) – True если не было ошибки</p></li>
<li><p><strong>result</strong> (<em>string</em>) – Задано на «pong»</p></li>
</ul>
</dd>
<dt class="field-even">Код статуса<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – Без ошибки</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="http get">
<dt class="sig sig-object http" id="get--features.json">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/features.json</span></span><a class="headerlink" href="#get--features.json" title="Ссылка на это определение"></a></dt>
<dd><p>Получить информацию о характерных чертах сервера.</p>
<p><a class="reference external" href="https://tada-team.github.io/td-swagger-ui/#/default/get_features_json">🔍 Попробуйте!</a></p>
<dl class="field-list simple">
<dt class="field-odd">Ответный JSON объект<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ok</strong> (<em>boolean</em>) – True если не было ошибки</p></li>
<li><p><strong>result</strong> (<em>object</em>) – <a class="reference internal" href="data_index.html#tdmodels-Features"><span class="std std-ref">Features</span></a> объект.</p></li>
</ul>
</dd>
<dt class="field-even">Код статуса<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – Без ошибки</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="http get">
<dt class="sig sig-object http" id="get--api-v4-badge">
<span class="sig-name descname"><span class="pre">GET</span> </span><span class="sig-name descname"><span class="pre">/api/v4/badge</span></span><a class="headerlink" href="#get--api-v4-badge" title="Ссылка на это определение"></a></dt>
<dd><p>Получить список не прочитанных сообщений.</p>
<p><a class="reference external" href="https://tada-team.github.io/td-swagger-ui/#/default/get_api_v4_badge">🔍 Попробуйте!</a></p>
<dl class="field-list simple">
<dt class="field-odd">Ответный JSON объект<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ok</strong> (<em>boolean</em>) – True если не было ошибки</p></li>
<li><p><strong>result</strong> (<em>int</em>) – Количество не прочитанных сообщений.</p></li>
</ul>
</dd>
<dt class="field-even">Код статуса<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><span><a class="reference external" href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1">200 OK</a></span> – Без ошибки</p></li>
</ul>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Нижняя область">
<a href="group_paths.html" class="btn btn-neutral float-left" title="Пути относящиеся к группам" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Предыдущая</a>
<a href="websocket.html" class="btn btn-neutral float-right" title="Документация Websocket" accesskey="n" rel="next">Следующая <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<li><a href="https://github.com/tada-team/tdproto-sphinx/">Project Homepage</a> »</li>
<p>© Copyright .</p>
</div>
Собрано при помощи <a href="https://www.sphinx-doc.org/">Sphinx</a> с использованием
<a href="https://github.com/readthedocs/sphinx_rtd_theme">темы,</a>
предоставленной <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>