otp-v2

Send an OTP verification code

post/v2/otp/send

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/otp/send
  • Auth: API key in header X-Api-Key

Request body

channel'sms' | 'voice' | 'auto'

Delivery channel: sms (default), voice, or auto (SMS with voice fallback)

metadataobject

Optional metadata

tostring required

Recipient phone number (E.164)

Example request

{
  "channel": "sms"
}

Response

OTP sent

channelstring

Delivery channel used (sms or voice)

deduplicatedboolean

True if returning an existing OTP within dedup window

expires_ininteger

Seconds until code expires

number_typestring

Detected line type (mobile, voip, landline, unknown)

otp_idstring

OTP message ID

sandboxboolean

True if sent to a test number

successboolean
tostring

Normalized phone number

Changes

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