A través de la API de Sagicc, tendrás la capacidad de emplear los canales de comunicación previamente configurados en la plataforma para enviar mensajes de manera programada a tus clientes, adaptándote a sus necesidades específicas y las necesidades de tu empresa. Esta funcionalidad permite la integración fluida de Sagicc con otros sistemas o plataformas, aprovechando los canales ya establecidos para el envío de mensajes. Asimismo, dicha interacción dejará un rastro en Sagicc de los casos y las interacciones, facilitando el seguimiento detallado de las comunicaciones enviadas.
Para enviar interacciones a través de la API, realiza una petición de tipo POST al endpoint https://{{sagicc_instance_url}}/api/interaction/send, y envía en el cuerpo de la petición un objeto con la siguiente estructura y atributos:
ticket_id: Identificador del caso que estará asociado a la nueva interacción. 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 cuando ticket_id no se encuentra especificado.
type: Especifica el tipo de mensaje a enviar. Siempre REQUERIDO. 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.
contact_info_id: Identificador del dato de contacto al cual será enviado el mensaje. REQUERIDO cuando contacto_info no se encuentra especificado.
contact_info: Dato de contacto al cual será enviado el mensaje. REQUERIDO cuando contacto_info_id no se encuentra especificado.
channel_id: Identificador del canal que será utilizado para enviar el mensaje. 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 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.
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.
subject: Asunto de la interacción. REQUERIDO cuando el canal seleccionado es de tipo CORREO ELECTRONICO.
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: Identificador de la plantilla a enviar. Corresponde a una plantilla previamente configurada en Sagicc.
template_name: Nombre de la plantilla de tipo HSM, previamente configurada en Meta. REQUERIDO cuando type es HSM.
template_params: Cadena con los parámetros necesarios 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, si la plantilla configurada en Meta lo requiere. REQUERIDO cuando type es 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 cuando type es 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.
En caso de que la interacción se envíe exitosamente, la respuesta correspondiente devolverá el código 200 junto con un mensaje de éxito. Además, se proporcionará información adicional proveniente del canal. En situaciones de fallo en la solicitud, la respuesta mostrará el código 400 acompañado de un mensaje que identifica la causa del error.
A continuación, te presentamos varios ejemplos de envío de interacciones mediante la API de Sagicc, abarcando diversos tipos de mensajes y canales.
{
"ticket_id": 596914,
"type": "sm",
"message": "Hi, good morning! Now can I help you????",
"contact_info_id": 146350,
"channel_id": 52
} |
{
"ticket_id": 596914,
"type": "sm",
"message": "Hi, good morning! Now can I help you????",
"contact_info": "3001234567",
"channel_id": 52
} |
{
"campaign_id": 5,
"type": "sm",
"message": "I'm sending you the files",
"attachments": [
{
"url": "https:\/\/sagicc-domains-storage.s3.ca-central-1.amazonaws.com\/sagicctest\/templates\/83fb87b76db3169f40cc00562be14627.jpg",
"file_name_real": "test.jpg",
"mime_type": "image/jpg"
}
],
"contact_info_id": 146350,
"channel_id": 52
} |
{
"ticket_id": 596914,
"type": "sm",
"message": "Hello! This is a test email",
"subject": "Test Email",
"cc": "janedoe@gmail.com",
"contact_info_id": 46421,
"channel_id": 92
} |
{
"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"
} |
{
"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"
}
} |
{
"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"
}
]
}
}
|
{
"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"
}
]
}
} |