MENSAJES

Detalle Objeto Json

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

Parámetro	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		Código internacional del país del destinatario
msisdn	Texto OPCIONAL	Número de teléfono del destinatario en formato internacional. Sólo se debe incluir si el mensaje es de tipo individual.
direction	Texto	Dirección del mensaje. MO = Entrante, MT = Saliente
status	Texto	Estado del mensaje. Posibles valores: - PENDING – El mensaje grupal fue creado pero aún no se ha procesado - PROCESSING – El mensaje grupal está siendo procesado para incluir todos los contactos en los grupos en cuestión - READY – El mensaje está listo para ser enviado - SENT – El mensaje ha sido enviado hacia el operador
message	Texto	Texto del mensaje
total_recipients	Numérico	Total de destinatarios para el mensaje, sin incluir los monitores
sent_from	Vector OPCIONAL	Si el valor include_recipients es verdadero (“true”) en la llamada, esta propiedad contendrá un listado de los destinatarios del mensaje
sent_count	Num	Total de mensajes enviados, incluyendo destinatarios y monitores. Si el mensaje es de más de 160 caracteres, se enviarán más de un SMS por destinatarios. Este número reflejará la totalidad de SMS generados
error_count	Num	Total de mensajes que se han registrado con error luego de enviarlos al operador
total_monitors	Num	Total de destinatarios de monitoreo a los que se enviará el mensaje.
is_scheduled	Boolean	Indica si el mensaje es calendarizado o no. Posibles valores: 0 y 1
is_billable	Boolean	Indica si el mensaje es cobrado o no. Posibles valores: 0 y 1
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	Indica si el tipo de mensaje es individual o grupal. Posibles valores: 1 – INDIVIDUAL 2 – GRUPAL

{ 
   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 
}

Listando Los Mensajes Enviados

GET /messages

Este recurso se utiliza para obtener el listado de los mensajes enviados.

Parámetro	Tipo	Descripción
start_date	Fecha	Filtro de fecha para los mensajes enviados desde la fecha especificada. Formato D, d M Y H:i:s T. Ejemplo: Mon, 11 Jun 2014 17:33:23 GMT
end_date	Fecha	Filtro de fecha para los mensajes enviados hasta la fecha especificada. Formato D, d M Y H:i:s T. Ejemplo: Mon, 11 Jun 2014 17:33:23 GMT
Limit	Numérico	Límite de registros a retornar. Valor pre definido 200
start	Texto OPCIONAL	Offset de inicio para los registro iniciales
misdn	Num OPCIONAL	Búsqueda de mensajes enviados para un misdn especifico
group_short_name	Texto OPCIONAL	Filtro de mensajes enviados a un grupo específico por el valor short_name
delivery_status_enable	Boolean OPCIONAL	Parámetro para indicar si los mensajes retornaran la propiedad delivery_status
direction	Texto	Filtro para indicar la dirección de los mensajes a retornar en la consulta. Valor predeterminado: ALL. Posibles Valores: ALL – Mensajes entrantes y salientes MT – Mensajes salientes MO – Mensajes entrantes

Se devolverá un JSON conteniendo el vector con los objetos tipo “Message” por cada mensaje enviado.

Enviando mensajes individuales

POST /messages/send_to_contact

Este recurso se utiliza para enviar mensajes individuales a un contacto.

Parámetro	Tipo	Descripción
misdn	Num	Numeró de teléfono al que se desea enviar el mensaje. Código Internacional de País + Número De Teléfono (country code + phone number)
message	Texto	Texto del mensaje – La longitud máxima del campo es de: 160- (account_short_name+2) Ejemplo: account_short_name: TuEmpresa (10 caracteres) Cada mensaje incluirá el account_short_name + “: “ (dos puntos + espacio) 160-10=150

Notifícame devolverá un código que indicara si el envío de mensaje fue exitoso o bien si ocurrió un error. Por favor consultar la tabla de códigos de respuesta de plataforma.

{ 
  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 
}

POST /messages/send_to_contact

POST Data
{
   msisdn: "50235148163",
   message: "este es un mensaje de prueba",
   id: 12345
}

{
   message_id: '60eb82fe4caac830e3af82b6',
   short_code: '0050230000215',
   type: 1,
   direction: 'MT',
   status: 'READY',
   sent_from: 'API_REST',
   id: '12345',
   message: 'este es un mensaje de prueba',
   sent_count: 0,
   error_count: 0,
   total_recipients: 1,
   msisdn: '50235148163',
   country: '502',
   is_billable: true,
   is_scheduled: false,
   created_on: '2021-07-11 17:47:10',
   created_by: 'API',
   total_monitors: 0
}

Enviando mensajes a etiquetas

POST /messages/send

Este recurso se utiliza para enviar mensajes individuales a un contacto.

Parámetro	Tipo	Descripción
tags	Vector OPCIONAL	Vector de cadena de caracteres conteniendo los :short_name de cada grupo a los cuales fue enviado el mensaje
message	Texto	Texto del mensaje – La longitud máxima del campo es de: 160- (account_short_name+2) Ejemplo: account_short_name: TuEmpresa (10 caracteres) Cada mensaje incluirá el account_short_name + “: “ (dos puntos + espacio) 160-10=150
id	Texto OPCIONAL	Identificador externo del mensaje. Este identificador se puede utilizar para referenciar el mensaje con algún identificador del lado del cliente. También se utiliza durante las validaciones anti spam para evitar que dos mensajes con el mismo ID sean enviados en el período configurado de spam.

Notifícame devolverá un código que indicara si el envío de mensaje fue exitoso o bien si ocurrió un error. Por favor consultar la tabla de códigos de respuesta de plataforma.

{
   short_code: '0050230000215',
   type: 1,
   direction: 'MT',
   status: 'PENDING',
   sent_from: 'API_REST',
   message: 'This is a test message',
   sent_count: 0,
   error_count: 0,
   total_recipients: 0,
   is_billable: false,
   is_scheduled: false,
   created_on: '2021-07-11 19:07:28',
   total_monitors: 0
}

POST /messages/send

POST Data
{
   tags: ['home'],
   message: 'This is a test message'
}

{
   short_code: '0050230000215',
   type: 1,
   direction: 'MT',
   status: 'PENDING',
   sent_from: 'API_REST',
   message: 'This is a test message',
   sent_count: 0,
   error_count: 0,
   total_recipients: 0,
   is_billable: false,
   is_scheduled: false,
   created_on: '2021-07-11 19:07:28',
   total_monitors: 0
}

# MENSAJES

# Detalle Objeto Json

# Listando Los Mensajes Enviados

# GET /messages

# Enviando mensajes individuales

# POST /messages/send_to_contact

# Enviando mensajes a etiquetas

# POST /messages/send