Actions101
- š¤ Chatting Actions
- š„ļø Sessions Actions
- š Auth Actions
- š¼ļø Screenshot Actions
- š¢ Channels Actions
- š¢ Status Actions
- š¬ Chats Actions
- š¤ Contacts Actions
- š„ Groups Actions
- ā Presence Actions
- š·ļø Labels Actions
- š Observability Actions
Overview
This node operation requests a one-time code for authentication purposes, typically used in scenarios where a user needs to verify their identity via a mobile phone number. It supports sending the code via SMS or voice call, or using web pairing if no method is specified. This is useful for user registration, login verification, or two-factor authentication workflows.
Use Case Examples
- Requesting a verification code to be sent via SMS to a user's phone number during account registration.
- Sending a voice call with a verification code for login confirmation.
- Using web pairing to request a code without specifying SMS or voice method.
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'. If left empty, web pairing is used. |
| Request Options | Additional options for the request such as batching, SSL certificate validation, proxy settings, and timeout configuration. |
Output
JSON
session- The session name used for the authentication request.phoneNumber- The phone number to which the code was requested.method- The method used to send the code (sms, voice, or web pairing).status- The status of the code request, indicating success or failure.message- Additional information or error messages related to the request.
Dependencies
- Requires an API key credential or authentication token to interact with the authentication service.
Troubleshooting
- Ensure the phone number is in the correct international format to avoid request failures.
- If using a proxy, verify the proxy URL and credentials are correct to prevent connection issues.
- If SSL certificate validation fails, enabling 'Ignore SSL Issues' may help but should be used cautiously due to security risks.
- Timeout errors may occur if the server is slow to respond; increasing the timeout value can help.
Links
- Authentication API Documentation - Official documentation for the authentication API used to request one-time codes.