Enviar mensaje en Front, con una API

Enví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.

Identificador
front_send_message

La llamada

POST https://connect.reportei.com/api/tools/front_send_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "channel_id": "<channel_id>",
    "to": [],
    "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ámetroTipoObligatorioDescripción
channel_idstringSíChannel that sends the message: the id starting with cha_ from List channels, or alt:address: followed by the channel address, like alt:address:support@acme.com.
toarraySíRecipient handles, like email addresses or phone numbers, depending on the channel.
bodystringSíBody of the message. Email channels accept HTML.
ccarrayNoHandles that get a copy.
bccarrayNoHandles that get a blind copy.
subjectstringNoSubject, for email messages.
author_idstringNoId of the teammate the message is sent on behalf of, starting with tea_, from List teammates.
optionsobjectNoTags to add and whether to archive the new 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_send_message. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Front

Ver las 13 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.