API

این یک ترجمه است. نسخهٔ آلمانی معتبر است. هر جا این متن با آن فرق داشته باشد، متن آلمانی ملاک است. زبان را می‌توانید پایین صفحه عوض کنید.

فهرست مطالب

نمای کلی

نسخهٔ ۲ به برنامه‌های خودتان اجازه می‌دهد با tellmelo حرف بزنند: یک کلید در هر درخواست، پاسخ JSON، و همهٔ فهرست‌ها یکسان صفحه‌بندی می‌شوند. همان قوانین برنامه برقرار است.

همهٔ مسیرها با /api/v2 در نشانی این سرور شروع می‌شوند.
درخواست‌ها و پاسخ‌ها JSON با UTF-8 هستند. نام فیلدها، کدها و مقدارها انگلیسی‌اند و انگلیسی می‌مانند.
کلید به‌جای حساب شما عمل می‌کند: آنچه در برنامه نمی‌توانید ببینید، آن هم نمی‌تواند بخواند.

https://tellmelo.com/api/v2

شروع سریع

در «تنظیمات ← برنامه و داده‌ها ← API» کلیدی بسازید و کپی‌اش کنید. فقط یک بار نشان داده می‌شود.
با آن ریشه را فراخوانی کنید. پاسخ، نسخه، اختیارات کلید و درخواست‌های باقی‌ماندهٔ این دقیقه را نشان می‌دهد.
همهٔ مسیرها یکسان کار می‌کنند: کلید در سرآیند، پاسخ JSON، و برای فهرست‌ها items و next.

curl -H "Authorization: Bearer tm_key_…" https://tellmelo.com/api/v2

{
  "name": "tellmelo",
  "version": "2.9",
  "scope": "read write",
  "rateLimit": {
    "limit": 120,
    "remaining": 117
  },
  "docs": "/legal/api",
  "spec": "/api/v2/openapi.json"
}

بعدی: /me برای پروفایلتان، /posts برای پست‌های عمومی، /feed برای فیدتان.

امتحانش کنید

کاری انتخاب کنید، فیلدها را پر کنید و درخواست را کپی کنید یا از همین‌جا بفرستید. نوشتن ابتدا می‌پرسد. کد کلید را از TELLMELO_KEY می‌خواند.

کار

read نسخهٔ API و نام این سرور.

curl \
  -H "Authorization: Bearer $TELLMELO_KEY" \
  "https://tellmelo.com/api/v2"

کلید شمافقط تا وقتی این صفحه را ببندید در آن می‌ماند.

کلید شما

یک کلید برای هر حساب. با tm_key_ شروع می‌شود و فقط یک بار نشان داده می‌شود. گمش کردید؟ کلید تازه‌ای بسازید؛ قبلی از کار می‌افتد.

آن را در «تنظیمات ← برنامه و داده‌ها ← API» می‌سازید. در سرآیند درخواست فرستاده می‌شود:

curl -H "Authorization: Bearer tm_key_…" \
  https://tellmelo.com/api/v2/posts

یا اگر راحت‌تر است، در یک سرآیند جداگانه:

curl -H "X-Tellmelo-Key: tm_key_…" https://tellmelo.com/api/v2

نه در نشانی: آنجا در گزارش‌ها و تاریخچهٔ مرورگر می‌ماند.

همان کلید تصویرها را هم بارگیری می‌کند: هر url به /api/media اشاره می‌کند؛ آنجا هم کلید را در سرآیند بفرستید.

curl -H "Authorization: Bearer tm_key_…" \
  -o picture.webp "https://tellmelo.com/api/media?id=…"

یک کلید چه کاری می‌تواند بکند

هر کلید یکی از دو اختیار را دارد، و هر مسیر در زیر می‌گوید به کدام نیاز دارد:

read: خواندن. پست‌ها، پروفایل‌ها، گروه‌ها و برچسب‌های عمومی، به‌علاوهٔ فید، اعلان‌ها و پیام‌های شما.
write: انجام دادن. انتشار، پاسخ، رأی، ارسال پیام، دنبال کردن، پیوستن، مسدود کردن، علامت زدن اعلان‌ها به‌عنوان خوانده‌شده.

آنچه هیچ کلیدی نمی‌تواند

هیچ کلیدی به رمز عبور، نشانی ایمیل، نوع حساب، مکان، نقش، حذف، نشست‌ها، دستگاه‌های اعلان یا کلیدهای دیگر نمی‌رسد، و نه به مدیریت یا ادارهٔ گروه. آنچه رمز عبور از آن محافظت می‌کند، هیچ کلیدی نمی‌تواند.

درخواست‌ها و پاسخ‌ها

همه‌جا JSON. هر پاسخ application/json با UTF-8 است، از جمله خطاها. فقط تصویرها به‌صورت تصویر می‌آیند.
آنچه می‌فرستید. یک POST فیلدهایش را به‌صورت JSON در بدنه می‌برد. اگر فیلدی در نشانی هم باشد، بدنه برنده است.
زمان‌ها میلی‌ثانیه از ۱ ژانویهٔ ۱۹۷۰ به وقت UTC هستند.
شناسه‌ها رشته‌اند. فقط به‌صورت کامل مقایسه‌شان کنید.
هر فیلد همیشه هست. آنچه کم است null است؛ فهرست‌ها ممکن است خالی باشند.
متن‌ها ساده‌اند، دقیقاً همان‌طور که نوشته شده‌اند. #tags، @names و پیوندها همان‌طور می‌مانند، و ایموجی‌های اختصاصی سرور هم به‌صورت :name:؛ تصویرهایشان در /emojis آمده‌اند.
تصویرها نشانی‌های نسبی‌اند، /api/media?id=…. بدون کلید در سرآیند 401 می‌گیرید.

صفحه‌ها

هر فهرست limit و cursor می‌گیرد و با items و next پاسخ می‌دهد. next را به‌عنوان cursor پس بفرستید تا صفحهٔ بعد را بگیرید؛ وقتی next خالی است، تمام است. نشانگر مبهم است: آن را تجزیه نکنید، خودتان نسازید.

{ "items": [ … ], "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx" }

curl -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/posts?limit=20&cursor=MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"

بدون limit، ۲۰ ورودی، حداکثر ۵۰. بعضی فهرست‌ها صفحه‌بندی نمی‌شوند؛ nextِ آن‌ها همیشه null است.

فقط چیزهای تازه

هر پاسخ یک ETag دارد. دفعهٔ بعد آن را به‌عنوان If-None-Match پس بفرستید: اگر چیزی تغییر نکرده باشد، 304 بدون بدنه می‌گیرید.

ETag: W/"3Qk1mJ7fQe2Yb0sVxT9aL4pNdRc"
If-None-Match: W/"3Qk1mJ7fQe2Yb0sVxT9aL4pNdRc"  →  304

استثناها: /feed هیچ ETagای ندارد چون ترتیبش مدام تغییر می‌کند، و نوشتن‌ها هرگز 304 پاسخ نمی‌دهند.

سقف‌ها

هر کلید می‌تواند ۱۲۰ درخواست در دقیقه بدهد، با اشتراک «سازمان» ۶۰۰، مگر اینکه مدیریت چیز دیگری تعیین کند. بیش از آن 429 می‌گیرید و چیزی انجام نشده است. یک دقیقه صبر کنید و درخواست را دوباره بفرستید.

X-RateLimit-Limit: 120
X-RateLimit-Remaining: 117
X-RateLimit-Reset: 1758624060

نوشتن‌ها از سقف‌های برنامه هم کم می‌کنند، مثلاً چند پست در چند دقیقه. آن هم با 429 و rate_limited پاسخ می‌دهد.

سرآیندها

جز کلید، هیچ سرآیندی لازم نیست.

آنچه می‌فرستید

سرآیند	معنا
`Authorization`	کلید را می‌برد: `Bearer tm_key_…`. راه معمول.
`X-Tellmelo-Key`	کلید، به‌جای `Authorization`.
`Content-Type`	`application/json`، برای درخواستی با بدنه.
`If-None-Match`	`ETag` آخرین پاسخ. اگر از آن زمان چیزی تغییر نکرده باشد، پاسخ `304` بدون بدنه است.

آنچه برمی‌گردد

سرآیند	معنا
`ETag`	اثر انگشت این پاسخ (`W/`). آن را به‌عنوان `If-None-Match` پس بفرستید.
`X-RateLimit-Limit`	این کلید در هر دقیقه چند درخواست می‌تواند بدهد.
`X-RateLimit-Remaining`	چند تا از آن‌ها در دقیقهٔ جاری مانده است.
`X-RateLimit-Reset`	دقیقهٔ بعد کی شروع می‌شود، بر حسب ثانیه از ۱۹۷۰ به وقت UTC.
`X-Tellmelo-Scope`	این کلید چه می‌تواند بکند: `read` یا `read write`.
`Retry-After`	همراه `429`: چند ثانیه پیش از پرسیدن دوباره صبر کنید.
`WWW-Authenticate`	در `401` بدون کلید: `Bearer`.
`Cache-Control`	`no-store`: هیچ پراکسی‌ای نباید پاسخ را ذخیره کند. همچنان می‌توانید با `ETag` بررسی‌اش کنید.

