Documentacion Telegram API

Documentacion API Telegram - https://telegram.opcionguik.com.mx

Versión

1.0 - Ultima modificacion 2021-06-28

API Host

Todas las peticiones que se realicen a la API de Telegram deben ser enviadas a la siguiente URL:

https://telegram.opcionguik.com.mx/api/{metodo}

Autenticación

El API de Telegram utiliza una autenticación Basic, si se recibe una solicitud anónima HTTP, será rechazada con el código 401 y la soilcitud de autenticación (WWW-Authenticate)

HTTP/1.1 401 Access Denied
WWW-Authenticate: Basic realm="telegram.opcionguik.com.mx"
Content-Length: 0

Métodos

El API funciona con los siguientes métodos:

Método Tipo URL Acción Parámetros Respuesta

enviar

POST

send/message

Envía una mensaje de Telegram al usuario específicado en los parámetros.

Nombre	Descripcion
id	Identificador único para el mensaje. Funciona de referencia para notificaciones de entrega.
from	Cuenta a utilizar para envío del mensaje.
to	Número de destino del mensaje. (Nota. no es un número telefónico, es el número recibido en mensajes previos como parámetro "from")
message	Cuerpo del mensaje a enviar.

Ejemplo:

{
    "from": "opcionguik",
    "to": "876146479",
    "message": "Bienvenido al sistema de mensajería de OpcionGUIK ✅"
}

Nombre	Descripcion
result	ok - Mensaje enviado exitosamente error - Error en el envio del mensaje
id	id del Envío En caso que no se especifique en el envío, será generado automáticamente.
error	Descripción del error en caso de que exista

Fijar hook callback

POST

setHook

Establece el URL destino para la entrega de mensajes de entrada, así como notificaciones de lectura.

Nombre	Descripcion
url	URL a invocar para la entrega de mensajes
user	Opcional. Usuario para la autenticación BASIC a enviar.
password	Opcional. Contraseña.

Ejemplo:

{
    "url": "https://ejemplo.com/telegramInbound"
}

Nombre	Descripcion
result	ok - URL establecida exitosamente error - Error al guardar URL
error	Descripción del error en caso de que exista

Eventos

El API disparará llamada al hook establecido para la entrega de mensajes y/o notificaciones de entrega y lectura:

Evento Tipo URL Acción Parámetros

Mensaje Recibido

POST

{setHook(url)}/message

Envía el mensaje recibido a través de Telegram.

Nombre	Descripcion
id	Identificador único para el mensaje.
from	Id del usuario que envía el mensaje.
to	Cuenta a que recibió el mensaje.
message	Cuerpo del mensaje.
created	Fecha y hora de recepción del mensaje.
type (opcional)	Tipo de mensaje recibido. image document audio ptt video file
payload (opcional)	Contenido del mensaje (Codificación Base64.
ext (opcional)	Extensión del archivo recibido.

Ejemplo:

{
    "id": "87fcd1b3-8b54-44c3-af2a-6b972deead6a",
    "from": "876146479",
    "to": "opcionguik",
    "message": "Hola, necesito información"
}