Api Rich

API Rich 

 Envío

POST /2.0/rich/send

Envía un mensaje rich que tendrá en su interior tanto el mensaje como los destinatarios, plataforma, forma de envío, programación, etc.

El cuerpo de la petición debe ser un objeto MensajeDTO el cual contiene un objeto MensajeRichDTO con los datos del mensaje rich.

 

Ejemplo de petición
POST /octopus-rs/services/2.0/rich/send HTTP/1.1
Content-Type: application/json

 

 Ejemplo de JSON mínimo (sin push asociada)
{
    "claveAplicacion":"1afd7ea2f688459699d2597f878f7860",
    "broadcast":true,
    "plataforma":1,
    "mensajeRichDTO":{
        "enviaPush":false,
        "fechaInicioVigencia":"12-11-2015",
        "fechaFinVigencia":"14-11-2015",
        "contsMensajerichDTO":[
            {
                "titulo":"rich desde API",
                "descripcion":"envio de una rich desde api con idioma por defecto español",
                "detalle":"<h1>Rich enviada desde API</h1>",
                "idiomaObj":{
                    "codigo":"es"
                },
            "porDefecto":true
            }
        ]
    }
}

Ejemplo de JSON con push asociada
{
    "claveAplicacion":"1afd7ea2f688459699d2597f878f7860",
    "contenidosMensaje":[
            {
                "textoMensaje":"Envio push desde api con localizacion",
                "idiomaObj":{
                    "codigo":"es"
                },
                "porDefecto":true
            }
    ],
    "plataforma":1,
    "broadcast":false,
    "coordX":37.40793727801404,
    "coordY":-5.942401885986328,
    "radio":1000,
    "mensajeRichDTO":{
        "enviaPush":true,
        "fechaInicioVigencia":"12-11-2015",
        "fechaFinVigencia":"14-11-2015",
        "contsMensajerichDTO":[
            {
                "titulo":"rich desde API",
                "descripcion":"envio de una rich desde api con idioma por defecto español",
                "detalle":"<h1>Rich enviada desde API</h1>",
                "idiomaObj":{
                    "codigo":"es"
                },
    	        "porDefecto":true
            }
        ]
    }

}

Ejemplo de respuesta
{
    "error": {
        "descripcion": "Todo correcto",
        "codError": "0"
    },
    "respuesta": []
}

Parámetros JSON del MensajeRichDTO

enviaPush: parámetro boolean que indica si se enviará una push asociada a la rich.
fechaInicioVigencia: parámetro que indica la fecha de comienzo de vigencia de la rich. El formato utilizado será  “dd-MM-yyyy”.
fechaFinVigencia: parámetro que indica la fecha de finalización de vigencia de la rich. El formato utilizado será  “dd-MM-yyyy”.
contsMensajerichDTO: Lista de objetos ContMensajeRichDTO que contienen información de la rich.

  • Parámetros necesarios:
    • título: Titulo de la notificación Rich.
    • descripción: Descripción breve de la notificación Rich.
    • detalle: contenido del texto de la rich (html)
    • idiomaObj: Objeto Idioma del mensaje.
      • código: parámetro en modo texto que indica el idioma del textoMensaje
    • porDefecto: parámetro booleano que indica si es el texto que se envía por defecto si no se indica el idioma del dispositivo que lo va a recibir.

Control de errores
  • Introducir un código de idioma en el contMensajeRichDTO incorrecto o no indicarlo
  • Al poner el parámetro enviaPush a true se añaden las validaciones de la notificación push.

 Envío de lista

POST /2.0/rich/sendList

Envía una lista de notificaciones rich que tendrán en su interior tanto el mensaje como los destinatarios, plataforma, forma de envío, programación, etc.


Ejemplo de petición
POST /octopus-rs/services/2.0/rich/sendList HTTP/1.1
Content-Type: application/json

Ejemplo de JSON 
[
    {
        "claveAplicacion":"1afd7ea2f688459699d2597f878f7860",
        "broadcast":true,
        "plataforma":1,
        "mensajeRichDTO":{
            "enviaPush":false,
            "fechaInicioVigencia":"12-11-2015",
            "fechaFinVigencia":"14-11-2015",
            "contsMensajerichDTO":[
                {
                    "titulo":"rich desde API",
                    "descripcion":"envio de una rich desde api con idioma por defecto español",
                    "detalle":"<h1>Rich enviada desde API</h1>",
                    "idiomaObj":{
                        "codigo":"es"
                    },
                    "porDefecto":true
                }
            ]
        }
    },
    {
        "claveAplicacion":"1afd7ea2f688459699d2597f878f7860",
        "broadcast":true,
        "plataforma":1,
        "mensajeRichDTO":{
            "enviaPush":false,
            "fechaInicioVigencia":"13-11-2015",
            "fechaFinVigencia":"17-11-2015",
            "contsMensajerichDTO":[
                {
                    "titulo":"rich2 desde API",
                    "descripcion":"envio de una rich desde api con idioma por defecto inglés",
                    "detalle":"<h1>Rich2 enviada desde API</h1>",
                    "idiomaObj":{
                        "codigo":"en"
                    },
                    "porDefecto":true
                }
            ]
        }
    }
]

Ejemplo de respuesta
{
    "error": {
        "descripcion": "Todo correcto",
        "codError": "0"
    },
    "respuesta": [
        {
            "error": {
                "descripcion": "Todo correcto",
                "codError": "0"
            },
            "respuesta": []
        },
        {
            "error": {
                "descripcion": "Todo correcto",
                "codError": "0"
            },
            "respuesta": []
        }
    ]
}
Parámetros JSON de cada MensajeRichDTO

enviaPush: parámetro boolean que indica si se enviará una push asociada a la rich.
fechaInicioVigencia: parámetro que indica la fecha de comienzo de vigencia de la rich. El formato utilizado será  “dd-MM-yyyy”
fechaFinVigencia: parámetro que indica la fecha de finalización de vigencia de la rich. El formato utilizado será  “dd-MM-yyyy”
contsMensajerichDTO: Lista de objetos ContMensajeRichDTO que contienen información de la rich.

  • Parámetros necesarios:
    • título: Titulo de la notificación Rich
    • descripción: Descripción breve de la notificación Rich
    • detalle: contenido del texto de la rich (html)
    • idiomaObj: Objeto Idioma del mensaje.
      • código: parámetro en modo texto que indica el idioma del textoMensaje
    • porDefecto: parámetro booleano que indica si es el texto que se envía por defecto si no se indica el idioma del dispositivo que lo va a recibir.
Control de errores
  • En el caso de asociar una notificación push se añaden los controles de error de este objeto
  • Introducir un código de idioma en el contMensajeRichDTO incorrecto o no indicarlo
  • Al poner el parámetro enviaPush a true se añaden las validaciones de la notificación push.

 

Api Rich