Set Contact Information

La información de contacto se puede utilizar como destino para comunicaciones por canal, como notificaciones de la aplicación, SMS, correos electrónicos y WhatsApp. Cuando cambia la información de contacto de un usuario, se puede utilizar esta API para actualizarla.

La configuración de la información de contacto debe estar asociada al EUID.

Dirección de invocación

POST /v1/user/contact

Verificación de invocación

La API REST de EngageLab utiliza HTTP Basic Authentication como método de verificación. Añadir Authorization a la cabecera HTTP:

Authorization: Basic ${base64_auth_string}
              
              Authorization: Basic ${base64_auth_string}

            
Este bloque de código se muestra en una ventana flotante

El valor base64_auth_string se genera mediante el siguiente algoritmo: base64(api_key:api_secret).

  • El nombre de la cabecera es "Authorization" y el valor es el par "nombre_de_usuario:contraseña" codificado en base64 (separado por dos puntos).
  • Para la API de MA, el nombre de usuario corresponde a la APIKey y la contraseña corresponde al APISecret. Se debe configurar una fuente de datos de tipo API para obtener la APIKey y el API Secret.

Ejemplo de solicitud

Cabecera de solicitud

> POST /v1/user/contact > Content-Type: application/json > Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
              
              > POST /v1/user/contact
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

            
Este bloque de código se muestra en una ventana flotante

Cuerpo de solicitud

{ "euid":10362473, "contacts":{ "mobile_phone": "18023456879", "email": "12@gmail.com" } }
              
              {
    "euid":10362473,
    "contacts":{
        "mobile_phone": "18023456879",
        "email": "12@gmail.com"
    }
}

            
Este bloque de código se muestra en una ventana flotante

Parámetros de solicitud

Campo Tipo Obligatorio Descripción
euid Long El ID único
contacts JSON La clave es el nombre de la información de contacto y el valor es el valor de la información de contacto; ambos son de tipo de datos string.
  • Actualmente, la información de contacto admitida incluye email, mobile_phone, landline_phone, whatsapp_phone
  • Parámetros de respuesta

    Campo Tipo Obligatorio Descripción
    code Int Indica si la llamada a la API se ha realizado correctamente. 0 indica éxito o éxito parcial, y otros valores representan un fallo.
    message String Descripción del resultado de la llamada a la API, que explica el código de retorno.

    Todo correcto

    { "code": 0, "message": "success" }
                  
                  {
        "code": 0,
        "message": "success"
    }
    
                
    Este bloque de código se muestra en una ventana flotante

    Todo fallido

    { "code": 0, "message": "success" }
                  
                  {
        "code": 0,
        "message": "success"
    }
    
                
    Este bloque de código se muestra en una ventana flotante

    Código de error

    Código Descripción Explicación detallada
    40050 Falló la autenticación de la interfaz. Confirmar si el ID del proyecto y la clave secreta del proyecto son correctos.
    40007 El EUID está vacío. Comprobar el valor de EUID.
    50031 El ID del proyecto no es válido. Comprobar si la APIKey y el APISecret son correctos.
    50034 El ID del proyecto no existe. Comprobar si la APIKey y el APISecret son correctos y si el proyecto se ha eliminado.
    50074 La fuente de datos de API no existe. Comprobar si la APIKey y el APISecret son correctos y si la fuente de datos de API se ha eliminado.
    55004 Los parámetros de negocio no son válidos. Comprobar si los campos de los parámetros de la solicitud son correctos.
    55101 El número de identificadores de usuario supera el límite. Confirmar si el número de valores de identificación de usuario supera 100.
    55102 Hay nombres de atributos de usuario no válidos. Confirmar si el nombre del atributo cumple los requisitos de nomenclatura y si está vacío/usa caracteres reservados/supera el límite de longitud.
    55103 Los valores de los atributos de usuario no pueden estar vacíos. Confirmar si el valor del atributo de usuario en el cuerpo de la solicitud está vacío.
    55105 El valor del identificador de usuario no puede superar 256 caracteres. Confirmar si el valor de la identificación de usuario supera 256 caracteres.
    55106 El nombre del identificador de usuario no está dentro del intervalo admitido. Confirmar si el nombre de la identificación de usuario es user_id, anonymous_id o registration_id.
    55107 El valor del identificador de usuario está vacío. Confirmar si el valor de la identificación de usuario en el cuerpo de la solicitud está vacío.
    55108 EUID no válido. Comprobar el valor de EUID.
    -1 Error interno del servidor. Ponerse en contacto con el soporte técnico de EngageLab.
    icon
    Contacto