API Jestyc Messagerie

La liste des requêtes de l'outil de messagerie :

Pour effectuer une requête sur un outil, vous devez disposer d'un token valide et de l'ID de l'outil (plus de détails).

MessageAdd

Cette requête vous permet d'ajouter un nouveau message dans un canal de votre choix (la liste des valeurs utiles pour "target_type" et "target_id" peut être obtenue avec MessagesChannels).

https://api.jestyc.com/v1/MessageAdd
{
    "p": {
        "token": "TOKEN",
        "tool_id": 123,
        "target_type": 2,
        "target_id": 456
    },
    "d": {
        "message": "Mon message."
    }
}
tokenToken (requis)
tool_idID de l'outil (requis)
target_typeType du canal cible (requis)
  • 0 : canal "Général"
  • 1 : canal public (#)
  • 2 : canal privé (@)
target_idID de la cible (requis)
  • ID du canal si "target_type" < 2
  • ID de l'utilisateur si "target_type" = 2
messageMessage (requis)

Exemple de réponse au format JSON :

{
    "request": "success",
    "message_id": "6789"
}

MessageDelete

Cette requête vous permet d'effacer le contenu d'un message en fonction de son ID (l'ID du message peut être obtenu avec Messages ou avec MessageAdd).

https://api.jestyc.com/v1/MessageDelete
{
    "p": {
        "token": "TOKEN",
        "tool_id": 123,
        "message_id": 6789
    }
}
tokenToken (requis)
tool_idID de l'outil (requis)
message_idID du message (requis)

Exemple de réponse au format JSON :

{
    "request": "success"
}

MessageFile

Pour envoyer un fichier via l'API, envoyez le fichier en POST ("multipart/form-data", name = "jestyc") et ajoutez les données de la requête au format JSON directement dans à l'URL (encodées en base 64) :

https://api.jestyc.com/v1/MessageFile?d=eyZxdW90O3AmcXVvdDs6eyZxdW90O3Rva2VuJnF1b3Q7OiZxdW90O1RPS0VOJnF1b3Q7LCZxdW90O3Rvb2xfaWQmcXVvdDs6MTIzLCZxdW90O3RhcmdldF90eXBlJnF1b3Q7OjIsJnF1b3Q7dGFyZ2V0X2lkJnF1b3Q7OjQ1Nn19

La requête au format JSON (avant encodage en base 64) :

{
    "p": {
        "token": "TOKEN",
        "tool_id": 123,
        "target_type": 2,
        "target_id": 456
    }
}
tokenToken (requis)
tool_idID de l'outil (requis)
target_typeType du canal cible (requis)
  • 0 : canal "Général"
  • 1 : canal public (#)
  • 2 : canal privé (@)
target_idID de la cible (requis)
  • ID du canal si "target_type" < 2
  • ID de l'utilisateur si "target_type" = 2

Exemple de réponse au format JSON :

{
    "request": "success",
    "message_id": "6789"
}
Si le fichier dispose déjà d'une URL, vous pouvez simplement partager cette URL dans un message (MessageAdd).

MessageFileDownload

Pour disposer d'une URL de téléchargement d'un fichier joint, ajoutez les données de la requête au format JSON directement dans à l'URL (encodées en base 64) :

https://api.jestyc.com/v1/MessageFileDownload?d=eyZxdW90O3AmcXVvdDs6eyZxdW90O3Rva2VuJnF1b3Q7OiZxdW90O1RPS0VOJnF1b3Q7LCZxdW90O3Rvb2xfaWQmcXVvdDs6MTIzLCZxdW90O21lc3NhZ2VfaWQmcXVvdDs6Njc4OX19

La requête au format JSON (avant encodage en base 64) :

{
    "p": {
        "token": "TOKEN",
        "tool_id": 123,
        "message_id": 6789
    }
}
tokenToken (requis)
tool_idID de l'outil (requis)
message_idID du message (requis)

Si les données sont valides, l'URL permettra de télécharger directement le fichier.

L'URL de téléchargement d'un fichier joint est disponible dans la réponse de Messages.

Messages

Cette requête vous permet de récupérer les messages d'un canal de votre choix.

https://api.jestyc.com/v1/Messages
{
    "p": {
        "token": "TOKEN",
        "tool_id": 123,
        "target_type": 1,
        "target_id": 567,
        "limit": 100,
        "page": 1
    }
}
tokenToken (requis)
tool_idID de l'outil (requis)
target_typeType du canal cible (requis)
  • 0 : canal "Général"
  • 1 : canal public (#)
  • 2 : canal privé (@)
target_idID de la cible (requis)
  • ID du canal si "target_type" < 2
  • ID de l'utilisateur si "target_type" = 2
limitNombre de résultats au maximum (facultatif, par défaut : 100, maximum : 1000)
pagePage de résultats (facultatif, par défaut : 1, requiert le paramètre "limit")

Exemple de réponse au format JSON :

[
    {
        "id": "6048",
        "date": "1603299941",
        "message": "Merci",
        "user": {
            "id": "454",
            "name": "Antoine"
        }
    },
    {
        "id": "6047",
        "date": "1603299923",
        "message": "Doc API.pdf",
        "user": {
            "id": "456",
            "name": "Julie"
        },
        "file": {
            "url": "https://api.jestyc.com/v1/MessageFileDownload?d=eyZxdW90O3AmcXVvdDs6eyZxdW90O3Rva2VuJnF1b3Q7OiZxdW90O1RPS0VOJnF1b3Q7LCZxdW90O3Rvb2xfaWQmcXVvdDs6JnF1b3Q7MTIzJnF1b3Q7LCZxdW90O21lc3NhZ2VfaWQmcXVvdDs6JnF1b3Q7NjA0NyZxdW90O319",
            "size": 1566638
        }
    },
    {
        "id": "6046",
        "date": "1603299916",
        "message": "Et le PDF :",
        "user": {
            "id": "456",
            "name": "Julie"
        }
    },
    {
        "id": "6045",
        "date": "1603299854",
        "message": "https://jestyc.com/api",
        "user": {
            "id": "456",
            "name": "Julie"
        }
    },
    {
        "id": "6044",
        "date": "1603299852",
        "message": "Voila le lien :",
        "user": {
            "id": "456",
            "name": "Julie"
        }
    },
    {
        "id": "6043",
        "date": "1603299828",
        "message": "Tu as le PDF de la doc de l'API ? Ou le lien ?",
        "user": {
            "id": "454",
            "name": "Antoine"
        }
    },
    {
        "id": "6042",
        "date": "1603299795",
        "message": "Je mets en place l'API",
        "user": {
            "id": "456",
            "name": "Julie"
        }
    },
    {
        "id": "6041",
        "date": "1603299790",
        "message": "Base de données de mon côté",
        "user": {
            "id": "455",
            "name": "Michel"
        }
    },
    {
        "id": "6040",
        "date": "1603299656",
        "message": "Où en est le projet ?",
        "user": {
            "id": "454",
            "name": "Antoine"
        }
    },
    {
        "id": "6039",
        "date": "1603299563",
        "message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum convallis porttitor velit, accumsan placerat quam eleifend in. Praesent eu lorem vitae lorem congue vulputate. Aenean scelerisque, tortor in consequat sagittis, tellus mauris enim sed nibh.",
        "user": {
            "id": "454",
            "name": "Antoine"
        }
    },
    {
        "id": "6038",
        "date": "1603299500",
        "message": "Salut",
        "user": {
            "id": "455",
            "name": "Michel"
        }
    },
    {
        "id": "6037",
        "date": "1603299486",
        "message": "Bonjour à tous",
        "user": {
            "id": "456",
            "name": "Julie"
        }
    }
]

MessagesChannels

Cette requête vous permet d'obtenir la liste des canaux publics et privés d'un outil accessibles à l'utilisateur de l'API.

https://api.jestyc.com/v1/MessagesChannels
{
    "p": {
        "token": "TOKEN",
        "tool_id": 123
    }
}
tokenToken (requis)
tool_idID de l'outil (requis)

Exemple de réponse au format JSON :

[
    {
        "target_type": "0",
        "target_id": "238",
        "name": "Général",
        "unread": "0"
    },
    {
        "target_type": "1",
        "target_id": "240",
        "name": "Compta",
        "unread": "0"
    },
    {
        "target_type": "1",
        "target_id": "242",
        "name": "Design",
        "unread": "2"
    },
    {
        "target_type": "1",
        "target_id": "241",
        "name": "Dev",
        "unread": "0"
    },
    {
        "target_type": "1",
        "target_id": "243",
        "name": "Marketing",
        "unread": "1"
    },
    {
        "target_type": "1",
        "target_id": "239",
        "name": "Projets",
        "unread": "3"
    },
    {
        "target_type": "2",
        "target_id": "4",
        "name": "Antoine",
        "unread": "0"
    },
    {
        "target_type": "2",
        "target_id": "6",
        "name": "Julie",
        "unread": "0"
    },
    {
        "target_type": "2",
        "target_id": "1102",
        "name": "Michel",
        "unread": "0"
    },
    {
        "target_type": "2",
        "target_id": "5",
        "name": "Paul",
        "unread": "1"
    }
]