Freebox Server (Ultra V9/ Pop V8/ Delta V7 / Revolution V6 / Mini 4K)

Bonjour,

je souhaite développer une application en python pour me connecter à ma freebox POP.

J’ai bien compris que la première étape est d’inscrire son application et de l’autoriser sur la box. Voici mon code:

 headers = {}

  payload=json.dumps ({
 "app_id": "fr.freebox.test",
 "app_name": "test",
 "app_version": "1.0.0",
 "device_name": "NO"
  })

  try:        
      response = requests.request('POST', 'https://mafreebox.freebox.fr/api/v10/login/authorize', headers=headers, data=payload,verify=False)
  except Exception as e:
      print ('Execution Box Authorize commmand failed : ' + str(e))     
  else :
      if (response.status_code == 200) :
          authorize = response.json()
          print (authorize)

Tout fonctionne bien je récupère bien un app_token :

{’success’: True, ‘result’: {’app_token’: ‘xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx’, ‘track_id’: 74}}

Et sur la box s’affiche l’authorisation. Mais j’ai beau essayé de valider en sélectionnant Oui sur l’édcran LCD (Fleche droite puis l’écran affiche de nouveau l’heure), La console des accès reste la même :

—–> ‘Authentification en cours’

Avez-vous une idée de là où ça coince ?

Cordialement

Il serait intéressant de permettre aux dev’s plus d’interaction avec l’utilisateur en permettant par exemple d’afficher des messages sur l’écran du freebox serveur, de déclencher des alertes sonores via les hauts parleurs intégrés ou d’envoyer des bandeaux textes sur l’écran de la TV, voir même de pouvoir incruster une image (équivalent PIP) dans une zone de l’écran, de pouvoir ouvrir une zone de texte à remplir par l’utilisateur à l’aide de la télécommande, de pouvoir faire apparaitre des boutons cliquables à l’écran TV. Toutes ces fonctions étant accessibles via l’API.

j’en demande trop non ?

bonjour

serait il possible d ajouter des signaux de status de lecture pour le airmedia sur la freebox, etat lecture/pause/arret voir dans l ideal un signal de fin comme dans gstreamer avec le signal about_to_finish ou finished

merci

cdt

Bonjour,

Serait-il possible de proposer une API Freebox OS pour gérer les enregistrements programmés ?
- lister et interroger les enregistrements programmés,
- créer, modifier, supprimer un enregistrement programmé.

Une Application Freebox OS pourrait aussi être proposée, (mais c’est surtout l’API qui est demandée).

À voir si cette API pourrait aussi donner accès à un Guide des Programmes pour permettre la création d’un nouvel enregistrement, mais cela est peut être en dehors du champ de Freebox OS.

Pour la justification de cette demande, voir http://dev.freebox.fr/bugs/task/13413

Cordialement,

DFAL

Il serait très intéressant de pouvoir afficher un message texte appelé par une requête http (GET ou POST) afin de permettre un affichage de données provenant d’une box domotique à l’écran.

Bonsoir,

Serait il possible de gérer, lors des téléchargements, la reconstitution des fichiers nom-de-fichier.0, nom-de-fichier.1, nom-de-fichier.2 ...
lorsque je lance une réparation avec les Par2 qui devrait reconstruire le fichier, cela ne fonctionne pas.

Merci pour votre retour.

Bonne soirée,

J’ai ecrit un plugin pour les lecteurs multimedia Linux (un plugin Grilo) qui exporte les chaines de TV disponible en second poste vers un ordinateur.

Serait-il possible d’exporter aussi les logos de ces chaines pour un meilleure integration?

bonjour

actuellement dans la requête api pour les bouquets (http://mafreebox.freebox.fr/api/v3/tv/bouquets/xxx/channels/)

on obtient

{”rtsp”:”rtsp:\/\/mafreebox.freebox.fr\/fbxtv_pub\/stream?namespace=1&service=473&flavour=sd”,”type”:”iptv”,”hls”:”http:\/\/mafreebox.freebox.fr:8765\/service\/473\/sd\/master.m3u8”,”quality”:”sd”}],”sub_number”:0}

1/ serait il possible d avoir en plus l adresse du flux http (comme pour l’upnp) ?