وقتی چیزی کار نمی‌کند

خطاها به‌صورت JSON می‌آیند: یک کد ثابت انگلیسی در error برای برنامهٔ شما و یک جمله در message برای آدم‌ها، به‌علاوهٔ کد وضعیت مناسب. فقط کد را مقایسه کنید؛ جمله ممکن است تغییر کند.

{ "error": "rate_limited",
  "message": "Too many requests. Try again in a minute.",
  "limit": 120 }

بعضی خطاها یک فیلد بیشتر دارند: docs همراه 401 برای کلید غایب، limit همراه 429.

وضعیت	کد	معنا
`400`	`bad_request`	درخواست خواندنی نیست، فیلدی لازم کم است، یا مقداری مجاز نیست.
`401`	`key_missing`	کلیدی در سرآیند نیست.
`401`	`key_invalid`	کلید معتبر نیست: اشتباه تایپ شده، جایگزین شده، یا حساب مسدود است.
`401`	`unauthorized`	به‌عنوان واردنشده رد شد، به دلیلی جز کلید.
`403`	`scope_missing`	کلید اختیار لازم را ندارد، معمولاً `write`.
`403`	`account_data_locked`	اطلاعات حساب مثل رمز عبور، نشانی ایمیل یا حذف برای کلیدها ممنوع است.
`403`	`forbidden`	حساب شما اجازهٔ این کار را ندارد، مثلاً به‌خاطر اختیار پس‌گرفته‌شده یا مسدودی.
`404`	`unknown_path`	چنین مسیری نیست، یا با این روش نیست.
`404`	`not_found`	پیدا نشد، یا اجازهٔ دیدنش را ندارید.
`409`	`conflict`	با چیزی که از قبل هست برخورد دارد، مثلاً نامی که گرفته شده.
`413`	`too_large`	برای این سرور خیلی بزرگ است.
`422`	`unprocessable`	خواندنی است، اما به این شکل ممکن نیست.
`429`	`rate_limited`	درخواست‌ها زیادند. اتفاقی نیفتاد؛ صبر کنید و دوباره تلاش کنید.
`500`	`internal_error`	در سرور مشکلی پیش آمد.

نسخه‌ها

نسخه در مسیر آمده است. تا وقتی v2 نوشته شده، مسیرها و فیلدها همان می‌مانند؛ فقط چیزهای تازه اضافه می‌شوند.

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

/api/v1/ دیگر نیست: مسیرهای قدیمی 410 پاسخ می‌دهند و راه تازه را در بدنه نام می‌برند.

نقطه‌های پایانی

همهٔ مسیرها در یک نگاه، سپس هر کدام با مثال.

مسیر	اختیار	برای چه
راه ورود
GET`/api/v2`	`read`	نسخهٔ API و نام این سرور.
پست‌ها
GET`/api/v2/posts`	`read`	پست‌های عمومی، تازه‌ترین اول.
GET`/api/v2/posts/{id}`	`read`	یک پست، با `id` آن.
POST`/api/v2/posts`	`write`	انتشار یک پست.
DELETE`/api/v2/posts/{id}`	`write`	حذف یکی از پست‌های خودتان.
پاسخ‌ها
GET`/api/v2/posts/{id}/replies`	`read`	پاسخ‌های یک پست، بدون حساب‌های مسدود.
POST`/api/v2/posts/{id}/replies`	`write`	پاسخ به یک پست.
نظرسنجی‌ها
POST`/api/v2/posts/{id}/vote`	`write`	شرکت در نظرسنجی.
پروفایل‌ها
GET`/api/v2/profiles/{handle}`	`read`	یک پروفایل، با نام کوتاهش.
GET`/api/v2/profiles/{handle}/posts`	`read`	پست‌های عمومی یک پروفایل، تازه‌ترین اول.
گروه‌ها
GET`/api/v2/communities`	`read`	گروه‌های باز این سرور.
GET`/api/v2/communities/{id}`	`read`	یک گروه، با `id` آن.
GET`/api/v2/communities/{id}/posts`	`read`	پست‌های عمومی یک گروه، تازه‌ترین اول.
کاوش
GET`/api/v2/tags`	`read`	برچسب‌هایی که اکنون در جریان‌اند.
GET`/api/v2/search`	`read`	جست‌وجو در پست‌ها، نام‌ها، نام‌های کوتاه و برچسب‌ها.
GET`/api/v2/emojis`	`read`	ایموجی‌های اختصاصی سرور، با نشانی تصویرهایشان.
حساب شما
GET`/api/v2/me`	`read`	پروفایل خودتان، با `id`ای که مسیرهای دیگر انتظار دارند.
GET`/api/v2/feed`	`read`	فید خودتان، همان‌طور که برنامه آن را می‌چیند.
اعلان‌ها
GET`/api/v2/notifications`	`read`	اعلان‌های شما، تازه‌ترین اول.
POST`/api/v2/notifications/read`	`write`	علامت‌گذاری اعلان‌ها به‌عنوان خوانده‌شده.
پیام‌ها
GET`/api/v2/conversations`	`read`	صندوق شما: یک ردیف برای هر گفت‌وگو، تازه‌ترین اول.
GET`/api/v2/conversations/{with}/messages`	`read`	پیام‌های یک گفت‌وگو، تازه‌ترین اول.
POST`/api/v2/conversations/{with}/messages`	`write`	ارسال پیام در یک گفت‌وگو.
POST`/api/v2/conversations/{with}/read`	`write`	علامت زدن همهٔ پیام‌های یک گفت‌وگو به‌عنوان خوانده‌شده.
رابطه‌ها
POST`/api/v2/relations`	`write`	پسندیدن، ذخیره، بازنشر، دنبال کردن، پیوستن، مسدود کردن، بی‌صدا کردن، بسته به `kind`.

راه ورود

اولین درخواست هر برنامه: کلید کار می‌کند، و چه می‌تواند بکند؟

GET`/api/v2`

نسخهٔ API و نام این سرور.

اختیار read
با ETag
از v2.0

بدون اسلش در پایان: /api/v2/ با 308 به /api/v2 می‌رود، و همهٔ برنامه‌ها دنبالش نمی‌روند.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2"

پاسخ

با یک Service پاسخ می‌دهد.

مثال

{
  "name": "tellmelo",
  "version": "2.9",
  "scope": "read write",
  "rateLimit": {
    "limit": 120,
    "remaining": 117
  },
  "docs": "/legal/api",
  "spec": "/api/v2/openapi.json"
}

وضعیت‌های ممکن: 200304401429

پست‌ها

خواندن پست‌های عمومی، انتشار پست‌های خودتان و حذف دوباره‌شان.

GET`/api/v2/posts`

پست‌های عمومی، تازه‌ترین اول.

اختیار read
صفحه‌بندی‌پذیر
با ETag
از v2.0

در مسیرهای عمومی، counts.likes و counts.reposts همیشه 0 و pinned همیشه false است.

پست‌های گروه‌ها اینجا نیستند بلکه در /communities/{id}/posts.

پارامترها

نام	نوع	معنا
`limit`در پرس‌وجو	`integer`اختیاری	شمار ورودی در هر صفحه: پیش‌فرض ۲۰، حداکثر ۵۰.
`cursor`در پرس‌وجو	`string`اختیاری	مقدار `next` پاسخ قبلی. بدون آن، از آغاز.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/posts?limit=20"

پاسخ

با یک صفحه از Post پاسخ می‌دهد، به‌صورت `items` و `next`.

مثال

