Skip to main content
GET
Get Phone

Autorizaciones

Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parámetros de ruta

phone_id
string<uuid>
requerido

The unique identifier for the phone

Respuesta

Successful Response

id
string<uuid>
requerido

Unique identifier for the phone register record

number
string
requerido

The phone number or SIP identifier

telephony_provider
enum<string>
requerido

The telephony provider (NETELIP for purchased numbers, CUSTOM for imported numbers)

Opciones disponibles:
netelip,
custom
status
enum<string>
requerido

Current status of the phone register (RESERVED, PENDING_VERIFICATION, ASSIGNED, RELEASED, FINISHED)

Opciones disponibles:
reserved,
pending_verification,
assigned,
released,
finished
nickname
string | null

The nickname given to the phone number

released_at
string<date-time> | null

The date and time when the phone was released

scheduled_release_at
string<date-time> | null

The date and time when the phone is scheduled to be released. If set, the phone will be released at this time at the end of the billing period.

assigned_at
string<date-time> | null

The date and time when the phone was assigned

inbound_agent_id
string<uuid> | null

The unique identifier for the agent that will receive the call when this phone receives an inbound call

outbound_agent_id
string<uuid> | null

The unique identifier for the agent that will make the calls when using this phone to make outbound calls

sip_config
SipConfigResponseSchema · object | null

SIP trunk configuration details (only for custom/imported phones)

checkout_url
string | null

Stripe Checkout URL to continue payment. Present only for RESERVED (in-checkout) numbers whose checkout session is still open.

reservation_expires_at
string<date-time> | null

When the RESERVED hold expires and the number returns to the available pool. Present only for RESERVED numbers; drives the checkout countdown on the frontend.

region_codes
string[]

Spanish region codes the number's landline prefix maps to (usually one; shared Ceuta/Melilla prefixes return two). Empty for mobiles or non-geographic numbers.