2/ les infos que nous avons dans http://mafreebox.freebox.fr/api/v3/tv/channels, exemple

“uuid-webtv-404”:{”uuid”:”uuid-webtv-404”,”name”:”TEVA”,”available”:true,”logo_url”:”\/api\/v3\/tv\/img\/channels\/logos68x60\/uuid-webtv-404.png”,”has_service”:true,”short_name”:”TEVA”,”has_abo”:true}

rajouter au json des bouquets, name, available, has_service et/ou has_abo

je comprend pas trop la separation de toutes ces infos :p

par exemple dans freebox os ou compagnon, quel intérêt d afficher les chaînes non souscrites ou inaccessibles? (si ce n est allourdir le tout)

je pense que 2 requetes suffiraient, une pour avoir la liste des bouquets et la seconde pour la liste des chaines dans le bouquet avec toutes les infos d un coup non ? + eventuellement une option genre /availables en plus sur la requete get qui ferait que le json renvoyé ne contiendrait que les chaines vraiment visualisables...

merci !

cdt

Actuellement l’API AirMedia du FreeboxOS permet l’affichage de photos et de videos mais pas la lecture de fichiers audio.
Il est possible de choisir le media_type “video” et de renseigner l’url d’un fichier audio mais on se retrouve avec un écran noir sur la TV.

L’idéal serait de reproduire ce qui est proposé pour AirPlay :
- affichage du titre (cover, titre, etc) dans l’application AirMedia
- affichage de la notification (en haut à droite) à la lecture du fichier audio

Avec possibilité de renseigner les informations du media : cover, titre, artiste, etc; si celles-ci ne sont pas disponible dans le fichier. Ou même rendre ces infos obligatoires.

Bonjour,

Serait il possible de rajouter dans l’API de Freebox OS la possibilité de récupérer les messages vocaux laissés par les appelants, et de les lire dans un flux externe.

Merci.
Florian MULLER

Bonjour,

Serait il possible de mettre en place une procédure de réinitialisation du mot de passe Server par envoi d’un code par sms ou email à la place (ou en doublon ?) du code affiché sur le panneau du Server ?

Motivation :
- sécurisation de la procédure (voir par exemple  FS#17543 ),
- panneau d’affichage Server illisible (mon cas),
- intervention à distance.

Pour cela il faudrait :
- une évolution au niveau Freebox OS (ou page Web d’administration sur le site Free) pour pouvoir enregistrer un numéro de téléphone portable pour l’envoi du sms ou une adresse mail pour l’envoi d’un mail, et une option pour choisir le mode de gestion du code de réinitialisation du mot de passe (affiché sur le Server, envoyé par sms, envoyé par mail, ou plusieurs de ces options en même temps),
- une API Freebox OS pour pouvoir activer la procédure de réinitialisation à distance,
- l’implémentation dans les Compagnons (Android, iOS) de l’appel à cette API.

Cette procédure devrait aussi être utilisable pour une connexion à Freebox OS via un navigateur WEB.

Le code envoyé par sms ou mail devra avoir une durée de validité suffisamment longue pour permettre sa réception et sa ressaisie dans l’interface de réinitialisation du mot de passe.

Cordialement,

DFAL

Bonjour,

Avec la version 3.3, il est possible de gérer une liste de noms de domaines auxquels la Freebox répond depuis l’extérieur, et d’y ajouter des certificats SSL.

Serait-il possible d’étendre l’API pour permettre de configurer ces noms de domaines et leurs certificats ?

Ceci permettrait par exemple d’écrire un plugin pour le client letsencrypt qui permettrait de gérer le renouvellement automatisé (avec un client letsencrypt qui tourne sur un PC) du certificat SSL pour les noms de domaine personnalisés, et son installation automatique sur la Freebox.

Merci.

Example request:

PUT /api/v3/contact/addtogroup/ HTTP/1.1
Host: mafreebox.freebox.fr
{
  "group_id": 2,
  "contact_id": 6
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
    "success": true
}

Suite au bug : External Linkhttps://dev.freebox.fr/bugs/task/21461

Il apparaît que depuis la version 4 des API, certains appels nécessitent vraiment le header

Content-type: application/json

pour fonctionner correctement.

En effet, ce header est bien mentionné (71 fois) pour les réponses, mais jamais clairement pour les requêtes (juste 1 fois pour expliquer qu’il ne faut PAS l’envoyer dans un cas précis).

Cela n’est indiqué nulle part en clair dans la documentation.

Je suggère donc (améliorations) que la documentation mentionne cette “bonne pratique” (puisque en réalité 99% des API fonctionnent néanmoins, mais ce n’est effectivement pas 100% fiable).

Cela pourrait figurer dans la section d’introduction, en donnant des modèles de ‘curl’ par exemple.

Une documentation plus précise est en effet à même d’aider les futurs développeurs en leur évitant de tomber dans des bugs bizarres comme celui signalé plus haut.

Bonjour ,
de récurrents soucis de coupure de courant avec le réseau public de distribution de l’électricité m’ont incité à acquérir un ups pour protéger ma petite installation , et j’ai l’impression que ce type de problème est amené à se multiplié dans le futur .
Donc voila la question à peut être déjà été posée et je n’ai peut être pas cherché assez et par ailleurs je comprendrai que des contraintes techniques l’imposent ou rendent la chose impossible , mais après avoir cherché un minimum je n’ai pas trouvé de possibilité de faire un shutdown du freeboxserver , j’utilise apscupsd sur mes machines et je demande pas l’implémentation d’un client mais j’ai observé que l’api permettait le reboot (via POST /api/v4/system/reboot/) et me demande si le shutdown ne serait pas possible , en effet en cas de coupure si je souhaite continuer à alimenter la box pour maintenir le téléphone en cas d’urgence , j’aimerai aussi pourvoir l’éteindre et privilégier une autre machine à partir d’un certain temps / pourcentage de batterie .
Cette demande n’est ni urgente ni critique , mais je souhaitait avoir votre réponse avant d’envisager l’achat d’un autre ups uniquement pour la freebox ;)