{
  "items": [
    {
      "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "text": "The bees are back in the garden 🐝 #garden",
      "kind": "poll",
      "author": {
        "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
        "handle": "mara",
        "name": "Mara 🌻",
        "verified": true,
        "accountKind": "person"
      },
      "community": {
        "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
        "name": "Urban Gardening"
      },
      "media": [
        {
          "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
        }
      ],
      "poll": {
        "options": [
          {
            "text": "Lavender",
            "votes": 12
          },
          {
            "text": "Sunflowers",
            "votes": 7
          },
          {
            "text": "Clover",
            "votes": 3
          }
        ],
        "total": 22,
        "multiple": false,
        "endsAt": 1758710400000,
        "running": true,
        "resultsVisible": true,
        "myVotes": [
          0
        ]
      },
      "quotes": null,
      "continues": null,
      "counts": {
        "replies": 4,
        "likes": 31,
        "reposts": 2
      },
      "pinned": false,
      "createdAt": 1758624000000
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

وضعیت‌های ممکن: 200304401429

GET`/api/v2/posts/{id}`

یک پست، با id آن.

اختیار read
با ETag
از v2.0

در مسیرهای عمومی، counts.likes و counts.reposts همیشه 0 و pinned همیشه false است.

پست‌های گروه‌ها اینجا نیستند بلکه در /communities/{id}/posts.

پارامترها

نام	نوع	معنا
`id`در مسیر	`string`اجباری	`id` یک پست.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/posts/5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1"

پاسخ

با یک Post پاسخ می‌دهد.

مثال

{
  "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
  "text": "The bees are back in the garden 🐝 #garden",
  "kind": "poll",
  "author": {
    "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
    "handle": "mara",
    "name": "Mara 🌻",
    "verified": true,
    "accountKind": "person"
  },
  "community": {
    "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
    "name": "Urban Gardening"
  },
  "media": [
    {
      "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
    }
  ],
  "poll": {
    "options": [
      {
        "text": "Lavender",
        "votes": 12
      },
      {
        "text": "Sunflowers",
        "votes": 7
      },
      {
        "text": "Clover",
        "votes": 3
      }
    ],
    "total": 22,
    "multiple": false,
    "endsAt": 1758710400000,
    "running": true,
    "resultsVisible": true,
    "myVotes": [
      0
    ]
  },
  "quotes": null,
  "continues": null,
  "counts": {
    "replies": 4,
    "likes": 31,
    "reposts": 2
  },
  "pinned": false,
  "createdAt": 1758624000000
}

وضعیت‌های ممکن: 200304400401404429

POST`/api/v2/posts`

انتشار یک پست.

اختیار write
از v2.0

پست به متن یا نظرسنجی نیاز دارد. طول، گزینه‌های نظرسنجی و آهنگ را سرور تعیین می‌کند؛ فراتر از آن 400 یا 429 می‌گیرید.

هنوز نمی‌توان از طریق API تصویر پیوست کرد، فقط در برنامه.

پارامترها

نام	نوع	معنا
`text`در بدنه	`string`اختیاری	متن پست، پاسخ یا پیام.
`community`در بدنه	`string`اختیاری	`id` گروهی که پست به آن می‌رود. بدون آن، بیرون از همهٔ گروه‌ها.
`quotes`در بدنه	`string`اختیاری	`id` پستی که این پست نقل می‌کند.
`poll`در بدنه	`string[]`اختیاری	گزینه‌های پاسخ به‌صورت فهرستی از متن‌ها.

درخواست نمونه

curl -X POST \
  -H "Authorization: Bearer tm_key_…" \
  -H "Content-Type: application/json" \
  -d '{"text":"The bees are back in the garden 🐝 #garden"}' \
  "https://tellmelo.com/api/v2/posts"

پاسخ

با یک Created پاسخ می‌دهد.

مثال

{
  "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
  "scheduledFor": null,
  "deleteAt": null
}

وضعیت‌های ممکن: 200400401403429

DELETE`/api/v2/posts/{id}`

حذف یکی از پست‌های خودتان.

اختیار write
از v2.0

پارامترها

نام	نوع	معنا
`id`در مسیر	`string`اجباری	`id` یک پست.

درخواست نمونه

curl -X DELETE \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/posts/5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1"

پاسخ

با یک Ok پاسخ می‌دهد.

مثال

{
  "ok": true
}

وضعیت‌های ممکن: 200400401403404429

پاسخ‌ها

پاسخ‌های زیر یک پست، به‌صورت فهرست با parentId.

GET`/api/v2/posts/{id}/replies`

پاسخ‌های یک پست، بدون حساب‌های مسدود.

اختیار read
صفحه‌بندی‌پذیر
با ETag
از v2.0

فهرست تخت و به ترتیب نوشتن است؛ parentId آن را به درخت تبدیل می‌کند. هر صفحه همیشه رشته‌های کامل دارد. پاسخ‌های حساب‌های مسدود حذف می‌شوند.

پارامترها

نام	نوع	معنا
`id`در مسیر	`string`اجباری	`id` یک پست.
`limit`در پرس‌وجو	`integer`اختیاری	شمار ورودی در هر صفحه: پیش‌فرض ۲۰، حداکثر ۵۰.
`cursor`در پرس‌وجو	`string`اختیاری	مقدار `next` پاسخ قبلی. بدون آن، از آغاز.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/posts/5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1/replies?limit=20"

پاسخ

با یک صفحه از Reply پاسخ می‌دهد، به‌صورت `items` و `next`.

مثال

{
  "items": [
    {
      "id": "9e4b1c7d-2a3f-4d5e-8b6c-0f1e2d3c4b5a",
      "text": "Same here, the lavender is full of them.",
      "kind": "post",
      "author": {
        "id": "d4c3b2a1-6e5f-4a7b-9c8d-1e2f3a4b5c6d",
        "handle": "jon",
        "name": "Jon",
        "verified": false,
        "accountKind": "person"
      },
      "community": null,
      "media": [],
      "poll": null,
      "quotes": null,
      "continues": null,
      "counts": {
        "replies": 0,
        "likes": 3,
        "reposts": 0
      },
      "pinned": false,
      "createdAt": 1758624600000,
      "postId": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "parentId": null
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

وضعیت‌های ممکن: 200304400401404429

POST`/api/v2/posts/{id}/replies`

پاسخ به یک پست.

اختیار write
از v2.0

در حالت آهسته، هر نفر هر ۱۰ دقیقه یک پاسخ، وگرنه 429. نویسنده و حساب‌هایی که دنبال می‌کند مستثنا هستند.

پارامترها

نام	نوع	معنا
`id`در مسیر	`string`اجباری	`id` یک پست.
`text`در بدنه	`string`اجباری	متن پست، پاسخ یا پیام.
`parentId`در بدنه	`string`اختیاری	`id` پاسخی که این پاسخ به آن است. بدون آن، مستقیم به پست.

درخواست نمونه

curl -X POST \
  -H "Authorization: Bearer tm_key_…" \
  -H "Content-Type: application/json" \
  -d '{"text":"Same here, the lavender is full of them."}' \
  "https://tellmelo.com/api/v2/posts/5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1/replies"

پاسخ

با یک Created پاسخ می‌دهد.

مثال

{
  "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
  "scheduledFor": null,
  "deleteAt": null
}

وضعیت‌های ممکن: 200400401403404429

نظرسنجی‌ها

نظرسنجی پستی است که poll آن تنظیم شده است. رأی دادن مسیر خودش را دارد.

POST`/api/v2/posts/{id}/vote`

شرکت در نظرسنجی.

اختیار write
از v2.0

رأی‌های هر گزینه تا وقتی رأی ندهید یا نظرسنجی تمام نشود null هستند. total همیشه هست.

پارامترها

نام	نوع	معنا
`id`در مسیر	`string`اجباری	`id` یک پست.
`option`در بدنه	`integer`اجباری	کدام گزینه، شمرده از ۰. برای چندگزینه‌ای، برای هر گزینه یک بار فراخوانی کنید.
`retract`در بدنه	`boolean`اختیاری	`true` رأی را پس می‌گیرد.

درخواست نمونه

curl -X POST \
  -H "Authorization: Bearer tm_key_…" \
  -H "Content-Type: application/json" \
  -d '{"option":0}' \
  "https://tellmelo.com/api/v2/posts/5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1/vote"

پاسخ

با یک Ok پاسخ می‌دهد.

مثال

{
  "ok": true
}

وضعیت‌های ممکن: 200400401403404429

پروفایل‌ها

پروفایل‌های عمومی با نام کوتاهشان، و آنچه منتشر کرده‌اند.

GET`/api/v2/profiles/{handle}`

یک پروفایل، با نام کوتاهش.

اختیار read
با ETag
از v2.0

پارامترها

نام	نوع	معنا
`handle`در مسیر	`string`اجباری	نام کوتاه یک پروفایل.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/profiles/mara"

پاسخ

با یک Profile پاسخ می‌دهد.

مثال

{
  "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
  "handle": "mara",
  "name": "Mara 🌻",
  "verified": true,
  "accountKind": "person",
  "about": "Beekeeper, allotment, too many seeds. :tellmelo:",
  "website": "https://mara-imkerei.example/",
  "websiteVerified": true,
  "followers": 148,
  "createdAt": 1750848000000
}

وضعیت‌های ممکن: 200304400401404429

GET`/api/v2/profiles/{handle}/posts`

پست‌های عمومی یک پروفایل، تازه‌ترین اول.

اختیار read
صفحه‌بندی‌پذیر
با ETag
از v2.0

در مسیرهای عمومی، counts.likes و counts.reposts همیشه 0 و pinned همیشه false است.

پست‌های گروه‌ها اینجا نیستند بلکه در /communities/{id}/posts.

پارامترها

نام	نوع	معنا
`handle`در مسیر	`string`اجباری	نام کوتاه یک پروفایل.
`limit`در پرس‌وجو	`integer`اختیاری	شمار ورودی در هر صفحه: پیش‌فرض ۲۰، حداکثر ۵۰.
`cursor`در پرس‌وجو	`string`اختیاری	مقدار `next` پاسخ قبلی. بدون آن، از آغاز.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/profiles/mara/posts?limit=20"

پاسخ

با یک صفحه از Post پاسخ می‌دهد، به‌صورت `items` و `next`.

مثال

{
  "items": [
    {
      "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "text": "The bees are back in the garden 🐝 #garden",
      "kind": "poll",
      "author": {
        "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
        "handle": "mara",
        "name": "Mara 🌻",
        "verified": true,
        "accountKind": "person"
      },
      "community": {
        "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
        "name": "Urban Gardening"
      },
      "media": [
        {
          "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
        }
      ],
      "poll": {
        "options": [
          {
            "text": "Lavender",
            "votes": 12
          },
          {
            "text": "Sunflowers",
            "votes": 7
          },
          {
            "text": "Clover",
            "votes": 3
          }
        ],
        "total": 22,
        "multiple": false,
        "endsAt": 1758710400000,
        "running": true,
        "resultsVisible": true,
        "myVotes": [
          0
        ]
      },
      "quotes": null,
      "continues": null,
      "counts": {
        "replies": 4,
        "likes": 31,
        "reposts": 2
      },
      "pinned": false,
      "createdAt": 1758624000000
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

وضعیت‌های ممکن: 200304400401404429

گروه‌ها

گروه‌های باز و پست‌هایشان.

GET`/api/v2/communities`

گروه‌های باز این سرور.

اختیار read
با ETag
از v2.0

بر اساس شمار اعضا مرتب شده و صفحه‌بندی نمی‌شود؛ next همیشه null است.

پارامترها

نام	نوع	معنا
`limit`در پرس‌وجو	`integer`اختیاری	شمار ورودی در هر صفحه: پیش‌فرض ۲۰، حداکثر ۵۰.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/communities?limit=20"

پاسخ

با یک صفحه از Community پاسخ می‌دهد، به‌صورت `items` و `next`.

مثال

{
  "items": [
    {
      "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
      "name": "Urban Gardening",
      "description": "Balconies, allotments, rooftops: whatever grows.",
      "tags": [
        "garden",
        "bees"
      ],
      "members": 312,
      "joinPolicy": "open",
      "visibility": "open"
    }
  ],
  "next": null
}

وضعیت‌های ممکن: 200304401429

GET`/api/v2/communities/{id}`

یک گروه، با id آن.

اختیار read
با ETag
از v2.0

پارامترها

نام	نوع	معنا
`id`در مسیر	`string`اجباری	`id` یک گروه.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/communities/c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60"

پاسخ

با یک Community پاسخ می‌دهد.

مثال

{
  "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
  "name": "Urban Gardening",
  "description": "Balconies, allotments, rooftops: whatever grows.",
  "tags": [
    "garden",
    "bees"
  ],
  "members": 312,
  "joinPolicy": "open",
  "visibility": "open"
}

وضعیت‌های ممکن: 200304400401404429

GET`/api/v2/communities/{id}/posts`

پست‌های عمومی یک گروه، تازه‌ترین اول.

اختیار read
صفحه‌بندی‌پذیر
با ETag
از v2.0

در مسیرهای عمومی، counts.likes و counts.reposts همیشه 0 و pinned همیشه false است.

پارامترها

نام	نوع	معنا
`id`در مسیر	`string`اجباری	`id` یک گروه.
`limit`در پرس‌وجو	`integer`اختیاری	شمار ورودی در هر صفحه: پیش‌فرض ۲۰، حداکثر ۵۰.
`cursor`در پرس‌وجو	`string`اختیاری	مقدار `next` پاسخ قبلی. بدون آن، از آغاز.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/communities/c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60/posts?limit=20"

پاسخ

با یک صفحه از Post پاسخ می‌دهد، به‌صورت `items` و `next`.

مثال

{
  "items": [
    {
      "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "text": "The bees are back in the garden 🐝 #garden",
      "kind": "poll",
      "author": {
        "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
        "handle": "mara",
        "name": "Mara 🌻",
        "verified": true,
        "accountKind": "person"
      },
      "community": {
        "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
        "name": "Urban Gardening"
      },
      "media": [
        {
          "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
        }
      ],
      "poll": {
        "options": [
          {
            "text": "Lavender",
            "votes": 12
          },
          {
            "text": "Sunflowers",
            "votes": 7
          },
          {
            "text": "Clover",
            "votes": 3
          }
        ],
        "total": 22,
        "multiple": false,
        "endsAt": 1758710400000,
        "running": true,
        "resultsVisible": true,
        "myVotes": [
          0
        ]
      },
      "quotes": null,
      "continues": null,
      "counts": {
        "replies": 4,
        "likes": 31,
        "reposts": 2
      },
      "pinned": false,
      "createdAt": 1758624000000
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

وضعیت‌های ممکن: 200304400401404429

کاوش

روندها، جست‌وجو و ایموجی‌های اختصاصی سرور.

GET`/api/v2/tags`

برچسب‌هایی که اکنون در جریان‌اند.

اختیار read
با ETag
از v2.0

حداکثر ۱۰ برچسب روز بر اساس امتیاز: هر استفاده ۱ حساب می‌شود و هر ۳ روز نصف می‌شود، هر حساب در روز حداکثر ۳ حساب می‌شود. posts امتیاز گردشده است. limit فقط فهرست را کوتاه می‌کند. برچسب‌هایی که تیم برجسته می‌کند ممکن است بالاتر بایستند.

پارامترها

نام	نوع	معنا
`limit`در پرس‌وجو	`integer`اختیاری	شمار ورودی در هر صفحه: پیش‌فرض ۲۰، حداکثر ۵۰.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/tags?limit=10"

پاسخ

با یک صفحه از Tag پاسخ می‌دهد، به‌صورت `items` و `next`.

مثال

{
  "items": [
    {
      "tag": "garden",
      "posts": 58
    }
  ],
  "next": null
}

وضعیت‌های ممکن: 200304401429

GET`/api/v2/search`

جست‌وجو در پست‌ها، نام‌ها، نام‌های کوتاه و برچسب‌ها.

اختیار read
با ETag
از v2.0

فقط محتوای عمومی را جست‌وجو می‌کند: پست‌های بیرون از گروه‌ها، پروفایل‌ها و برچسب‌ها. limit برای هر نوع اعمال می‌شود.

پارامترها

نام	نوع	معنا
`q`در پرس‌وجو	`string`اجباری	واژه‌هایی که دنبالشان هستید.
`type`در پرس‌وجو	`string`اختیاری	کدام نوع نتیجه. بدون آن، همهٔ انواع.`allpostsprofilestags`
`limit`در پرس‌وجو	`integer`اختیاری	شمار ورودی در هر صفحه: پیش‌فرض ۲۰، حداکثر ۵۰.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/search?q=garden&type=posts"

پاسخ

با یک SearchResult پاسخ می‌دهد.

مثال

{
  "posts": [
    {
      "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "text": "The bees are back in the garden 🐝 #garden",
      "kind": "poll",
      "author": {
        "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
        "handle": "mara",
        "name": "Mara 🌻",
        "verified": true,
        "accountKind": "person"
      },
      "community": {
        "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
        "name": "Urban Gardening"
      },
      "media": [
        {
          "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
        }
      ],
      "poll": {
        "options": [
          {
            "text": "Lavender",
            "votes": 12
          },
          {
            "text": "Sunflowers",
            "votes": 7
          },
          {
            "text": "Clover",
            "votes": 3
          }
        ],
        "total": 22,
        "multiple": false,
        "endsAt": 1758710400000,
        "running": true,
        "resultsVisible": true,
        "myVotes": [
          0
        ]
      },
      "quotes": null,
      "continues": null,
      "counts": {
        "replies": 4,
        "likes": 31,
        "reposts": 2
      },
      "pinned": false,
      "createdAt": 1758624000000
    }
  ],
  "profiles": [
    {
      "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
      "handle": "mara",
      "name": "Mara 🌻",
      "verified": true,
      "accountKind": "person"
    }
  ],
  "tags": [
    {
      "tag": "garden",
      "posts": 58
    }
  ]
}

وضعیت‌های ممکن: 200304400401429

GET`/api/v2/emojis`

ایموجی‌های اختصاصی سرور، با نشانی تصویرهایشان.

اختیار read
با ETag
از v2.1

در متن‌ها ایموجی به‌صورت :name: می‌آید. آن را با تصویر این فهرست جایگزین کنید؛ نام‌های ناشناخته متن می‌مانند.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/emojis"

پاسخ

با یک صفحه از Emoji پاسخ می‌دهد، به‌صورت `items` و `next`.

مثال

{
  "items": [
    {
      "name": "tellmelo",
      "url": "/api/media?id=e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
    }
  ],
  "next": null
}

وضعیت‌های ممکن: 200304401429

حساب شما

پروفایل و فید شما.

GET`/api/v2/me`

پروفایل خودتان، با idای که مسیرهای دیگر انتظار دارند.

اختیار read
با ETag
از v2.0

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/me"

پاسخ

با یک Profile پاسخ می‌دهد.

مثال

{
  "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
  "handle": "mara",
  "name": "Mara 🌻",
  "verified": true,
  "accountKind": "person",
  "about": "Beekeeper, allotment, too many seeds. :tellmelo:",
  "website": "https://mara-imkerei.example/",
  "websiteVerified": true,
  "followers": 148,
  "createdAt": 1750848000000
}

وضعیت‌های ممکن: 200304401429

GET`/api/v2/feed`

فید خودتان، همان‌طور که برنامه آن را می‌چیند.

اختیار read
صفحه‌بندی‌پذیر
از v2.0

بدون ETag، چون ترتیب مدام تغییر می‌کند. فهرستی که شروع کرده‌اید تا پایانش همان می‌ماند.

پارامترها

نام	نوع	معنا
`tab`در پرس‌وجو	`string`اختیاری	کدام فید: `for-you`، `following`، `latest` یا `bookmarks`. پیش‌فرض `latest`.`for-youfollowinglatestbookmarks`
`tag`در پرس‌وجو	`string`اختیاری	فقط پست‌های این برچسب: نوشته‌شده با آن یا تشخیص‌داده‌شده در آن‌ها توسط سرور. بدون آن، بدون پالایش.
`limit`در پرس‌وجو	`integer`اختیاری	شمار ورودی در هر صفحه: پیش‌فرض ۲۰، حداکثر ۵۰.
`cursor`در پرس‌وجو	`string`اختیاری	مقدار `next` پاسخ قبلی. بدون آن، از آغاز.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/feed?tab=following&limit=20"

پاسخ

با یک صفحه از Post پاسخ می‌دهد، به‌صورت `items` و `next`.

مثال

{
  "items": [
    {
      "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "text": "The bees are back in the garden 🐝 #garden",
      "kind": "poll",
      "author": {
        "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
        "handle": "mara",
        "name": "Mara 🌻",
        "verified": true,
        "accountKind": "person"
      },
      "community": {
        "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
        "name": "Urban Gardening"
      },
      "media": [
        {
          "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
        }
      ],
      "poll": {
        "options": [
          {
            "text": "Lavender",
            "votes": 12
          },
          {
            "text": "Sunflowers",
            "votes": 7
          },
          {
            "text": "Clover",
            "votes": 3
          }
        ],
        "total": 22,
        "multiple": false,
        "endsAt": 1758710400000,
        "running": true,
        "resultsVisible": true,
        "myVotes": [
          0
        ]
      },
      "quotes": null,
      "continues": null,
      "counts": {
        "replies": 4,
        "likes": 31,
        "reposts": 2
      },
      "pinned": false,
      "createdAt": 1758624000000
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

وضعیت‌های ممکن: 200400401429

اعلان‌ها

آنچه پیرامون حساب شما اتفاق افتاد، صفحه به صفحه.

GET`/api/v2/notifications`

اعلان‌های شما، تازه‌ترین اول.

اختیار read
صفحه‌بندی‌پذیر
با ETag
از v2.0

خواندن چیزی را خوانده‌شده علامت نمی‌زند؛ POST /notifications/read این کار را می‌کند. رویدادهای هم‌نوع روی یک پست یک ردیف مشترک دارند؛ more می‌گوید چند تا.

پارامترها

نام	نوع	معنا
`limit`در پرس‌وجو	`integer`اختیاری	شمار ورودی در هر صفحه: پیش‌فرض ۲۰، حداکثر ۵۰.
`cursor`در پرس‌وجو	`string`اختیاری	مقدار `next` پاسخ قبلی. بدون آن، از آغاز.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/notifications?limit=20"

پاسخ

با یک صفحه از Notification پاسخ می‌دهد، به‌صورت `items` و `next`.

مثال

{
  "items": [
    {
      "id": "3f2e1d0c-9b8a-4765-8432-10fedcba9876",
      "kind": "like",
      "text": null,
      "actor": {
        "handle": "jon",
        "name": "Jon"
      },
      "postId": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "read": false,
      "more": 2,
      "createdAt": 1758624300000,
      "updatedAt": 1758624900000
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

وضعیت‌های ممکن: 200304401429

POST`/api/v2/notifications/read`

علامت‌گذاری اعلان‌ها به‌عنوان خوانده‌شده.

اختیار write
از v2.0

درخواست نمونه

curl -X POST \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/notifications/read"

پاسخ

با یک Ok پاسخ می‌دهد.

مثال

{
  "ok": true
}

وضعیت‌های ممکن: 200401403429

پیام‌ها

صندوق و گفت‌وگوهای شما. هر گفت‌وگو به نام حساب طرف مقابل است.

GET`/api/v2/conversations`

صندوق شما: یک ردیف برای هر گفت‌وگو، تازه‌ترین اول.

اختیار read
صفحه‌بندی‌پذیر
با ETag
از v2.0

پارامترها

نام	نوع	معنا
`limit`در پرس‌وجو	`integer`اختیاری	شمار ورودی در هر صفحه: پیش‌فرض ۲۰، حداکثر ۵۰.
`cursor`در پرس‌وجو	`string`اختیاری	مقدار `next` پاسخ قبلی. بدون آن، از آغاز.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/conversations?limit=20"

پاسخ

با یک صفحه از Conversation پاسخ می‌دهد، به‌صورت `items` و `next`.

مثال

{
  "items": [
    {
      "with": "d4c3b2a1-6e5f-4a7b-9c8d-1e2f3a4b5c6d",
      "handle": "jon",
      "name": "Jon",
      "excerpt": "See you on Saturday at the market!",
      "truncated": false,
      "fromMe": true,
      "lastMessageId": "7c6b5a49-3827-4165-9f0e-d1c2b3a49586",
      "unread": 0,
      "updatedAt": 1758624060000
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

وضعیت‌های ممکن: 200304401429

GET`/api/v2/conversations/{with}/messages`

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

اختیار read
صفحه‌بندی‌پذیر
با ETag
از v2.0

خواندن چیزی را خوانده‌شده علامت نمی‌زند؛ POST /conversations/{with}/read این کار را می‌کند.

پارامترها

نام	نوع	معنا
`with`در مسیر	`string`اجباری	`id` حساب طرف مقابل. گفت‌وگو `id` جداگانه ندارد.
`limit`در پرس‌وجو	`integer`اختیاری	شمار ورودی در هر صفحه: پیش‌فرض ۲۰، حداکثر ۵۰.
`cursor`در پرس‌وجو	`string`اختیاری	مقدار `next` پاسخ قبلی. بدون آن، از آغاز.

درخواست نمونه

curl \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/conversations/a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05/messages?limit=20"

پاسخ

با یک صفحه از Message پاسخ می‌دهد، به‌صورت `items` و `next`.

مثال

{
  "items": [
    {
      "id": "7c6b5a49-3827-4165-9f0e-d1c2b3a49586",
      "text": "See you on Saturday at the market!",
      "from": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
      "to": "d4c3b2a1-6e5f-4a7b-9c8d-1e2f3a4b5c6d",
      "read": true,
      "media": [],
      "replyTo": null,
      "createdAt": 1758624060000
    }
  ],
  "next": "MTc1ODYyNDAwMDAwMDo1ZjBjMmE5ZS04ZDQx"
}

وضعیت‌های ممکن: 200304400401404429

POST`/api/v2/conversations/{with}/messages`

ارسال پیام در یک گفت‌وگو.

اختیار write
از v2.0

قوانین برنامه برقرار است: به کسی که شما را مسدود کرده نمی‌توان رسید، و تنظیمات طرف مقابل حساب می‌شود.

هنوز نمی‌توان از طریق API تصویر پیوست کرد، فقط در برنامه.

پارامترها

نام	نوع	معنا
`with`در مسیر	`string`اجباری	`id` حساب طرف مقابل. گفت‌وگو `id` جداگانه ندارد.
`text`در بدنه	`string`اجباری	متن پست، پاسخ یا پیام.
`replyTo`در بدنه	`string`اختیاری	`id` پیامی پیشین در همین گفت‌وگو که این پیام به آن پاسخ می‌دهد. از نسخهٔ ۲٫۲.

درخواست نمونه

curl -X POST \
  -H "Authorization: Bearer tm_key_…" \
  -H "Content-Type: application/json" \
  -d '{"text":"See you on Saturday at the market!"}' \
  "https://tellmelo.com/api/v2/conversations/a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05/messages"

پاسخ

با یک Ok پاسخ می‌دهد.

مثال

{
  "ok": true
}

وضعیت‌های ممکن: 200400401403404429

POST`/api/v2/conversations/{with}/read`

علامت زدن همهٔ پیام‌های یک گفت‌وگو به‌عنوان خوانده‌شده.

اختیار write
از v2.1

پارامترها

نام	نوع	معنا
`with`در مسیر	`string`اجباری	`id` حساب طرف مقابل. گفت‌وگو `id` جداگانه ندارد.

درخواست نمونه

curl -X POST \
  -H "Authorization: Bearer tm_key_…" \
  "https://tellmelo.com/api/v2/conversations/a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05/read"

پاسخ

با یک Ok پاسخ می‌دهد.

مثال

{
  "ok": true
}

وضعیت‌های ممکن: 200400401403404429

رابطه‌ها

پسندیدن، ذخیره، بازنشر، دنبال کردن، پیوستن، مسدود کردن: یک مسیر، برقرار و برداشته با active.

POST`/api/v2/relations`

پسندیدن، ذخیره، بازنشر، دنبال کردن، پیوستن، مسدود کردن، بی‌صدا کردن، بسته به kind.

اختیار write
از v2.0

target برای like، save و repost یک پست است، برای join یک گروه، برای follow، block و mute یک حساب. active: false رابطه را برمی‌دارد.

پارامترها

نام	نوع	معنا
`kind`در بدنه	`string`اجباری	کدام رابطه: `like`، `save`، `repost`، `follow`، `join`، `block` یا `mute` (از ۲٫۲).`likesaverepostfollowjoinblockmute`
`target`در بدنه	`string`اجباری	`id` پست، پروفایل یا گروه، بسته به `kind`.
`active`در بدنه	`boolean`اختیاری	`true` رابطه را برقرار می‌کند، `false` آن را برمی‌دارد.

درخواست نمونه

curl -X POST \
  -H "Authorization: Bearer tm_key_…" \
  -H "Content-Type: application/json" \
  -d '{"kind":"like","target":"5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1","active":true}' \
  "https://tellmelo.com/api/v2/relations"

پاسخ

با یک Ok پاسخ می‌دهد.

مثال

{
  "ok": true
}

وضعیت‌های ممکن: 200400401403429

اشیا

همهٔ اشیا، فیلد به فیلد. [] یعنی فهرست.

`Service`

پاسخ ریشه: چه کسی پاسخ می‌دهد، و این کلید چه می‌تواند بکند.

فیلد	نوع	معنا
`name`	`string`	همیشه `tellmelo`.
`version`	`string`	نسخهٔ API، مثلاً `2.1`.
`scope`	`string`	این کلید چه می‌تواند بکند: `read` یا `read write`.
`rateLimit`	`RateLimit`	سهمیهٔ این کلید.
`docs`	`string`	این مستندات کجاست، به‌صورت مسیری روی این سرور.
`spec`	`string`	توضیح ماشین‌خوان کجاست.

مثال

{
  "name": "tellmelo",
  "version": "2.9",
  "scope": "read write",
  "rateLimit": {
    "limit": 120,
    "remaining": 117
  },
  "docs": "/legal/api",
  "spec": "/api/v2/openapi.json"
}

`RateLimit`

سهمیهٔ این کلید در دقیقهٔ جاری.

فیلد	نوع	معنا
`limit`	`integer`	درخواست در دقیقه.
`remaining`	`integer`	چند تا در این دقیقه مانده است.

مثال

{
  "limit": 120,
  "remaining": 117
}

`Post`

یک پست، همه‌جا با یک شکل.

فیلد	نوع	معنا
`id`	`string`	شناسهٔ پست.
`text`	`string`یا null	متن، همان‌طور که نوشته شده (`null` برای پستی که فقط نظرسنجی یا فقط تصویر است).
`kind`	`string`	پست چیست. `post` — پستی با متن، تصویر یا نقل‌قول. `poll` — پستی با نظرسنجی.
`author`	`ProfileBrief`	چه کسی آن را نوشت.
`community`	`CommunityBrief`یا null	گروهی که در آن نوشته شد (`null` بیرون از همهٔ گروه‌ها).
`media`	`Media[]`	تصویرهایش، به ترتیب؛ اگر نباشند خالی.
`poll`	`Poll`یا null	نظرسنجی (`null` اگر نباشد).
`quotes`	`string`یا null	شناسهٔ پستی که این پست نقل می‌کند.
`continues`	`string`یا null	شناسهٔ پستی که این پست، به‌عنوان افزوده، ادامه‌اش می‌دهد.
`counts`	`Counts`	پاسخ‌ها، پسندها و بازنشرها.
`pinned`	`boolean`	اینکه بالای پروفایل نویسنده‌اش سنجاق شده است یا نه.
`createdAt`	`integer`	کی نوشته شد.

مثال

{
  "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
  "text": "The bees are back in the garden 🐝 #garden",
  "kind": "poll",
  "author": {
    "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
    "handle": "mara",
    "name": "Mara 🌻",
    "verified": true,
    "accountKind": "person"
  },
  "community": {
    "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
    "name": "Urban Gardening"
  },
  "media": [
    {
      "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
    }
  ],
  "poll": {
    "options": [
      {
        "text": "Lavender",
        "votes": 12
      },
      {
        "text": "Sunflowers",
        "votes": 7
      },
      {
        "text": "Clover",
        "votes": 3
      }
    ],
    "total": 22,
    "multiple": false,
    "endsAt": 1758710400000,
    "running": true,
    "resultsVisible": true,
    "myVotes": [
      0
    ]
  },
  "quotes": null,
  "continues": null,
  "counts": {
    "replies": 4,
    "likes": 31,
    "reposts": 2
  },
  "pinned": false,
  "createdAt": 1758624000000
}

`Reply`

پاسخی زیر یک پست: پستی با دو فیلد بیشتر.

همهٔ فیلدهای Post، و افزون بر آن:

فیلد	نوع	معنا
`postId`	`string`	پستی که کل گفت‌وگو به آن آویزان است.
`parentId`	`string`یا null	پاسخی که این پاسخ به آن است (`null` اگر مستقیم به پست پاسخ دهد).

مثال

{
  "id": "9e4b1c7d-2a3f-4d5e-8b6c-0f1e2d3c4b5a",
  "text": "Same here, the lavender is full of them.",
  "kind": "post",
  "author": {
    "id": "d4c3b2a1-6e5f-4a7b-9c8d-1e2f3a4b5c6d",
    "handle": "jon",
    "name": "Jon",
    "verified": false,
    "accountKind": "person"
  },
  "community": null,
  "media": [],
  "poll": null,
  "quotes": null,
  "continues": null,
  "counts": {
    "replies": 0,
    "likes": 3,
    "reposts": 0
  },
  "pinned": false,
  "createdAt": 1758624600000,
  "postId": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
  "parentId": null
}

`Counts`

یک پست چند پاسخ، پسند و بازنشر دارد.

فیلد	نوع	معنا
`replies`	`integer`	پاسخ‌ها، همهٔ سطح‌ها با هم.
`likes`	`integer`	پسندها.
`reposts`	`integer`	بازنشرها.

مثال

{
  "replies": 4,
  "likes": 31,
  "reposts": 2
}

`Media`

تصویری از یک پست یا پیام.

فیلد	نوع	معنا
`url`	`string`	نشانی تصویر، نسبت به این سرور. آن را با کلید در سرآیند بارگیری کنید.

مثال

{
  "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
}

`Poll`

نظرسنجی یک پست.

فیلد	نوع	معنا
`options`	`PollOption[]`	گزینه‌ها، به ترتیب. `option` در رأی از ۰ شمرده می‌شود.
`total`	`integer`	همهٔ رأی‌ها با هم، همیشه هست.
`multiple`	`boolean`	اینکه بیش از یک گزینه را می‌توان انتخاب کرد یا نه.
`endsAt`	`integer`یا null	نظرسنجی کی تمام می‌شود (`null` اگر بی‌پایان باشد).
`running`	`boolean`	اینکه هنوز می‌توان رأی داد یا نه.
`resultsVisible`	`boolean`	اینکه رأی‌های هر گزینه نشان داده می‌شوند یا نه (نگاه کنید به `votes`).
`myVotes`	`integer[]`	گزینه‌هایی که انتخاب کردید، شمرده از ۰.

مثال

{
  "options": [
    {
      "text": "Lavender",
      "votes": 12
    },
    {
      "text": "Sunflowers",
      "votes": 7
    },
    {
      "text": "Clover",
      "votes": 3
    }
  ],
  "total": 22,
  "multiple": false,
  "endsAt": 1758710400000,
  "running": true,
  "resultsVisible": true,
  "myVotes": [
    0
  ]
}

`PollOption`

یک گزینهٔ نظرسنجی.

فیلد	نوع	معنا
`text`	`string`	گزینه.
`votes`	`integer`یا null	رأی‌هایش (`null` تا وقتی نتیجه‌ها پنهان‌اند).

مثال

{
  "text": "Lavender",
  "votes": 12
}

`ProfileBrief`

پروفایل آن‌طور که درون اشیای دیگر می‌آید: به‌عنوان نویسنده، در جست‌وجو.

فیلد	نوع	معنا
`id`	`string`	شناسهٔ حساب: آنچه `/relations` و `/conversations/{with}` انتظار دارند.
`handle`	`string`	نام کوتاه، بدون `@`.
`name`	`string`	نام نمایشی. ممکن است ایموجی داشته باشد، از جمله `:name:`.
`verified`	`boolean`	اینکه حساب تأییدشده است یا نه.
`accountKind`	`string`	چه نوع حسابی است. `person` — یک شخص. `business` — یک کسب‌وکار. `association` — یک باشگاه یا انجمن. `automated` — یک حساب خودکار، مثلاً بات.

مثال

{
  "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
  "handle": "mara",
  "name": "Mara 🌻",
  "verified": true,
  "accountKind": "person"
}

`Profile`

یک پروفایل به‌تنهایی، با توضیحات و دنبال‌کنندگانش.

همهٔ فیلدهای ProfileBrief، و افزون بر آن:

فیلد	نوع	معنا
`about`	`string`یا null	توضیحات (`null` اگر نباشد).
`website`	`string`یا null	وب‌سایت پروفایل (اگر نباشد `null`). از نسخهٔ ۲٫۳.
`websiteVerified`	`boolean`	اینکه آیا وب‌سایت با `rel=me` به این پروفایل پیوند برمی‌گرداند؛ هر هفته بررسی می‌شود. از نسخهٔ ۲٫۳.
`followers`	`integer`	چند حساب آن را دنبال می‌کنند.
`createdAt`	`integer`یا null	حساب کی ساخته شد (`null`، تا وقتی عضو تاریخ پیوستن را پنهان کند؛ از ۲٫۹).

مثال

{
  "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
  "handle": "mara",
  "name": "Mara 🌻",
  "verified": true,
  "accountKind": "person",
  "about": "Beekeeper, allotment, too many seeds. :tellmelo:",
  "website": "https://mara-imkerei.example/",
  "websiteVerified": true,
  "followers": 148,
  "createdAt": 1750848000000
}

`CommunityBrief`

گروهی که پست در آن نوشته شده است.

فیلد	نوع	معنا
`id`	`string`	شناسهٔ گروه.
`name`	`string`یا null	نامش.

مثال

{
  "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
  "name": "Urban Gardening"
}

`Community`

گروهی از این سرور.

فیلد	نوع	معنا
`id`	`string`	شناسهٔ گروه.
`name`	`string`	نامش.
`description`	`string`یا null	توضیحات (`null` اگر نباشد).
`tags`	`string[]`	موضوع‌هایی که دربارهٔ آن‌هاست.
`members`	`integer`	چند عضو دارد.
`joinPolicy`	`string`	چطور می‌توان وارد شد. `open` — هر کسی می‌تواند بپیوندد. `application` — پیوستن به درخواستی نیاز دارد که گروه بپذیرد. `invite` — فقط با دعوت.
`visibility`	`string`	از طریق کلید همیشه `open`. `open` — برای همه قابل مشاهده.

مثال

{
  "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
  "name": "Urban Gardening",
  "description": "Balconies, allotments, rooftops: whatever grows.",
  "tags": [
    "garden",
    "bees"
  ],
  "members": 312,
  "joinPolicy": "open",
  "visibility": "open"
}

`Tag`

یک برچسب و اینکه چند پست آن را دارند.

فیلد	نوع	معنا
`tag`	`string`	برچسب، بدون `#`.
`posts`	`integer`	چند پست تازه آن را دارند.

مثال

{
  "tag": "garden",
  "posts": 58
}

`SearchResult`

سه فهرست، احتمالاً خالی.

فیلد	نوع	معنا
`posts`	`Post[]`	پست‌های جور، تازه‌ترین اول.
`profiles`	`ProfileBrief[]`	پروفایل‌های جور، بر اساس نام کوتاه.
`tags`	`Tag[]`	برچسب‌های جور، پرکاربردترین اول.

مثال

{
  "posts": [
    {
      "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
      "text": "The bees are back in the garden 🐝 #garden",
      "kind": "poll",
      "author": {
        "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
        "handle": "mara",
        "name": "Mara 🌻",
        "verified": true,
        "accountKind": "person"
      },
      "community": {
        "id": "c81d4e2a-0f3b-4a6c-9e57-1d2b3c4a5f60",
        "name": "Urban Gardening"
      },
      "media": [
        {
          "url": "/api/media?id=b2d7e9f1-3c4a-4e8b-a1f0-6d5c4b3a2918"
        }
      ],
      "poll": {
        "options": [
          {
            "text": "Lavender",
            "votes": 12
          },
          {
            "text": "Sunflowers",
            "votes": 7
          },
          {
            "text": "Clover",
            "votes": 3
          }
        ],
        "total": 22,
        "multiple": false,
        "endsAt": 1758710400000,
        "running": true,
        "resultsVisible": true,
        "myVotes": [
          0
        ]
      },
      "quotes": null,
      "continues": null,
      "counts": {
        "replies": 4,
        "likes": 31,
        "reposts": 2
      },
      "pinned": false,
      "createdAt": 1758624000000
    }
  ],
  "profiles": [
    {
      "id": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
      "handle": "mara",
      "name": "Mara 🌻",
      "verified": true,
      "accountKind": "person"
    }
  ],
  "tags": [
    {
      "tag": "garden",
      "posts": 58
    }
  ]
}

`Emoji`

ایموجی‌ای از این سرور.

فیلد	نوع	معنا
`name`	`string`	نام، همان‌طور که میان دو نقطه می‌آید.
`url`	`string`	نشانی تصویر، نسبت به این سرور.

مثال

{
  "name": "tellmelo",
  "url": "/api/media?id=e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b"
}

`Notification`

یک اعلان. یک ردیف می‌تواند چند رویداد هم‌نوع را گرد آورد.

فیلد	نوع	معنا
`id`	`string`	شناسهٔ اعلان.
`kind`	`string`	چه اتفاقی افتاد. `reply` — کسی به شما پاسخ داد. `like` — کسی پست شما را پسندید. `reply_like` — کسی پاسخ شما را پسندید. `repost` — کسی پست شما را بازنشر کرد. `follow` — کسی شما را دنبال می‌کند. `mention` — کسی از شما نام برد. `group_mention` — کسی از گروهی که اداره‌اش می‌کنید نام برد؛ `text` نام آن است. `message` — کسی برایتان پیامی نوشت. `scheduled` — یکی از پست‌های زمان‌بندی‌شدهٔ شما منتشر شد. `reminder` — یادآوری‌ای دربارهٔ یک پست ذخیره‌شده سررسید شده است. `report` — نتیجهٔ گزارشی که فرستاده‌اید. `moderation` — تصمیمی دربارهٔ حساب شما: هشدار، محدودیت، اعتراض. `team` — کار تازه برای تیم (فقط مالکان، مدیران و ناظران). `reward` — پاداشی برای دعوت به‌زودی از دست می‌رود یا از دست رفته است. `gift` — هدیه‌ای از تیم: یک اشتراک، یا جرقه برای شما یا برای گروهی که رهبری می‌کنید. `present` — هدیه‌ای از یک عضو: جرقه یا زمان اشتراک؛ عضو همان `actor` است. `spark` — جرقه‌ها به‌زودی تمام می‌شوند، یا گروهی که رهبری می‌کنید به سطحی رسیده یا آن را فقط برای مدتی نگه می‌دارد. `loyalty` — دربارهٔ ریتم وفاداری: هفته‌ای فعال شمرده می‌شود یا یک روز کم دارد، پاداشی تازه است یا رو به محو شدن. `impact` — پست‌های دوازده ساعت شما پس از یک روز چطور بودند، در یک اعلان. `discovery` — دعوتی به برنامهٔ کشف، یا اینکه جایگاهی آنجا آغاز یا پایان می‌یابد. `group_post` — پستی تازه در گروهی که زنگش برای آن به صدا درمی‌آید. `group_moderation` — رهبری یک گروه یکی از پست‌های شما یا خودتان را از گروه برداشت.
`text`	`string`یا null	فقط برای گزارش‌ها و نظارت: متن مربوط، وگرنه `null`.
`actor`	`Actor`	چه کسی آن را انجام داد.
`postId`	`string`یا null	پستی که دربارهٔ آن است (`null` اگر دربارهٔ هیچ پستی نباشد).
`read`	`boolean`	اینکه به‌عنوان خوانده‌شده علامت خورده یا نه.
`more`	`integer`	این ردیف، افزون بر رویداد نام‌برده، نمایندهٔ چند رویداد دیگر است.
`createdAt`	`integer`	نخستین بار کی اتفاق افتاد.
`updatedAt`	`integer`	آخرین بار کی رویداد دیگری به آن افزوده شد. فهرست بر اساس این مرتب است.

مثال

{
  "id": "3f2e1d0c-9b8a-4765-8432-10fedcba9876",
  "kind": "like",
  "text": null,
  "actor": {
    "handle": "jon",
    "name": "Jon"
  },
  "postId": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
  "read": false,
  "more": 2,
  "createdAt": 1758624300000,
  "updatedAt": 1758624900000
}

`Actor`

چه کسی اعلان را ایجاد کرد.

فیلد	نوع	معنا
`handle`	`string`	نام کوتاه.
`name`	`string`	نام نمایشی.

مثال

{
  "handle": "jon",
  "name": "Jon"
}

`Conversation`

یک ردیف از صندوق شما.

فیلد	نوع	معنا
`with`	`string`	شناسهٔ حساب طرف مقابل: آنچه `/conversations/{with}/messages` انتظار دارد.
`handle`	`string`	نام کوتاه او.
`name`	`string`	نام نمایشی او.
`excerpt`	`string`یا null	آغاز آخرین پیام (`null` اگر متن نداشته باشد).
`truncated`	`boolean`	اینکه گزیده کوتاه شده است یا نه.
`fromMe`	`boolean`	اینکه آخرین پیام مال شماست یا نه.
`lastMessageId`	`string`	شناسهٔ آخرین پیام.
`unread`	`integer`	چند پیام او را هنوز نخوانده‌اید.
`updatedAt`	`integer`	آخرین پیام کی نوشته شد.

مثال

{
  "with": "d4c3b2a1-6e5f-4a7b-9c8d-1e2f3a4b5c6d",
  "handle": "jon",
  "name": "Jon",
  "excerpt": "See you on Saturday at the market!",
  "truncated": false,
  "fromMe": true,
  "lastMessageId": "7c6b5a49-3827-4165-9f0e-d1c2b3a49586",
  "unread": 0,
  "updatedAt": 1758624060000
}

`Message`

پیامی در یک گفت‌وگو.

فیلد	نوع	معنا
`id`	`string`	شناسهٔ پیام.
`text`	`string`یا null	متن (`null` برای پیامی که فقط تصویر است).
`from`	`string`	شناسهٔ حسابی که آن را نوشت.
`to`	`string`	شناسهٔ حسابی که برایش نوشته شد.
`read`	`boolean`	اینکه گیرنده آن را خوانده است یا نه.
`media`	`Media[]`	تصویرهایش؛ اگر نباشند خالی.
`replyTo`	`string`یا null	`id` پیامی که این پیام به آن پاسخ می‌دهد (اگر به هیچ پیامی پاسخ ندهد `null`). از نسخهٔ ۲٫۲.
`createdAt`	`integer`	کی فرستاده شد.

مثال

{
  "id": "7c6b5a49-3827-4165-9f0e-d1c2b3a49586",
  "text": "See you on Saturday at the market!",
  "from": "a3e1f7c2-54b9-4d0e-8f16-7b2c9d4e1a05",
  "to": "d4c3b2a1-6e5f-4a7b-9c8d-1e2f3a4b5c6d",
  "read": true,
  "media": [],
  "replyTo": null,
  "createdAt": 1758624060000
}

`Created`

پاسخ نوشتنی که چیزی ساخت.

فیلد	نوع	معنا
`id`	`string`	شناسهٔ آنچه ساخته شد.
`scheduledFor`	`integer`یا null	کی منتشر می‌شود، اگر انتشار زمان‌بندی شده باشد (وگرنه `null`).
`deleteAt`	`integer`یا null	کی خودش را حذف می‌کند، اگر تنظیم شده باشد (وگرنه `null`).

مثال

{
  "id": "5f0c2a9e-8d41-4b7a-9c3e-2e61d0f4a7b1",
  "scheduledFor": null,
  "deleteAt": null
}

`Ok`

پاسخ نوشتنی که چیزی برای پس دادن ندارد.

فیلد	نوع	معنا
`ok`	`boolean`	همیشه `true`.

مثال

{
  "ok": true
}

توضیح ماشین‌خوان

جدول پشت این صفحه به‌صورت OpenAPI در /api/v2/openapi.json در دسترس است.

https://tellmelo.com/api/v2/openapi.json

آنچه از شما انتظار داریم

همان قوانینی برقرار است که همه‌جا: بدون آزار، بدون هرزنامه، بدون محتوایی که حقش را ندارید. مسئولیت آنچه کلید شما منتشر می‌کند با شماست.

API

نمای کلی

شروع سریع

امتحانش کنید

کلید شما

یک کلید چه کاری می‌تواند بکند

آنچه هیچ کلیدی نمی‌تواند

درخواست‌ها و پاسخ‌ها

صفحه‌ها

فقط چیزهای تازه

سقف‌ها

سرآیندها

آنچه می‌فرستید

آنچه برمی‌گردد

وقتی چیزی کار نمی‌کند

نسخه‌ها

نقطه‌های پایانی

راه ورود

GET/api/v2

درخواست نمونه

پاسخ

پست‌ها

GET/api/v2/posts

پارامترها

درخواست نمونه

پاسخ

GET/api/v2/posts/{id}

پارامترها

درخواست نمونه

پاسخ

POST/api/v2/posts

پارامترها

درخواست نمونه

پاسخ

DELETE/api/v2/posts/{id}

پارامترها

درخواست نمونه

پاسخ

پاسخ‌ها

GET/api/v2/posts/{id}/replies

پارامترها

درخواست نمونه

پاسخ

POST/api/v2/posts/{id}/replies

پارامترها

درخواست نمونه

پاسخ

نظرسنجی‌ها

POST/api/v2/posts/{id}/vote

پارامترها

درخواست نمونه

پاسخ

پروفایل‌ها

GET/api/v2/profiles/{handle}

پارامترها

درخواست نمونه

پاسخ

GET/api/v2/profiles/{handle}/posts

پارامترها

درخواست نمونه

پاسخ

گروه‌ها

GET/api/v2/communities

پارامترها

درخواست نمونه

پاسخ

GET/api/v2/communities/{id}

پارامترها

درخواست نمونه

پاسخ

GET/api/v2/communities/{id}/posts

پارامترها

درخواست نمونه

پاسخ

کاوش

GET/api/v2/tags

پارامترها

درخواست نمونه

پاسخ

GET/api/v2/search

GET`/api/v2`

GET`/api/v2/posts`

GET`/api/v2/posts/{id}`

POST`/api/v2/posts`

DELETE`/api/v2/posts/{id}`

GET`/api/v2/posts/{id}/replies`

POST`/api/v2/posts/{id}/replies`

POST`/api/v2/posts/{id}/vote`

GET`/api/v2/profiles/{handle}`

GET`/api/v2/profiles/{handle}/posts`

GET`/api/v2/communities`

GET`/api/v2/communities/{id}`

GET`/api/v2/communities/{id}/posts`

GET`/api/v2/tags`

GET`/api/v2/search`

GET`/api/v2/emojis`

GET`/api/v2/me`

GET`/api/v2/feed`

GET`/api/v2/notifications`

POST`/api/v2/notifications/read`

GET`/api/v2/conversations`

GET`/api/v2/conversations/{with}/messages`

POST`/api/v2/conversations/{with}/messages`

POST`/api/v2/conversations/{with}/read`

POST`/api/v2/relations`

`Service`

`RateLimit`

`Post`

`Reply`

`Counts`

`Media`

`Poll`

`PollOption`

`ProfileBrief`

`Profile`

`CommunityBrief`

`Community`

`Tag`

`SearchResult`

`Emoji`

`Notification`

`Actor`

`Conversation`

`Message`

`Created`

`Ok`