Appwrite icon

Appwrite

Interact with Appwrite API

Actions181

Account → Create Phone Session

AI-generated

Overview

This node interacts with the Appwrite API to create a phone session for a user account. It is useful in scenarios where you need to initiate a phone-based session for user authentication or verification, such as sending a verification code to a user's phone number to start a session.

Use Case Examples

  1. Creating a phone session for a user to verify their phone number during account setup.
  2. Initiating a phone session to enable phone-based login or multi-factor authentication.

Properties

Name Meaning
Phone The phone number in E.164 format to be used for creating the phone session.
User ID The unique identifier of the user for whom the phone session is being created.

Output

JSON

  • sessionId - The ID of the created phone session.
  • status - The status of the phone session creation request.
  • message - Additional information or message related to the phone session creation.

Dependencies

  • Appwrite API key credential for authentication

Troubleshooting

  • Ensure the phone number is in the correct E.164 format, e.g., +14155552671.
  • Verify that the User ID provided exists and is correct.
  • Check that the Appwrite API credentials (endpoint, project ID, API key) are correctly configured.
  • Common errors include authentication failures due to invalid API keys, or validation errors if the phone number format is incorrect.

Links

Discussion