REST API Documentation

Current Version

The current version of API is v1. All API access is done over HTTPS, and accessed from the jaconda.im domain. All data is sent and received as JSON. If you have any issues, do not hesitate to contact us at support@jaconda.im

Use Cases

Jaconda provides two-way REST access to Telegram. You can post messages and media to Telegram groups from Jaconda Bot, and you can receive custom webhooks from groups. Jaconda do not read or store you messages, but you can configure multiple /hook commands and Jaconda will perform a GET or POST-request to a configured url.

Authentication

All requests require authentication and will return 401 Unauthorized otherwise. You can find your API token on your API page. You should pass token parameter to each request in order to make it.

Methods List

List Groups

This method allows you to get list of groups, where Jaconda are present.

GET /api/v1/endpoint/groups?token=:token

Input

token API Token

Response

[
   {
      "id":"29",
      "name":"Acme Main",
      "created_at":1424726840,
      "updated_at":1424726840
   },
   {
      "id":"30",
      "name":"Acme Core Dev",
      "created_at":1424766200,
      "updated_at":1424766200
   }
]

Get Group Information

This method allows you to pull group information.

GET /api/v1/endpoint/groups/:id?token=:token

Input

token API Token
id Group ID

Response

{
    "id":"29",
    "name":"Acme Main",
    "created_at":1424726840,
    "updated_at":1424726840
 }

Send Text Message

This method allows you to send text messages to a group. Current maximum length is 4096 UTF8 characters.

POST /api/v1/endpoint/groups/:id/messages

Input

token API Token
id Group ID
text Message Body

Response

{
    "success":true,
    "message":"Message was successfully sent"
 }

Send Media File (Picture)

This method allows you to send pictures to a group. File size should be less then 800kb.

POST /api/v1/endpoint/groups/:id/media

Input

token API Token
id Group ID
file Media file

Response

{
    "success":true,
    "message":"Message was successfully sent"
 }