پیام‌ها

یادداشت‌ها
سطح کارشناسی
کلید API باید به عنوان توکن Bearer در هدر مجوز درخواست ارسال شود. کلید API خود را بگیرید.
لیست

پایانه API:

GET 
https://ai.mr-web.ir/api/v1/messages

مثال درخواست: 

curl --location --request GET 'https://ai.mr-web.ir/api/v1/messages' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {api_key}'
پارامتر
نوع
توضیحات
search
اختیاری string
متن جستجو.
search_by
اختیاری string
جستجو بر اساس. مقادیر ممکن هستند: :مقدار برای پیام. مقدار پیش فرض: message.
chat_id
اختیاری string
فیلتر براساس شناسه چت.
role
اختیاری string
فیلتر براساس نقش. مقادیر ممکن هستند: :مقدار برای کاربر, :مقدار برای معاون.
sort_by
اختیاری string
مرتب سازی بر اساس. مقادیر ممکن هستند: :مقدار برای تاریخ ایجاد. مقدار پیش فرض: id.
sort
اختیاری string
مرتب‌سازی. مقادیر ممکن هستند: :مقدار برای نزولی, :مقدار برای صعودی. مقدار پیش فرض: desc.
per_page
اختیاری int
نتایج در هر صفحه. مقادیر ممکن هستند: 10, 25, 50, 100. مقدار پیش فرض: 10.
فروشگاه

پایانه API:

POST 
https://ai.mr-web.ir/api/v1/messages

مثال درخواست: 

curl --location --request POST 'https://ai.mr-web.ir/api/v1/messages' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Bearer {api_key}' \
--data-urlencode 'name={name}' \
--data-urlencode 'description={description}'
پارامتر
نوع
توضیحات
name
الزامی string
نام چت.
chat_id
الزامی string
شناسه چت که پیام در زیر آن ذخیره خواهد شد.
role
الزامی string
نقش پیام. مقادیر ممکن هستند: :مقدار برای کاربر, :مقدار برای معاون.