Merci d’avance,
Cordialement

Bonjour,

avec les nouvelles fonctionalités de la Freebox Delta, il serait préférable de pouvoir integrer la domotique (Somfy, ...) avec des applications tierces en fournissant un API

Merci

Bonjour,
serait-il possible d’avoir de la documentation et des exemples sur la partie domotique et l’alarme en particulier.

J’ai bien vu la partie “Special Tiles specification” dans la documentation sur la Freebox mais je n’ai pas trouvé comment, par exemple, activer ou désactiver l’alarme.

Merci

Je souhaiterai récupérer la totalité des appels émis ou reçus sur ma Freebox. J’utilise donc l’API via cette URL :

/api/v4/call/log/

Seulement 100 éléments me sont affichés mais la numérotation de ceux-ci va bien au-delà (+ de 3000 dans mon cas). Si tous les appels sont gardés en mémoire, est-ce possible de mettre un paramètre optionnel pour récupérer l’ensemble des éléments ?

Bonjour,

J’utilise les APIs du serveur de la freebox et j’ai identifié qu’il existait une API de récupération des sessions (c-a-d une liste des sessions des applications tierces connectées aux API). Cette API correspond à “Gestion des accès > Sessions” dans l’interface web accessible depuis mafreebox.freebox.fr.

L’API semble être accessible depuis l’url http://mafreebox.freebox.fr/api/v6/sessions mais lorsque je l’appelle avec ma propre application (qui possède son propre app_token préalablement granted), j’ai un code retour 403 (Unauthorized).

Que dois-je faire pour pouvoir accéder à cette API ?

Merci bcp pour votre aide

Bien cordialement,

Jean-Baptiste

Bonjour,

Afin de pouvoir administrer et superviser de façon plus fine les Hosts qui se connectent au réseau de la Freebox (wifi ou LAN), j’ai besoin de pouvoir spécifier la durée par défaut du bail DHCP (cela devrait à priori être possible selon la RFC RFC1541)

Cette durée semble être forcée à 12h et n’est pas configurable malgré la disponibilité de l’API “/api/v6/dhcp/config/” (avec un PUT).

Pouvez-vous svp ajouter à l’API existante (”/api/v6/dhcp/config/”) la gestion de ce paramètre (ajout du champ dans l’objet DhcpConfig) ?

Merci

Bien à vous

Bonjour,

