شروع به کار

sem.chat API به شما امکان می دهد مکالمات را به صورت برنامه نویسی مدیریت کنید، پیام ارسال کنید و به تجزیه و تحلیل دسترسی داشته باشید. همه درخواست‌های API نیاز به احراز هویت با استفاده از کلید API دارند.

URL پایه

https://api.sem.chat/v1

احراز هویت

کلید API خود را در هدر مجوز همه درخواست‌ها قرار دهید:

Authorization: Bearer your_api_key_here

گفتگوها

لیست مکالمات

GET /conversations

لیستی از تمام مکالمات را برای حساب خود بازیابی کنید.

پارامتر تایپ کنید توضیحات
محدود کردن عدد صحیح تعداد نتایج برای بازگشت (حداکثر 100)
جبران عدد صحیح تعداد نتایج برای رد شدن
وضعیت رشته فیلتر بر اساس وضعیت: فعال، بسته، در انتظار

دریافت مکالمه

GET /conversations/{id}

جزئیات یک مکالمه خاص از جمله همه پیام ها را بازیابی کنید.

ایجاد مکالمه

POST /conversations

یک مکالمه جدید را به صورت برنامه ای شروع کنید.

پیام ها

ارسال پیام

POST /conversations/{id}/messages

به یک مکالمه موجود پیام بفرستید.

// Example request body { "content": "Hello, how can I help you today?", "sender": "agent" }

وب هوک ها

برای دریافت اعلان‌های بی‌درنگ درباره رویدادهای مکالمه، وب هوک‌ها را راه‌اندازی کنید.

رویدادهای موجود

رویداد توضیحات
گفتگو شروع شد گفتگوی جدیدی آغاز شده است
پیام.دریافت شد پیام جدیدی از یک بازدیدکننده دریافت شد
گفتگو.بسته یک گفتگو بسته شده است
سرب.اسیر اطلاعات تماس جمع آوری شد

محدودیت های نرخ

درخواست های API برای اطمینان از استفاده منصفانه محدود است:

برنامه ریزی کنید محدودیت نرخ
محاکمه 100 درخواست در ساعت
حرفه ای 1000 درخواست در ساعت
تجارت 10000 درخواست در ساعت