> 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/commands/command-reference-1.md). # Calls commands Use these commands for: * [Calls settings](#calls-settings) * [Calls push credentials](#calls-push-credentials) * [Credits and usage](#credits-and-usage) The CLI doesn't: * Start calls * Create Calls rooms * Show call logs * Control Sendbird Live Each table lists a command's own options. For options shared by all commands and for reading results, see [CLI reference](/readme/commands.md). For step-by-step tasks, follow the [Calls tutorials](/readme/calls.md). To add calling to your app, follow [Add voice and video calls](/plugins/client/add-voice-and-video-calls.md). ## Change settings safely Change a setting in this order: 1. Read the current setting and keep its values, so you can restore them. 2. Preview the change with `--dry-run`. 3. Apply the change. 4. Read the setting again. General settings include relay and recording options. To restore a setting, set the values you kept again. ## Calls settings | Command | Purpose | Command-specific inputs | | ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `sendbird calls activate` | Turn on Calls for an app created without it. Requires `--yes`. With `--claim-trial`, also request the organization's free Calls trial. | `--claim-trial` `--no-claim-trial` | | `sendbird calls settings push get` | Read the push switch shared by Chat and Calls, and whether Calls is turned on. | No command-specific options. | | `sendbird calls settings general get` | Read Calls general settings. | No command-specific options. | | `sendbird calls settings general set` | Update Calls general settings. Read the current values first. Requires `--yes`. | `--relay-method ` `--direct-call-cloud-recording-enabled ` `--group-call-cloud-recording-enabled ` `--direct-call-recording-video ` `--direct-call-recording-display-timestamp ` `--direct-call-recording-timestamp-timezone ` | | `sendbird calls settings webhook get` | Read Calls webhook settings. | `--display-all-webhook-categories ` | | `sendbird calls settings webhook set` | Update Calls webhook settings. Read the current values first. Requires `--yes`. | `--enabled ` `--enabled-events ` | | `sendbird calls settings chat-integration get` | Read Calls chat-integration settings. | `--display-all-chat-integration-categories ` | | `sendbird calls settings chat-integration set` | Update Calls chat-integration settings. Read the current values first. Requires `--yes`. | `--enabled ` `--enabled-events ` | ## Calls push credentials Calls push credentials are separate from the push switch that Chat and Calls share. `calls settings push get` reads the shared switch. To change it, use `chat push enabled set` with `--confirm-shared-push true` and `--yes`; the change affects both Chat and Calls. Pass push credentials from a private credential file instead of typing them in the command. | Command | Purpose | Command-specific inputs | | ---------------------------- | -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `sendbird calls push list` | List Calls VoIP push credentials. | `--push-type ` `--paginated ` `--limit ` `--token ` | | `sendbird calls push create` | Register Calls VoIP push credentials from a private credential file. Requires `--yes`. | `--credential-file ` `--push-type ` `--format ` `--environment ` `--apns-bundle-id ` `--apns-key-id ` `--apns-team-id ` `--huawei-app-id ` `--push-sound ` | | `sendbird calls push update` | Replace Calls VoIP push credentials from a private credential file. Requires `--yes`. | `--credential-file ` `--push-type ` `--id ` `--format ` `--environment ` `--apns-bundle-id ` `--apns-key-id ` `--apns-team-id ` `--huawei-app-id ` `--push-sound ` | | `sendbird calls push delete` | Delete Calls VoIP push credentials. Requires `--yes`. | `--push-type ` `--id ` | ## Credits and usage | Command | Purpose | Command-specific inputs | | ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | | `sendbird calls credits list` | Read the organization's Calls credit history, status, balance, and expiry date. A balance on an expired, depleted, or not-yet-active voucher isn't available credit. | `--limit ` `--offset ` `--ordering ` | | `sendbird calls credits claim-trial` | Request the organization's one-time free Calls trial. Requires `--yes` or a confirmation in the terminal. Doesn't buy credits. | No command-specific options. | | `sendbird usage calls org` | Read Calls and Live credit usage by application for the selected organization. | No command-specific options. | | `sendbird usage calls app` | Read one application's Calls and Live credit usage and organization totals. | No command-specific options. | | `sendbird usage calls trend` | Read daily or monthly Calls and Live credit usage trend for an organization. | `--resolution ` `--start ` `--end ` | | `sendbird usage calls app-trend` | Read an app's daily or monthly voice and video usage. | `--resolution ` `--start ` `--end ` |