{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/functions/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["partial"]},"type":"markdown"},"seo":{"title":"Developer Documentation","siteUrl":"https://developers.sinch.com","llmstxt":{"title":"Sinch Developer Documentation","description":"LLMs.txt containing a map of all the documentation files for Sinch.","sections":[{"title":"SMS API","description":"The SMS API allows you to send and receive SMS messages with a few easy steps. You can also send bulk SMS messages to multiple customers using the Sinch SMS service.","includeFiles":["docs/sms/**/*.md","docs/sms/**/*.yaml"],"excludeFiles":["docs/sms/index.md"]},{"title":"Numbers API","description":"The Numbers API enables you to search for, view, and activate numbers. It's considered a precursor to other APIs in the Sinch product family. The numbers API can be used in tandem with any of our APIs that perform messaging or calling.","includeFiles":["docs/numbers/**/*.md","docs/numbers/**/*.yaml"],"excludeFiles":["docs/numbers/index.md"]},{"title":"Conversation API","description":"Send and receive messages globally on many popular channels with ease and confidence when using Sinch's Conversation API. Conversation API is the preferred API for sending mobile messages on SMS and other social channels with Sinch. It is a simple API with unified error messages, consistent request payloads, and common webhook payloads that are channel-agnostic.","includeFiles":["docs/conversation/**/*.md","docs/conversation/**/*.yaml"],"excludeFiles":["docs/conversation/index.md"]},{"title":"Voice API","description":"The Voice API works as a big telephony switch. The Voice API handles incoming phone calls (also known as incoming call “legs”), sets up outgoing phone calls (or outgoing call “legs”), and bridges the two. The incoming call leg may come in over a data connection (from a smartphone or web application using the Sinch SDKs) or through a local phone number (from the PSTN network). Similarly, the outgoing call leg can be over data (to another smartphone or web application using the Sinch SDKs) or the PSTN network.","includeFiles":["docs/voice/**/*.md","docs/voice/**/*.yaml"],"excludeFiles":["docs/voice/index.md"]},{"title":"Verification API","description":"The Verification API is a platform for phone number verification. It consists of the API and different software development kits (the Sinch SDKs) that you integrate with your smartphone or web application and cloud based back-end services. Together they enable SMS, Flashcall, Phone Call and Data verification in your application.","includeFiles":["docs/verification/**/*.md","docs/verification/**/*.yaml"],"excludeFiles":["docs/verification/index.md"]},{"title":"Provisioning API","description":"Provisioning API allows you to programmatically set up your senders, accounts and templates on your favorite messaging platforms on the Conversation API. For now, you can create your first WhatsApp channel through Meta's Embedded sign up, you can configure your first SMS App and configure your webhooks. As development continues, we will be adding the most commonly used channels.","includeFiles":["docs/provisioning-api/**/*.md","docs/provisioning-api/**/*.json"],"excludeFiles":["docs/provisioning-api/index.md"]},{"title":"Elastic SIP Trunking API","description":"With Elastic SIP Trunking you can create and manage your SIP trunks and phone numbers programmatically.","includeFiles":["docs/est/**/*.md","docs/est/**/*.yaml"],"excludeFiles":["docs/est/index.md"]},{"title":"Fax API","description":"Send and receive HIPAA compliant faxes on our modern fax platform using our developer-friendly API.","includeFiles":["docs/fax/**/*.md","docs/fax/**/*.yaml"],"excludeFiles":["docs/fax/index.md"]},{"title":"In-app Voice and Video SDK","description":"The In-app Voice and Video SDK enables you to add voice and video calling capabilities directly into your mobile or web application using the Sinch SDKs.","includeFiles":["docs/in-app-calling/**/*.md"],"excludeFiles":["docs/in-app-calling/index.md"]}],"hide":false,"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"sinch-numbers","__idx":0},"children":["sinch numbers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Manage Sinch phone numbers: search available numbers, view active numbers, update configuration, and release numbers. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/docs/numbers/"},"children":["Sinch Numbers API"]}," on developers.sinch.com for product documentation."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sinch-numbers-active","__idx":1},"children":["sinch numbers active"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Manage phone numbers currently active in your project."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sinch-numbers-active-list","__idx":2},"children":["sinch numbers active list"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List all active phone numbers, with optional filters."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"sinch numbers active list [options]\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-r, --region <code>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by region code (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GB"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SE"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-t, --type <type>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MOBILE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LOCAL"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TOLL_FREE"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-c, --capability <cap...>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by capability: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VOICE"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-p, --pattern <digits>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by digit pattern"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--search-pattern <mode>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pattern match mode: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["START"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CONTAINS"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["END"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-l, --limit <number>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum results to return"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Output as JSON"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sinch-numbers-active-get","__idx":3},"children":["sinch numbers active get"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Get details for a specific active number."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"sinch numbers active get [phone-number]\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sinch-numbers-active-update","__idx":4},"children":["sinch numbers active update"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Update configuration for an active number (display name, SMS service plan, voice app, or callback URL)."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"sinch numbers active update [phone-number] [options]\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-d, --display-name <name>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["New display name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--sms-service-plan <id>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["SMS service plan ID (empty string to unlink)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--voice-app <id>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Voice app ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--callback-url <url>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Callback URL for provisioning events"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"sinch-numbers-active-release","__idx":5},"children":["sinch numbers active release"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Release an active number, cancelling your subscription. Requires confirmation."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"sinch numbers active release [phone-number] [-f, --force]\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sinch-numbers-available","__idx":6},"children":["sinch numbers available"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Search for available phone numbers that you can rent."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"sinch numbers available [options]\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-r, --region <code>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Region code (e.g., ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["US"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GB"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-t, --type <type>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number type: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MOBILE"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LOCAL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TOLL_FREE"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-c, --capability <cap...>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Capability: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["VOICE"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-p, --pattern <digits>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Digit pattern to search"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-l, --limit <number>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum results"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--rent"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Interactively choose and rent a number from results"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sinch-numbers-regions","__idx":7},"children":["sinch numbers regions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List regions where phone numbers are available."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"sh","header":{"controls":{"copy":{}}},"source":"sinch numbers regions [options]\n","lang":"sh"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-t, --type <type>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by number type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["-c, --capability <cap>"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by capability"]}]}]}]}]}]},"headings":[{"value":"sinch numbers","id":"sinch-numbers","depth":1},{"value":"sinch numbers active","id":"sinch-numbers-active","depth":2},{"value":"sinch numbers active list","id":"sinch-numbers-active-list","depth":3},{"value":"sinch numbers active get","id":"sinch-numbers-active-get","depth":3},{"value":"sinch numbers active update","id":"sinch-numbers-active-update","depth":3},{"value":"sinch numbers active release","id":"sinch-numbers-active-release","depth":3},{"value":"sinch numbers available","id":"sinch-numbers-available","depth":2},{"value":"sinch numbers regions","id":"sinch-numbers-regions","depth":2}],"frontmatter":{"seo":{"title":""}},"lastModified":"2026-02-22T19:51:31.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/functions/cli/commands/numbers","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}