Mock phones

Mock phones let you register fictional phone numbers and a fixed verification code at the project level. When a tester signs in with a registered number, the registered code works in place of a real SMS, so phone authentication flows can be exercised in CI, demo accounts, and app store review submissions without sending SMS or paying provider fees.

Each project stores its mock phones on the project document. Numbers must be in E.164 format, and verification codes are exactly six digits.

Add from the Console

To add a mock phone manually:

1. Open your project in the Appwrite Console.
2. Navigate to Auth in the sidebar, then open the Settings tab.
3. Scroll to the Mock phone numbers card and click Add a number.
4. Enter a phone number in E.164 format (for example, +15555550100) and a six-digit verification code.
5. Click Save on the row, then Update at the bottom of the section to persist.

Use fictional ranges (such as North American 555 numbers) to avoid collision with real subscribers.

Manage with a Server SDK

The Project service exposes endpoints to list, create, get, update, and delete mock phones. All endpoints require an API key with the appropriate scope or a Console session.

Create a mock phone

import { Client, Project } from 'node-appwrite';

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1')
    .setProject('<PROJECT_ID>')
    .setKey('<YOUR_API_KEY>');

const project = new Project(client);

const result = await project.createMockPhone({
    number: '+15555550100',
    otp: '123456'
});

The endpoint returns the new MockNumber document.

List mock phones

import { Client, Project } from 'node-appwrite';

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1')
    .setProject('<PROJECT_ID>')
    .setKey('<YOUR_API_KEY>');

const project = new Project(client);

const result = await project.listMockPhones();

Get a mock phone

import { Client, Project } from 'node-appwrite';

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1')
    .setProject('<PROJECT_ID>')
    .setKey('<YOUR_API_KEY>');

const project = new Project(client);

const result = await project.getMockPhone({
    number: '+15555550100'
});

Update a mock phone

import { Client, Project } from 'node-appwrite';

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1')
    .setProject('<PROJECT_ID>')
    .setKey('<YOUR_API_KEY>');

const project = new Project(client);

const result = await project.updateMockPhone({
    number: '+15555550100',
    otp: '654321'
});

Delete a mock phone

import { Client, Project } from 'node-appwrite';

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1')
    .setProject('<PROJECT_ID>')
    .setKey('<YOUR_API_KEY>');

const project = new Project(client);

await project.deleteMockPhone({
    number: '+15555550100'
});

Benefits

• No SMS costs in test flows. Exercise phone authentication in CI, demo accounts, and app store review submissions without sending real SMS or paying provider fees.
• Stable credentials for automation. Registered numbers and codes don't expire or rotate, so end-to-end tests stay deterministic across runs.
• Repeatable provisioning. Script the mock phone set a project should expose and apply it from CI when spinning up a new environment.