Etiquetas

Etiquetas

julio 11, 2021 0

 

Etiqueta Objeto Json

 

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

 

Propiedad Tipo Descripción
name Texto Nombre de la etiqueta
count Numérico Total de contactos en la etiqueta.
 

Ejemplo del objeto Json:

{ name: 'Home', count: 1 }

 

Obteniendo las etiquetas a los que pertenece un Contacto

 

GET /contacts/:msisdn/tags Este recurso se utiliza para identificar las etiquetas a los que el contacto específico pertenece.

 

Llamada

Parámetro Tipo Descripción
:msisdn Numérico Código Internacional de País + Número de Teléfono (country code + phone number)

Ejemplo de llamada:

GET /contacts/50235148164/tags

Respuesta

[ 
   { name: 'Work', count: 0 }, 
   { name: 'Sports', count: 0 }
] 

Se devolverá un JSON conteniendo el vector con los objetos tipo “Tags”.

 

 

Listar Etiquetas

 

GET /tags


Este recurso se utiliza para obtener el listado de etiquetas existentes.

Parámetro Tipo Descripción
search Texto
Opcional
Búsqueda de cualquier registro que contenga el filtro con el nombre o el nombre corto

Respuesta

Se devolverá un JSON conteniendo el vector de objetos tipo “Tag”. Si no existieran resultados, se devolverá un vector vacío.

Ejemplo de llamada

GET /tags?search=Sport

[ 
   { name: 'Sports', count: 2 }
]


Agregar etiqueta a contacto

 

POST /contacts/:msisdn/tag/:tag_name


Este recurso se utiliza para agregar una etiqueta a un contacto, la etiqueta no debe contener espacios ni caractéres especiales.

Parámetro Tipo Descripción
:short_name Texto Nombre corto del grupo
:msisdn Texto Código Internacional de País + Número Telefónico (country code + phone number)
 

Respuesta

Se devolverá un JSON conteniendo el objeto de tipo “Contact”.

Ejemplo de llamada

POST /contacts/:50235148163/tag/newTag

{
   msisdn: '50235148164',
   phone_number: '35148164',
   country_code: '502',
   first_name: 'Josefino',
   last_name: 'Gomez',
   full_name: 'Josefino Gomez',
   status: 'SUSCRIBED',
   added_from: 'API',
   tags: [ 'Work', 'Sports', 'newTag' ],
   profile_uid: '60eb787f96f7540689656be4',
   monitoring: false
}





Listando los contactos que pertenecen a un grupo

GET /tags/:tag_name/contacts


Este recurso se utiliza para obtener la lista de contactos pertenecientes a un grupo detallado por el valor :TAG_NAME

Llamada

Parámetro Tipo Descripción
:tag_name Texto Nombre corto del grupo short_name
limit Num
Opcional
Límite de registros a retornar. Valor predeterminado: 50. Valor máximo: 1000
start Num
Opcional
Corrimiento para la cuenta de registros. Valor predeterminado: 0
 

Respuesta

Se devolverá un JSON conteniendo el vector de objetos tipo “Contact”. Si no existieran resultados se devolverá un vector vacío.

Ejemplo de llamada

GET /tags/Sports/contacts?limit=1&start=0

[
 { 
   msisdn: '50235148163',
   phone_number: '35148163',
   country_code: '502',
   first_name: 'Rony',
   last_name: 'Velasquez',
   full_name: 'Rony Velasquez',
   status: 'SUSCRIBED',
   added_from: 'WEB_FORM',
   tags: [Array],
   profile_uid: '6058c1f18bf1280651396444',
   monitoring: false
 }
]

 

 

 

Eliminando Etiquetas

DELETE /tags/:tag_name

Este recurso se utiliza para eliminar una etiqueta existente detallado por el valor :TAG_NAME

Llamada

Parámetro Tipo Descripción
:tag_name Texto Nombre corto del grupo

RESPUESTA

Se devolverá un código que indicará si la eliminación fue exitosa o 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 /groups/Home

 

190    API-REST  
Total 0 Votes:
0

Tell us how can we improve this post?

+ = Verify Human or Spambot ?