شروع سریع با نویدا

۱. حساب ارسال خود را متصل کنید

ابتدا وارد داشبورد نویدا شوید و از بخش حساب‌ها، سرویس موردنظر خود را انتخاب کنید.

پس از تکمیل مراحل اتصال، حساب باید در وضعیت فعال قرار داشته باشد.

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

۲. یک API Key ایجاد کنید

از بخش کلیدهای API یک کلید جدید بسازید.

درخواست‌های Messaging API باید کلید را در Header زیر ارسال کنند:

۳. اولین پیام را ارسال کنید

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

curl -X POST "https://api.navidaa.ir/v1/messages/send" \
  -H "X-API-Key: navidaa_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "09123456789",
    "message": "سلام، این یک پیام آزمایشی از نویدا است.",
    "channels": ["eitaa"]
  }'

در این درخواست:

• to شماره گیرنده است.
• message متن پیام است.
• channels مسیر ارسال را مشخص می‌کند.

شماره گیرنده می‌تواند در قالب‌های رایج ارسال شود و نویدا آن را به فرمت استاندارد تبدیل می‌کند.

۴. پاسخ API را دریافت کنید

در صورت پذیرفته شدن درخواست، API پاسخ 201 Created برمی‌گرداند.

{
  "message_id": "7bc41a7b-3d61-47e3-9da1-8f1812d19c41",
  "status": "queued",
  "strategy": "failover",
  "scheduled_for": null,
  "template": null,
  "current_channel": {
    "type": "messenger",
    "provider": "eitaa",
    "credential_id": 15,
    "label": "حساب ایتا فروشگاه"
  }
}

queued به این معناست که درخواست پذیرفته شده و پیام برای ارسال در صف قرار گرفته است.

ارسال واقعی پیام به‌صورت غیرهمزمان انجام می‌شود.

۵. وضعیت پیام را بررسی کنید

برای مشاهده وضعیت نهایی پیام، از message_id دریافت‌شده استفاده نمایید:

curl "https://api.navidaa.ir/v1/messages/7bc41a7b-3d61-47e3-9da1-8f1812d19c41" \
  -H "X-API-Key: navidaa_live_xxxxxxxxxxxxxxxxxxxx"

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