-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs for Conversation Send Message and New Actions (#78)
* Remove redundant row in create user verification request input table * Fix Oauth scope for POST_ADDON_CREATE * Add docs for conversation send message and actions
- Loading branch information
1 parent
7beac52
commit e5e745b
Showing
4 changed files
with
183 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,12 @@ | ||
| # اکشن های ویجت ها | ||
| # اکشن‌های ویجت‌ها | ||
|
|
||
| برخی از ویجت ها علاوه بر نمایش اطلاعات د رهمان ویجت ، میتوانند با کلیک روی قسمتی از ویجت ، اکشنی انجام دهند ، برای مثال ، کاربر را به وب سایت دیگری ریدایرکت کنند. | ||
| برخی از ویجت ها علاوه بر نمایش اطلاعات در همان | ||
| ویجت، میتوانند با کلیک روی قسمتی از ویجت، اکشنی انجام دهند، | ||
| برای مثال، کاربر را به وب سایت دیگری ریدایرکت کنند. | ||
|
|
||
| برخی از ویجت ها این قابلیت را دارند و برای مشخص کردن `action` برای ویجت ، یک فیلد `json` با نام `action` میگیرند. | ||
| برخی از ویجت‌ها این قابلیت را دارند و برای مشخص کردن `action` برای ویجت ، یک فیلد `json` با نام `action` میگیرند. | ||
|
|
||
| در حال حاضر در افزونه های کنار دیوار ، دو اکشن زیر ساپورت میشوند: | ||
|
|
||
| - [LoadWebViewPage](./load_web_view_page.md) | ||
| - [OpenDirectLink](./open_direct_link.md) | ||
| - [OpenServerLink](./open_server_link.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # Open Direct Link | ||
| این اکشن به صورت یک فیلد در کنار دیتای ویجت قرار می‌گیرد: | ||
| ```json | ||
| { | ||
| "action": { | ||
| "open_direct_link": "https://provider.com/redirect-page?id=12345" | ||
| } | ||
| } | ||
| ``` | ||
| در صورتی که کاربر از کلاینت وب استفاده می‌کند، فرد به تب | ||
| دیگری با آدرس مشخص شده ریدایرکت می‌شود و | ||
| اگر کاربر از کلاینت اندروید و iOS استفاده کند، | ||
| داخل اپلیکیشن یک صفحه‌ی وب با آدرس ذکر شده باز می‌شود. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # Open Server Link | ||
| این اکشن به صورت یک فیلد در کنار دیتای ویجت قرار می‌گیرد: | ||
| ```json | ||
| { | ||
| "action": { | ||
| "open_server_link": { | ||
| "data": { | ||
| "your_key_1": "your value", | ||
| "your_key_2": "your value" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| پس از کلیک کاربر بر روی ویجتی که این اکشن را داشته باشد، ابتدا یک درخواست از سمت | ||
| دیوار به برنامه‌ی شما برای دریافت آدرس هدایت کاربر ارسال می‌شود. | ||
| شما در جواب این درخواست باید آدرسی که کاربر باید به آن هدایت شود را برگردانید. | ||
|
|
||
| درخواست دریافت آدرس هدایت کاربر به صورت زیر است: | ||
| ```http request | ||
| POST {{YOUR_INIT_URL}} | ||
| Content-Type: application/json | ||
| Authorization: {{YOUR_DIVAR_AUTH_HEADER}} | ||
| API_VERSION: 2 | ||
| { | ||
| "return_url": "https://divar.ir/" | ||
| "source": "POST_ADDON", | ||
| "post_token": "wZC44q5D", | ||
| "conversation_id": "6b3d5cf7-9291-4fa9-892a-9d07e300daea", | ||
| "user_side": "Supply", | ||
| "extra_data": { | ||
| "your_key_1": "your value", | ||
| "your_key_2": "your value" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| | نام فیلد | نوع | حداکثر طول | توضیحات | | ||
| |:----------------|:-----------------:|:----------:|-----------------------------------------------------------------:| | ||
| | return_url | String | 2048 | آدرسی که کاربر پس از اتمام فراید باید به آن بازگردد | | ||
| | source | String | 20 | محلی که کاربر از آن به سمت برنامه شما هدایت شده است | | ||
| | post_token | String (Nullable) | 10 | توکن پست (در صورت وجود) | | ||
| | conversation_id | String (Nullable) | 64 | شناسه مرتبط با چت (در صورت وجود) | | ||
| | user_side | String (Nullable) | 50 | نوع کاربر (خریدار یا فروشنده) | | ||
| | extra_data | JSON | N/A | داده‌های اضافی که از سمت برنامه‌ی شما در کلید data قرار داده شده | | ||
|
|
||
|
|
||
| انتظار می‌رود که در پاسخ به این درخواست، پاسخ موفق با کد وضعیت ۲۰۰ برگردانده شود | ||
| و بدنه‌ی پاسخ به صورت زیر باشد: | ||
| ```json | ||
| { | ||
| "url": "https://your-doman.com/landings/6b3d5cf7-9291-4fa9-892a-9d07e300daea" | ||
| } | ||
| ``` | ||
|
|
||
|
|
||
| ### مقادیر ممکن برای فیلد source | ||
|
|
||
| | Source | فیلد‌های موجود | توضیحات | | ||
| |:----------------------|:---------------------------------------------:|--------------------------------------------:| | ||
| | `POST_ADODN` | `post_token`, `conversation_id`, `user_side` | کاربر بر روی یک افزونه‌ی آگهی کلیک کرده است | | ||
| | `CHAT_MESSAGE_ACTION` | `post_token`, `conversation_id`, `user_side` | کاربر بر روی یک دکمه در چت کلیک کرده است | | ||
|
|
||
| در صورتی که کاربر از کلاینت وب استفاده می‌کند، فرد به تب | ||
| دیگری با آدرس مشخص شده ریدایرکت می‌شود و | ||
| اگر کاربر از کلاینت اندروید و iOS استفاده کند، | ||
| داخل اپلیکیشن یک صفحه‌ی وب با آدرس ذکر شده باز می‌شود. | ||
|
|