Obter todos os números de telefone

Obter todos os números de telefone pertencentes ao usuário autenticado

GET https://suasofia.online/api//user/phone-numbers/all

Obter todos os números de telefone

cURL

curl --request GET \
  --url https://suasofia.online/api/user/phone-numbers/all \
  --header 'Authorization: Bearer <token>'

200 Response

{
  "data": [
    {
      "id": 1,
      "phone_number": "[phone]",
      "country_code": "US",
      "type": "normal",
      "type_label": "Número Dedicado",
      "sms_capable": true,
      "region": "us1",
      "has_active_subscription": true,
      "created_at": "2025-01-08T10:30:00.000000Z"
    },
    {
      "id": 2,
      "phone_number": "[phone]",
      "country_code": "GB",
      "type": "normal",
      "type_label": "Número Dedicado",
      "sms_capable": false,
      "region": "us1",
      "has_active_subscription": true,
      "created_at": "2025-01-05T14:20:00.000000Z"
    }
  ]
}

Este endpoint retorna uma lista de todos os números de telefone associados à sua conta, incluindo seu status de assinatura e capacidades.

Resposta

data · array

Array de objetos de números de telefone

Show propriedades dos números de telefone

id · integer

O identificador único do número de telefone

phone_number · string

O número de telefone no formato E.164 (por exemplo, [phone])

country_code · string

O código do país ISO 3166-1 alpha-2 (por exemplo, US, GB, AU)

type · string

O tipo do número de telefone: normal, sip, ou caller_id

type_label · string

Rótulo legível por humanos para o tipo de número de telefone

sms_capable · boolean

Se o número de telefone pode enviar e receber SMS

region · string

A região onde o número de telefone é provisionado

has_active_subscription · boolean

Se o número de telefone tem uma assinatura ativa

created_at · string

Timestamp ISO 8601 de quando o número de telefone foi adquirido

200 Response

{
  "data": [
    {
      "id": 1,
      "phone_number": "[phone]",
      "country_code": "US",
      "type": "normal",
      "type_label": "Número Dedicado",
      "sms_capable": true,
      "region": "us1",
      "has_active_subscription": true,
      "created_at": "2025-01-08T10:30:00.000000Z"
    },
    {
      "id": 2,
      "phone_number": "[phone]",
      "country_code": "GB",
      "type": "normal",
      "type_label": "Número Dedicado",
      "sms_capable": false,
      "region": "us1",
      "has_active_subscription": true,
      "created_at": "2025-01-05T14:20:00.000000Z"
    }
  ]
}

Há também um endpoint legado GET /user/phone-numbers que retorna apenas números de telefone capazes de SMS com assinaturas ativas. Use este endpoint /all se você precisar de todos os números de telefone independentemente da capacidade de SMS ou status de assinatura.