> ## Documentation Index
> Fetch the complete documentation index at: https://docs.suasofia.online/llms.txt
> Use this file to discover all available pages before exploring further.

# Buscar números de telefone disponíveis

> Buscar números de telefone disponíveis que podem ser comprados

Este endpoint permite buscar números de telefone disponíveis do nosso provedor. Use os resultados para encontrar um número que deseja comprar.

### Parâmetros de Consulta

<ParamField query="country_code" type="string" default="US">
  O código de país ISO 3166-1 alpha-2 para buscar (ex.: US, GB, AU, CA)
</ParamField>

<ParamField query="contains" type="string">
  Filtrar números de telefone que contêm dígitos específicos (apenas caracteres numéricos, máximo de 10 dígitos)
</ParamField>

### Resposta

<ResponseField name="data" type="array">
  Array de números de telefone disponíveis

  <Expandable title="propriedades do número disponível">
    <ResponseField name="phone_number" type="string">
      O número de telefone no formato E.164
    </ResponseField>

    <ResponseField name="phone_number_formatted" type="string">
      O número de telefone formatado para exibição
    </ResponseField>

    <ResponseField name="country_code" type="string">
      O código de país ISO
    </ResponseField>

    <ResponseField name="price" type="number">
      Preço de aluguel mensal em USD
    </ResponseField>

    <ResponseField name="stripe_price_id" type="string">
      O ID de preço do Stripe para faturamento
    </ResponseField>

    <ResponseField name="address_requirements" type="string">
      Requisitos de endereço para este número: `none`, `local`, `foreign`, ou `inventory`
    </ResponseField>

    <ResponseField name="sms_capable" type="boolean">
      Se o número suporta SMS
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200 Resposta theme={null}
  {
    "data": [
      {
        "phone_number": "+14155551234",
        "phone_number_formatted": "+1 415-555-1234",
        "country_code": "US",
        "price": 3.99,
        "stripe_price_id": "price_1PkA4dBXoZOzqQuAsvGvVJTZ",
        "address_requirements": "none",
        "sms_capable": true
      },
      {
        "phone_number": "+14155555678",
        "phone_number_formatted": "+1 415-555-5678",
        "country_code": "US",
        "price": 3.99,
        "stripe_price_id": "price_1PkA4dBXoZOzqQuAsvGvVJTZ",
        "address_requirements": "none",
        "sms_capable": false
      }
    ]
  }
  ```

  ```json 200 Resposta Vazia theme={null}
  {
    "data": []
  }
  ```
</ResponseExample>

### Países Suportados

| País           | Código |
| -------------- | ------ |
| Estados Unidos | US     |
| Canadá         | CA     |
| Reino Unido    | GB     |
| Austrália      | AU     |
| Israel         | IL     |
| Polônia        | PL     |
| Finlândia      | FI     |
| Holanda        | NL     |
| Dinamarca      | DK     |
| Itália         | IT     |