Callback

You can configure a Callback URL from your profile settings. Once set, incoming OTP events will be forwarded to your endpoint using an HTTP POST request.

  • Your server must respond with a 2xx status code to acknowledge receipt.
  • If your server fails to respond or returns a non-2xx code, the request will be retried after 15 seconds, up to 5 times.
  • The maximum request timeout is 3 seconds.

Callback Event

s1_otp_received

Payload Properties

PropertyTypeDescription
orderIdStringUnique identifier of the order associated with this OTP request.
timestampString (UTC)The UTC timestamp when the OTP was received by our system.
numberStringThe virtual or temporary phone number assigned to the request.
serviceStringThe service or platform (e.g., WhatsApp, Telegram, Gmail) for which the OTP was issued.
messageStringFull SMS or message content received that contains the OTP.
otpStringExtracted one-time password (OTP) from the received message.

Callback Event

s1_win_premium_request

Payload Properties

PropertyTypeDescription
orderIdStringUnique identifier of the order associated with this OTP request.
statusStringCurrent state of the number. When the order is confirmed, the number enters a reserved state with a new expiry time until it is released or expired.
numberStringThe virtual or temporary phone number assigned to the request.
serviceStringThe service or platform (e.g., WhatsApp, Telegram, Gmail) for which the OTP was issued.
expiredInNumberTime remaining (in seconds) before the reserved number automatically expires and becomes unavailable.

Callback Event

s2_otp_received

Payload Properties

PropertyTypeDescription
orderIdStringUnique identifier of the order associated with this OTP request.
timestampString (UTC)The UTC timestamp when the OTP was received by our system.
numberStringThe virtual or temporary phone number assigned to the request.
serviceStringThe service or platform (e.g., WhatsApp, Telegram, Gmail) for which the OTP was issued.
messageStringFull SMS or message content received that contains the OTP.
otpStringExtracted one-time password (OTP) from the received message.

Callback Event

rental_otp_received

Payload Properties

PropertyTypeDescription
orderIdStringUnique identifier of the order associated with this OTP request.
timestampString (UTC)The UTC timestamp when the OTP was received by our system.
numberStringThe virtual or temporary phone number assigned to the request.
serviceStringThe service or platform (e.g., WhatsApp, Telegram, Gmail) for which the OTP was issued.
messageStringFull SMS or message content received that contains the OTP.
otpStringExtracted one-time password (OTP) from the received message.