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