ریز لاگ‌های ارسال کمپین

فهرست صفحه‌بندی‌شدهٔ تک‌تک پیامک‌های یک اجرای کمپین را برمی‌گرداند (گیرنده، خط، زمان، وضعیت تحویل و هزینه). صفحه‌بندی با page_number و page_size کنترل می‌شود؛ اندازهٔ صفحه به‌صورت پیش‌فرض ۱۰ و حداکثر ۱۰۰ است و مقادیر بزرگ‌تر بدون خطا به ۱۰۰ محدود می‌شوند. داده‌ها فقط برای حسابی که توکن به آن تعلق دارد بازگردانده می‌شود.

احراز هویت

نوع احراز هویتتوکن BearerbearerAuth

کلید API را در هدر Authorization با پیشوند Bearer بفرستید:

``` Authorization: Bearer YOURAPIKEY ```

این روش برای سرویس‌های نسخهٔ ۲، نسخهٔ ۳ و بارگذاری فایل به کار می‌رود. سرویس‌های نسخهٔ ۱ کلید را از مسیر URL می‌گیرند و هدری نمی‌خواهند.

هدر لازم

Authorization: Bearer YOUR_ACCESS_TOKEN

کلید خود را کجا پیدا کنم؟

اطلاعات ورود را از پنل کاربری خود بگیرید و توکن را فقط روی سرور و در یک متغیر محیطی نگه دارید؛ هرگز آن را در کد سمت کاربر قرار ندهید.

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

نام	نوع	الزامی	توضیح
`id`*	integer	الزامی	شناسهٔ اجرای کمپین (`execution_id`). اگر عدد صحیح نباشد خطای ۴۰۰ برمی‌گردد. نمونه`100`

پارامترهای کوئری

نام	نوع	الزامی	توضیح
`page_number`	integer	اختیاری	شمارهٔ صفحه. اگر ارسال نشود مقدار ۱ در نظر گرفته می‌شود. مقدار غیرعددی خطای ۴۰۰ می‌دهد. پیش‌فرض`1`نمونه`2`
`page_size`	integer	اختیاری	تعداد رکورد در هر صفحه. پیش‌فرض ۱۰ و سقف ۱۰۰ است؛ اگر عددی بزرگ‌تر از ۱۰۰ بفرستید بدون خطا روی ۱۰۰ تنظیم می‌شود. مقدار غیرعددی خطای ۴۰۰ می‌دهد. — تعداد رکورد در هر صفحه. پیش‌فرض ۱۰ و سقف ۱۰۰ است؛ اگر عددی بزرگ‌تر از ۱۰۰ بفرستید بدون خطا روی ۱۰۰ تنظیم می‌شود. مقدار غیرعددی خطای ۴۰۰ می‌دهد. محدودیت: حداکثر ۱۰۰؛ مقادیر بزرگ‌تر بی‌صدا به ۱۰۰ کاهش می‌یابند پیش‌فرض`10`نمونه`50`

پاسخ‌ها

ساختار پاسخ

نام	نوع	الزامی	توضیح
`return`	ApiStatus	اختیاری	وضعیت پاسخ. مقدار `status` با کد وضعیت HTTP پاسخ یکسان است.
`status`*	integer	الزامی	کد وضعیت — همان کد وضعیت HTTP پاسخ. نمونه`200`
`message`*	string	الزامی	پیام فارسی قابل نمایش به کاربر. نمونه`درخواست تایید شد.`
`entries`	CampaignLogsResponse	اختیاری
`results`	array<CampaignLog>	اختیاری	فهرست رکوردهای لاگ.
`count`	integer	اختیاری	تعداد کل رکوردها. نمونه`2`

نمونهٔ پاسخ

{
  "return": {
    "status": 200,
    "message": "درخواست تایید شد."
  },
  "entries": {
    "results": [
      {
        "id": 98765,
        "line": "9830008080",
        "date": "2026-03-15 09:31:12",
        "receiver": "09121234567",
        "status": "DELIVERED",
        "cost": 100
      },
      {
        "id": 98766,
        "line": "9830008080",
        "date": "2026-03-15 09:31:12",
        "receiver": "09351234567",
        "status": "SENT_FAILED",
        "cost": 0
      }
    ],
    "count": 2
  }
}