Referencia de la API

La API de Huwi es tRPC por HTTP, la misma que usa la app. No hay un SDK: son pedidos HTTP con JSON.

Cómo se llamaCopiar el enlace

• Dirección: https://huwi.app/api/trpc/<procedimiento>, por ejemplo bot.me o message.send.
• Autenticación: el encabezado x-api-key: hwk_....
• Lecturas (query): GET con la entrada en ?input= como JSON con URL codificada: ?input={"json": <entrada>}. Sin entrada, sin ?input.
• Escrituras (mutation): POST con content-type: application/json y el cuerpo {"json": <entrada>}.
• Respuesta: {"result":{"data":{"json": <salida>}}}. Las fechas llegan como texto ISO.

# Lectura
curl -s -G "https://huwi.app/api/trpc/bot.updates" -H "x-api-key: $HUWI_KEY" \
  --data-urlencode 'input={"json":{"timeout":25000}}'

# Escritura
curl -s "https://huwi.app/api/trpc/message.send" -H "x-api-key: $HUWI_KEY" \
  -H "content-type: application/json" \
  -d '{"json":{"chatId":"…","clientId":"x1","text":"Hola"}}'

Descubre la API desde la APICopiar el enlace

Con la clave del bot, api.index lista los procedimientos que esa clave puede usar. Con prefix devuelve además la entrada y la salida en JSON Schema:

curl -s -G "https://huwi.app/api/trpc/api.index" -H "x-api-key: $HUWI_KEY" \
  --data-urlencode 'input={"json":{"prefix":"message.send"}}'

Es la fuente exacta de la forma de cada procedimiento: esta página resume los principales.

ErroresCopiar el enlace

Un error trae un código HTTP y este cuerpo:

{ "error": { "json": { "message": "botPermission", "code": -32003, "data": { "code": "FORBIDDEN", "httpStatus": 403 } } } }

Las tablas de códigos y mensajes están en Límites y errores.

BotCopiar el enlace

bot.me · lecturaCopiar el enlace

La cuenta del bot. Sin entrada.

bot.updates · lecturaCopiar el enlace

Pide las novedades pendientes. Con un webhook puesto responde BAD_REQUEST webhookActive.

Salida: { updates: [{ id, type, chatId, payload, createdAt }] }, hasta 100, en orden. Los tipos y su payload están en Webhooks.

bot.setWebhook, bot.deleteWebhook, bot.webhookInfoCopiar el enlace

bot.setCommands, bot.commandsCopiar el enlace

command: de 1 a 32 caracteres a-z, 0-9, _. description: de 1 a 80.

bot.answerAction · escrituraCopiar el enlace

Contesta el toque de un botón. Entrada: { token, toast?, alert? } (token viene en la novedad action; toast hasta 120 caracteres; alert hasta 300). Salida: { ok }. Ver el aviso de estado.

PlantillasCopiar el enlace

bot.setTemplate ({ name, body }, name con a-z0-9_, hasta 40), bot.templates (lectura, [{ name }]) y bot.deleteTemplate ({ name }). Ver Plantillas para su estado.

Texto en vivoCopiar el enlace

bot.startStream, bot.appendStream y bot.endStream existen, pero con la base de datos real bot.startStream responde BAD_REQUEST use-message. Usa message.send y message.edit (ejemplo).

OtrosCopiar el enlace

bot.directory (público: los bots del directorio), bot.relation ({ userId }: si esa persona empezó con tu bot y qué comandos tiene), bot.reference y bot.changelog (los cambios de la API que ven los bots).

MensajesCopiar el enlace

message.send · escrituraCopiar el enlace

Manda un mensaje en un chat donde el bot puede contestar.

Hace falta al menos una de las cosas: texto, componentes, adjuntos o plantilla. No se pueden mandar efímeras ni ubicación.

Salida: el mensaje (id, chatId, sender, kind —text o interactive—, text, components, createdAt, reactions...).

Otros procedimientos de mensajesCopiar el enlace

Publicar y subirCopiar el enlace

upload.create · escrituraCopiar el enlace

Pide dónde subir un archivo. Entrada: { contentType, size } (image/*, video/*; imágenes hasta 20 MB y videos hasta 200 MB). Salida: { uploadUrl, url }. Sube los bytes con PUT a uploadUrl (relativa a https://huwi.app) y usa url en post.create.

post.create · escrituraCopiar el enlace

Publica en la cuenta del bot (permiso post, hasta 50 por día). Entrada principal:

La salida es la publicación (id, author, media, caption...). Su dirección es https://huwi.app/@<usuario>/post/<id>.

Procedimientos por permisoCopiar el enlace

Esta es la lista completa de lo que un bot puede usar, tomada del código de Huwi. Cada fila dice el permiso que lo abre.

Siempre disponiblesCopiar el enlace

MensajesCopiar el enlace

Componentes y fotos del chatCopiar el enlace

Publicar, historias, comentar, reaccionar y seguirCopiar el enlace

Perfil y gruposCopiar el enlace

LeerCopiar el enlace

MúsicaCopiar el enlace