Saltearse al contenido

CONTACTOS

Detalle Objeto Json

El Objeto “Contacto” se encuentra estructurado de la siguiente forma:

PropiedadTipoDescripción
MsisdnTextoCódigo Internacional de País + Número de Teléfono
phone_numberTextoNúmero de Teléfono
first_nameTextoPrimer Nombre del Contacto
last_nameTextoApellido del Contacto
full_nameTextoCombinación de Primer Nombre y Apellido
country_codeTextoCódigo Internacional de País
added_fromTextoOrigen del contacto (WEB_FORM, API, FILE_UPLOAD, SMS, SUBSCRIPTION_REQUEST)
StatusTextoSUBSCRIBED, INVITED, CONFIRMED, CANCELLED

Ejemplo del Objeto Contact JSON:

{
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 Una Lista De Contactos

GET /contacts

Este recurso se utiliza para obtener la lista de contactos existentes.

GET /contacts?limit=10&start=20&status=SUBSCRIBED
ParámetroTipoDescripción
LimitNuméricoLímite de registros (max: 1000)
StartTexto (OPCIONAL)Offset de inicio
QueryTexto (OPCIONAL)Búsqueda por msisdn o nombres
StatusTexto (OPCIONAL)SUBSCRIBED, INVITED, CONFIRMED, CANCELLED

Obteniendo La Información De Un Contacto Específico

GET /contacts/:msisdn

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

GET /contacts/50212345678

Creando Un Nuevo Contacto

POST /contacts/:msisdn

{
country_code:'502',
first_name: 'Jose',
last_name: 'Gomez',
msisdn: "50235148164"
}

Editando Un Contacto

PUT /contacts/50212345678

{
first_name: 'Jose',
last_name: 'Xuya',
}

Eliminando Un Contacto Existente

DELETE /contacts/:msisdn

DELETE /contacts/50212345678

Por favor consultar la tabla de códigos de respuesta.