mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 04:41:02 +01:00
487 lines
16 KiB
HTML
487 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Webhooks - Hangouts Chat v2.0.0+20210324</title>
|
|
|
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/highlight.css">
|
|
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
|
|
<script type="text/javascript" src="../js/highlight.pack.js"></script>
|
|
<script src="../js/theme.js"></script>
|
|
|
|
<style>
|
|
body {font-size: 90%;}
|
|
pre, code {font-size: 100%;}
|
|
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
|
|
</style>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Hangouts Chat v2.0.0+20210324</a>
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<span>Dms</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../dms_conversations-messages">Conversations Messages</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../dms_messages">Messages</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Webhooks</a>
|
|
|
|
<ul>
|
|
|
|
<li class="toctree-l2"><a href="#required-scalar-argument">Required Scalar Argument</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Media</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../media_download">Download</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Rooms</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../rooms_conversations-messages">Conversations Messages</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../rooms_messages">Messages</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../rooms_webhooks">Webhooks</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Spaces</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../spaces_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../spaces_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../spaces_members-get">Members Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../spaces_members-list">Members List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../spaces_messages-attachments-get">Messages Attachments Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../spaces_messages-create">Messages Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../spaces_messages-delete">Messages Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../spaces_messages-get">Messages Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../spaces_messages-update">Messages Update</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../spaces_webhooks">Webhooks</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
|
|
<a href=".."></a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="..">Docs</a> »</li>
|
|
<li>Webhooks</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/master/gen/chat1-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Legacy path for creating message. Calling these will result in a BadRequest response.</p>
|
|
<h1 id="required-scalar-argument">Required Scalar Argument</h1>
|
|
<ul>
|
|
<li><strong><parent></strong> <em>(string)</em><ul>
|
|
<li>Required. Space resource name, in the form "spaces/*". Example: spaces/AAAAMpdlehY</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>Message:
|
|
action-response:
|
|
type: string
|
|
url: string
|
|
argument-text: string
|
|
create-time: string
|
|
fallback-text: string
|
|
name: string
|
|
preview-text: string
|
|
sender:
|
|
display-name: string
|
|
domain-id: string
|
|
is-anonymous: boolean
|
|
name: string
|
|
type: string
|
|
slash-command:
|
|
command-id: string
|
|
space:
|
|
display-name: string
|
|
name: string
|
|
single-user-bot-dm: boolean
|
|
threaded: boolean
|
|
type: string
|
|
text: string
|
|
thread:
|
|
name: string
|
|
|
|
</code></pre>
|
|
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r .action-response type=kasd</code><ul>
|
|
<li>The type of bot response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>url=et</code></p>
|
|
<ul>
|
|
<li>URL for users to auth or config. (Only for REQUEST_CONFIG response types.)</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. argument-text=sed</code></p>
|
|
<ul>
|
|
<li>Plain-text body of the message with all bot mentions stripped out.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>create-time=et</code><ul>
|
|
<li>Output only. The time at which the message was created in Hangouts Chat server.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>fallback-text=et</code><ul>
|
|
<li>A plain-text description of the message's cards, used when the actual cards cannot be displayed (e.g. mobile notifications).</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=vero</code><ul>
|
|
<li>No description provided.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>preview-text=erat</code><ul>
|
|
<li>Text for generating preview chips. This text will not be displayed to the user, but any links to images, web pages, videos, etc. included here will generate preview chips.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>sender display-name=sed</code><ul>
|
|
<li>The user's display name.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>domain-id=duo</code><ul>
|
|
<li>Obfuscated domain information.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>is-anonymous=false</code><ul>
|
|
<li>True when the user is deleted or the user's profile is not visible.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=diam</code><ul>
|
|
<li>Resource name, in the format "users/*".</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>type=dolor</code></p>
|
|
<ul>
|
|
<li>User type.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..slash-command command-id=et</code></p>
|
|
<ul>
|
|
<li>The id of the slash command invoked.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>..space display-name=et</code></p>
|
|
<ul>
|
|
<li>Output only. The display name (only if the space is a room). Please note that this field might not be populated in direct messages between humans.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=sadipscing</code><ul>
|
|
<li>Resource name of the space, in the form "spaces/*". Example: spaces/AAAAMpdlehYs</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>single-user-bot-dm=false</code><ul>
|
|
<li>Whether the space is a DM between a bot and a single human.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>threaded=false</code><ul>
|
|
<li>Whether the messages are threaded in this space.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>type=vero</code></p>
|
|
<ul>
|
|
<li>Output only. The type of a space. This is deprecated. Use <code>single_user_bot_dm</code> instead.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. text=invidunt</code></p>
|
|
<ul>
|
|
<li>Plain-text body of the message.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>thread name=stet</code><ul>
|
|
<li>Resource name, in the form "spaces/<em>/threads/</em>". Example: spaces/AAAAMpdlehY/threads/UMxbHmzDlr4</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li><strong>-p thread-key=string</strong><ul>
|
|
<li>Opaque thread identifier string that can be specified to group messages into a single thread. If this is the first message with a given thread identifier, a new thread is created. Subsequent messages with the same thread identifier will be posted into the same thread. This relieves bots and webhooks from having to store the Hangouts Chat thread ID of a thread (created earlier by them) to post further updates to it. Has no effect if thread field, corresponding to an existing thread, is set in message.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../media_download" class="btn btn-neutral float-right" title="Download"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../dms_messages" class="btn btn-neutral" title="Messages"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
<!-- Copyright etc -->
|
|
</p>
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
<span><a href="../dms_messages" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../media_download" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |