اندپوینت و دسترسی ثبت درخواست ارسال رمز یکبار مصرف (Initiate)
این صفحه مستندات فنی فراخوانی POST /messaging/v2/clients/{clientId}/otp/initiate است.
Scope: messaging:otp-initiate:post
Grant type: client_credentials
دستهبندی OpenAPI: پیامک و رمز یکبار مصرف. شناسه عملیات: messagingOtpInitiatePost.
معرفی ثبت درخواست ارسال رمز یکبار مصرف (Initiate)
سرویس «ثبت درخواست ارسال رمز یکبار مصرف (Initiate)» (SMS/OTP) در دسته ارسال و دریافت پیامک فینوتک. ورودیها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، راهنمای شروع را ببینید.
ورودی و خروجی ثبت درخواست ارسال رمز یکبار مصرف (Initiate)
ورودیهای اصلی: شناسه کلاینت، کد پیگیری، شماره موبایل یا شناسه کاربر، متد ارسال رمز.
فیلدهای مهم پاسخ: شناسه تراکنش OTP، وضعیت، زمان اعتبار کد به ثانیه.
جزئیات نوع داده، الزامی بودن و نمونه JSON در مشخصات Elements همین صفحه آمده است.
کاربرد فنی ثبت درخواست ارسال رمز یکبار مصرف (Initiate)
سرویس «ثبت درخواست ارسال رمز یکبار مصرف (Initiate)» (SMS/OTP) در دسته ارسال و دریافت پیامک فینوتک. ورودیها و خروجی در مشخصات فنی همین صفحه آمده است. بدون رضایت پیامکی کاربر و با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، راهنمای شروع را ببینید.
پس از دریافت توکن مناسب (مطابق Grant type)، درخواست را به مسیر بالا بفرستید و پاسخ را بر اساس اسکیمای اعلامشده پردازش کنید. راهنمای گرفتن توکن در راهنمای شروع آمده است.
در صورت خطای احراز هویت یا Scope ناکافی، ابتدا اعتبار توکن و سطح دسترسی کلاینت را بررسی کنید؛ سپس پارامترهای الزامی مسیر و بدنه را با اسکیمای همین صفحه تطبیق دهید.
برای توضیح کسبوکاری، موارد استفاده و پیشنیازها به صفحه سرویس «ثبت درخواست ارسال رمز یکبار مصرف (Initiate)» مراجعه کنید.
عملیات مرتبط با ثبت درخواست ارسال رمز یکبار مصرف (Initiate)
- استعلام فینوتکست —
GET /facility/v2/clients/{clientId}/finnotextInquiry - استعلام فینوتکست —
GET /facility/v2/clients/{clientId}/finnotextInquiry - ارسال پیامک کد تأیید (OTP) —
POST /facility/v2/clients/{clientId}/finnotextOtp - ارسال پیامک کد تأیید (OTP) —
POST /facility/v2/clients/{clientId}/finnotextOtp - فینوتکست — ارسال پیامک گروهی —
POST /facility/v2/clients/{clientId}/finnotext