مرجع API
گفتوگوهای پروژه
گفتوگوهای مربوط به یک پروژه را برای نمایش در فضای کاری فهرست کنید. برای دیدن پیامهای هر گفتوگو از بخش گفتوگوها استفاده کنید.
روند کار
روی هر عملیات بزنید تا همهٔ ورودیها، request، response و کدهای وضعیت آن را ببینید.
فهرست گفتوگوهای پروژه
GET
/api/v1/tenancy/projects/{project_id}/chatsآدرس پایهٔ API
https://api.mahvashai.irاحراز هویتJWT کاربر
Responseresponse در قالب مخصوص مهوش
پارامترها
این جدول همهٔ ورودیهایی را که این endpoint میپذیرد نشان میدهد. مقدارهای نمونهها ساختگیاند و یک روش امن برای یکپارچهسازی را نشان میدهند.
| نام | محل ارسال | نوع | الزامی | پشتیبانی | توضیحات |
|---|---|---|---|---|---|
project_id | مسیر (path) | string | الزامی | مخصوص مهوش | UUID پروژه. |
search | Query | string | اختیاری | مخصوص مهوش | جستوجو در عنوان گفتوگوها، بدون حساسیت به حروف بزرگ و کوچک. |
status | Query | string | اختیاری | مخصوص مهوش | فیلتر بر اساس وضعیت چرخهٔ عمر گفتوگو. |
page | Query | integer | اختیاری | مخصوص مهوش | شمارهٔ صفحه (از ۱)، وقتی صفحهبندی میخواهید. |
page_size | Query | integer | اختیاری | مخصوص مهوش | اندازهٔ صفحه از ۱ تا ۱۰۰، وقتی صفحهبندی میخواهید. |
X-Request-ID | Header | string | اختیاری | مخصوص مهوش | شناسهٔ ردگیری که کلاینت میفرستد. در همهٔ پاسخها برمیگردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازهای میسازد. |
X-Mahvash-Project | Header | string | اختیاری | مخصوص مهوش | slug یا شناسهٔ پروژه در سازمان شما. دامنهٔ request را محدودتر میکند و هرگز دسترسی بیشتری نمیدهد. |
Request
curl -X GET 'https://api.mahvashai.ir/api/v1/tenancy/projects/<project_id>/chats' \
-H "Authorization: Bearer $MAHVASH_USER_JWT"Response
{
"status": 0,
"data": "<value>"
}این نمونه فقط ساختار response را نشان میدهد؛ فیلدهای واقعی به نوع عملیات و مدل بستگی دارند.
کدهای وضعیت
| HTTP | توضیحات |
|---|---|
| 200 | request با موفقیت انجام شد. |
| 401 | اطلاعات احراز هویت فرستاده نشده یا معتبر نیست. |
| 403 | دسترسی لازم را ندارید. |
| 404 | منبع پیدا نشد یا برای شما قابل دسترسی نیست. |
| 429 | از سقف مجاز عبور کردهاید. |
| 500 | خطای داخلی سرور. |