فهرست مخاطبان

حرفه‌ایکلید خواندن

در پلن حرفه‌ای و سازمانی در دسترس است (بتا).

GET…/public/contacts

مخاطبان را صفحه‌به‌صفحه برمی‌گرداند؛ تازه‌ترین اول.

درخواست
curl https://app.reshta.ir/api/v1/public/contacts \​  -H "Authorization: Bearer $RESHTA_API_KEY"​

سرآیندها

AuthorizationstringالزامیBearer و کلید API کسب‌وکار (rk_live_…).

پارامترهای جستجو

owner_idstringاختیاریهمکار مسئول.
qstringاختیاریمتن جستجو.
cursorstringاختیاریnext_cursor پاسخ قبلی؛ برای صفحهٔ اول نفرستید.
limitstringاختیاریاندازهٔ صفحه؛ پیش‌فرض ۵۰، بیشینه ۱۰۰.

پاسخ‌ها و خطاها

200—موفق.
401unauthorizedکلید نیست، نادرست یا باطل است، یا سازنده‌اش دیگر فعال نیست.
429rate_limitedبیش از ۱۲۰ درخواست در دقیقه؛ Retry-After می‌گوید چند ثانیه صبر کنید.
پاسخ
{​  "data": [​    { "id": "0192c4e8-7b1a-7c3e-9f20-5d6a1b2c3d4e", "first_name": "سارا", "last_name": "رضایی", … },​    { "id": "0192c4f9-0a2b-7c4d-8e5f-60718293a4b5", "first_name": "نگار", "last_name": "احمدی", … }​  ],​  "next_cursor": "eyJpZCI6IjAxOTJjNGY5In0"​}​

کلید API بسازید و اولین درخواست را بفرستید

کلید در اپ رشتا ساخته می‌شود و فقط یک بار نشان داده می‌شود. API و وب‌هوک (بتا) در پلن حرفه‌ای و سازمانی است و کلید را فقط مدیر کسب‌وکار می‌سازد.

  1. ۱ورود به app.reshta.ir
  2. ۲اتصال ← توسعه‌دهنده
  3. ۳ساخت کلید API