API pour numéros et documents

A l'aide d'API vous pouvez effectuer la connexion et la géstion de numéros virtuels depuis votre propre interface sans accès à l'espace client Zadarma.

Toutes les possibilités et methodes d'API Zadarma - https://zadarma.com/fr/support/api/

Dans plusieurs pays la connexion du numéro demande l'identification de l'utilisateur final. Les documents de l'utilisateur sont également chargés par API.

Possibilités d'API:

• choix et connexion de numéros virtuels
• réglage de numéros connectés
• géstion de documents pour la connexion de numéros (prescriptions aux documents, chargement de documents, vérification de documents pour la commande)

Algorithme de connexion du numéro par API:

1. Réception et affichage de la liste de pays et directions pour la commande
2. Réception et affichage de la liste de numéros disponibles
3. Création du groupe de documents de l'utilisateur (s'il n'est pas encore créé) et chargement de documents (si nécessaire).
4. Connexion du numéro choisi.
5. Transfert du numéro au SIP login ou SIP URI (set_sip_id)

Connexion de nouveaux numéros

La méthode GET /v1/direct_numbers/countries/ fournit la liste de pays où vous pouvez commander le numéro si la demande envoyée est sans paramètres, la réponse sera en langue de votre espace client, mais en ajoutant le paramètre optionnel language vous recevrez la réponse en une des langues de l'espace client.

La méthode GET /v1/direct_numbers/country/ fournit la liste de directions dans un pays où vous pouvez commander le numéro. Paramètre obligatoire country - iso est le préfixe (ISO 3166-1 alpha-2); Paramètres optionnels sont language et direction_id. Dans la réponse vous verrez la matrice de données avec la description du numéro: pays, ville, frais de connexion, frais d'utilisation mensuel, particularités, réception des SMS etc.

Réception de la liste de numéros disponibles grâce à la méthode GET /v1/direct_numbers/available/<DIRECTION_ID>/ avec les paramètres DIRECTION_ID - ID de la direction ou fr1; et mask - paramètre optionnel, pour rechercher des correspondances pour des numéros.

Commande du numéro grâce à la méthode POST /v1/direct_numbers/order/ .

Le numéro connecté peut être prolongé pour quelques mois grâce à la méthode POST /v1/direct_numbers/prolong/

Paramètres obligatoires sont number et months

Géstion des numéros connectés

La méthode GET /v1/direct_numbers/ (sans paramètres) rend la matrice avec l'information sur les numéros connectés.

La méthode GET /v1/direct_numbers/number/ fournit l'information sur le numéro, la demande est envoyée avec les paramètres type et number

Le statut de renouvellement automatique du numéro (si le numéro est automatiquement prolongé ou désactivé) se découvre grâce à la méthode GET /v1/direct_numbers/autoprolongation/ avec les paramètres type et number

Pour changer de statut de renouvellement automatique - la méthode PUT /v1/direct_numbers/autoprolongation/ avec les paramètres type, number et value

La méthode PUT /v1/direct_numbers/set_caller_name/ - l'installation ou l'activation du Nom du numéro (lettres latines et chiffres, jusqu'à 30 symboles) la description du numéro, pendant un appel entrant le nom est envoyé dans le titre From en tant que CALLERID(name).

La méthode PUT /v1/direct_numbers/set_sip_id/ transfert les appels du numéro virtuel vers le sip login, vers le serveur externe par SIP URI ou activer le mode TEST. Les paramètres obligatoires sont type, number et sip_id - sip login ou adresse du serveur externe, par exemple 1234567890@myserver.com test_mode - optionnel, (on|off) - pour activer le mode de test.

Géstion de documents

Groupe de documents ce sont les données de la personne ou entreprise que le numéro virtuel utilisera, on peut créer plusieurs groupes.

Création du nouveau groupe de documents, la méthode POST /v1/documents/groups/create/ .

Actualiser les données dans le groupe de documents grâce à la méthode PUT /v1/documents/groups/update/<GROUPID>/ .

Chargement du fichier pour un groupe s'effectue grâce à la méthode POST /v1/documents/upload/ .

La méthode GET /v1/documents/groups/list/ fournit la liste de groupes de documents, la méthode GET /v1/documents/groups/get/<ID>/ où ID est l'identificateur de groupe, 0 - le groupe de documents principal, fournit l'information sur le groupe de documents.

La méthode GET /v1/documents/files rend la liste de documents chargés dans le groupe de documents. group_id - optionnel, ID de groupe de documents, (0 ou non indiqué - le groupe de documents principal).

Vérification: si le groupe de documents correspond au numéro commandé dans la ville - s'effectue grâce à la méthode GET /v1/documents/groups/valid/<ID>/ .