Responder a la conversación en Front, con una API
Envía una respuesta en una conversación de inmediato y responde 202 con un message_uid. Front archiva la conversación cuando sale la respuesta, salvo que options.archive sea false. Requiere el permiso de envío en el token de API. Una conversación fusionada responde con una redirección a la conversación en la que se fusionó.
- Identificador
- front_reply_to_conversation
La llamada
POST https://connect.reportei.com/api/tools/front_reply_to_conversation/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"conversation_id": "<conversation_id>",
"body": "<body>"
}
}Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.
Parámetros
Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| conversation_id | string | Sí | Id of the conversation, starting with cnv_, from Search conversations. |
| body | string | Sí | Body of the message. Email channels accept HTML. |
| to | array | No | Recipient handles, like email addresses. |
| cc | array | No | Handles that get a copy. |
| bcc | array | No | Handles that get a blind copy. |
| subject | string | No | Subject, for email messages. |
| author_id | string | No | Id of the teammate the reply is sent on behalf of, starting with tea_, from List teammates. |
| channel_id | string | No | Id of the channel to send the reply from, starting with cha_, from List channels. |
| options | object | No | Tags to add and whether to archive the conversation after sending. |
Conexiones posibles
Tu cliente conecta su cuenta de Front una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
Clave de API
Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.
La respuesta
Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/front_reply_to_conversation. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Front
- Buscar conversacionesGETBusca las conversaciones a las que llega el token de API, de la actividad más reciente a la más antigua, y devuelve _total con las coincidencias. Las conversaciones en la papelera quedan fuera, salvo que la consulta pida is:trashed. La página siguiente viene del page_token dentro de _pagination.next, que es null en la última página.
- Obtener conversaciónGETDevuelve una conversación con asunto, estado, responsable, destinatario principal, etiquetas, campos personalizados y enlaces. Los mensajes vienen de Listar mensajes de la conversación.
- Listar mensajes de la conversaciónGETLista los mensajes de una conversación, los más nuevos primero salvo que sort_order sea asc, con autor, destinatarios, asunto, cuerpo y detalles de los adjuntos. La página siguiente viene del page_token dentro de _pagination.next, que es null en la última página.
- Actualizar conversaciónPATCHActualiza el responsable, la bandeja, el estado, las etiquetas o los campos personalizados de una conversación. Envía solo los campos a cambiar. tag_ids reemplaza todas las etiquetas de la conversación; para añadir etiquetas sin quitar las demás, usa Aplicar etiquetas.
- Aplicar etiquetasPOSTAñade una o más etiquetas a una conversación y conserva las que ya tiene.
- Crear comentarioPOSTAñade un comentario interno a una conversación. Los comentarios solo los ven los compañeros, nunca el contacto. El cuerpo admite Markdown.
- Crear borradorPOSTCrea un borrador de respuesta al último mensaje de una conversación, para que un compañero lo revise y lo envíe en Front. No se envía nada. Un borrador privado solo lo ve su autor, así que define author_id con el compañero que lo revisará, o usa el modo shared.
- Enviar mensajePOSTEnvía un mensaje nuevo desde un canal, lo que inicia una conversación nueva, y responde 202 con un message_uid. Sale de inmediato, y Front archiva la conversación nueva salvo que options.archive sea false. Requiere el permiso de envío en el token de API.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
