WAHA

Connect with Whatsapp HTTP API

Actions116

Overview

This node operation requests a one-time authentication code to be sent to a specified phone number. It supports different delivery methods such as SMS or voice call, or can be left empty for web pairing. This is useful for scenarios requiring user verification or registration via phone number authentication.

Use Case Examples

  1. Requesting a verification code via SMS to a user's phone during account registration.
  2. Sending a voice call with a code for two-factor authentication setup.

Properties

Name Meaning
Session The session name used to identify the authentication session.
Phone Number The mobile phone number in international format to which the one-time code will be sent.
Method The method to receive the one-time code, either 'sms' or 'voice'. Leaving it empty defaults to web pairing.
Request Options Additional options for the request such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • codeRequested - Indicates whether the request for the one-time code was successful.
  • session - The session name associated with the authentication request.
  • phoneNumber - The phone number to which the code was sent.
  • method - The method used to send the code (sms, voice, or web pairing).

Dependencies

  • Requires an API key credential or authentication token to interact with the authentication service.

Troubleshooting

  • Common issues include invalid phone number format, unsupported method values, or network connectivity problems.
  • Errors related to SSL certificate validation can be resolved by enabling the 'Ignore SSL Issues' option if appropriate.
  • Timeout errors can be mitigated by increasing the timeout setting in the request options.

Discussion