شروع کرنا

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" }

ویب ہکس

گفتگو کے واقعات کے بارے میں ریئل ٹائم اطلاعات موصول کرنے کے لیے ویب ہکس ترتیب دیں۔

دستیاب واقعات

واقعہ تفصیل
گفتگو شروع ہوئی۔ ایک نئی بات چیت شروع کی گئی ہے۔
پیغام موصول ہوا۔ ایک وزیٹر کی طرف سے ایک نیا پیغام موصول ہوا۔
بات چیت بند ایک گفتگو بند کر دی گئی ہے۔
lead.captured رابطے کی معلومات اکٹھی کی گئی۔

شرح کی حدود

API درخواستیں منصفانہ استعمال کو یقینی بنانے کے لیے محدود ہیں:

منصوبہ شرح کی حد
ٹرائل 100 درخواستیں فی گھنٹہ
پرو 1,000 درخواستیں/گھنٹہ
کاروبار 10,000 درخواستیں فی گھنٹہ