Il semble que Freebox OS ne permette pas de mettre à jour les certificats de noms de domaine non administrés par freeboxos. Le seul moyen que j’aie pu trouver est de supprimer et recréer le domaine.

Dans l’idéal, il faudrait une API (documentée) afin de permettre des mise à jour automatiques par scripts (par exemple lorsqu’on a un certificat Let’s Encrypt pour son domaine, qu’il faut renouveler régulièrement).

Bonjour,

A ce jour, la documentation disponible dans l’interface de Freebox OS est basée sur la version d’API 5.0, alors que l’OS actuel est basé sur la version 8.1
Merci d’effectuer un petit rafraichissement de rigueur.

Bien cordialement

[EDIT 2025-04-17]

Pour backup, une fois le trafic TLS décrypté, je trouve:

GET /api/latest/backup/config/export

Il est donc maintenant possible de backup régulièrement et en automatique la Freebox, par exemple en utilisant la fonction backup_fbx_config() de la library BASH
[/EDIT 2025-04-17/]

Bonjour

Suite au passage en 4.5.3 “officiel”, la section changes de l’API ne fait pas mention de l’ajout d’une API pour faire une sauvegarde de la box / restorer une sauvegarde.

Pourriez vous SVP ajouter une API permettant d’automatiser les sauvegardes ?
Pourriez vous également ajouter une API permettant de restorer une sauvegarde ?

Pouvoir créer une sauvegarde avec l’API vers un drive de la box ou un serveur réseau serait un plus.
Idem pour la restoration d’une sauvegarde depuis l’API.

En vous remerciant d’avance,
Cordialement
nbanba

Bonjour,

Je rencontre un problème lors de l’utilisation de l’API. Actuellement, lorsque j’effectue un nombre excessif de requêtes, je reçois en retour le message “Too Many Requests”.

Vu que le blacklistage des machines qui effectuent trop de requêtes est exponentiel (plus on insiste, plus la limitation est longue ; https://https://dev.freebox.fr/bugs/task/19160#comment79018), serait-il possible d’ajouter une indication du temps d’attente nécessaire avant de pouvoir effectuer de nouvelles requêtes ?

Actuellement, nous sommes contraints de réessayer à plusieurs reprises sans savoir exactement dans combien de temps nous pourrons effectuer de nouvelles requêtes. Cela a pour conséquence d’augmenter le temps d’attente si nous essayons de nouveau avant la fin de la période de blocage, ce qui a pour conséquence d’aggraver la situation.

Dans la demande “ FS#19160 “, il était indiqué que “Pour réinitialiser cette limitation il suffit de redémarrer le Server”. Cependant, après avoir essayé cette solution, le problème persiste toujours. Donc l’ajout de cette évolution aiderait grandement.

Je vous remercie par avance pour votre considération de cette demande d’amélioration.

Cordialement

Bonjour

1) Il serait pratique de pouvoir custom le champ 'type' des notifications :
Aujourd'hui seul 3 choix sont possibles :
Android | IOS | Firebase

L'ajout d'un type 'custom' (et pourquoi pas la possibilité de personnaliser un champ associé ⇒ ajout d'un "custom_type") serait bien.
Par exemple :

GET /api/v11/notif/targets/11111111-2222-3333-4444-666666666666
{
   "success":true,
   "result":[
      {
         "last_use":0,
         "type":"custom",
         "custom_type":"firewall",
         "name":"FGT901G-API",
         "id":"11111111-2222-3333-4444-666666666666",
         "subscriptions":[
                              "security",
                              "lan_host",
                              "box_state",
         ],
         "api_url": "https://myserver.example.com/my_fortigate_API_app",
         "message_type": "notification"
      }
   ]
}

2) Il serait bien d'ajouter à la "subscriptions" les notifications des events des VM qui sont aujourd'hui renvoyés en websocket (+ celles des type l2/l3_address_(un)reachable)

3) Il serait bien de pouvoir avoir tous les types de notifications au travers des websocket API (register event) :

phone	        notification when missing call
download	notification when download is finished
security	notification when alarm is on
box_state	notification when box state changed
lan_host	notification related to lan events
password_change	notification when admin password is changed

Ainsi le système serait un peu plus complet et homogène et surtout on pourrait piloter d'autres équipements (avec leur propre API) à réception de ces notifications.

Merci
Cordialement
nbanba