Skip to content

Commit 4e7979f

Browse files
committed
Deploying to gh-pages from @ adc784c 🚀
1 parent 4a9351d commit 4e7979f

File tree

4 files changed

+22
-4
lines changed

4 files changed

+22
-4
lines changed

docs/how-to/groups/index.html

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,20 @@
5454
</span></span><span class=line><span class=cl> <span class=nt>&#34;adminsOnly&#34;</span><span class=p>:</span> <span class=kc>true</span>
5555
</span></span><span class=line><span class=cl><span class=p>}</span></span></span></code></pre></div></figure></div><p>Returns <code>true</code> if the setting was properly updated. This can return false if the user does not have the necessary permissions.</p><p>Get the group settings to only allow admins to send messages.</p><div class=expressive-code><figure class="frame not-content"><figcaption class=header><span class=title></span></figcaption><div class=highlight><pre tabindex=0 class=chroma><code class=language-http data-lang=http><span class=line><span class=cl><span class=err>GET /api/{session}/groups/{groupId}/settings/security/messages-admin-only</span></span></span></code></pre></div></figure></div><div class=expressive-code><figure class="frame has-title not-content"><figcaption class=header><span class=title>Response</span></figcaption><div class=highlight title=Response><pre tabindex=0 class=chroma><code class=language-jsonc data-lang=jsonc><span class=line><span class=cl><span class=p>{</span>
5656
</span></span><span class=line><span class=cl> <span class=nt>&#34;adminsOnly&#34;</span><span class=p>:</span> <span class=kc>true</span>
57-
</span></span><span class=line><span class=cl><span class=p>}</span></span></span></code></pre></div></figure></div><h3 id=participants>Participants<a href=#participants class=anchor aria-hidden=true>#</a></h3><h4 id=get-participants>Get participants<a href=#get-participants class=anchor aria-hidden=true>#</a></h4><div class=expressive-code><figure class="frame not-content"><figcaption class=header><span class=title></span></figcaption><div class=highlight><pre tabindex=0 class=chroma><code class=language-http data-lang=http><span class=line><span class=cl><span class=err>GET /api/{session}/groups/{groupId}/participants</span></span></span></code></pre></div></figure></div><h4 id=add-participants>Add participants<a href=#add-participants class=anchor aria-hidden=true>#</a></h4><div class=expressive-code><figure class="frame not-content"><figcaption class=header><span class=title></span></figcaption><div class=highlight><pre tabindex=0 class=chroma><code class=language-http data-lang=http><span class=line><span class=cl><span class=err>POST /api/{session}/groups/{groupId}/participants/add</span></span></span></code></pre></div></figure></div><div class=expressive-code><figure class="frame has-title not-content"><figcaption class=header><span class=title>Body</span></figcaption><div class=highlight title=Body><pre tabindex=0 class=chroma><code class=language-jsonc data-lang=jsonc><span class=line><span class=cl><span class=p>{</span>
57+
</span></span><span class=line><span class=cl><span class=p>}</span></span></span></code></pre></div></figure></div><h3 id=participants>Participants<a href=#participants class=anchor aria-hidden=true>#</a></h3><h4 id=get-participants-v2>Get participants v2<a href=#get-participants-v2 class=anchor aria-hidden=true>#</a></h4><p>Get list of participants with the &ldquo;almost&rdquo; the same response across engines</p><div class=expressive-code><figure class="frame not-content"><figcaption class=header><span class=title></span></figcaption><div class=highlight><pre tabindex=0 class=chroma><code class=language-http data-lang=http><span class=line><span class=cl><span class=err>GET /api/{session}/groups/{groupId}/participants/v2</span></span></span></code></pre></div></figure></div><div class=expressive-code><figure class="frame not-content"><figcaption class=header><span class=title></span></figcaption><div class=highlight><pre tabindex=0 class=chroma><code class=language-json data-lang=json><span class=line><span class=cl><span class=p>[</span>
58+
</span></span><span class=line><span class=cl> <span class=p>{</span>
59+
</span></span><span class=line><span class=cl> <span class=nt>&#34;id&#34;</span><span class=p>:</span> <span class=s2>&#34;111111111111@c.us&#34;</span><span class=p>,</span>
60+
</span></span><span class=line><span class=cl> <span class=nt>&#34;role&#34;</span><span class=p>:</span> <span class=s2>&#34;participant&#34;</span>
61+
</span></span><span class=line><span class=cl> <span class=p>},</span>
62+
</span></span><span class=line><span class=cl> <span class=p>{</span>
63+
</span></span><span class=line><span class=cl> <span class=nt>&#34;id&#34;</span><span class=p>:</span> <span class=s2>&#34;222222222222@c.us&#34;</span><span class=p>,</span>
64+
</span></span><span class=line><span class=cl> <span class=nt>&#34;role&#34;</span><span class=p>:</span> <span class=s2>&#34;superadmin&#34;</span>
65+
</span></span><span class=line><span class=cl> <span class=p>},</span>
66+
</span></span><span class=line><span class=cl> <span class=p>{</span>
67+
</span></span><span class=line><span class=cl> <span class=nt>&#34;id&#34;</span><span class=p>:</span> <span class=s2>&#34;33333333333@c.us&#34;</span><span class=p>,</span>
68+
</span></span><span class=line><span class=cl> <span class=nt>&#34;role&#34;</span><span class=p>:</span> <span class=s2>&#34;participant&#34;</span>
69+
</span></span><span class=line><span class=cl> <span class=p>}</span>
70+
</span></span><span class=line><span class=cl><span class=p>]</span></span></span></code></pre></div></figure></div><p>Role:</p><ul><li><code>left</code></li><li><code>participant</code></li><li><code>admin</code></li><li><code>superadmin</code></li></ul><h4 id=get-participants>Get participants<a href=#get-participants class=anchor aria-hidden=true>#</a></h4><div class=expressive-code><figure class="frame not-content"><figcaption class=header><span class=title></span></figcaption><div class=highlight><pre tabindex=0 class=chroma><code class=language-http data-lang=http><span class=line><span class=cl><span class=err>GET /api/{session}/groups/{groupId}/participants</span></span></span></code></pre></div></figure></div><h4 id=add-participants>Add participants<a href=#add-participants class=anchor aria-hidden=true>#</a></h4><div class=expressive-code><figure class="frame not-content"><figcaption class=header><span class=title></span></figcaption><div class=highlight><pre tabindex=0 class=chroma><code class=language-http data-lang=http><span class=line><span class=cl><span class=err>POST /api/{session}/groups/{groupId}/participants/add</span></span></span></code></pre></div></figure></div><div class=expressive-code><figure class="frame has-title not-content"><figcaption class=header><span class=title>Body</span></figcaption><div class=highlight title=Body><pre tabindex=0 class=chroma><code class=language-jsonc data-lang=jsonc><span class=line><span class=cl><span class=p>{</span>
5871
</span></span><span class=line><span class=cl> <span class=nt>&#34;participants&#34;</span><span class=p>:</span> <span class=p>[</span>
5972
</span></span><span class=line><span class=cl> <span class=p>{</span>
6073
</span></span><span class=line><span class=cl> <span class=nt>&#34;id&#34;</span><span class=p>:</span> <span class=s2>&#34;123123123123@c.us&#34;</span>

docs/how-to/send-messages/index.html

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,12 @@
194194
</span></span><span class=line><span class=cl> <span class=nt>&#34;mentions&#34;</span><span class=p>:</span> <span class=p>[</span>
195195
</span></span><span class=line><span class=cl> <span class=s2>&#34;2132132130@c.us&#34;</span>
196196
</span></span><span class=line><span class=cl> <span class=p>]</span>
197-
</span></span><span class=line><span class=cl><span class=p>}</span></span></span></code></pre></div></figure></div><h2 id=send-image>Send Image<a href=#send-image class=anchor aria-hidden=true>#</a></h2><p>Use API to send images to the chat.</p><div class=expressive-code><figure class="frame not-content"><figcaption class=header><span class=title></span></figcaption><div class=highlight><pre tabindex=0 class=chroma><code class=language-http data-lang=http><span class=line><span class=cl><span class=err>POST /api/sendImage</span></span></span></code></pre></div></figure></div><p>You can send images in two ways:</p><ol><li>Provide a <strong>URL</strong> for the image.</li><li>Encode the whole file content into <strong>BASE64</strong> and send it in the request body.</li></ol><p><nav><div class="nav nav-tabs" id=nav-tab role=tablist><button class="nav-link active" id=tabs-send-image-body-0-tab data-bs-toggle=tab data-bs-target=#tabs-send-image-body-0 type=button role=tab aria-controls=tabs-send-image-body-0 aria-selected=true>
197+
</span></span><span class=line><span class=cl><span class=p>}</span></span></span></code></pre></div></figure></div><div class="callout callout-tip d-flex flex-row mt-4 mb-4 pt-4 pe-4 pb-2 ps-3"><svg width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentcolor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="outline/hand-finger-right svg-inline callout-icon me-2 mb-3" id="svg-hand-finger-right" role="img"><path stroke="none" d="M0 0h24v24H0z" fill="none"/><path d="M12 8h8.5a1.5 1.5.0 010 3H13"/><path d="M13.5 11h2a1.5 1.5.0 010 3H13"/><path d="M14.5 14a1.5 1.5.0 010 3H13"/><path d="M13.5 17a1.5 1.5.0 110 3H9a6 6 0 01-6-6v-2 .208a6 6 0 012.7-5.012L6 7q.718-.468 5.728-3.286a1.5 1.5.0 012.022.536c.44.734.325 1.674-.28 2.28L12 8"/></svg><div class=callout-content><div class=callout-title><p>Mention Everyone in a Group</p></div><div class=callout-body><p>In <strong>groups</strong>, you can mention all participants at once by using the <code>"all"</code> keyword in the <code>mentions</code> field:</p><div class=expressive-code><figure class="frame has-title not-content"><figcaption class=header><span class=title>Body (Mention All)</span></figcaption><div class=highlight title="Body (Mention All)"><pre tabindex=0 class=chroma><code class=language-jsonc data-lang=jsonc><span class=line><span class=cl><span class=p>{</span>
198+
</span></span><span class=line><span class=cl> <span class=nt>&#34;session&#34;</span><span class=p>:</span> <span class=s2>&#34;default&#34;</span><span class=p>,</span>
199+
</span></span><span class=line><span class=cl> <span class=nt>&#34;chatId&#34;</span><span class=p>:</span> <span class=s2>&#34;12132132130@c.us&#34;</span><span class=p>,</span>
200+
</span></span><span class=line><span class=cl> <span class=nt>&#34;text&#34;</span><span class=p>:</span> <span class=s2>&#34;Hi there, check this out!&#34;</span><span class=p>,</span>
201+
</span></span><span class=line><span class=cl> <span class=nt>&#34;mentions&#34;</span><span class=p>:</span> <span class=p>[</span> <span class=s2>&#34;all&#34;</span> <span class=p>]</span>
202+
</span></span><span class=line><span class=cl><span class=p>}</span></span></span></code></pre></div></figure></div></div></div></div><h2 id=send-image>Send Image<a href=#send-image class=anchor aria-hidden=true>#</a></h2><p>Use API to send images to the chat.</p><div class=expressive-code><figure class="frame not-content"><figcaption class=header><span class=title></span></figcaption><div class=highlight><pre tabindex=0 class=chroma><code class=language-http data-lang=http><span class=line><span class=cl><span class=err>POST /api/sendImage</span></span></span></code></pre></div></figure></div><p>You can send images in two ways:</p><ol><li>Provide a <strong>URL</strong> for the image.</li><li>Encode the whole file content into <strong>BASE64</strong> and send it in the request body.</li></ol><p><nav><div class="nav nav-tabs" id=nav-tab role=tablist><button class="nav-link active" id=tabs-send-image-body-0-tab data-bs-toggle=tab data-bs-target=#tabs-send-image-body-0 type=button role=tab aria-controls=tabs-send-image-body-0 aria-selected=true>
198203
URL</button>
199204
<button class=nav-link id=tabs-send-image-body-1-tab data-bs-toggle=tab data-bs-target=#tabs-send-image-body-1 type=button role=tab aria-controls=tabs-send-image-body-1 aria-selected=true>
200205
BASE64</button></div></nav><div class=tab-content id=nav-tabContent><div class="tab-pane fade show active" id=tabs-send-image-body-0 role=tabpanel aria-labelledby=tabs-send-image-body-0-tab tabindex=0><div class=expressive-code><figure class="frame has-title not-content"><figcaption class=header><span class=title>Body</span></figcaption><div class=highlight title=Body><pre tabindex=0 class=chroma><code class=language-jsonc data-lang=jsonc><span class=line><span class=cl><span class=p>{</span>

0 commit comments

Comments
 (0)