Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mkhahani committed Nov 12, 2021
1 parent 8e0d89d commit 5cdc1a7
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 50 deletions.
29 changes: 2 additions & 27 deletions doc/asset/help.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ HTTP/1.1 200 OK

|کد خطا|توضیح|
|:---:|---:|
|10|کلید وب‌سرویس نامعتبر است.|
|10|وب‌سرویس غیرفعال است.|
|11|کلید وب‌سرویس نامعتبر است.|
|12|درخواست شما غیرمجاز است.|
|13|درخواست شما معتبر نیست.|
Expand Down Expand Up @@ -748,32 +748,7 @@ HTTP/1.1 200 OK
}
```

#### دریافت آدرس ورود مستقیم به اتاق بدون نیاز به لاگین (منسوخ شده)
با استفاده از این تابع می‌توان برای یک کاربر خاص که پیش‌تر ساخته شده و دسترسی آن به اتاق مورد نظر داده شده است لینک ورود مستقیم ایجاد کرد تا کاربر بدون نیاز به درج نام کاربری و گذرواژه وارد اتاق شود. بهتر است به جای این تابع از تابع createLoginUrl که ساده‌تر است و کارآمدی بیشتری دارد استفاده شود.
##### درخواست:
```json
{
"action": "getLoginUrl",
"params": {
"room_id": 1,
"user_id": 1,
"language": "fa",
"ttl": 300
}
}
```
`ttl` یا Time To Live مدت زمان اعتبار لینک به ثانیه است که در مثال بالا این مدت 3600 ثانیه معادل یک ساعت می‌باشد. پس از این مدت، لینک تولید شده معتبر نیست و در صورت استفاده، کاربر با خطای عدم اعتبار لینک روبرو می‌شود.

##### پاسخ:
```json
{
"ok": true,
"result": "https://www.skyroom.online/ch/faramooz/meeting/t/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1MDY2MDgxMzYsInVpZCI6NjM0N30.uFp056uU4JRKk_UxBy7sw0dkS7qQ80JL05N5_u62zUs/l/fa"
}
```
<br>

#### دریافت آدرس ورود مستقیم به اتاق بدون نیاز به لاگین و ساخت کاربر (جدید)
#### دریافت آدرس ورود مستقیم به اتاق بدون نیاز به لاگین و ساخت کاربر
مزیت این تابع نسبت به تابع `getLoginUrl` این است که نیازی به ساخت کاربر و اعطای دسترسی به اتاق وجود ندارد. کافی است شناسه اتاق را به همراه مشخصات مورد نظر ارسال کنید تا لینک ورود مستقیم برای شما ایجاد شود.
##### درخواست:
```json
Expand Down
25 changes: 2 additions & 23 deletions doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ <h3>مدیریت خطاها</h3>
<tbody>
<tr>
<td style="text-align:center">10</td>
<td style="text-align:right">کلید وب‌سرویس نامعتبر است.</td>
<td style="text-align:right">وب‌سرویس غیرفعال است.</td>
</tr>
<tr>
<td style="text-align:center">11</td>
Expand Down Expand Up @@ -1013,28 +1013,7 @@ <h5>پاسخ:</h5>
&quot;result&quot;: 2
}
</code></pre>
<h4>دریافت آدرس ورود مستقیم به اتاق بدون نیاز به لاگین (منسوخ شده)</h4>
<p>با استفاده از این تابع می‌توان برای یک کاربر خاص که پیش‌تر ساخته شده و دسترسی آن به اتاق مورد نظر داده شده است لینک ورود مستقیم ایجاد کرد تا کاربر بدون نیاز به درج نام کاربری و گذرواژه وارد اتاق شود. بهتر است به جای این تابع از تابع createLoginUrl که ساده‌تر است و کارآمدی بیشتری دارد استفاده شود.</p>
<h5>درخواست:</h5>
<pre><code class="lang-json">{
&quot;action&quot;: &quot;getLoginUrl&quot;,
&quot;params&quot;: {
&quot;room_id&quot;: 1,
&quot;user_id&quot;: 1,
&quot;language&quot;: &quot;fa&quot;,
&quot;ttl&quot;: 300
}
}
</code></pre>
<p><code>ttl</code> یا Time To Live مدت زمان اعتبار لینک به ثانیه است که در مثال بالا این مدت 3600 ثانیه معادل یک ساعت می‌باشد. پس از این مدت، لینک تولید شده معتبر نیست و در صورت استفاده، کاربر با خطای عدم اعتبار لینک روبرو می‌شود.</p>
<h5>پاسخ:</h5>
<pre><code class="lang-json">{
&quot;ok&quot;: true,
&quot;result&quot;: &quot;https://www.skyroom.online/ch/faramooz/meeting/t/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1MDY2MDgxMzYsInVpZCI6NjM0N30.uFp056uU4JRKk_UxBy7sw0dkS7qQ80JL05N5_u62zUs/l/fa&quot;
}
</code></pre>
<p><br></p>
<h4>دریافت آدرس ورود مستقیم به اتاق بدون نیاز به لاگین و ساخت کاربر (جدید)</h4>
<h4>دریافت آدرس ورود مستقیم به اتاق بدون نیاز به لاگین و ساخت کاربر</h4>
<p>مزیت این تابع نسبت به تابع <code>getLoginUrl</code> این است که نیازی به ساخت کاربر و اعطای دسترسی به اتاق وجود ندارد. کافی است شناسه اتاق را به همراه مشخصات مورد نظر ارسال کنید تا لینک ورود مستقیم برای شما ایجاد شود.</p>
<h5>درخواست:</h5>
<pre><code class="lang-json">{
Expand Down

0 comments on commit 5cdc1a7

Please sign in to comment.