Versiones comparadas

Versión Versión anterior 6 Nueva versión Actual
Cambios realizados por

Laura Ortiz

Laura Ortiz

Guardado el

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

...

  • ticket_id: Identificador del caso que estará asociado a la nueva interacción. REQUERIDO Requerido cuando campaign_id no se encuentra especificado.

  • campaign_id: Identificador de la campaña en la cual se creará un caso que estará asociado a la nueva interacción. REQUERIDO Requerido cuando ticket_id no se encuentra especificado.

  • type: Especifica el tipo de mensaje a enviar. Siempre REQUERIDOrequerido. Sus posibles valores pueden ser:

    • sm: Standard message o mensaje estándar.

    • hsm: Highly structured message o mensaje altamente estructurado. Exclusivo para canales de tipo WhatsApp.

  • message: Texto o contenido del mensaje a enviar. Siempre REQUERIDO Requerido cuando template_id no se encuentra especificado.

  • contact_info_id: Identificador del dato de contacto al cual será enviado el mensaje. REQUERIDO Requerido cuando contacto_info no se encuentra especificado.

  • contact_info: Dato de contacto al cual será enviado el mensaje. REQUERIDO Requerido cuando contacto_info_id no se encuentra especificado.

  • channel_id: Identificador del canal que será utilizado para enviar el mensaje. REQUERIDO Requerido cuando channel_type_id no se encuentra especificado.

  • channel_type_id: Identificador del tipo de canal que será enviado para enviar el mensaje. Sagicc utilizada el primer canal encontrado del tipo especificado para enviar el mensaje. REQUERIDO Requerido cuando channel_id no se encuentra especificado.

  • transfer_to_agent: Especifica si una vez enviado el mensaje el caso debe o no asignarse a un agente. Sus posibles valores son true o false.

  • close_ticket: Especifica si el caso debe o no marcarse como cerrado luego de ser enviado al mensaje. Sus posibles valores son true o false.

  • attachments: Arreglo con información de los documentos adjuntos que serán enviados. Cada uno de los objetos debe tener la siguiente estructura:

    • url: URL del adjunto a enviar. La URL debe permitir descargar el archivo original. REQUERIDO Siempre requerido.

    • file_name_real: Nombre real del archivo adjunto a enviar. En caso de no especificarlo, el archivo se enviará con un nombre generado por la plataforma. OPCIONAL.

    • mime_type: Identificador mime del archivo a enviar. Por ejemplo, image/png, application/pdf, etc. Siempre requerido.

  • subject: Asunto de la interacción. REQUERIDO Requerido cuando el canal seleccionado es de tipo CORREO ELECTRONICO“Correo Electrónico”.

  • cc: Cadena con correos electrónicos (separados por coma) a los cuales será enviada una copia de la interacción. REQUERIDO cuando el canal seleccionado es de tipo CORREO ELECTRONICO.

  • bcc: Cadena con correos electrónicos (separados por coma) a los cuales será enviada una copia oculta de la interacción. REQUERIDO cuando el canal seleccionado es de tipo CORREO ELECTRONICO.template_id

  • template_id: Identificador de la plantilla a enviar. Corresponde a una plantilla previamente configurada en Sagicc. Requerido cuando message no se encuentra especificado.

  • template_name: Nombre de la plantilla de tipo HSM, previamente configurada en Meta. REQUERIDO Requerido cuando type es HSM“hsm”.

  • template_params: Cadena con los parámetros necesarios que contiene las variables necesarias para la plantilla, separados por el caracter |. La cantidad de parámetros debe coincidir con los parámetros configurados en la plantilla en Meta. REQUERIDO cuando type es HSM.template_media_url: URL del elemento multimedia para la plantilla. Estas deben estar en el formato {{1}}, {{2}}, etc. (excluyendo variables básicas de Sagicc como {{id}} o {{cliente.primer_nombre}}) y deben separarse con el carácter |. La cantidad de parámetros debe coincidir con el número de variables externas definidas en la plantilla. Requerido cuando type es “hsm”.

  • template_media_url: URL del elemento multimedia para la plantilla, si la plantilla configurada en Meta lo requiere. REQUERIDO Requerido cuando type es HSM“hsm”.

  • template_lang: Idioma seleccionado para el envío de la plantilla. El idioma debe coincidir con alguno de los idiomas para la plantilla configurada en Meta. REQUERIDO Requerido cuando type es HSM“hsm”.

  • interactive_content: Elemento interactivo a enviar. Consiste en un objeto de tipo JSON que incluye todos los elementos interactivos a enviar, ya sea texto, elementos multimedia, botones, listas, etc.

