ایران ناتیفیکیشن

ساخت کمپین تماس

کمپین می‌سازد؛ با `start` شروع می‌شود.

POSThttps://api.irnoti.com/v1/voip/campaigns
scope: sms.send

برای نظرسنجی باید حداقل یک گزینه تعریف شود. سقف ۱۰ در دقیقه. هزینه هنگام شروع رزرو می‌شود.

پارامترها

ناممحلنوعتوضیح
name *بدنهstringنام (≤۱۲۰).
kind *بدنهstringbroadcast (پخش پیام) یا survey (نظرسنجی با کلید).
script *بدنهobjectمتن گفتار یا فایل صوتی؛ برای نظرسنجی گزینه‌ها (options: کلید ← برچسب).
numbersبدنهstring[]شماره‌ها.
contactGroupIdبدنهstringگروه دفترچه. یکی از numbers یا contactGroupId الزامی است.
callerIdبدنهstringشمارهٔ نمایشی.
windowبدنهobjectبازهٔ مجاز تماس (ساعت روز).
concurrencyبدنهintegerتماس هم‌زمان (پیش‌فرض ۳).
cpsبدنهintegerتماس در ثانیه (پیش‌فرض ۱).
maxAttemptsبدنهintegerتعداد تلاش (پیش‌فرض ۲).
retryDelayMinبدنهintegerفاصلهٔ تلاش دوباره (دقیقه، پیش‌فرض ۳۰).

خطاهای خاص این endpoint

401unauthorizedکلید API نامعتبر یا منقضی است.
403insufficient_scopeکلید API دامنهٔ دسترسی لازم را ندارد.
400validation_errorورودی نامعتبر است (جزئیات در پاسخ).
429rate_limitedتعداد درخواست از سقف مجاز بیشتر شد؛ پس از زمان Retry-After دوباره تلاش کنید.

اجرای زنده (محیط تست)

باز کردن در کنسول کامل ←

این endpoint در محیط تست پشتیبانی نمی‌شود؛ برای اجرا، کلید واقعی را در حالت «اجرای واقعی» وارد کنید.

curl -X POST 'https://api.irnoti.com/v1/voip/campaigns' \
  -H "Authorization: Bearer $IRNOTI_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "kind": "survey",
  "name": "نظرسنجی رضایت",
  "script": {
    "text": "برای رضایت یک و برای نارضایتی دو را بزنید",
    "options": {
      "1": "راضی",
      "2": "ناراضی"
    }
  },
  "numbers": [
    "09121234567"
  ]
}'
پاسخ نمونه200 OK
{
  "id": "5",
  "status": "draft"
}
ساخت کمپین تماس — مستندات API | ایران ناتیفیکیشن