GET Número Específico Detalles para obtener un número de teléfono por su ID.

Consultar un Número de Teléfono Específico por ID

Este endpoint permite obtener los detalles de un número de teléfono específico utilizando su ID único.

Endpoint

GET https://www.x-ianet.com/api/v1/xia_phone_numbers/{id}

Donde {id} es el ID único del número de teléfono a consultar. Este ID se puede obtener del endpoint que lista todos los números de teléfono.

Nota: Asumiendo que la ruta base de tu API es /api/v1/. Ajusta esta URL si la configuración real de tus rutas es diferente.

Parámetros de Ruta

Parámetro Tipo Descripción
id UUID (string) / integer El ID único del número de teléfono a consultar.

Formato de Respuesta Exitosa (JSON)

Si la solicitud es exitosa (código de estado 200), se obtiene un objeto JSON con la siguiente estructura:


{
    "status": "Ok",
    "data": {
        "id": "76c7f30a-c0f3-442a-854c-8e1d383c70e6",
        "orgId": "7dc3cace-f298-4ad4-85d9-54cd98303f60",
        "assistantId": "57ac9d17-5b59-4f8a-b75b-b6206da263d7",
        "number": "+34822272829",
        "createdAt": "2025-03-17T18:21:45.709Z",
        "updatedAt": "2025-03-26T19:33:34.039Z",
        "twilioAccountSid": "AC9572d544da4da3d117684c910ac89c2f",
        "name": "José Manuel Ramos Expósito",
        "provider": "twilio",
        "fallbackDestination": {
            "type": "number",
            "number": "+34922547512"
        },
        "status": "active",
        "smsEnabled": true
    },
    "status_code": 200
}
        

Descripción de Campos de Respuesta:

  • id: (UUID/string) Identificador único del número de teléfono.
  • orgId: (UUID/string) ID de la organización a la que pertenece el número.
  • assistantId: (UUID/string) ID del asistente asociado a este número (si aplica).
  • number: (string) El número de teléfono en formato internacional (ej. +34822272829).
  • createdAt: (timestamp) Fecha y hora de creación del registro.
  • updatedAt: (timestamp) Fecha y hora de la última actualización del registro.
  • twilioAccountSid: (string, opcional) SID de la cuenta de Twilio (si el proveedor es Twilio).
  • name: (string, opcional) Nombre descriptivo o etiqueta para el número de teléfono.
  • provider: (string) Proveedor del número de teléfono (ej. "twilio").
  • fallbackDestination: (object, opcional) Configuración de destino alternativo.
    • type: (string) Tipo de destino alternativo (ej. "number").
    • number: (string) Número de teléfono del destino alternativo.
  • status: (string) Estado actual del número de teléfono (ej. "active").
  • smsEnabled: (boolean) Indica si los SMS están habilitados para este número.

Respuesta de Error (Código 404)

Si el número de teléfono con el ID especificado no se encuentra, se retornará:


{
    "status": "Error",
    "message": "Número de teléfono no encontrado.",
    "status_code": 404
}