Skip to main content
GET
/
user
/
assistants
/
phone-numbers
Obter números de telefone disponíveis
curl --request GET \
  --url https://suasofia.online/api/user/assistants/phone-numbers \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 45,
    "phone_number": "+1234567890",
    "country_code": "US",
    "type_label": "Normal",
    "is_available": true
  },
  {
    "id": 46,
    "phone_number": "+1234567891",
    "country_code": "US",
    "type_label": "SIP",
    "is_available": false
  },
  {
    "id": 47,
    "phone_number": "+441234567890",
    "country_code": "GB",
    "type_label": "Caller ID",
    "is_available": true
  }
]
Este endpoint retorna uma lista de números de telefone pertencentes ao usuário autenticado que podem ser atribuídos aos assistentes, com filtragem opcional por tipo de assistente.

​
Parâmetros de Consulta

​
type
string
Filtrar números de telefone por tipo de assistente. Opções: inbound, outbound

​
Campos de Resposta

​
data
array
[
  {
    "id": 45,
    "phone_number": "+1234567890",
    "country_code": "US",
    "type_label": "Normal",
    "is_available": true
  },
  {
    "id": 46,
    "phone_number": "+1234567891",
    "country_code": "US",
    "type_label": "SIP",
    "is_available": false
  },
  {
    "id": 47,
    "phone_number": "+441234567890",
    "country_code": "GB",
    "type_label": "Caller ID",
    "is_available": true
  }
]

​
Notas

  • Apenas números de telefone pertencentes ao usuário autenticado são retornados
  • Quando type=inbound é especificado, números de identificação de chamadas e números já atribuídos são filtrados
  • O campo is_available indica se o número pode ser atribuído a um novo assistente de entrada
  • Números de telefone são retornados no formato de coleção de valores (array indexado)
  • Use o campo id ao atribuir números de telefone aos assistentes