API pour les marchands et les partenaires

Grâce à API vous pouvez proposer les services de la téléphonie à vos clients sans les faire s'enregistrer sur le site Zadarma. En plus les clients peuvent recevoir les services sous votre marque (Whitelabel).

Vous pouvez proposer la téléphonie comme une partie de votre système complétement intégrée.

Vos clients peuvent recevoir et effectuer les appels depuis votre interface en utilisant toutes les possibilités du standard virtuel Zadarma et encore plus.

Toutes les possibilités et méthodes d'API Zadarma

Pour gérer les méthodes indiquées il faut avoir accès au compte du marchand de Zadarma. Si vous n'avez pas d'accès, créez un ticket dans le département financier.

Possibilités de l'intégration:

  • Création de nouveaux comptes Zadarma depuis le compte de marchand et leur géstion
  • Transfert de solde entre le compte de marchand et celui d'utilisateur
  • Connexion de numéros virtuels
  • Création et réglage du standard virtuel
  • Réception de clés API de compte d'utilisateur
  • Installation du lien webhook pour gérer les appels entrants du standard virtuel
  • Création du widget WebRTC aux comptes d'utilisateur etc.

Algorithme de connexion de la téléphonie à votre client:

1. Enregistrement d'utilisateur (Création du nouveau compte Zadarma) s'effectue grâce à la méthode POST /v1/reseller/users/registration/new/ .

Pour finir l'enregistrement l'utilisateur doit confirmer l'enregistrement avec la méthode POST /v1/reseller/users/registration/confirm/

Pour recevoir des moyens de test et recharger le compte, il faut ajouter le numéro à contacter d'utilisateur. Ajouter le numéro avec la méthode POST /v1/reseller/users/phones/add/ .

Pour confirmer le numéro, envoyez un SMS avec un code /v1/reseller/users/phones/prove_by_sms, l'utilisateur le saisit sur votre site et pour le transmettre vous utilisez la méthode /v1/reseller/users/phones/confirm .

2. Virement des fonds entre le compte de marchand et celui d'utilisateur s'effectue avec la méthode GET /v1/reseller/users/topup/ .

3. Processus de la connexion de numéros virtuels est décrit ici, il ne reste qu'à ajouter à la méthode le paramètre user_id avec l'identificateur d'utilisateur de l'action effectuée (Connexion du numéro, chargement de documents etc).

4. En utilisant la méthode POST /v1/pbx/create/ vous pouvez créer le standard virtuel Zadarma pour l'utilisateur.

5. Créez un numéro interne à chaque employé en utilisant la méthode POST /v1/pbx/internal/create/ .

Activez l'enregistrement d'appels dans le Cloud sur un numéro interne du standard virtuel en utilisant la méthode PUT /v1/pbx/internal/recording/ .

6. Pour distribuer les appels entrants du standard virtuel vous pouvez créer des SVI et des scénarios (des éléments du menu - des groupes de numéros internes qui reçoivent des appels). La méthode /v1/pbx/create/ crée le standard virtuel avec le nombre minimal de paramètres: 1 numéro interne et 1 scénario “sans appui” (qui reçoit tous les appels). Ensuite vous pouvez créer le nombre nécessaire de menus et scénarios.

Les scénarios sont indispensables pour la géstion dynamique du menu vocal, si vous voulez renvoyer les appels vers plusieurs numéros internes. Créer le nouveau scénario avec la méthode /v1/pbx/ivr/scenario/create/ , voir la liste /v1/pbx/ivr/scenario/ et supprimer /v1/pbx/ivr/scenario/delete/ . Dans le scénario la liste de numéros internes qui reçoivent des appels si le client appuie sur le bouton est créée. Si vous n'allez pas indiquer le bouton dans les paramètres, indiquez la chiffre push_button supérieure à 11.


7. Charger le fichier audio pour le menu vocal avec la méthode POST /v1/pbx/ivr/sounds/upload .

La taille du fichier audio est 5 Мo maximum, les formats - MP3, WAV.


8. Accès à API. L'utilisateur peut également utiliser l'API sur son compte pour l'intégration avec des services à part ou CRM systèmes, il doit générer les clés. Il peut les générer dans l'espace client ou le marchand peut les recevoir en utilisant la méthode POST /v1/reseller/users/api_key/ avec des paramètres user_id - id d'utilisateur. Dans la réponse il y aura "key" et "secret" d'utilisateur, pour son accès à API.

Il est possible d'indiquer l'url pour l'envoi de notifications sur les appels du standard virtuel d'utilisateur en utilisant la méthode POST /v1/pbx/callinfo/url/ et l'url à part pour les autres notifications (Actualisation de contacts, Call tracking, SMS et Analyse vocale) en utilisant la méthode POST /v1/pbx/webhooks/url/ les paramètres sont les mêmes pour les deux demandes url - le lien et user_id - id d'utilisateur.


9. Pour la géstion dynamique du menu vocal et appels entrants du client, vous pouvez utiliser la PHP bibliothèque disponible sur notre Github ou réaliser votre propre solution en utilisant notre système de notifications, en savoir plus ici.


10. Manuel d'intégration du standard virtuel avec le CRM à part vous trouverez ici.


11. Pour effectuer des appels depuis l'interface web, utilisez le widget WebRTC. Vous pouvez connecter les applications ou équipement compatibles à SIP. Recevez les paramètres de connexion (login-mot de passe) avec la méthode /v1/pbx/internal/