BulkGate icon

BulkGate

Interact with the BulkGate API

Actions23

One Time Password → Send OTP via SMS

AI-generated

Summary

Send a one-time password (OTP) verification code via SMS to a specified phone number with customizable parameters such as language, code type, code length, sender ID, quotas, retry trials, and expiration.

Inputs

  • Phone Number (required) — The recipient's phone number to send the OTP, which should be in international format or accompanied by the country code.
  • Country — The recipient's country using ISO 3166-1 alpha-2 format to help format the phone number or message context.
  • Language — The language for the OTP message; if not provided, the language is auto-detected from the phone number.
  • Code Type — The type of OTP code to send, choosing between integer, string, or a combined format.
  • Code Length — The length of the OTP code to be generated and sent.
  • Request Quota Number — Quota number to limit OTP request frequency.
  • Request Quota Identification (required) — A unique identifier string to track the OTP request quota.
  • Trials Available Resend — Optional limit of retry attempts allowed for resending the OTP.
  • Trials Available Verification — Optional limit of verification attempts allowed for the OTP.
  • Daily Limit — Optional daily limit on OTP requests per user.
  • Daily Limit Country — Optional daily limit on OTP requests filtered by country.
  • OTP Expiration — Time in seconds before the OTP expires; defaults to one week (604800 seconds).
  • Sender ID — Select the sender ID type used to send the SMS.
  • Sender ID Value — Custom value for the sender ID when applicable.
  • Unicode — Option to send the SMS as Unicode for special characters; otherwise, 7-bit encoding is used.
  • Domain — URL of a website using WebOTP to enable auto input of the received OTP code.

Output shape

a JSON object containing information about the OTP send request result, including status and details provided by the BulkGate API

The returned data includes fields about the success or failure of the OTP SMS request. The output structure follows the BulkGate API response format.

Examples

Example 1: Send OTP SMS to user

Set recipient phone number, country, language, code type, code length, and optionally sender ID and quotas. Then trigger to send OTP via SMS.

Links

Discussion