Documentación

CONTACTOS

Obteniendo una lista de contactos

ATENCIÓN

En la respuesta existen ahora los campos tags y profile_uid, estos no afectarán el funcionamiento si no se toman en cuenta.

Ejemplo de llamada

Llamada en Notifícame

GET /contacts

Respuesta en Notifícame versión anterior

[
    {
        "msisdn": "50212345678",
        "first_name": "Jose",
        "last_name": "Gomez",
        "status": "SUSCRIBED"
    }
]

Respuesta en Notifícame nueva versión

[   
    {
        "msisdn": "50235200846",
        "phone_number": "35200846",
        "country_code": "502",
        "first_name": "Rocael",
        "last_name": "Guzman",
        "full_name": "Rocael Guzman",
        "status": "SUSCRIBED",
        "added_from": "WEB_FORM",
        "tags": [ "Home" ],
        "profile_uid": "60e7d5a834224d067d9795d0",
        "monitoring": false 
    }
    ...
]

Obteniendo La Información de un contacto específico

Este recurso se utiliza para poder obtener un contacto ingresando como parámetro de entrada el valor de número telefónico: MSISDN.

ADVERTENCIA

El número de teléfono deberá de incluir el código internacional de país.

Ejemplo de llamada

Llamada en Notifícame

GET /contacts/50212345678

Respuesta en Notifícame versión anterior

{
    "msisdn": "50212345678",
    "first_name": "Jose",
    "last_name": "Gomez",
    "status": "CONFIRMED"
}

Respuesta en Notifícame nueva versión

{
   "msisdn": "50235148164",
   "phone_number": "35148164",
   "country_code": "502",
   "first_name": "Jose",
   "last_name": "Xuya",
   "full_name": "Jose Xuya",
   "status": "SUSCRIBED",
   "added_from": "API",
   "tags": [],
   "profile_uid": "60eb4ec901347f06638b8b6a",
   "monitoring": false
}

Creando Un Nuevo Contacto

Este recurso se utiliza para crear un nuevo contacto.

Ejemplo de llamada

Llamada en Notifícame

POST /contacts/50212345678

{ 
    "msisdn": "50212345678", 
    "first_name": "Jose", 
    "last_name": "Gomez"
}

Respuesta en Notifícame versión anterior

Se devolverá un código que indicará si la creación fue exitosa o bien si ocurrió un error al efectuar la operación. Por favor consultar la Tabla de códigosopen in new window de respuesta de la plataforma.

Respuesta en Notifícame nueva versión

{
   "msisdn": "50235148164",
   "phone_number": "35148164",
   "country_code": "502",
   "first_name": "Jose",
   "last_name": "Gomez",
   "full_name": "Jose Gomez",
   "status": "SUSCRIBED",
   "added_from": "API",
   "tags": [],
   "profile_uid": "60eb4ec901347f06638b8b6a",
   "monitoring": false 
}

Actualizando Un Contacto

Este recurso se utiliza para actualizar un contacto.

Ejemplo de llamada

Llamada en Notifícame

PUT /contacts/50212345678

{ 
    "first_name": "Jose", 
    "last_name": "Gomez" 
}

Respuesta en Notifícame versión anterior

Se devolverá un código que indicará si la actualización fue exitosa o bien si ocurrió un error al efectuar la operación. Por favor consultar la Tabla de códigosopen in new window de respuesta de la plataforma.

Respuesta en Notifícame nueva versión

{
   "msisdn": "50235148164",
   "phone_number": "35148164",
   "country_code": "502",
   "first_name": "Jose",
   "last_name": "Xuya",
   "full_name": "Jose Xuya",
   "status": "SUSCRIBED",
   "added_from": "API",
   "tags": [],
   "profile_uid": "60eb4ec901347f06638b8b6a",
   "monitoring": false 
}

Eliminando Un Contacto Existente

Este recurso se utiliza para eliminar un contacto existente.

Ejemplo de llamada

Llamada en Notifícame

DELETE /contacts/50212345678

Respuesta en Notifícame versión anterior

Se devolverá un código que indicará si la eliminación fue exitosa o bien si ocurrió un error al efectuar la operación. Por favor consultar la Tabla de códigosopen in new window de respuesta de la plataforma.

Respuesta en Notifícame nueva versión

Se devolverá un código que indicará si la eliminación fue exitosa o bien si ocurrió un error al ejecutar la operación. Por favor consultar la Tabla de códigosopen in new window de respuesta de la plataforma.