Notifications Signal API

Signal API

Aperçu

• Source: https://github.com/bbernhard/signal-cli-rest-api
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Oui
• Limites de caractères des messages:
  • Corps: 32768
• Créer votre URL Apprise

Configuration du Compte

Tout d’abord, vous devez disposer d’un compte Signal. Il est donc supposé que vous disposez de la version Apple ou Android du logiciel Signal.

À partir de là, le plugin suppose que vous avez configuré le Signal Rest API Service.

Une configuration simple pourrait ressembler à ceci :

# Create a directory for our configuration to get stored into
mkdir -p $HOME/.signal-api

# Launch a Signal API instance that listens on port 9922
docker run -d --name signal-api --restart=always -p 9922:8080 \
 -v $HOME/.signal-api:/home/.local/share/signal-cli \
   -e 'MODE=native' -e SIGNAL_CLI_UID=$(id -u) -e SIGNAL_CLI_GID=$(id -g) \
   bbernhard/signal-cli-rest-api

Si tout se passe bien, vous devriez pouvoir pointer votre navigateur vers : http://localhost:9922/v1/qrcodelink?device_name=signal-api et, depuis l’application de votre téléphone, suivre les instructions pour ajouter un Linked Device.

Le {FromPhoneNo} doit être le numéro associé à votre compte.

Syntaxe

La syntaxe valide est la suivante :

• signal://{user}:{password}@{hostname}/{from_phone}
• signal://{user}:{password}@{hostname}:{port}/{from_phone}
• signal://{user}:{password}@{hostname}/{from_phone}/{target}
• signal://{user}:{password}@{hostname}:{port}/{from_phone}/{target}

Vous pouvez publier dans plusieurs conversations en les enchaînant simplement à la fin de l’URL.

• signal://{user}:{password}@{hostname}:{port}/{from_phone}/{target1}/{target2}/{target3}
• signals://{user}:{password}@{hostname}:{port}/{from_phone}/{target1}/{target2}/{target3}

Détail des Paramètres

Variable	Requis	Description
hostname	Oui	Le nom d’hôte du serveur Web
port	Non	Le port sur lequel notre serveur Web est en écoute. Par défaut, le port est 80 pour signal:// et 443 pour toutes les références signals://.
user	Non	Si votre système est configuré pour utiliser HTTP-AUTH, vous pouvez fournir le nom d’utilisateur pour l’authentification.
password	Non	Si votre système est configuré pour utiliser HTTP-AUTH, vous pouvez fournir le mot de passe pour l’authentification.
from	Oui	Il doit s’agir d’un numéro de téléphone expéditeur que vous avez ajouté au service API.
to	*Non	Un numéro de téléphone ou un identifiant de groupe auquel vous souhaitez envoyer votre notification. Si aucun n’est spécifié, le champ from est utilisé à la place.
batch	Non	Envoyer plusieurs notifications spécifiées en un seul lot (1 envoi en amont vers le serveur final). Par défaut, cette option est définie sur no.
status	Non	Inclure éventuellement une petite chaîne ASCII représentant le statut de la notification envoyée (en ligne avec celle-ci) ; par défaut, cette option est définie sur yes.

Paramètres Globaux

