ثبت درخواست ارسال رمز یکبار مصرف (Initiate)

سرویس «ثبت درخواست ارسال رمز یکبار مصرف (Initiate)» (SMS/OTP) در دسته ارسال و دریافت پیامک فینوتک. ورودی‌ها و خروجی در مشخصات فنی همین صفحه آمده است. با رویکرد Client Credential قابل فراخوانی است. برای ساخت کلاینت و گرفتن توکن، راهنمای شروع را ببینید.

سرویس یکپارچه مدیریت چرخه حیات OTP — در این مرحله با ارسال شناسه کاربر و انتخاب کانال (SMS، USSD یا Bot)، فرآیند تولید رمز آغاز شده و traceId برای مرحله بعد صادر می‌گردد.

Scope: messaging:otp-initiate:post<br />

Grant type: client_credentials

مراحل فراخوانی

ثبت درخواست ارسال رمز (این سرویس)
دریافت رمز توسط کاربر از طریق کانال انتخابی
صحت‌سنجی رمز (Verify)

post/messaging/v2/clients/{clientId}/otp/initiate

Request

Base URL: https://api.finnotech.ir
URL: https://api.finnotech.ir/messaging/v2/clients/{clientId}/otp/initiate
Auth: HTTP bearer

Path parameters

clientIdstring required

Query parameters

trackIdstring required

Correlation ID (max 40 alphanumeric characters). UUID recommended.

Request body

identifierstring required

شماره موبایل یا شناسه کاربر

method'sms' | 'ussd' | 'bot' required

متد ارسال رمز

purposestring

هدف از ارسال (جهت گزارش‌گیری و متن پیام)

ttlinteger

مدت زمان اعتبار رمز به ثانیه (پیش‌فرض ۱۲۰)

Example request

{
  "identifier": "09123456789",
  "purpose": "login",
  "ttl": 120
}

Response

Successful response

responseCodestring

trackIdstring

statusstring

Changes

No recorded changes to this operation across all 1 revision of this API.