CONTACTOS
Detalle Objeto Json
El Objeto “Contacto” se encuentra estructurado de la siguiente forma:
| Propiedad | Tipo | Descripción |
|---|---|---|
| Msisdn | Texto | Código Internacional de País + Número de Teléfono |
| phone_number | Texto | Número de Teléfono |
| first_name | Texto | Primer Nombre del Contacto |
| last_name | Texto | Apellido del Contacto |
| full_name | Texto | Combinación de Primer Nombre y Apellido |
| country_code | Texto | Código Internacional de País |
| added_from | Texto | Origen del contacto (WEB_FORM, API, FILE_UPLOAD, SMS, SUBSCRIPTION_REQUEST) |
| Status | Texto | SUBSCRIBED, 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ámetro | Tipo | Descripción |
|---|---|---|
| Limit | Numérico | Límite de registros (max: 1000) |
| Start | Texto (OPCIONAL) | Offset de inicio |
| Query | Texto (OPCIONAL) | Búsqueda por msisdn o nombres |
| Status | Texto (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/50212345678Creando 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/50212345678Por favor consultar la tabla de códigos de respuesta.