ساخت کمپین تماس
کمپین میسازد؛ با `start` شروع میشود.
POST
scope: sms.sendhttps://api.irnoti.com/v1/voip/campaignsبرای نظرسنجی باید حداقل یک گزینه تعریف شود. سقف ۱۰ در دقیقه. هزینه هنگام شروع رزرو میشود.
پارامترها
| نام | محل | نوع | توضیح |
|---|---|---|---|
| name * | بدنه | string | نام (≤۱۲۰). |
| kind * | بدنه | string | broadcast (پخش پیام) یا survey (نظرسنجی با کلید). |
| script * | بدنه | object | متن گفتار یا فایل صوتی؛ برای نظرسنجی گزینهها (options: کلید ← برچسب). |
| numbers | بدنه | string[] | شمارهها. |
| contactGroupId | بدنه | string | گروه دفترچه. یکی از numbers یا contactGroupId الزامی است. |
| callerId | بدنه | string | شمارهٔ نمایشی. |
| window | بدنه | object | بازهٔ مجاز تماس (ساعت روز). |
| concurrency | بدنه | integer | تماس همزمان (پیشفرض ۳). |
| cps | بدنه | integer | تماس در ثانیه (پیشفرض ۱). |
| maxAttempts | بدنه | integer | تعداد تلاش (پیشفرض ۲). |
| retryDelayMin | بدنه | integer | فاصلهٔ تلاش دوباره (دقیقه، پیشفرض ۳۰). |
خطاهای خاص این endpoint
| 401 | unauthorized | کلید API نامعتبر یا منقضی است. |
| 403 | insufficient_scope | کلید API دامنهٔ دسترسی لازم را ندارد. |
| 400 | validation_error | ورودی نامعتبر است (جزئیات در پاسخ). |
| 429 | rate_limited | تعداد درخواست از سقف مجاز بیشتر شد؛ پس از زمان Retry-After دوباره تلاش کنید. |
اجرای زنده (محیط تست)
باز کردن در کنسول کامل ←این endpoint در محیط تست پشتیبانی نمیشود؛ برای اجرا، کلید واقعی را در حالت «اجرای واقعی» وارد کنید.