Enviar mensaje en Gmail, con una API
Envía un email de inmediato a los destinatarios de los headers To, Cc y Bcc de raw y devuelve el mensaje enviado con id, threadId y labelIds. Para responder dentro de una conversación, pasa su threadId, mantén el mismo Subject y define In-Reply-To y References con el Message-ID del mensaje respondido, que Get message devuelve en payload.headers.
- Identificador
- gmail_send_message
La llamada
POST https://connect.reportei.com/api/tools/gmail_send_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"raw": "RnJvbTogc2VuZGVyQGV4YW1wbGUuY29tDQpUbzogcmVjaXBpZW50QGV4YW1wbGUuY29tDQpTdWJqZWN0OiBDb25uZWN0IGV4YW1wbGUNCk1JTUUtVmVyc2lvbjogMS4wDQpDb250ZW50LVR5cGU6IG11bHRpcGFydC9hbHRlcm5hdGl2ZTsgYm91bmRhcnk9ImNvbm5lY3QtZXhhbXBsZSINCg0KLS1jb25uZWN0LWV4YW1wbGUNCkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsgY2hhcnNldD0iVVRGLTgiDQpDb250ZW50LVRyYW5zZmVyLUVuY29kaW5nOiA4Yml0DQoNCkhlbGxvISBUaGlzIGlzIGFuIGV4YW1wbGUgbWVzc2FnZS4NCg0KLS1jb25uZWN0LWV4YW1wbGUNCkNvbnRlbnQtVHlwZTogdGV4dC9odG1sOyBjaGFyc2V0PSJVVEYtOCINCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IDhiaXQNCg0KPHAgc3R5bGU9Im1hcmdpbjowIDAgMTJweCAwO2ZvbnQtZmFtaWx5OkFyaWFsLHNhbnMtc2VyaWY7Zm9udC1zaXplOjE0cHg7bGluZS1oZWlnaHQ6MS40OyI-SGVsbG8hIFRoaXMgaXMgYW4gZXhhbXBsZSBtZXNzYWdlLjwvcD4NCi0tY29ubmVjdC1leGFtcGxlLS0NCg"
}
}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.
Ejemplo ilustrativo. Sustituye los tokens, el UUID de la conexión y los datos de destino por los tuyos. Esta página no ejecuta la petición.
Antes de ejecutar
- raw contiene el mensaje MIME completo en base64url, no solo el cuerpo del correo. El ejemplo incluye text/plain y text/html en UTF-8, con CRLF entre las líneas MIME.
- Antes de codificar, sustituye sender@example.com por la cuenta conectada o un alias autorizado, y recipient@example.com por el destinatario. Usa una biblioteca MIME para asuntos con caracteres no ASCII.
- Para responder en un hilo, envía threadId, conserva Subject e incluye References e In-Reply-To del Message-ID correspondiente. La conexión necesita un scope Gmail que permita enviar.
Cómo preparar raw en JavaScript (Node.js)
// Node.js: replace the example addresses before encoding.
const mime = [
"From: sender@example.com",
"To: recipient@example.com",
"Subject: Connect example",
"MIME-Version: 1.0",
"Content-Type: multipart/alternative; boundary=\"connect-example\"",
"",
"--connect-example",
"Content-Type: text/plain; charset=\"UTF-8\"",
"Content-Transfer-Encoding: 8bit",
"",
"Hello! This is an example message.",
"",
"--connect-example",
"Content-Type: text/html; charset=\"UTF-8\"",
"Content-Transfer-Encoding: 8bit",
"",
"<p style=\"margin:0 0 12px 0;font-family:Arial,sans-serif;font-size:14px;line-height:1.4;\">Hello! This is an example message.</p>",
"--connect-example--",
""
].join("\r\n");
const raw = Buffer.from(mime, "utf8").toString("base64url");
const body = {
customer_toolkit: "<connection UUID>",
arguments: { raw }
};
// Serialize body with JSON.stringify(body) in your HTTP client.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 |
|---|---|---|---|
| raw | string | Sí | The whole email in RFC 2822 format, base64url encoded: the header lines, such as To, Cc, Subject and Content-Type: text/plain; charset=UTF-8, a blank line and the body. A subject with accents goes encoded as =?UTF-8?B?...?=. |
| threadId | string | No | Thread id from List messages, Get message or Get thread, to send the email as a reply in that conversation. |
Conexiones posibles
Tu cliente conecta su cuenta de Gmail una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.
OAuth con la app de tu producto
Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/gmail, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.
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}.
Formato ilustrativo de éxito
{
"id": "example-message-id",
"threadId": "example-thread-id",
"labelIds": [
"SENT"
]
}El contenido es un ejemplo, no una ejecución registrada. Guarda X-Toolkit-Execution-Id cuando se devuelva para consultar la ejecución. Connect no aplica reintentos ni idempotencia: repetir un POST puede repetir el envío.
Lista para agentes de IA
El input de esta tool es un JSON Schema, disponible en GET /api/tools/gmail_send_message. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Gmail
- Listar mensajesGETLista los mensajes del buzón que coinciden con q y labelIds. Cada elemento tiene solo id y threadId: lee el contenido con Get message. Envía nextPageToken como pageToken para leer la página siguiente.
- Leer mensajeGETObtiene un mensaje con threadId, labelIds y snippet. Con format full, el valor por defecto, payload trae los headers (From, To, Subject, Date, Message-ID) y las partes del cuerpo, cuyo data viene en base64url. Los adjuntos vienen solo como attachmentId y no se descargan.
- Leer conversaciónGETObtiene una conversación con todos sus mensajes. Cada mensaje tiene id, labelIds, snippet y, con format full, el valor por defecto, el payload con los headers y las partes del cuerpo en base64url.
- Actualizar etiquetas del mensajePOSTAñade y quita etiquetas de un mensaje y devuelve sus labelIds. Quita UNREAD para marcarlo como leído, quita INBOX para archivarlo, añade STARRED para destacarlo con estrella o añade TRASH para moverlo a la papelera.
- Listar etiquetasGETLista las etiquetas del buzón: las del sistema, como INBOX, SENT, DRAFT, UNREAD, STARRED y SPAM, y las creadas por el usuario. El id de cada una es lo que reciben labelIds, addLabelIds y removeLabelIds.
- Crear etiquetaPOSTCrea una etiqueta y la devuelve con su id, para aplicar con Update message labels. El nombre no puede ser el de una etiqueta del sistema ni el de una etiqueta existente.
- Listar borradoresGETLista los borradores del buzón. Cada elemento tiene el id del borrador y un message con id y threadId: lee el contenido con Get message usando message.id. Envía nextPageToken como pageToken para leer la página siguiente.
- Crear borradorPOSTGuarda un email como borrador sin enviarlo y devuelve el id del borrador y su message con id y threadId. Envíalo después con Send draft.
Mira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