Variable	Description
overflow	Ce paramètre peut être défini sur split, truncate ou upstream. Il détermine la manière dont Apprise remet le message que vous lui transmettez. Par défaut, il vaut upstream. 👉 upstream : ne fait aucune modification et transmet le message exactement tel qu’il a été reçu au service. 👉 truncate : veille à ce que le message tienne dans la limite amont documentée par le service. Si plus d’informations sont fournies que la limite définie, l’excédent est tronqué. 👉 split : similaire à truncate, sauf que si le message dépasse la limite amont documentée par le service, il est découpé en plusieurs morceaux plus petits puis envoyés séquentiellement.
format	Ce paramètre peut être défini sur text, html ou markdown. Certains services prennent en charge plusieurs formats de publication du contenu. La valeur par défaut varie selon le service choisi et peut correspondre à l’un de ces trois formats. Vous pouvez facultativement forcer cette option pour vous écarter du comportement par défaut. Si le service ne prend pas en charge plusieurs formats de transmission, ce champ est ignoré.
verify	Les requêtes externes vers des emplacements sécurisés, par exemple via https, utilisent des certificats. Par défaut, Apprise vérifie la validité de ces certificats ; si ce n’est pas le cas, aucune notification n’est envoyée à la source. Dans certains cas, un utilisateur ne dispose pas d’une autorité de certification pour valider la clé ou fait simplement confiance à la source ; dans ce cas, vous pouvez définir ce drapeau sur no. Par défaut, il vaut yes.
cto	Signifie Socket Connect Timeout. Il s’agit du nombre de secondes pendant lesquelles Requests attend que votre client établisse une connexion avec une machine distante, ce qui correspond à l’appel connect() sur la socket. La valeur par défaut est de 4.0 secondes.
rto	Signifie Socket Read Timeout. Il s’agit du nombre de secondes pendant lesquelles le client attend que le serveur envoie une réponse. La valeur par défaut est de 4.0 secondes.
emojis	Active la prise en charge des emojis, par exemple :+1: qui sera traduit en 👍. Par défaut, cette option vaut no. Remarque : selon la configuration côté serveur, l’administrateur peut désactiver globalement la prise en charge des emojis ; mais par défaut, ce n’est pas le cas.
tz	Identifie le fuseau horaire de la base IANA que vous souhaitez utiliser. Par défaut, celui-ci est détecté à partir de la configuration du serveur qui exécute Apprise. Vous pouvez le définir sur des valeurs comme America/Toronto, ou sur tout autre fuseau correctement formaté correspondant à votre région.

Obtenir un Identifiant de Groupe

Les groupes peuvent être créés dans l’application ou via le Signal Rest API Service. Pour obtenir la liste des groupes disponibles et leurs identifiants, exécutez :

curl -X GET -H "Content-Type: application/json" localhost:9922/v1/groups/+15555551234 | jq

Un exemple de sortie est le suivant :

[
  {
    "name": "Test Group",
    "id": "group.abcdefghijklmnop=",
    "internal_id": "aabbccdd/eeffgghh=",
    "members": [
      "+1555555551234
      "+16666661234"
    ],
      "blocked": false,
      "pending_invites": [],
      "pending_requests": [],
      "invite_link": "",
      "admins": [
      "+1555555551234"
    ]
  }
]

The takeaway from the above is the group

Exemple d’envoi d’une notification à un groupe : group.aabbccdd/eeffgghh= identifié par le champ id.

Exemples

Envoyer une notification Signal (via Signal API) :

# Assuming our {Hostname} is localhost (hosting the bbernhard/signal-cli-rest-api)
# Assuming our {FromPhoneNo} is +1-900-555-9999
# Assuming our {PhoneNo} - is in the US somewhere making our country code +1
#                        - identifies as 800-555-1223
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "signal://localhost/19005559999/18005551223"

# the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field):
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "signal://localhost/1-(900) 555-9999/1-(800) 555-1223"

D’après mon expérience personnelle, j’ai pu m’envoyer une notification à moi-même en procédant simplement comme suit :

# Assuming our {Hostname} is localhost (hosting the bbernhard/signal-cli-rest-api)
# Assuming our {Port} is 9922
# Assuming our {FromPhoneNo} is +1 555 555 1234
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "signal://localhost:9922/15555551234"

Si vous connaissez l’identifiant du groupe auquel vous souhaitez envoyer une notification, vous pouvez également le spécifier sur la ligne de commande :

# Assuming our {Hostname} is localhost (hosting the bbernhard/signal-cli-rest-api)
# Assuming our {Port} is 9922
# Assuming our {FromPhoneNo} is +1 555 555 1234
# Assuming our {Group} is group.abcdefghijklmnop=
apprise -vv -t "Group Message:" -b "Hello group members" \
    "signal://localhost:9922/+1555555551234/group.abcdefghijklmnop="

J’ai même pu envoyer une pièce jointe sans problème :

apprise -vv -t -b "test" \
   signal://localhost:9922/15555551234 --attach apprise-test.gif

Ce qui a produit :