راهنمای داشبورد
راهنمای اتصال حساب ها، دریافت کلید، ترتیب ارسال، قالب پیام، تست و وبهوک ها.
اتصال حساب
در صفحه حساب ها، حساب های پیام رسان و sms.ir اضافه می شوند در درخواست API، مقدار account_id همان شناسه ای است که کنار هر حساب دیده می شود.
قالب های نویدا فقط روی پیام رسان ها اثر دارند. متن پیامک از قالبی می آید که در پنل sms.ir تعریف شده است.
دریافت کلید
کلید API از داشبورد ساخته می شود و فقط همان لحظه نمایش داده می شود. کلید زنده با endpoint های /v1/otp کار می کند. کلید تست با endpoint های /v1/sandbox/otp کار می کند.
تنظیم مسیر ارسال پیش فرض
ترتیب ارسال از بالا به پایین اجرا می شود. اگر در درخواست channels ارسال نشود، همین ترتیب پیش فرض استفاده می شود. بدون ترتیب ارسال ذخیره شده و بدون channels در درخواست، ارسال با خطای fallback_order_required برمی گردد.
برای هر مرحله، زمان انتظار مشخص می شود. وقتی کاربر در آن زمان تایید نکند، مرحله بعدی اجرا می شود. اگر هر درخواست verify برسد، در جریان زنده فعلی fallback های بعدی لغو می شوند.
قالب های پیام
قالب پیام رسان باید placeholder کد را داشته باشد. وقتی در send مقدار template_id ارسال شود، پیام رسان ها از آن قالب استفاده می کنند. پیامک ارسالی همچنان از قالب سمت سرویس دهنده پیامک استفاده می کند.
تست فرایند ارسال و دریافت کد یکبار مصرف
صفحه تست OTP در داشبورد با حساب لاگین شده کار می کند و برای تست عملی مسیر ارسال، ارسال، تایید و وضعیت مناسب است. این صفحه برای کاربر نهایی نیست؛ برای اطمینان از تنظیمات حساب استفاده می شود.
مدیریت وبهوک ها
در صفحه وبهوک ها URL، توضیح، رویدادهای مورد علاقه و گزینه مخفی سازی بخش میانی شماره تلفن تنظیم می شود. secret فقط هنگام ساخت یا چرخش نمایش داده می شود.