sms_ovh/Readme.md

57 lines
1.4 KiB
Markdown

# Presentation
Code de test d'envoi de SMS via l'API OVH
Pour le moment ces un traitment simple ( envoi d'un message sur un numero de téléphone)
Il reste a traiter les envois par lot soit via lecture d'un fichier, d'une queue ou interrogation d'une autre API.
# Prerequis (Debian):
```
apt install pip3
/usr/bin/pip3 install --break-system-packages ovh
apt install python3-dotenv
```
- Vous devez avoir creer ou disposer d'une clé d'api sur le site OVH
- Un nom de service sms
L'ensemble des paramètre sont définis dans un fichier .env ayant le format suivant
```
application_key = "xxxxxxxxxxxxx"
application_secret="xxxxxxxxxxxxxxxxxxxxxx"
consumer_key="xxxxxxxxxxxxxxxxxxx"
sms_service_name="sms-xxxxxxx-y"
credit_warning=100
log_file="sms.log"
LOG_LEVEL="INFO"
```
Note:
Modifier le ```LOG_LEVEL``` en DEBUG si besoin de voir plus de details de fonctionnement.
Idem pour le seuil d'avertissement ```credit_warning```
# Fonctionnement
```
python3 send_sms.py --help
usage: send_sms.py [-h] [-n NUMERO] [-m MESSAGE]
options:
-h, --help show this help message and exit
-n NUMERO, --numero NUMERO
-m MESSAGE, --message MESSAGE
```
```
python3 send_sms.py -n "+33xxxxxxxxx" -m "Message de test."
{
"totalCreditsRemoved": 1,
"validReceivers": [
"+33xxxxxxxxx"
],
"invalidReceivers": [],
"ids": [
xxxxxxxxx
],
"tag": "xxxxxxxxxxx"
}
```