API de servicios

Tema Anterior
Próximo Tema

Teléfonos

API de servicios Servicios JSON 2.5 Teléfonos

Teléfonos

 

Servicio de Normalización de Teléfonos (Phone Normalize)

El cliente debe enviar una estructura de datos según lo detallado en el apartado Parámetros de Llamada» debiendo completar mínimamente los campos que se detallan a continuación:

  • phoneNumber: deberá completarse con el número de teléfono completo, tanto de celular como particular. El mismo puede contener prefix, characteristic, etc.
  • level1: puede no completarse si se informa el postalCode.
  • level2: puede no completarse si se informa el postalCode.
  • level4: puede no completarse si se informa el postalCode.
  • postalCode: el CP puede no completarse si se informa el level4.

Los siguientes campos son los Headers Obligatorios que deben informarse:

  • Authorization: Header con el ID de acceso de cliente (ClientAccessCode).
  • Content-Type: Header que se informa el tipo de contenido del mensaje, se debe informar application/json.

Método: POST

Endpoint: https://ws.merlindataquality.com/phone/normalize

Parámetros de llamada
Parámetro Descripción Longitud Tipo
Authorization Identificador único de usuarios. Este valor identifica y valida en cada invocación a un usuario determinado. Este valor tiene asociado los roles que le corresponden al usuario. 64 String
Content-Type Header que se informa el tipo de contenido del mensaje, se debe informar application/json. String
level1 Corresponde al primer nivel (País) administrativo de una dirección. 64 String
level2 Corresponde al segundo nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde a Provincia. 64 String
level3 Corresponde al tercer nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde al Partido. 64 String
level4 Corresponde al cuarto nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde a Localidad. 64 String
level5 Corresponde al quinto nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde a Barrio. 64 String
postalCode Código postal de la dirección. 4 String
prefix Código de Discado Directo Nacional. 5 String
characteristic Características del teléfono. 5 String
phoneNumber Número de teléfono. Este campo puede contener el número completo (prefijo, característica, número) o característica y número. 12 String
additionalData Observaciones u otros comentarios que se sumen al teléfono. 64 String
Mensaje JSON de petición
{
  "level1": "AR",
  "level2": "",
  "level3": "",
  "level4": "",
  "level5": "",
  "phoneNumber": "01144420390",
  "characteristic": "",
  "postalCode": "",
  "prefix": "",
  "additionalData": ""
}
Respuesta

La respuesta está compuesta por una lista de elementos que tienen la siguiente estruactura:

Parámetro Descripción Longitud Tipo
status Indica el estado de normalización y/o validación. Valores:
  • CO: Corregido
  • NE: No Encontrado
  • SD: Sin Datos
 2 String
statusReason Indica la razón con referencia al estado de normalización y/o validación. Valores:
  • SM: Sin Motivo (Corregido)
 2 String
transactionId Merlin asigna un id de transacción por consulta. 40 String
nPhone Son los datos del número telefónico Normalizado. – –
level1 Corresponde al primer nivel (País) administrativo de una dirección. 64 String
level2 Corresponde al segundo nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde a Provincia. 64 String
level3 Corresponde al tercer nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde al Partido. 64 String
level4 Corresponde al cuarto nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde a Localidad. 64 String
level5 Corresponde al quinto nivel administrativo de una dirección. Por ejemplo para Argentina, corresponde a Barrio. 64 String
postalCode Código postal de la dirección. 5 String
ddi Código de Discado Directo Internacional. 5 String
ddn Código de Discado Directo Nacional. 5 String
characteristic Los cuatro dígitos correspondientes al número telefónico sin su característica. 5 String
phoneNumber Los cuatro dígitos correspondientes al número telefónico sin su característica. 5 String
validated Comparación entre lo ingresado con la respuesta de merlin. Valores:
  • SI: El dato informado en la entrada es Igual al que retorna Merlin en la salida.
  • NO: El dato informado es diferente con el dato retornado en la salida.
 3 String
additionalData Son datos extra encontrados en el teléfono original que no corresponden a ningún campo (prefijo, característica, número, localidad, provincia, cp). 64 String
merlinCustomValues Valores desarrollados por demanda del cliente o que se proveen opcionalmente. – Object
fullCellPhoneNumber Retorna el número completo informado (para los celulares NO se incluye el 15). El campo se incluye dentro del objeto merlinCustomValues. 12 String
doNotCallRegistry Indica si el teléfono se encuentra limitado para llamadas publicitarias. El campo se incluye dentro del objeto merlinCustomValues. 3 String
fullPhone Retorna el número completo informado (para los celulares SI se incluye el 15). El campo se incluye dentro del objeto merlinCustomValues. 14 String
directory Indica si el teléfono informado figura en la guía telefónica. Valores posibles sí (teléfono en guía), no (no aparece en la guía) y ce (para celulares). El campo se incluye dentro del objeto merlinCustomValues. 2 String
Mensaje JSON de respuesta
{
    "status": "CO",
    "statusReason": "SM",
    "transactionId": "7eed6248-e5e9-4906-998c-a76a94739883",
    "nPhone": {
        "level1": "AR",
        "level2": "CAPITAL FEDERAL",
        "level3": "",
        "level4": "",
        "level5": "",
        "postalCode": "1058",
        "ddi": "",
        "ddn": "011",
        "characteristic": "4442",
        "phoneNumber": "0390",
        "validated": "SI",
        "additionalData": "",
        "merlinCustomValues": {
            "fullCellPhoneNumber": "01144420390",
            "doNotCallRegistry": "SI",
            "fullPhone": "01144420390",
            "directory": "SI"
        }
    }
Tema Anterior
Volver a la Lección
Próximo Tema