...

A continuación, te presentamos varios ejemplos de envío de interacciones mediante la API de Sagicc, abarcando diversos tipos de mensajes y canales.

Interacción Simple

...

Bloque de código
{
    "ticket_id": 596914,
    "type": "sm",
    "message": "Hi, good morning! Now can I help you????", 
    "contact_info_id": "3001234567"146350,
    "channel_id": 52
}

Bloque de código
{
    "campaignticket_id": 5596914,
    "type": "sm",
    "message": "I'm sending you the filesHi, good morning! Now can I help you????", 
    "attachmentscontact_info": ["3001234567",
        {
       "channel_id": 52
}

Interacción de Correo Electrónico con adjuntos

Bloque de código
{
    "url": "https:\/\/sagicc-domains-storage.s3.ca-central-1.amazonaws.com\/sagicctest\/templates\/83fb87b76db3169f40cc00562be14627.jpg"ticket_id": 11812,
    "type": "sm",
    "template_id": 168,
    "filecontact_name_realinfo": "testjanedoe@gmail.jpgcom",
    "channel_id": 6,
      "cc": "johnwick@gmail.com",
    "mime_typeattachments": "image/jpg"[
        }{
      ],      "contact_info_id": 146350 "url": "https://sagicc-domains-storage.s3.ca-central-1.amazonaws.com/sagicctest/templates/83fb87b76db3169f40cc00562be14627.jpg",
    "channel_id": 52
}
Bloque de código
{
    "ticket_id": 596914,
    "typefile_name_real": "smtest.jpg",
    "message": "Hello! This is a test email",        "subjectmime_type": "Test Email",image/jpg"
    "cc": "janedoe@gmail.com",     }
    "contact_info_id": 46421],
    "channeltemplate_idparams": 92 "CASA|APARTAMENTO"    
}

Interacción de Plantilla Tipo HSM (exclusivo para WhatsApp)

Bloque de código
{
    "ticket_id": 596914,
    "type": "hsm",
    "contact_info_id": 146350,
    "channel_id": 52,
    "template_name": "saludo_bdr_marketing",
    "template_params": "Jane|34532|Good",
    "template_language": "es"
}

Interacción de WhatsApp con Contenido Interactivo - Media

Bloque de código
{
    "ticket_id": 596914,
    "type": "sm",
    "contact_info_id": 146350,
    "channel_id": 52,
    "interactive_content": {
        "type": "media",
        "media_url": "https:\/\/sagicc-domains-storage.s3.ca-central-1.amazonaws.com\/sagicctest\/templates\/83fb87b76db3169f40cc00562be14627.jpg",
        "media_type": "image",
        "media_caption": "Esta es la leyenda del archivo multimedia"
    }
}

Interacción de WhatsApp con Contenido Interactivo - Botones

Bloque de código
{
    "ticket_id": 596914,
    "type": "sm",
    "contact_info_id": 146350,
    "channel_id": 52,
    "interactive_content": {
        "type": "interactive",
        "footer": "Pie de pagina de la plantilla",
        "message": "Cuerpo\/mensaje de la plantilla",
        "header_text": "Encabezado de la plantilla",
        "header_type": "TEXT",
        "interactive_type": "button",
        "buttons": [
            {
                "text": "Si"
            },
            {
                "text": "No"
            }
        ]
    }
}

Interacción de WhatsApp con Contenido Interactivo - Lista

Bloque de código
{
    "ticket_id": 596914,
    "type": "sm",
    "contact_info_id": 146350,
    "channel_id": 52,
    "interactive_content": {
        "type": "interactive",
        "footer": "Este es el pie de pagina de la plantilla con lista",
        "message": "Este es el mensaje o cuerpo de la plantilla con lista",
        "header_text": "Este es el encabezado de la plantilla con lista",
        "header_type": "TEXT",
        "interactive_type": "list",
        "list_button_text": "Opciones",
        "list": [
            {
                "rows": [
                    {
                        "title": "Opcion 1",
                        "description": "Esta es la opcion 1"
                    },
                    {
                        "title": "Opcion 2",
                        "description": "Esta es la opcion 2"
                    }
                ],
                "section": "Seccion 1"
            },
            {
                "rows": [
                    {
                        "title": "Opcion 1",
                        "description": "Esta es la opcion 1"
                    },
                    {
                        "title": "Opcion 2",
                        "description": "Esta es la opcion 2"
                    },
                    {
                        "title": "Opcion 3",
                        "description": "Esta es la opcion 3"
                    }
                ],
                "section": "Seccion 2"
            }
        ]
    }
}

...