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 (country code + phone number) |
| 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 del Contacto |
| country_code | Texto | Código Internacional de País |
| added_from | Texto | Origen del contacto. Posibles valores: WEB_FORM API FILE_UPLOAD SMS SUBSCRIPTION_REQUEST |
| Status | Texto | Posibles valores: 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. La consulta puede ser filtrada por nombres o estados. Si se desea buscar contactos por grupos por favor consulta la sección
“Operaciones de grupos”.
LlamadaRespuesta:
| Parámetro | Tipo | Descripción |
|---|---|---|
| Limit | Numérico | Límite de registros que retornara, valor pre determinado: 50. Valor máximo: 1000 |
| Start | Texto OPCIONAL |
Offset de inicio para los registros de iniciales. Valor inicial: 0 |
| Query | Texto OPCIONAL |
Búsqueda de cualquier registro que contenga el filtro en el msisdn, o nombres |
| Status | Texto OPCIONAL |
Posibles valores: SUBSCRIBED INVITED CONFIRMED CANCELLED |
| shortResults | Booleano | De ser verdadero se retornará una versión reducida del contacto conteniendo solamente msisdn y nombre. Valor por defecto: 0 Posibles valores: 0 – VERDADERO 1 – FALSO |
Se retornará un JSON conteniendo el vector con los objetos tipo “Contact”. Si no existieran resultados se devolverá un vector vacío.
Ejemplo de llamada:
GET /contacts?limit=10&start=20&status=SUBSCRIBED
Resultado: [{ msisdn:'50212345678', first_name:'Jose', last_name:'Gomez', status:”SUBSCRIBED” }]
Obteniendo La Información De Un Contacto Específico
GET /contacts/:msisdn
Este recurso se utiliza para poder obtener un contacto ingresando como parámetro de entrada el valor de número telefónico: MSISDN. Nota: el número de teléfono deberá de incluir el código internacional de país.
Llamada
| Parámetro | Tipo | Descripción |
|---|---|---|
| :msisdn | Numérico | Código Internacional de País + Número de Teléfono (country code + phone number) |
Respuesta
Se devolverá un objeto tipo “Contact” conteniendo la información del contacto.
Ejemplo de llamada
GET /contacts/50212345678
{
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
POST /contacts/:msisdn
Este recurso se utiliza para crear un nuevo contacto.
Llamada:
| Parámetro | Tipo | Descripción |
|---|---|---|
| :msisdn | Numérico | Código Internacional de País + Número de Teléfono (country code + phone number) |
Parámetros del Query
POST Body
El POST BODY (o cuerpo de la solicitud) debe de contener un objeto tipo “contact” conteniendo la información del contacto que se desea crear. El status del contacto debe ser omitido debido a que su administración es realizada por la plataforma.
{
country_code:'502',
first_name: 'Jose',
last_name: 'Gomez',
msisdn: "50235148164"
}
RESPUESTA
{
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
}
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ódigos de respuesta de la plataforma.
Ejemplo de llamada para editar un contacto
PUT /contacts/50212345678
PUT Data
{
first_name: 'Jose',
last_name: 'Xuya',
}
Respuesta
{
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
DELETE /contacts/:msisdn
Este recurso se utiliza para eliminar un contacto existente.
Llamada:
| Parámetro | Tipo | Descripción |
|---|---|---|
| :msisdn | Numérico | Código Internacional de País + Número de Teléfono (country code + phone number) |
RESPUESTA
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ódigos de respuesta de la plataforma.
Ejemplo de Llamada
DELETE /contacts/50212345678