رفتن به محتوا

مرجع API

گفت‌وگوهای پروژه

گفت‌وگوهای مربوط به یک پروژه را برای نمایش در فضای کاری فهرست کنید. برای دیدن پیام‌های هر گفت‌وگو از بخش گفت‌وگوها استفاده کنید.

روند کار

  1. 01فهرست گفت‌وگوهای پروژه

روی هر عملیات بزنید تا همهٔ ورودی‌ها، request، response و کدهای وضعیت آن را ببینید.

فهرست گفت‌وگوهای پروژه

GET/api/v1/tenancy/projects/{project_id}/chats
آدرس پایهٔ APIhttps://api.mahvashai.ir
احراز هویتJWT کاربر
Responseresponse در قالب مخصوص مهوش

پارامترها

این جدول همهٔ ورودی‌هایی را که این endpoint می‌پذیرد نشان می‌دهد. مقدارهای نمونه‌ها ساختگی‌اند و یک روش امن برای یکپارچه‌سازی را نشان می‌دهند.

ناممحل ارسالنوعالزامیپشتیبانیتوضیحات
project_idمسیر (path)stringالزامیمخصوص مهوشUUID پروژه.
searchQuerystringاختیاریمخصوص مهوشجست‌وجو در عنوان گفت‌وگوها، بدون حساسیت به حروف بزرگ و کوچک.
statusQuerystringاختیاریمخصوص مهوشفیلتر بر اساس وضعیت چرخهٔ عمر گفت‌وگو.
pageQueryintegerاختیاریمخصوص مهوششمارهٔ صفحه (از ۱)، وقتی صفحه‌بندی می‌خواهید.
page_sizeQueryintegerاختیاریمخصوص مهوشاندازهٔ صفحه از ۱ تا ۱۰۰، وقتی صفحه‌بندی می‌خواهید.
X-Request-IDHeaderstringاختیاریمخصوص مهوششناسهٔ ردگیری که کلاینت می‌فرستد. در همهٔ پاسخ‌ها برمی‌گردد و اگر فرستاده نشود یا قالبش درست نباشد، سرور شناسهٔ تازه‌ای می‌سازد.
X-Mahvash-ProjectHeaderstringاختیاریمخصوص مهوش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توضیحات
200request با موفقیت انجام شد.
401اطلاعات احراز هویت فرستاده نشده یا معتبر نیست.
403دسترسی لازم را ندارید.
404منبع پیدا نشد یا برای شما قابل دسترسی نیست.
429از سقف مجاز عبور کرده‌اید.
500خطای داخلی سرور.