Skip to content

Latest commit

 

History

History
135 lines (115 loc) · 4.59 KB

chatbot_conversations.md

File metadata and controls

135 lines (115 loc) · 4.59 KB

مکالمه با چت‌بات (آزمایشی)

پیش‌نیازها

برای استفاده ازاین امکان، نیاز به موارد زیر دارید:

  1. تنظیم "آدرس ارسال رویدادها" در پنل کنار برای دریافت پیام‌های کاربر
  2. دسترسی CHAT_BOT_SEND_MESSAGE برای ارسال پیام (در صورت نیاز از طریق تیکت درخواست دهید)

چت‌بات برنامه شما در لینکی به فرم https://divar.ir/chat/addon_{your_app_slug} در دسترس قرار دارد

دریافت پیام‌های کاربر

پس از تنظیم آدرس ارسال رویدادها، پیام‌های کاربر به صورت درخواست POST به آدرس شما ارسال می‌شود:

POST https://{{new_events_url}}
Authorization: {{identification_key}}
Content-Type: application/json

{
    "type": "NEW_CHATBOT_MESSAGE",
    "new_chatbot_message": {
        "text": "hello world",
        "id": {{message_id}},
        "conversation": {
            "id": {{conversation_id}},
            "type": "BOT",
        },
        "sender": {
            "type": "HUMAN"
        },
        "type": "TEXT",
        "sent_at": 1729429926140000
    }
}

ارسال پیام در مکالمه ایجاد شده (با در دست داشتن conversation id)

برای پاسخ دادن به کاربر در شرایطی که conversation_id را در اختیار دارید، می‌توانید از API زیر استفاده کنید. توجه داشته باشید که برای استفاده از این قابلیت، باید دسترسی CHAT_BOT_SEND_MESSAGE را داشته باشید. در صورتی که این دسترسی را ندارید، می‌توانید از طریق ثبت تیکت در پنل کنار دیوار آن را درخواست کنید.

POST https://api.divar.ir/experimental/open-platform/chat/bot/conversations/{conversation_id}/messages
Content-Type: application/json
X-Api-Key: {your-api-key}

{
  "type": "TEXT",
  "text_message": "hello, World!",
  "buttons": {
    "rows": [
      {
        "buttons": [
          {
            "action": {
              "open_direct_link": "آدرس مورد نظر برای باز شدن بعد از کلیک"
            },
            "icon_name": "REAL_STATE",
            "caption": "متن دکمه"
          },
          {
            "action": {
              "open_server_link": {
                "data": {
                  "my_key_1": "value",
                  "my_key_2": "value2"
                }
              }
            },
            "icon": "HOME",
            "caption": "متن دکمه"
          }
        ]
      }
    ]
  }
}

ارسال پیام مستقیم به کاربر

در این روش با در اختیار داشتن شناسه یکتا کاربر (user_id) و اخذ اجازه کاربر در فرایند OAuth می‌توانید بدون نیاز به conversation_id به کاربر پیام ارسال کنید.

  • در این روش شما قابلیت این را دارید که مکالمه را از سمت چت‌بات شروع کنید.
  • جهت دریافت اطلاعات بیشتر در مورد user_id اینجا را مطالعه کنید.
Authorization Level Required Scope
API CHAT_BOT_SEND_MESSAGE
User (OAuth) CHAT_BOT_USER_MESSAGE_SEND 
POST https://api.divar.ir/experimental/open-platform/chat/bot/users/{user_id}/messages
Content-Type: application/json
X-Api-Key: {your-api-key}
X-Access-Token: {your-access-token}

{
  "type": "TEXT",
  "text_message": "hello, World!",
  "buttons": {
    "rows": [
      {
        "buttons": [
          {
            "action": {
              "open_direct_link": "آدرس مورد نظر برای باز شدن بعد از کلیک"
            },
            "icon_name": "REAL_STATE",
            "caption": "متن دکمه"
          },
          {
            "action": {
              "open_server_link": {
                "data": {
                  "my_key_1": "value",
                  "my_key_2": "value2"
                }
              }
            },
            "icon": "HOME",
            "caption": "متن دکمه"
          }
        ]
      }
    ]
  }
}

Icons

آیکون‌ها موجود برای دکمه‌ها