ESTRUCTURA Y PROPIEDADES
Objeto Grupo ➜ Etiquetas
En la versión anterior de Notificame, se tenia el Objeto Grupo en el API. Ahora, en esta nueva versión, pasa a ser nombrado Etiquetas.
Propiedades de Grupo en Noitifícame versión anterior
Propiedad | Tipo | |
---|---|---|
short_name | texto | deprecada |
name | texto | |
description | texto | deprecada |
members | objeto | deprecada |
Propiedades de Etiqueta en Notificame nueva versión
Propiedad | Tipo | Descripción |
---|---|---|
name | texto | Nombre de la etiqueta |
count | numérico | Total de contactos en la etiqueta |
TIP
Se agregó la propiedad count
Ejemplos del JSON
JSON de Grupo en Notifícame versión anterior
{
"short_name": "vip",
"name": "VIP",
"description": "vip group",
"members":
{
"total": 5,
"pending": 1,
"confirmed": 4,
"cancelled": 3
}
}
JSON de Etiqueta en Notifícame nueva versión
{
"name": "VIP",
"count": 1
}
Objeto Contactos
Propiedades de Contactos en Notifícame nueva versión
Propiedad | Tipo |
---|---|
msisdn | texto |
phone_number | texto |
first_name | texto |
last_name | texto |
full_name | texto |
country_code | texto |
added_from | texto |
status | texto |
Propiedades de Contactos en Notifícame nueva versión
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 |
tags | array(texto) | Array con los nombres de las etiquetas |
monitoring | boolean | true: el contacto es monitor, false: el contacto no es monitor |
Ejemplos del JSON
JSON de Contacto en Notifícame versión anterior
{
"msisdn": "50212345678",
"phone_number": "Jose",
"country_code": ‘502’,
"first_name": "Jose",
"last_name": "Gomez",
"last_name": "Jose Gomez",
"added_from": "WEB_FORM",
"status": "SUBSCRIBED"
}
JSON de Contacto en Notifícame nueva versión
{
"msisdn": "50235200846",
"phone_number": "35200846",
"country_code": "502",
"first_name": "Rocael",
"last_name": "Guzman",
"full_name": "Rocael Guzman",
"added_from": "WEB_FORM",
"status": "SUSCRIBED",
"tags": [ "VIP" ],
"profile_uid": "60e7d5a834224d067d9795d0",
"monitoring": false
}
TIP
Se agregó la propiedad tags, donde se listan las etiquetas agregadas al contacto
Objeto Mensajes
Propiedades de Mensajes en Notifícame versión anterior
Propiedad | Tipo |
---|---|
message_id | numérico |
id | texto |
short_code | texto |
country | texto |
msisdn | texto |
groups | vector |
direction | texto |
status | texto |
message | texto |
total_recipients | numérico |
sent_from | vector |
sent_count | numérico |
error_count | numérico |
total_monitors | numérico |
is_scheduled | boolean |
is_billable | boolean |
created_on | Fecha |
created_bt | texto |
type | numérico |
Propiedades de Mensajes en Notifícame nueva versión
Propiedad | Tipo | Descripción |
---|---|---|
message_id | texto | Identificador único del mensaje |
id | texto | Identificador externo del mensaje enviado por el cliente. Este es el valor del parámetro id al enviar un mensaje. Puede servir como referencia cruzada para identificar los mensajes. Como dato adicional el maximo de caracteres es 40, si se excede producira un error. |
short_code | texto | Número por el cual fue enviado el mensaje |
country | texto | Código internacional del país del destinatario |
msisdn | texto | Número de teléfono del destinatario en formato internacional. Sólo se debe incluir si el mensaje es de tipo individual. |
tags | vector | Etiquetas asignadas al contacto |
direction | texto | Dirección del mensaje. MO = Entrante, MT = Saliente |
status | texto | Estado del mensaje: PENDING, PROCESSING, READY, SENT |
message | texto | Texto del mensaje |
total_recipients | numérico | Total de destinatarios para el mensaje, sin incluir los monitores |
sent_from | vector | Si el valor include_recipients es verdadero “true” en la llamada, esta propiedad contendrá un listado de los destinatarios del mensaje |
sent_count | numérico | Total de mensajes enviados |
error_count | numérico | Total de mensajes que se registraron con error luego de enviarlos al operador |
total_monitors | numérico | Total de destinatarios de monitoreo a los que se les enviará el mensaje |
is_scheduled | boolean | Indica si el mensajes es calendarizado o no. valores: 1 - 0 |
is_billable | boolean | Indica si el mensajes es cobrado o no. valores: 1 - 0 |
created_on | Fecha | Fecha y hora en la que se creó el mensaje |
created_by | texto | Nombre del usuario que generó el mensaje |
type | numérico | Indica si el mensaje es individual o grupal. valores: 1 individual, 2 grupal |
Ejemplos del JSON
JSON de Mensajes en Notifícame versión anterior
{
"message_id":109212,
"id":1234,
"short_code":"50210000290",
"groups":[
"sales",
"tech"
],
"direction":"MT",
"status":"SENT",
"message":"demo: This is a test message",
"total_recipients":21,
"sent_from":"API_HTTP",
"sent_count":24,
"error_count":0,
"total_monitors":3,
"is_scheduled":false,
"is_billable":true,
"created_by":"usuario@dominio.com",
"created_on":"201408 06 21:56:41",
"type":2
}
JSON de Mensajes en Notifícame nueva versión
{
"message_id": "60eb80fa110ff06b4d9ec8e2",
"short_code": "0050230000215",
"type": 1,
"direction": "MT",
"status": "READY",
"sent_from": "API_REST",
"message": "messageTest",
"sent_count": 0,
"error_count": 0,
"total_recipients": 1,
"msisdn": "50235148164",
"country": "502",
"is_billable": true,
"is_scheduled": false,
"created_on": "2021-07-11 17:38:34",
"created_by": "API",
"total_monitors": 0
}
ATENCIÓN
Se quitó la propiedad groups