Comment configurer Dropbox Fax API

Cet article contient des informations sur la configuration de Dropbox Fax API à l’aide des points de terminaison v. 1, la façon de s’assurer qu’elle est opérationnelle et l’achat de lignes de fax supplémentaires si nécessaire.

Configurer Dropbox Fax API à l’aide des points de terminaison v. 1

Pour commencer à utiliser les points de terminaison v. 1 :

1. Envoyez un e-mail à support@hellosign.com en renseignant l’adresse e-mail que vous souhaitez utiliser pour votre compte Dropbox Fax. Vous recevrez une réponse une fois votre accès à Dropbox Fax API activé. Apprenez-en plus sur les tarifs de Dropbox Fax API.
2. Connectez-vous à votre compte Dropbox Fax.Notez bien le GUID de votre compte, car vous en aurez besoin pour la plupart des demandes d’API (ou points de terminaison).
3. Effectuez votre première demande d’API et obtenez les informations de configuration de votre compte :

Voici un exemple :

Un autre exemple (n’oubliez pas d’encoder l’URL) :

La réponse sera une représentation JSON des paramètres de votre compte.

4. Pour ajouter à nouveau des URL de rappel pour vos fax entrants et sortants via une requête POST :

5. Pour consulter les lignes de fax disponibles :

La ligne de fax que vous avez choisie lors de votre inscription à un abonnement premium figurera dans la réponse.

6. Avant que vous puissiez acheter un numéro de fax, nous devons vérifier les indicatifs régionaux disponibles (car ils ne le sont pas tous) via une requête GET :

7. Achetez un numéro de fax appartenant à l’un des indicatifs régionaux disponibles mentionnés à l’étape 6 :

8. Pour envoyer un fax :

Cela lance le processus d’envoi du fax. La réception d’une réponse HTTP 200 ne garantit pas la transmission du fax, car une erreur de conversion de fichier peut se produire. Cependant, une fois que le code de statut du fax passe à E (pour Erreur) ou S (pour Succès), vous recevrez une requête POST à l’URL de rappel que vous avez fournie à l’étape 4. Apprenez-en plus sur les événements de rappel.

Valeurs de code de statut possibles :

• T = Transmission/envoi en cours.
• P = En attente/conversion en cours.
• S = Envoi réussi.
• E = Erreur. Échec de la conversion ou de l’envoi complet.
• H = En attente. Cette erreur se produit si votre compte n’est pas confirmé ou si vous n’avez plus de pages de fax disponibles sans abonnement mensuel.

Valeurs de code d’erreur possibles (uniquement lorsque le code de statut est défini sur E) :

• B = Signal occupé reçu.
• N = Pas de réponse.
• A = Numéro non attribué (signifie généralement qu’il est hors service).
• D = Ligne hors service ou inaccessible.
• L = Numéro sur la liste des numéros refusés (cela ne devrait pas se produire pour les numéros américains).
• U = Erreur inconnue. Cela se produit généralement lorsqu’une personne décroche la ligne ou qu’une erreur s’est produite lors de la transmission du fax.
  

Remarques :

• Si vous envoyez un fax et que l’appareil du destinataire prend en charge la lecture de l’identifiant de l’abonné demandé (CSID), l’identifiant de l’appelant affichera votre numéro de fax principal ou le numéro de fax que vous avez renseigné dans le paramètre « Expéditeur ». Pour rappel, votre numéro de fax principal figure sur le fax lui-même. Si vous possédez plusieurs lignes Dropbox Fax, vous pouvez choisir celle à utiliser pour l’envoi en incluant le paramètre « Expéditeur » dans l’URL :

Pour le format de la valeur « Expéditeur », consultez le champ « Numéro » renvoyé par appel ou lignes de fax (voir l’étape 5 ci-dessus).

• Vous pouvez importer plusieurs fichiers et envoyer plusieurs fax en un seul appel. Il suffit de créer des tableaux de paramètres pour les valeurs « Fichier » et/ou « Expéditeur » :

ou

• Vous pouvez ajouter une page de garde générée par Dropbox Fax en spécifiant un ou plusieurs des paramètres suivants : CoverPageTo, CoverPageFrom et CoverPageMessage.
• Une fois envoyés, les fax envoyés par l’API ne sont pas stockés sur nos serveurs, mais supprimés. Par conséquent, vous ne pouvez pas les afficher dans l’interface utilisateur. Cependant, les fax entrants envoyés via une requête POST à votre URL de rappel sont stockés sur nos serveurs et peuvent être consultés depuis la vue « Documents ».
• Seuls 200 fax peuvent être mis en attente par jour. Si vous atteignez cette limite, vous rencontrerez une erreur 429 :

Comment consulter le statut des fax ?

1. Vous pouvez localiser le GUID de transmission dans la réponse JSON reçue de l’appel d’API à l’étape 8. De plus, vous pouvez consulter le statut de toutes vos transmissions en omettant le GUID de transmission :

Ces résultats sont paginés. Vous pouvez obtenir différentes pages en spécifiant les paramètres d’URL Page et PageSize. Reportez-vous aux éléments de réponse FirstPageUri, NextPageUri, PreviousPageUri et LastPageUri pour savoir comment fonctionne la pagination.

2. Une fois le code de statut du fax défini sur S ou E, vérifiez que votre URL de rappel de fax sortant a été déclenchée. Votre URL devrait recevoir une requête POST avec un paramètre appelé « json » qui contient tout ce que vous obtiendriez en réponse à un appel (voir étape 1).

Si un problème de serveur ou de réseau empêche le rappel POST, Dropbox effectuera de nouvelles tentatives à ces intervalles :

• 15 minutes
• 45 minutes
• 1 heure et 30 minutes
• 2 heures et 45 minutes
• 4 heures
• 8 heures et 15 minutes
• 16 heures et 30 minutes

À chaque intervalle, Dropbox peut essayer d’envoyer la requête POST plusieurs fois si aucun code de réponse 200 n’est reçu.

3. Si vous avez envoyé le fax à votre propre numéro Dropbox Fax (utile pour les tests), vérifiez bien que votre URL de rappel de fax entrant a également été déclenchée.
4. Répertoriez les lignes de fax que vous avez achetées :

5. Pour supprimer une ligne de fax, effectuez un appel DELETE à l’URI de cette ligne de fax (figurant dans la réponse à l’étape précédente) :

Si l’opération réussit, vous recevrez une réponse 200.