> For the complete documentation index, see [llms.txt](https://tools.docs.sendbird.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tools.docs.sendbird.com/readme/calls/turn-on-calls.md). # Turn on Calls for an app If your Sendbird app doesn't have Calls yet, turn it on so the app can use 1-to-1 voice and video calls. For example, an app created with `--is-calls-enabled false` in the Quickstart doesn't have Calls. Turning on Calls doesn't change the app's region. Calls also needs credits, so this page shows how to request your organization's one-time free Calls trial while you turn on Calls, or later if the app already has Calls. ## Before you begin * [Log in](/readme/quickstart.md#step-2-log-in) and [select an app](/readme/quickstart.md#step-3-select-your-app) by following the Quickstart. * Your Sendbird account needs the `organization.applications.all` permission in the organization. To check, run `sendbird --profile prod --json auth status` and look for `organization.applications.all` in `result.role.permissions`. * The organization, your contract, and the app's region must support Calls. * Calls requires credits. Your organization can request a one-time free Calls trial when you turn on Calls. The trial is available only when all of these are true: * Your account is an OWNER of the organization. * The organization is a self-service organization, and its plan isn't the Developer plan. * The organization has never had Calls credits, including credits that expired or ran out. ## Step 1. Check the app and your Calls credits The commands on this page use the organization and app you selected. Check that the selected app is the one you want, whether it already has Calls, and whether your organization has had Calls credits: ```bash sendbird --profile prod app get sendbird --profile prod --json calls settings push get sendbird --profile prod calls credits list ``` To target another app without changing your selection, add `--org-id --app-id ` to each command. Copy the **Organization UID** value from `sendbird --profile prod org list`, and the **App ID** value from `sendbird --profile prod app list --org-id `. In both commands, replace each placeholder with its value, without the angle brackets. In the `calls settings push get` response, `result.is_calls_enabled` shows whether the app has Calls: * `true`: The app already has Calls. If your organization still needs the free trial, follow [Request the free trial for an app that has Calls](#request-the-free-trial-for-an-app-that-has-calls). Otherwise, you don't need this page. If you came from another Calls tutorial, return to it, or go to [Add voice and video calls](/plugins/client/add-voice-and-video-calls.md). * `false`: The app doesn't have Calls. Continue to Step 2. The response also shows `push_enabled`. It's a push notification setting, and you don't need it on this page. The `calls credits list` output shows your organization's Calls credit history. Each entry has a **Status** and an **Expires** date: * `ACTIVE`: The credits are available. * `READY`, `EXPIRED`, or `DEPLETED`: The credits aren't available, even if the entry shows a balance. If the list has any entry, your organization can't request the free trial. Leave out `--claim-trial` in Steps 2 and 3. ## Step 2. Preview the request to turn on Calls The command in Step 3 asks Sendbird to turn on Calls for your app. With `--claim-trial`, it then requests your organization's free trial. Run it first with `--dry-run` to see which organization and app the requests go to. Nothing is sent, and Calls stays off: ```bash sendbird --profile prod calls activate --claim-trial --dry-run ``` Check that the organization and app in the output are the ones you want to turn on Calls for. The **Free trial** row shows that the CLI requests the trial after it turns on Calls. If the organization or app isn't right, [select the right app](/readme/quickstart.md#step-3-select-your-app) and run the command again. ## Step 3. Turn on Calls You can't turn off Calls after you turn it on. Run the same command with `--yes` instead of `--dry-run`. This turns on Calls for the app, then requests the free trial: ```bash sendbird --profile prod --json calls activate --claim-trial --yes ``` The `--yes` option confirms turning on Calls, and `--claim-trial` confirms the trial request. Without `--claim-trial`, the CLI requests the trial only if your organization is eligible and you agree when the terminal asks. To skip that question, use `--no-claim-trial`. With `--json`, the CLI never asks. After Sendbird accepts the request, the CLI checks the app again, and `result.readback.status` shows whether Calls is on:
StatusMeaning
matchesCalls is on.
mismatchSendbird accepted the request, but Calls doesn't show as on yet.
unavailableSendbird accepted the request, but the CLI couldn't check the app again.
If the status is `mismatch` or `unavailable`, check the app in Step 4 before you try to turn on Calls again. The response includes `result.calls_trial` only when the CLI handled the trial, which happens with `--claim-trial` or when the terminal asked you about it. Otherwise, the response has only `result.readback`. The `status` field of `result.calls_trial` shows the result of the trial request:
StatusMeaning
acceptedThe free trial was granted.
skippedThe CLI didn't request the trial, for example because your organization has had Calls credits or doesn't meet the conditions. The response explains why.
declinedThe trial request was canceled.
failedThe trial step failed. Calls stays on.
If the trial step fails, don't run `calls activate` again. Check your credits in Step 4, and if you still need the trial, follow [Request the free trial for an app that has Calls](#request-the-free-trial-for-an-app-that-has-calls). ## Step 4. Check that Calls is on Check that the app has Calls, and check your organization's credits: ```bash sendbird --profile prod --json calls settings push get sendbird --profile prod calls credits list ``` When `result.is_calls_enabled` is `true`, the app has Calls. If you requested the trial, the credit list shows an entry with its **Status** and **Expires** date. The server decides the trial's credits and expiry date. Next, [add voice and video calls](/plugins/client/add-voice-and-video-calls.md) to your app. ## Request the free trial for an app that has Calls The trial is usually requested when you turn on Calls. Use this section when the app already has Calls but your organization has no Calls credits yet. For example: * You created the app with `--is-calls-enabled true` but without `--claim-trial`. * You ran `calls activate` without `--claim-trial`, or answered No when the CLI asked about the trial. * Calls was turned on another way, such as on Sendbird Dashboard. Without credits, your app can't use Calls. Preview the request, request the trial, then check the result: ```bash sendbird --profile prod calls credits claim-trial --dry-run sendbird --profile prod calls credits claim-trial --yes sendbird --profile prod calls credits list ``` The preview sends nothing and doesn't check whether your organization can get the trial. The request checks the conditions in [Before you begin](#before-you-begin). Requesting the trial doesn't buy credits or change your subscription. If the request times out or returns an error, the trial might still have been granted. Run `calls credits list` before you try again.