Aller au contenu
Espace client
Documentation de l’API

API revendeur

Créez et gérez vos clients, leurs abonnements, leur téléphonie et leur facturation depuis votre site. Avec X-Organization, toute l’API clients s’utilise au nom d’un client.

106 routes documentées · spécification OpenAPI

Démarrer

L'API revendeur vous permet d'intégrer toute la plateforme à votre site ou à votre outil : créer vos clients, leur vendre un abonnement, configurer leur téléphonie (utilisateurs, postes, numéros, files d'attente, standard vocal…), les facturer et les suivre. Tout ce que vous faites dans le panneau se fait par l'API.

Adresse et format

  • Adresse : https://api.hcloud.fr
  • Requêtes et réponses en JSON (Content-Type: application/json), sauf envoi de fichiers (multipart/form-data).
  • Dates au format ISO 8601 (2026-12-01T09:00:00Z), montants en centimes (priceCents), numéros au format international (+33612345678) ; les numéros français à 10 chiffres sont acceptés en entrée.

Clé d'API

Créez une clé dans le panneau revendeur, rubrique Clés d'API (affichée une seule fois). Envoyez-la à chaque requête :

curl "https://api.hcloud.fr/api/reseller/clients" -H "Authorization: Bearer vxr_…"

Une clé peut être en lecture seule (seules les requêtes GET passent) et limitée à des adresses IP (IPv4, IPv6, plages CIDR). Elle cesse de fonctionner si le compte qui l'a créée est désactivé. Développez d'abord avec un compte d'essai (voir ce guide) : rien n'y a d'effet réel.

Erreurs

Code Signification
200, 201 Succès (201 : ressource créée)
400 Requête invalide : le champ error dit lequel et pourquoi (ex. number : format invalide)
401 Clé absente, invalide ou révoquée
403 Droits insuffisants, fonction non incluse dans l'offre, compte suspendu, clé en lecture seule
404 Ressource introuvable (ou appartenant à une autre entreprise)
409 Conflit (ex. numéro pris entre-temps, e-mail déjà utilisé)
429 Trop de requêtes : réessayez après le délai indiqué par l'en-tête Retry-After

Chaque erreur renvoie { "error": "message en français", "code": "BAD_REQUEST" }.

Limites de débit

1 200 requêtes par minute et par adresse IP ; certaines routes sensibles ont leur propre limite (création de clients, achats). En cas de dépassement : 429.

Requêtes rejouables

Pour une création (POST) que vous risquez d'envoyer deux fois (coupure réseau), ajoutez Idempotency-Key: <identifiant unique> : la même clé renvoie la même réponse sans refaire l'action.

Agir au nom d’un client

Toutes les routes de la documentation Clients s'utilisent avec votre clé revendeur, au nom d'un de vos clients, en ajoutant l'en-tête X-Organization (identifiant ou identifiant court du client) :

curl "https://api.hcloud.fr/api/org/users" -H "Authorization: Bearer vxr_…" -H "X-Organization: garage-dubois"

Vous agissez alors comme l'administrateur du client. Pour agir comme un utilisateur précis (son softphone, ses renvois, sa messagerie vocale, ses contacts…), ajoutez X-User (identifiant ou e-mail) :

curl "https://api.hcloud.fr/api/me/sip-accounts" -H "Authorization: Bearer vxr_…" -H "X-Organization: garage-dubois" -H "X-User: julie.martin@garage-dubois.fr"

Seuls vos clients sont accessibles. Chaque action est inscrite au journal d'audit du client avec la mention « en tant que ».

Lien de connexion automatique

Pour ouvrir le panneau d'un client depuis votre site (bouton « Mon standard ») sans lui redemander son mot de passe :

curl -X POST "https://api.hcloud.fr/api/reseller/clients/{id}/login-link" -H "Authorization: Bearer vxr_…" -H "Content-Type: application/json" -d '{"user":"julie.martin@garage-dubois.fr","next":"/admin"}'

L'adresse renvoyée est à usage unique et valable 60 secondes par défaut (ttlSeconds : 10 à 900).

Parcours complet : un client équipé

Exemple : un nouveau client, deux utilisateurs, un numéro qui arrive sur une file d'attente.

1. Créer le client (POST /api/reseller/clients)

curl -X POST "https://api.hcloud.fr/api/reseller/clients" -H "Authorization: Bearer vxr_…" -H "Content-Type: application/json" \
  -d '{"company":"Garage Dubois","name":"Paul Dubois","email":"paul@garage-dubois.fr","password":"Un-mot-de-passe-solide","product":"CENTREX_HOSTED","trialDays":14}'

Gardez l'id et le slug renvoyés. Les appels suivants portent X-Organization: <slug>.

2. L'abonner à une offre (marque blanche, quand vous facturez vous-même) : GET /api/reseller/plans pour vos offres, puis POST /api/reseller/clients/{id}/subscription (planId, seats, months…). Sinon le client souscrit lui-même (POST /api/billing/checkout en son nom).

3. Identifier le client (obligatoire avant d'attribuer un numéro) : POST /api/org/kyc puis les pièces avec POST /api/org/kyc/documents.

4. Créer les utilisateurs et leurs postes (POST /api/org/users, puis POST /api/org/extensions ou createExtension dans la même requête) :

curl -X POST "https://api.hcloud.fr/api/org/users" -H "Authorization: Bearer vxr_…" -H "X-Organization: garage-dubois" -H "Content-Type: application/json" \
  -d '{"email":"julie@garage-dubois.fr","name":"Julie Martin","role":"USER","sendInvite":true}'

5. Acheter un numéro : la liste des numéros disponibles dans une zone, puis l'achat :

curl "https://api.hcloud.fr/api/billing/numbers?area=04" -H "Authorization: Bearer vxr_…" -H "X-Organization: garage-dubois"
curl -X POST "https://api.hcloud.fr/api/billing/numbers" -H "Authorization: Bearer vxr_…" -H "X-Organization: garage-dubois" -H "Content-Type: application/json" -d '{"number":"+33478000000"}'

6. Créer la file d'attente avec ses agents (identifiants des postes) :

curl -X POST "https://api.hcloud.fr/api/centrex/queues" -H "Authorization: Bearer vxr_…" -H "X-Organization: garage-dubois" -H "Content-Type: application/json" \
  -d '{"number":"600","name":"Atelier","strategy":"longest-idle-agent","members":["<poste 1>","<poste 2>"],"maxWaitSeconds":300}'

7. Router le numéro vers la file (destType : EXTENSION, RING_GROUP, IVR, QUEUE, VOICEMAIL, CONFERENCE, TIME_CONDITION, FLOW, EXTERNAL…) :

curl -X PUT "https://api.hcloud.fr/api/centrex/numbers/{id du numéro}" -H "Authorization: Bearer vxr_…" -H "X-Organization: garage-dubois" -H "Content-Type: application/json" -d '{"destType":"QUEUE","destId":"<id de la file>"}'

8. Ouvrir le panneau du client depuis votre site : POST /api/reseller/clients/{id}/login-link.

Pour transférer ses numéros actuels : POST /api/v1/porting (au nom du client), suivi par le webhook porting.status.

Envoyer un SMS

Vous envoyez au nom d’un client : ajoutez l’en-tête X-Organization. Le SMS est compté sur les crédits de ce client.

1. Envoyer

curl -X POST "https://api.hcloud.fr/api/v1/sms" \
  -H "Authorization: Bearer vxr_…" \
  -H "X-Organization: <identifiant du client>" \
  -H "Content-Type: application/json" \
  -d '{"to":"0612345678","text":"Votre commande est prête.","tag":"commande-42"}'
Champ Requis Description
to oui Mobile du destinataire : 0612345678, 06 12 34 56 78 ou +33612345678 (mobiles français, 06 et 07)
text oui Message, 1 000 caractères au plus (voir « Crédits consommés »)
sender non Expéditeur affiché, 3 à 11 lettres ou chiffres (par défaut : celui de l’entreprise) ; refusé s’il est interdit
tag non Votre référence (100 caractères), renvoyée dans les statuts et le webhook
type non transactional (par défaut) ou marketing
channel non sms (par défaut), whatsapp, ou auto (WhatsApp si possible, sinon SMS)

Réponse immédiate : le message est mis en file et part en quelques secondes.

{ "id": "cmx…", "to": "+33612345678", "status": "queued", "segments": 1, "tag": "commande-42", "type": "transactional", "channel": null, "createdAt": "2026-11-17T09:00:00.000Z" }

Gardez l’id : il identifie le message dans le suivi et dans le webhook. Pour ne jamais envoyer deux fois le même SMS (coupure réseau, nouvel essai), ajoutez l’en-tête Idempotency-Key.

2. Suivre la remise

status Signification
queued En file d’envoi
sent Accepté par l’opérateur
delivered Remis sur le téléphone
failed Échec ; le motif est dans error (un SMS en échec n’est pas facturé)
  • Webhook (recommandé) : abonnez une adresse à l’événement sms.status (POST /api/reseller/webhooks). Vous recevez { "event": "sms.status", "data": { "id", "to", "status", "tag", "segments", "sender", "error", "at" } } à chaque étape, pour tous vos clients (avec data.orgId).
  • Interrogation : GET /api/v1/sms/{id} renvoie le message et ses étapes (events) ; GET /api/v1/sms?status=failed&since=…&tag=… liste les messages.

3. Crédits consommés

  • 1 SMS = 160 caractères ; au-delà, le message est découpé en parties de 153 caractères, chacune comptée (segments dans la réponse).
  • Avec ê, â, î, ô, û, ç minuscule ou un emoji, la limite tombe à 70 caractères (67 par partie). É, è, à, ù et € ne changent rien.
  • Ordre de décompte : forfait du mois, puis solde, puis (si l’entreprise y a droit) SMS au comptage, facturés à l’unité en fin de mois, dans la limite d’un éventuel plafond mensuel.
  • GET /api/v1/sms/balance : forfait du mois, solde et comptage (metered : tarif, consommation du mois, plafond restant).

4. Erreurs

Code error Que faire
400 Numéro invalide Vérifiez to. Un numéro valide mais qui n’est pas un mobile français (fixe, étranger) est accepté puis passe en failed avec le motif dans error
400 Crédits SMS insuffisants Forfait et solde épuisés, sans comptage : ajoutez des crédits
400 Plafond mensuel des SMS au comptage atteint Attendez le mois suivant ou faites relever le plafond
400 Option SMS et WhatsApp non activée L’option doit être activée sur le compte
400 Expéditeur invalide / Expéditeur « … » interdit 3 à 11 lettres ou chiffres, et pas un nom bloqué
401 / 403 Clé absente ou invalide, ou client qui n’est pas le vôtre

Un compte d’essai (sandbox) accepte les mêmes appels : rien n’est envoyé, le message passe « remis » et le webhook part comme en production.

Compatibilité Twilio

Une adresse dédiée reprend le format de l’API Twilio : un code écrit pour les bibliothèques Twilio (Node.js, PHP, Python…) fonctionne ici en changeant les identifiants et en ajoutant quelques lignes. Chacun de vos clients a ses propres identifiants (POST /api/org/twilio-compat/token avec X-Organization, ou depuis son panneau).

Identifiants

POST /api/org/twilio-compat/token (ou panneau › Intégrations › Compatibilité Twilio) crée l’Account SID (AC…) et l’Auth Token, affiché une seule fois ; un nouvel appel remplace le jeton. Authentification Basic AccountSid:AuthToken, comme chez Twilio.

Adresses

Twilio Ici
https://api.twilio.com/2010-04-01/… /api/twilio/2010-04-01/…
https://verify.twilio.com/v2/… /api/twilio/verify/v2/…
https://lookups.twilio.com/v2/… /api/twilio/lookups/v2/…

Avec les bibliothèques Twilio

// Node.js : npm i twilio @voxnova/sdk
import twilio from 'twilio';
import { TwilioCompatHttpClient } from '@voxnova/sdk';
const client = twilio(ACCOUNT_SID, AUTH_TOKEN, { httpClient: new TwilioCompatHttpClient('https://api.exemple.fr') });
await client.messages.create({ to: '+33612345678', from: 'MaMarque', body: 'Bonjour' });
// PHP : composer require twilio/sdk voxnova/sdk
$client = new Twilio\Rest\Client(ACCOUNT_SID, AUTH_TOKEN, null, null, new VoxNova\Twilio\HttpClient('https://api.exemple.fr'));
$client->messages->create('+33612345678', ['from' => 'MaMarque', 'body' => 'Bonjour']);
# Python : pip install twilio
from twilio.rest import Client
from twilio.http.http_client import TwilioHttpClient
class VoxNova(TwilioHttpClient):
    def request(self, method, url, **kw):
        host, path = url.split('://', 1)[1].split('/', 1)
        prefix = {'api': '', 'verify': '/verify', 'lookups': '/lookups'}[host.split('.')[0]]
        return super().request(method, 'https://api.exemple.fr/api/twilio' + prefix + '/' + path, **kw)
client = Client(ACCOUNT_SID, AUTH_TOKEN, http_client=VoxNova())

Pris en charge

Ressource Opérations Équivalent dans l’API habituelle
Messages créer (To, From, Body, StatusCallback), lire, lister POST /api/v1/sms (statusCallback)
Calls créer (To, From, Url ou Twiml, StatusCallback, Timeout), lire, lister, raccrocher (Status=completed), rediriger (Url, Twiml) POST /api/v1/calls (url, twiml, statusCallback), hangup, redirect
IncomingPhoneNumbers lister, lire, modifier (VoiceUrl, VoiceFallbackUrl, StatusCallback, FriendlyName) PATCH /api/v1/numbers/{number}
Recordings lister, lire, télécharger, supprimer /api/v1/recordings
Verify v2 Services, Verifications (sms, whatsapp), VerificationCheck, annulation /api/v1/verify
Lookups v2 PhoneNumbers (line_type_intelligence) GET /api/v1/lookup/{number}

TwiML (réponse de votre adresse vocale) : Say, Play, Pause, Gather (Say/Play imbriqués), Dial (numéro, Number, Client, Sip, Conference, Queue), Record, Redirect, Hangup, Reject, Enqueue, Message. Les requêtes vers votre adresse sont au format Twilio (CallSid, From, To, CallStatus, Digits, RecordingUrl…) et signées X-Twilio-Signature avec votre Auth Token : la fonction de vérification des bibliothèques Twilio fonctionne telle quelle. Les applications de l’API habituelle acceptent aussi le TwiML (format: "twiml", ou réponse XML).

Limites

Les codes d’erreur suivent ceux de Twilio (20003 authentification, 20404 introuvable, 21211 numéro invalide, 60200 et 60203 pour Verify…). Non pris en charge : MMS, Messaging Services, Conversations, Studio, Flex, TaskRouter, Video, et les SDK téléphone de Twilio (Voice SDK pour navigateur et mobiles) : utilisez le webphone. Lookups n’indique pas l’opérateur (carrier_name: null), peu fiable avec la portabilité.

Webhooks

Créez un webhook (POST /api/reseller/webhooks) pour être prévenu en temps réel, pour tous vos clients :

Événement Quand
voicemail.new Nouveau message vocal chez un client
porting.status Changement d'étape d'une portabilité (reçue, en cours, date fixée, portée, refusée, annulée)
sms.status Statut de remise d'un SMS (envoyé, remis, échec)
call.completed Fin d'un appel chez un client (sens, numéros, durée, cause de fin)
number.assigned Numéro attribué à un client (achat ou portabilité terminée)
invoice.created, invoice.paid Facture d'un client émise, puis payée
client.created, client.suspended, client.reactivated, client.terminated Vie d'un client : création, suspension, réactivation, résiliation

Chaque événement d'un client porte data.organization (id, slug, name).

Nouveaux essais et journal

Sans réponse 2xx sous 8 secondes, l'envoi est réessayé automatiquement après 1 min, 5 min, 30 min, 2 h puis 12 h (6 essais au total), puis marqué en échec. L'en-tête X-VoxNova-Delivery identifie l'envoi : il est le même à chaque essai, ce qui permet d'ignorer un doublon. GET /api/reseller/webhooks/{id}/deliveries donne le journal des 14 derniers jours (état, essais, réponse reçue, contenu) ; POST …/deliveries/{envoi}/retry renvoie tout de suite ; POST /api/reseller/webhooks/{id}/test envoie un événement de test.

Chaque envoi est un POST JSON { "event": "porting.status", "createdAt": "…", "data": { … } }, avec les en-têtes X-VoxNova-Event (nom de l'événement) et X-VoxNova-Signature: sha256=<hex>, où <hex> = HMAC-SHA256(secret du webhook, corps brut de la requête). Vérifiez la signature sur le corps avant de le décoder. Répondez 2xx en moins de 8 secondes ; le résultat du dernier envoi est visible dans GET /api/reseller/webhooks (lastStatus).

const expected = 'sha256=' + crypto.createHmac('sha256', secret).update(rawBody).digest('hex');
const valid = crypto.timingSafeEqual(Buffer.from(expected), Buffer.from(req.headers['x-voxnova-signature']));

Compte d’essai (sandbox)

Un compte d'essai est un revendeur fictif, livré avec deux clients fictifs déjà équipés. Il s'utilise exactement comme un vrai compte : mêmes routes, mêmes validations, mêmes réponses, mêmes webhooks. Mais rien ne sort de la plateforme :

  • aucun appel n'est passé ni reçu, aucun poste ne peut s'enregistrer ; un appel lancé par l'API apparaît dans le journal comme un appel fictif de 42 secondes ;
  • aucun SMS, aucun WhatsApp, aucun e-mail n'est envoyé : ils sont notés « remis » (statuts et webhooks compris) et visibles dans la console d'essai ;
  • aucun paiement réel : utilisez la carte de test 4242 4242 4242 4242 (date future, code au choix) ;
  • aucun vrai numéro : seuls les numéros fictifs de la plage réservée à la fiction, 01 99 00 00 00 à 01 99 00 99 99 (+33199000000 à +33199009999), peuvent être achetés, déclarés ou portés ;
  • aucune démarche n'est transmise à un opérateur ou à l'équipe : portabilité, identification, commande de services, paiement par virement se valident d'un clic dans la console d'essai ;
  • aucun téléphone de bureau n'est enregistré chez son constructeur, aucun enregistrement DNS n'est créé, aucun vrai domaine ne peut être pris (utilisez un domaine en .test).

Créer un compte d'essai

Depuis votre session (ou avec votre clé) :

curl -X POST "https://api.hcloud.fr/api/reseller/sandboxes" -H "Authorization: Bearer vxr_…"

Réponse (affichée une seule fois) :

{
  "id": "…", "name": "Votre marque (essai)", "sandbox": true,
  "apiKey": "vxr_test_…",
  "panel": { "url": "…/login", "email": "revendeur-…@sandbox.invalid", "password": "Essai-…" },
  "consoleUrl": "https://api.hcloud.fr/api/sandbox/console/r.…",
  "clients": [{ "id": "…", "slug": "essai-…", "name": "Garage Dubois" }, { "id": "…", "slug": "essai-…", "name": "Cabinet Lefèvre" }]
}

La clé vxr_test_… s'utilise comme une clé de production : /api/reseller/…, et toutes les routes clients avec X-Organization. Les clients que vous créez avec cette clé sont fictifs eux aussi. Trois comptes d'essai au plus ; DELETE /api/reseller/sandboxes/{id} supprime un compte d'essai et ses clients.

La console d'essai

L'adresse consoleUrl (lien secret, sans connexion) affiche tout ce qui aurait eu lieu (e-mails avec leur texte, SMS, appels, enregistrements DNS…) et les démarches à valider :

Démarche Boutons
Portabilité Signer le mandat, Prise en charge, Fixer la date, Portage effectué (les numéros sont ajoutés au compte), Refuser
Identification Valider, Refuser
Commande de services Étape suivante (devis, commandé, planifié, actif), Annuler
Facture à régler (virement) Marquer payée
Appel entrant Simuler un appel (décroché ou manqué) sur un numéro du compte : journal des appels et webhook call.completed

Les mêmes actions existent en API, pour vos tests automatisés :

# état de la console
curl "https://api.hcloud.fr/api/sandbox/console/<jeton>/state"
# action : kind = porting | kyc | order | invoice ; action = sign | in_progress | schedule | done | reject | approve | next | cancel | paid
curl -X POST "https://api.hcloud.fr/api/sandbox/console/<jeton>/actions" -H "Content-Type: application/json" -d '{"kind":"porting","id":"<demande>","action":"sign"}'

Chaque étape déclenche les mêmes webhooks qu'en production (porting.status, sms.status…) : votre intégration se teste de bout en bout.

Simuler un appel entrant, remettre à zéro

# appel entrant simulé sur un numéro du compte d'essai (answered: false pour un appel manqué)
curl -X POST "https://api.hcloud.fr/api/sandbox/console/<jeton>/simulate" -H "Content-Type: application/json" -d '{"number":"+33199000000","from":"+33612345678","answered":true,"durationSec":35}'

POST …/sandboxes/{id}/reset remet le compte dans son état d'origine (données fictives recréées) en gardant la même clé et la même console : pratique entre deux séries de tests. Un compte d'essai sans aucune utilisation pendant 90 jours est supprimé.

Limites

  • L'assistant IA de création de scénarios n'est pas disponible (créez le scénario avec POST /api/centrex/flows).
  • Les appels ne pouvant pas avoir lieu, les statistiques ne contiennent que l'historique fictif et les appels lancés par l'API.
  • Un compte d'essai ne crée pas d'autre compte d'essai.

Référence complète, tirée du code de la plateforme : chaque champ indiqué est celui réellement vérifié par l’API.

Votre compte revendeur

Marque (nom, logo, couleurs, domaine du panneau), préférences de facturation, fonctions proposées à vos clients, équipe, messages système.

GET/api/reseller/billing-profileRevendeur#

Vos coordonnées de facturation (en-tête des factures de vos clients).

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/billing-profile" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "id": "reseller:cmwjdhkgc0002q7e0dkez0qxp",
  "sellerName": "Télécom Démo",
  "sellerAddress": "",
  "sellerSiret": "",
  "sellerVat": "",
  "sellerEmail": "",
  "iban": "",
  "bic": "",
  "bankName": "",
  "paymentInstructions": "",
  "paymentTermDays": 15,
  "renewalNoticeDays": 10,
  "legalMentions": "",
  "sellerSiren": "",
  "sellerLegalForm": "",
  "sellerCapital": "",
  "sellerRcs": "",
  "sellerPostalCode": "",
  "sellerCity": "",
  "vatOnDebits": false,
  "invoicePrefix": "",
  "invoiceStart": 1,
  "invoiceStartYear": null,
  "updatedAt": "2026-11-16T14:42:38.828Z"
}
PUT/api/reseller/billing-profileRevendeur#

Modifie vos coordonnées de facturation.

Corps (JSON)

ChampTypeDétails
sellerName requistexte1 à 200 caractères
sellerAddress requistexte500 caractères au plus
sellerSiret requistexte30 caractères au plus
sellerVat requistexte30 caractères au plus
sellerEmail requistexte ou ""
iban requistexte50 caractères au plus
bic requistexte20 caractères au plus
bankName requistexte100 caractères au plus
paymentInstructions requistexte1000 caractères au plus
paymentTermDays requisentierde 0 à 90
legalMentions requistexte2000 caractères au plus
Exemple
curl -X PUT "https://api.hcloud.fr/api/reseller/billing-profile" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"sellerName":"…","sellerAddress":"…","sellerSiret":"…","sellerVat":"…","sellerEmail":"julie.martin@exemple.fr","iban":"…","bic":"…","bankName":"…","paymentInstructions":"…","paymentTermDays":0,"legalMentions":"…"}'
PUT/api/reseller/brandingRevendeur#

Votre marque : nom, logo, couleurs, e-mail et site du support, domaine du panneau.

Corps (JSON)

ChampTypeDétails
brandNametexte2 à 60 caractères
logotexte ou null
primaryColortexteformat ^#[0-9a-fA-F]{6}$
supportEmailtexte ou "" ou null
supportPhonetexte ou null
websitetexte ou "" ou null
supportUrltexte ou "" ou null
domaintexte ou null
Exemple
curl -X PUT "https://api.hcloud.fr/api/reseller/branding" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"brandName":"…","logo":"…","primaryColor":"…"}'
GET/api/reseller/domain-checkRevendeur#

Vérification du domaine propre : il doit pointer vers le serveur (CNAME ou A).

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/domain-check" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "ok": false,
  "domain": null,
  "reason": "Aucun domaine propre"
}
GET/api/reseller/featuresRevendeur#

Fonctions proposées à vos clients.

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/features" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "features": [
    {
      "key": "••••••••",
      "label": "Rappels",
      "description": "Bouton « Être rappelé » sur votre site, API et file virtuelle de rappel",
      "kind": "free",
      "group": "Accueil des appels"
    },
    {
      "key": "••••••••",
      "label": "SMS et WhatsApp",
      "description": "Envoi automatique de SMS ou de messages WhatsApp depuis vos scénarios",
      "kind": "granted",
      "group": "Accueil des appels"
    }
  ],
  "disabled": []
}
PUT/api/reseller/featuresRevendeur#

Masque ou propose des fonctions à tous vos clients.

Corps (JSON)

ChampTypeDétails
disabled requisliste de "callbacks" | "messaging" | "receptionist" | "conferences" | "music" | "satisfaction" | "ai" | "integrations" | "api" | "teams" | "porting" | "sso" | "backups"13 éléments au plus
Exemple
curl -X PUT "https://api.hcloud.fr/api/reseller/features" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"disabled":["callbacks"]}'
GET/api/reseller/meRevendeur#

Votre compte revendeur : mode (apporteur ou marque blanche), marque, réglages.

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/me" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "reseller": {
    "id": "cmwjdhkgc0002q7e0dkez0qxp",
    "sandbox": false,
    "sandboxOwnerId": null,
    "disabledFeatures": [],
    "name": "Télécom Démo",
    "slug": "demo-revendeur",
    "mode": "WHITE_LABEL",
    "status": "ACTIVE",
    "contactEmail": null,
    "commissionPercent": 15,
    "discountPercent": 20,
    "brandName": null,
    "primaryColor": "#2554ea",
    "domain": null,
    "cloudflareZone": null,
    "sipBaseDomain": null,
    "supportEmail": null,
    "supportPhone": null,
    "supportUrl": null,
    "website": null,
    "notes": "",
    "systemAudios": {},
    "paymentMethod": "TRANSFER",
    "paymentLabel": null,
    "billClients": true,
    "publicSite": true,
    "sipDomains": [],
    "sipDefaultDomain": null,
    "trialsEnabled": true,
    "trialDays": 14,
    "trialMinutes": 35,
    "createdAt": "2026-11-16T14:42:36.877Z",
    "updatedAt": "2026-11-16T14:42:36.877Z",
    "paymentReady": true,
    "hasLogo": false,
    "hasCloudflare": false,
    "url": "http://demo-revendeur.partner.sip.localhost:5173",
    "defaultHost": "demo-revendeur.partner.sip.localhost",
    "brand": {
      "name": "Télécom Démo",
      "logoUrl": null,
      "primaryColor": "#2554ea",
      "supportEmail": null,
      "supportPhone": null,
      "website": null,
      "supportUrl": null,
      "centrexHostedName": "Centrex Télécom Démo",
      "url": "http://demo-revendeur.partner.sip.localhost:5173",
      "whiteLabel": true,
      "resellerId": "cmwjdhkgc0002q7e0dkez0qxp"
    }
  },
  "mrr": {
    "activeLicenses": 1,
    "retailCents": 9400,
    "wholesaleCents": 7520,
    "commissionCents": 0,
    "marginCents": 1880
  },
  "clientsByStatus": {
    "ACTIVE": 2
  },
  "clients": 2,
  "trials": 0,
  "month": {
    "month": "2026-11",
    "retailCents": 0,
    "balanceCents": 0,
    "invoices": 0
  },
  "pendingInvoices": 0,
  "signupUrl": "http://demo-revendeur.partner.sip.localhost:5173/signup",
  "setup": {
    "brand": false,
    "plans": 1,
    "billing": false,
    "domain": false
  },
  "dnsTarget": {
    "host": "localhost",
    "ips": []
  },
  "taxRatePercent": 20
}
GET/api/reseller/paymentRevendeur#

Votre moyen de paiement (reversements à la plateforme).

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/payment" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "method": "TRANSFER",
  "label": null,
  "ready": true,
  "online": false
}
PUT/api/reseller/paymentRevendeur#

Choisit votre moyen de paiement (virement, carte, prélèvement).

Corps (JSON)

ChampTypeDétails
method requis"TRANSFER"
Exemple
curl -X PUT "https://api.hcloud.fr/api/reseller/payment" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"method":"…"}'
POST/api/reseller/payment/setupRevendeur#

Enregistre une carte ou un mandat de prélèvement (adresse de la page sécurisée).

Corps (JSON)

ChampTypeDétails
method requis"CARD" | "SEPA"
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/payment/setup" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"method":"CARD"}'
GET/api/reseller/preferencesRevendeur#

Préférences : qui facture vos clients, essai, minutes de démo.

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/preferences" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "mode": "WHITE_LABEL",
  "billClients": true,
  "publicSite": true,
  "trialsEnabled": true,
  "trialDays": 14,
  "trialMinutes": 35,
  "sipDomains": [],
  "sipDefaultDomain": "sip.localhost",
  "platformDomains": [
    "sip.localhost"
  ],
  "ownDomain": null,
  "signupUrl": "http://demo-revendeur.partner.sip.localhost:5173/signup"
}
PUT/api/reseller/preferencesRevendeur#

Modifie vos préférences.

Corps (JSON)

ChampTypeDétails
billClients requisbooléen
publicSite requisbooléen
trialsEnabled requisbooléen
trialDays requisentierde 1 à 60
trialMinutes requisentierde 5 à 600
sipDomains requisliste de texte10 éléments au plus
sipDefaultDomain requistexte ou null
Exemple
curl -X PUT "https://api.hcloud.fr/api/reseller/preferences" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"billClients":true,"publicSite":true,"trialsEnabled":true,"trialDays":1,"trialMinutes":5,"sipDomains":["…"],"sipDefaultDomain":"…"}'
POST/api/reseller/system-audioRevendeur#

Remplace un message système par le vôtre (multipart : key, file).

Corps (multipart/form-data)

ChampTypeDétails
key requistexteMessage système (GET /api/reseller/system-audios)
file requisfichier
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/system-audio" \
  -H "Authorization: Bearer vxr_…" \
  -F "key=…" \
  -F "file=@fichier"
DELETE/api/reseller/system-audioRevendeur#

Rétablit le message système d’origine.

Exemple
curl -X DELETE "https://api.hcloud.fr/api/reseller/system-audio" \
  -H "Authorization: Bearer vxr_…"
GET/api/reseller/system-audio/listenRevendeur#

Écoute un message système.

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/system-audio/listen" \
  -H "Authorization: Bearer vxr_…"
GET/api/reseller/system-audiosRevendeur#

Messages système (annonces de la plateforme) personnalisables.

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/system-audios" \
  -H "Authorization: Bearer vxr_…"

Réponse

[
  {
    "key": "••••••••",
    "label": "Bienvenue (par défaut)",
    "hint": "Standard vocal ou scénario sans message d’accueil choisi",
    "custom": null
  },
  {
    "key": "••••••••",
    "label": "Touche invalide",
    "hint": "Mauvaise touche dans un standard vocal ou un scénario",
    "custom": null
  }
]
GET/api/reseller/teamRevendeur#

Les membres de votre équipe revendeur.

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/team" \
  -H "Authorization: Bearer vxr_…"

Réponse

[
  {
    "id": "cmwjdhkgf0004q7e056574kiw",
    "email": "demo-revendeur@hcloud.invalid",
    "name": "Paul Durand",
    "role": "RESELLER",
    "orgId": null,
    "locale": "fr",
    "status": "ACTIVE",
    "permissions": [],
    "emailVerified": false,
    "resellerId": "cmwjdhkgc0002q7e0dkez0qxp",
    "newsletterOptOut": false,
    "lastLoginAt": null
  }
]
POST/api/reseller/teamRevendeur#

Ajoute un membre à votre équipe (invitation par e-mail).

Corps (JSON)

ChampTypeDétails
name requistexte2 à 100 caractères
email requistextee-mail
password requistexte10 à 200 caractères
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/team" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"Julie Martin","email":"julie.martin@exemple.fr","password":"Un-mot-de-passe-solide"}'
DELETE/api/reseller/team/{id}Revendeur#

Supprime un membre de l’équipe.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X DELETE "https://api.hcloud.fr/api/reseller/team/{id}" \
  -H "Authorization: Bearer vxr_…"

Espace client clé en main

Connexion de vos clients à l’espace client que vous hébergez (dépôts publics voxnova-espace-client-node et voxnova-espace-client-php, prêts à installer) : vérification des identifiants avec votre clé, mot de passe oublié à vos couleurs.

POST/api/reseller/portal/forgotRevendeur#

Espace client hébergé chez vous : envoie le lien de réinitialisation du mot de passe à vos couleurs (resetUrl : votre page qui reçoit ?token=, puis POST /api/auth/reset). Réponse identique que le compte existe ou non.

Corps (JSON)

ChampTypeDétails
email requistextee-mail · 200 caractères au plus
resetUrltexteadresse web · 300 caractères au plus
clientIptexte60 caractères au plus
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/portal/forgot" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"email":"julie.martin@exemple.fr"}'
POST/api/reseller/portal/loginRevendeur#

Espace client hébergé chez vous : vérifie l’e-mail et le mot de passe d’un utilisateur d’un de VOS clients (puis le code de double authentification : réponse { mfaRequired: true } sans code). Ne délivre aucun jeton : agissez ensuite avec votre clé, X-Organization et X-User. Limité par clé et par adresse du visiteur (clientIp).

Corps (JSON)

ChampTypeDétails
email requistextee-mail · 200 caractères au plus
password requistexte1 à 200 caractères
codetexte6 à 20 caractères
clientIptexte60 caractères au plus
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/portal/login" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"email":"julie.martin@exemple.fr","password":"Un-mot-de-passe-solide"}'

Clients

Création des clients, abonnement, suspension, résiliation, fiche de facturation, SMS, lien de connexion automatique à leur panneau. Pour configurer le téléphone d’un client (utilisateurs, numéros, files…), utilisez les routes de la documentation « Clients » avec l’en-tête X-Organization.

GET/api/reseller/clientsRevendeur#

Vos clients avec leur abonnement en cours (?q= recherche).

Paramètres de requête

ChampTypeDétails
qtexte
Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/clients" \
  -H "Authorization: Bearer vxr_…"

Réponse

[
  {
    "id": "cmwjdhkgh0006q7e0mrvecev1",
    "sandbox": false,
    "sandboxOwnerId": null,
    "name": "Cabinet Lefèvre",
    "slug": "demo-client-revendeur",
    "sipDomain": "demo-client-revendeur.demo.invalid",
    "status": "ACTIVE",
    "billingEmail": null,
    "vatNumber": null,
    "address": null,
    "country": "FR",
    "trialEndsAt": null,
    "settings": {},
    "centrexEnabled": false,
    "timezone": "Europe/Paris",
    "defaultCallerId": null,
    "recordingRetentionDays": 90,
    "maxChannels": null,
    "pbxNodeId": null,
    "pbxHomeNodeId": null,
    "pbxPinned": false,
    "lat": null,
    "lon": null,
    "telecomBilledMonth": null,
    "apps": [],
    "mohId": null,
    "announceOverMusic": false,
    "announceMode": "alone",
    "announceMusicLevel": 25,
    "simpleMode": true,
    "product": "RELAY",
    "onboardingDone": false,
    "aiGranted": false,
    "postalCode": null,
    "inseeCode": null,
    "city": null,
    "blockPremium": true,
    "blockShortNumbers": true,
    "specialCapCents": 3000,
    "internationalCapCents": 3000
  },
  {
    "id": "cmvnthjy30000q767x21lez8y",
    "sandbox": false,
    "sandboxOwnerId": null,
    "name": "Horizon Services (démo)",
    "slug": "demo-commerciale",
    "sipDomain": "demo-commerciale.sip.localhost",
    "status": "ACTIVE",
    "billingEmail": "demo-test@hcloud.invalid",
    "vatNumber": null,
    "address": "24 quai Saint-Antoine",
    "country": "FR",
    "trialEndsAt": null,
    "settings": {},
    "centrexEnabled": true,
    "timezone": "Europe/Paris",
    "defaultCallerId": null,
    "recordingRetentionDays": 90,
    "maxChannels": 6,
    "pbxNodeId": null,
    "pbxHomeNodeId": null,
    "pbxPinned": false,
    "lat": null,
    "lon": null,
    "telecomBilledMonth": "2026-10",
    "apps": [
      "callcenter",
      "hotel"
    ],
    "mohId": null,
    "announceOverMusic": false,
    "announceMode": "alone",
    "announceMusicLevel": 25,
    "simpleMode": false,
    "product": "CENTREX_HOSTED",
    "onboardingDone": true,
    "aiGranted": true,
    "postalCode": "69002",
    "inseeCode": "69382",
    "city": "Lyon",
    "blockPremium": true,
    "blockShortNumbers": true,
    "specialCapCents": 3000,
    "internationalCapCents": 3000
  }
]
POST/api/reseller/clientsRevendeur#

Crée un client : entreprise, administrateur (e-mail et mot de passe), type de service, jours d’essai.

Corps (JSON)

ChampTypeDétails
company requistexte2 à 100 caractères
name requistexte2 à 100 caractères
email requistextee-mail
password requistexte10 à 200 caractères
product"CENTREX_HOSTED" | "CENTREX" | "RELAY" | "TRUNK" | "DEVELOPER"par défaut "CENTREX_HOSTED"
trialDaysentierde 0 à 60 · par défaut 14
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/clients" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"company":"Julie Martin","name":"Julie Martin","email":"julie.martin@exemple.fr","password":"Un-mot-de-passe-solide"}'
GET/api/reseller/clients/{id}Revendeur#

Fiche d’un client : utilisateurs, licences, factures, postes utilisés.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/clients/{id}" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "org": {
    "id": "cmwjdhkgh0006q7e0mrvecev1",
    "sandbox": false,
    "sandboxOwnerId": null,
    "name": "Cabinet Lefèvre",
    "slug": "demo-client-revendeur",
    "sipDomain": "demo-client-revendeur.demo.invalid",
    "status": "ACTIVE",
    "billingEmail": null,
    "vatNumber": null,
    "address": null,
    "country": "FR",
    "trialEndsAt": null,
    "settings": {},
    "centrexEnabled": false,
    "timezone": "Europe/Paris",
    "defaultCallerId": null,
    "recordingRetentionDays": 90,
    "maxChannels": null,
    "pbxNodeId": null,
    "pbxHomeNodeId": null,
    "pbxPinned": false,
    "lat": null,
    "lon": null,
    "telecomBilledMonth": null,
    "apps": [],
    "mohId": null,
    "announceOverMusic": false,
    "announceMode": "alone",
    "announceMusicLevel": 25,
    "simpleMode": true,
    "product": "RELAY",
    "onboardingDone": false,
    "aiGranted": false,
    "postalCode": null,
    "inseeCode": null,
    "city": null,
    "blockPremium": true,
    "blockShortNumbers": true,
    "specialCapCents": 3000,
    "internationalCapCents": 3000
  },
  "users": [
    {
      "id": "cmwjdjq42001iq7rril3gxir3",
      "email": "demo-client-admin@hcloud.invalid",
      "name": "Claire Lefèvre",
      "role": "ORG_ADMIN",
      "orgId": "cmwjdhkgh0006q7e0mrvecev1",
      "locale": "fr",
      "status": "ACTIVE",
      "permissions": [],
      "emailVerified": false,
      "newsletterOptOut": false,
      "lastLoginAt": null
    }
  ],
  "licenses": [],
  "invoices": [],
  "usage": {
    "used": 1,
    "seats": 0,
    "available": 0
  }
}
PATCH/api/reseller/clients/{id}Revendeur#

Suspend, réactive un client ou prolonge son essai.

Paramètres de chemin

ChampTypeDétails
id requistexte

Corps (JSON)

ChampTypeDétails
status"ACTIVE" | "SUSPENDED"
extendTrialDaysentierde 1 à 30
blockPremiumbooléen
blockShortNumbersbooléen
specialCapCentsentier ou null
internationalCapCentsentier ou null
rejectAnonymousbooléen
rejectNpvbooléen
teamsEnabledbooléen
Exemple
curl -X PATCH "https://api.hcloud.fr/api/reseller/clients/{id}" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"status":"ACTIVE","extendTrialDays":1,"blockPremium":true}'
POST/api/reseller/clients/{id}/impersonateRevendeur#

Ouvre une session dans le panneau du client, en tant que son administrateur.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/clients/{id}/impersonate" \
  -H "Authorization: Bearer vxr_…"
GET/api/reseller/clients/{id}/licensesRevendeur#

Licences d'un client (offre, quantités, échéances).

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/clients/{id}/licenses" \
  -H "Authorization: Bearer vxr_…"

Réponse

[]
POST/api/reseller/clients/{id}/login-linkRevendeur#

Lien de connexion automatique au panneau du client (usage unique, 60 s par défaut) : WHMCS « Se connecter », espace client du revendeur. `user` : e-mail ou identifiant d'un utilisateur du client (par défaut son administrateur) ; `next` : page d'arrivée.

Paramètres de chemin

ChampTypeDétails
id requistexte

Corps (JSON)

ChampTypeDétails
usertexte120 caractères au plus
nexttexte300 caractères au plus
ttlSecondsentierde 10 à 900
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/clients/{id}/login-link" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"user":"…","next":"…","ttlSeconds":10}'
PUT/api/reseller/clients/{id}/messagingRevendeur#

Option SMS / WhatsApp d'un client : activation, plafond WhatsApp, expéditeur par défaut (les crédits SMS : packs).

Paramètres de chemin

ChampTypeDétails
id requistexte

Corps (JSON)

ChampTypeDétails
messagingEnabled requisbooléen
waMonthlyLimitentierde 0 à 1000000
smsSendertexte ou null
Exemple
curl -X PUT "https://api.hcloud.fr/api/reseller/clients/{id}/messaging" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"messagingEnabled":true}'
PATCH/api/reseller/clients/{id}/profileRevendeur#

Coordonnées et réglages d'un client : raison sociale, facturation, adresse, fuseau horaire.

Paramètres de chemin

ChampTypeDétails
id requistexte

Corps (JSON)

ChampTypeDétails
nametexte2 à 120 caractères
billingEmailtexte ou null
vatNumbertexte ou null
addresstexte ou null
postalCodetexte ou null
countrytexte2 à 2 caractères
timezonetexte60 caractères au plus
Exemple
curl -X PATCH "https://api.hcloud.fr/api/reseller/clients/{id}/profile" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"Julie Martin","billingEmail":"julie.martin@exemple.fr","vatNumber":"…"}'
GET/api/reseller/clients/{id}/smsRevendeur#

SMS du client : crédits et consommation.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/clients/{id}/sms" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "credits": {
    "monthlyLimit": 0,
    "monthlyUsed": 0,
    "monthlyLeft": 0,
    "balance": 0,
    "available": 0,
    "metered": {
      "enabled": false,
      "unitPriceCents": 0,
      "unitPriceDeci": 0,
      "cap": null,
      "monthUsed": 0,
      "monthCents": 0,
      "left": null
    }
  },
  "blocks": []
}
POST/api/reseller/clients/{id}/sms/packRevendeur#

Ajoute un pack de SMS au client.

Paramètres de chemin

ChampTypeDétails
id requistexte

Corps (JSON)

ChampTypeDétails
packId requistexte
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/clients/{id}/sms/pack" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"packId":"…"}'
POST/api/reseller/clients/{id}/sms/sender-blocksRevendeur#

Interdit un expéditeur SMS pour ce client.

Paramètres de chemin

ChampTypeDétails
id requistexte

Corps (JSON)

ChampTypeDétails
kind"exact" | "prefix" | "contains"par défaut "exact"
value requistexte2 à 30 caractères
reasontexte200 caractères au plus · par défaut ""
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/clients/{id}/sms/sender-blocks" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"value":"…"}'
DELETE/api/reseller/clients/{id}/sms/sender-blocks/{blockId}Revendeur#

Lève l’interdiction d’un expéditeur.

Paramètres de chemin

ChampTypeDétails
id requistexte
blockId requistexte
Exemple
curl -X DELETE "https://api.hcloud.fr/api/reseller/clients/{id}/sms/sender-blocks/{blockId}" \
  -H "Authorization: Bearer vxr_…"
POST/api/reseller/clients/{id}/subscriptionRevendeur#

Abonne un client à une de vos offres (marque blanche, quand vous facturez vous-même) : postes, canaux, numéros, options, durée.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/clients/{id}/subscription" \
  -H "Authorization: Bearer vxr_…"
POST/api/reseller/clients/{id}/terminateRevendeur#

Fin de contrat (résiliation WHMCS) : abonnements annulés et compte suspendu. Les données sont conservées.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/clients/{id}/terminate" \
  -H "Authorization: Bearer vxr_…"

Offres et catalogue

Vos offres (prix par poste, par canal, options) et le catalogue de la plateforme.

GET/api/reseller/catalogRevendeur#

Offres de l'éditeur (prix de gros ou commission) et offres du revendeur (marque blanche).

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/catalog" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "mode": "WHITE_LABEL",
  "discountPercent": 20,
  "commissionPercent": 15,
  "basePlans": [
    {
      "id": "cmuxgv7nk001sq7zpeoa1u6o4",
      "code": "ia-muxgv7jr",
      "name": "Centrex IA muxgv7jr",
      "description": "",
      "pricePerSeatCents": 0,
      "currency": "EUR",
      "interval": "MONTH",
      "minSeats": 1,
      "maxSeats": 1000,
      "features": {},
      "kind": "CENTREX",
      "centrex": false,
      "channelsPerSeat": 0,
      "numbersIncluded": 0,
      "trunkId": "cmuxgv7n0001mq7zpuro1e81o",
      "apps": [],
      "pricePerChannelCents": 500,
      "unlimitedChannelsCents": null,
      "pricePerNumberCents": 200,
      "maxChannels": 20,
      "unlimitedCallsCents": null,
      "aiAnalysisCents": 900,
      "teamsCents": null,
      "basePriceCents": 0,
      "callRates": [],
      "unlimitedCallsScope": "BOTH",
      "resellerId": null,
      "basePlanId": null,
      "active": true,
      "sortOrder": 0,
      "createdAt": "2026-10-07T02:06:34.113Z",
      "product": "CENTREX_HOSTED",
      "wholesale": {
        "pricePerSeatCents": 0,
        "pricePerChannelCents": 400,
        "unlimitedChannelsCents": null,
        "pricePerNumberCents": 160,
        "unlimitedCallsCents": null,
        "aiAnalysisCents": 720,
        "teamsCents": null,
        "basePriceCents": 0
      }
    },
    {
      "id": "cmuv4p4xo0001q78ywqmyr45l",
      "code": "essentiel",
      "name": "Essentiel",
      "description": "Softphone web, bureau et mobile avec réveil push. Idéal pour les petites équipes.",
      "pricePerSeatCents": 990,
      "currency": "EUR",
      "interval": "MONTH",
      "minSeats": 1,
      "maxSeats": 50,
      "features": {
        "web": true,
        "chat": true,
        "push": true,
        "mobile": true,
        "desktop": true,
        "gateway": true,
        "presence": true,
        "recording": false,
        "conference": false,
        "maxSipServers": 1
      },
      "kind": "RELAY",
      "centrex": false,
      "channelsPerSeat": 0,
      "numbersIncluded": 0,
      "trunkId": null,
      "apps": [],
      "pricePerChannelCents": 0,
      "unlimitedChannelsCents": null,
      "pricePerNumberCents": 0,
      "maxChannels": 100,
      "unlimitedCallsCents": null,
      "aiAnalysisCents": null,
      "teamsCents": null,
      "basePriceCents": 0,
      "callRates": [],
      "unlimitedCallsScope": "BOTH",
      "resellerId": null,
      "basePlanId": null,
      "active": true,
      "sortOrder": 1,
      "createdAt": "2026-10-05T10:50:22.908Z",
      "product": "RELAY",
      "wholesale": {
        "pricePerSeatCents": 792,
        "pricePerChannelCents": 0,
        "unlimitedChannelsCents": null,
        "pricePerNumberCents": 0,
        "unlimitedCallsCents": null,
        "aiAnalysisCents": null,
        "teamsCents": null,
        "basePriceCents": 0
      }
    }
  ],
  "plans": [
    {
      "id": "cmwjdjq3w001cq7rrx8sk4erc",
      "code": "demo-revendeur-pro",
      "name": "Offre Pro",
      "description": "",
      "pricePerSeatCents": 1500,
      "currency": "EUR",
      "interval": "MONTH",
      "minSeats": 1,
      "maxSeats": 1000,
      "features": {},
      "kind": "RELAY",
      "centrex": false,
      "channelsPerSeat": 0,
      "numbersIncluded": 0,
      "trunkId": null,
      "apps": [],
      "pricePerChannelCents": 0,
      "unlimitedChannelsCents": null,
      "pricePerNumberCents": 0,
      "maxChannels": 100,
      "unlimitedCallsCents": null,
    
…
POST/api/reseller/plansRevendeur#

Crée une offre.

Corps (JSON)

ChampTypeDétails
pricePerSeatCents requisentierde 0 à 10000000
pricePerChannelCentsentierde 0 à 10000000 · par défaut 0
unlimitedChannelsCentsentier ou null
pricePerNumberCentsentierde 0 à 9007199254740991 · par défaut 0
unlimitedCallsCentsentier ou null
aiAnalysisCentsentier ou null
teamsCentsentier ou null
basePriceCentsentierde 0 à 9007199254740991 · par défaut 0
basePlanId requistexte
name requistexte1 à 100 caractères
descriptiontexte500 caractères au plus · par défaut ""
activebooléenpar défaut true
sortOrderentierde -9007199254740991 à 9007199254740991 · par défaut 0
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/plans" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"pricePerSeatCents":0,"basePlanId":"…","name":"Julie Martin"}'
PUT/api/reseller/plans/{id}Revendeurpartiel#

Modifie une offre.

Modification partielle : seuls les champs envoyés sont modifiés.

Paramètres de chemin

ChampTypeDétails
id requistexte

Corps (JSON)

ChampTypeDétails
pricePerSeatCentsentierde 0 à 10000000
pricePerChannelCentsentierde 0 à 10000000 · par défaut 0
unlimitedChannelsCentsentier ou null
pricePerNumberCentsentierde 0 à 9007199254740991 · par défaut 0
unlimitedCallsCentsentier ou null
aiAnalysisCentsentier ou null
teamsCentsentier ou null
basePriceCentsentierde 0 à 9007199254740991 · par défaut 0
nametexte1 à 100 caractères
descriptiontexte500 caractères au plus · par défaut ""
activebooléenpar défaut true
sortOrderentierde -9007199254740991 à 9007199254740991 · par défaut 0
Exemple
curl -X PUT "https://api.hcloud.fr/api/reseller/plans/{id}" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"pricePerSeatCents":0,"pricePerChannelCents":0,"unlimitedChannelsCents":0}'
DELETE/api/reseller/plans/{id}Revendeur#

Supprime une offre.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X DELETE "https://api.hcloud.fr/api/reseller/plans/{id}" \
  -H "Authorization: Bearer vxr_…"

Facturation

Factures de vos clients (validation d’un paiement, annulation), relevés mensuels de commissions ou de reversement.

GET/api/reseller/invoicesRevendeur#

Factures de vos clients (filtre par état).

Paramètres de requête

ChampTypeDétails
pageentierde 1 à 9007199254740991 · par défaut 1
pageSizeentierde 1 à 200 · par défaut 50
statustexte
Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/invoices" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "items": [],
  "total": 0,
  "canValidate": true
}
GET/api/reseller/invoices/{id}Revendeur#

Détail d’une facture.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/invoices/{id}" \
  -H "Authorization: Bearer vxr_…"
POST/api/reseller/invoices/{id}/cancelRevendeur#

Annule une facture non réglée.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/invoices/{id}/cancel" \
  -H "Authorization: Bearer vxr_…"
POST/api/reseller/invoices/{id}/validateRevendeur#

Marque blanche : le revendeur encaisse ses clients et valide leurs paiements (active ou prolonge l'abonnement).

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/invoices/{id}/validate" \
  -H "Authorization: Bearer vxr_…"
GET/api/reseller/statementsRevendeur#

Relevés mensuels (commissions ou reversements).

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/statements" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "mode": "WHITE_LABEL",
  "commissionPercent": 15,
  "discountPercent": 20,
  "months": [
    {
      "month": "2026-11",
      "mode": "WHITE_LABEL",
      "retailCents": 0,
      "wholesaleCents": 0,
      "commissionCents": 0,
      "balanceCents": 0,
      "settled": null,
      "invoices": 0
    },
    {
      "month": "2026-10",
      "mode": "WHITE_LABEL",
      "retailCents": 0,
      "wholesaleCents": 0,
      "commissionCents": 0,
      "balanceCents": 0,
      "settled": null,
      "invoices": 0
    }
  ]
}
GET/api/reseller/statements/{month}Revendeur#

Relevé d’un mois (AAAA-MM) détaillé par client.

Paramètres de chemin

ChampTypeDétails
month requistexte
Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/statements/{month}" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "month": "2026-10",
  "mode": "WHITE_LABEL",
  "lines": [],
  "retailCents": 0,
  "wholesaleCents": 0,
  "commissionCents": 0,
  "balanceCents": 0,
  "settled": null
}

SMS

Envoyer un SMS au nom d’un client : POST /api/v1/sms avec X-Organization (voir le guide « Envoyer un SMS »). Suivi, crédits du client, packs de SMS proposés à vos clients, expéditeurs interdits.

GET/api/reseller/smsRevendeur#

Tous les SMS des clients du revendeur (suivi de remise).

Paramètres de requête

ChampTypeDétails
orgIdtexte
statustexte
pageentierde 1 à 9007199254740991 · par défaut 1
Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/sms" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "total": 0,
  "items": []
}
GET/api/reseller/sms/packsRevendeur#

Packs de SMS.

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/sms/packs" \
  -H "Authorization: Bearer vxr_…"

Réponse

[
  {
    "id": "cmwjdjq3z001eq7rram33vul6",
    "resellerId": "cmwjdhkgc0002q7e0dkez0qxp",
    "name": "Pack 1 000 SMS",
    "kind": "LIFETIME",
    "credits": 1000,
    "priceCents": 0,
    "active": true,
    "createdAt": "2026-11-16T14:44:17.519Z"
  }
]
POST/api/reseller/sms/packsRevendeur#

Crée un pack de SMS.

Corps (JSON)

ChampTypeDétails
name requistexte1 à 80 caractères
kind requis"MONTHLY" | "LIFETIME"
credits requisentierde 1 à 10000000
priceCentsentierde 0 à 100000000 · par défaut 0
activebooléenpar défaut true
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/sms/packs" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"Julie Martin","kind":"MONTHLY","credits":1}'
PUT/api/reseller/sms/packs/{id}Revendeurpartiel#

Modifie un pack de SMS.

Modification partielle : seuls les champs envoyés sont modifiés.

Paramètres de chemin

ChampTypeDétails
id requistexte

Corps (JSON)

ChampTypeDétails
nametexte1 à 80 caractères
kind"MONTHLY" | "LIFETIME"
creditsentierde 1 à 10000000
priceCentsentierde 0 à 100000000 · par défaut 0
activebooléenpar défaut true
Exemple
curl -X PUT "https://api.hcloud.fr/api/reseller/sms/packs/{id}" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"Julie Martin","kind":"MONTHLY","credits":1}'
DELETE/api/reseller/sms/packs/{id}Revendeur#

Supprime un pack de SMS.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X DELETE "https://api.hcloud.fr/api/reseller/sms/packs/{id}" \
  -H "Authorization: Bearer vxr_…"
GET/api/reseller/sms/sender-blocksRevendeur#

Expéditeurs SMS interdits.

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/sms/sender-blocks" \
  -H "Authorization: Bearer vxr_…"

Réponse

[]
POST/api/reseller/sms/sender-blocksRevendeur#

Crée un expéditeur interdit.

Corps (JSON)

ChampTypeDétails
kind"exact" | "prefix" | "contains"par défaut "exact"
value requistexte2 à 30 caractères
reasontexte200 caractères au plus · par défaut ""
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/sms/sender-blocks" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"value":"…"}'
DELETE/api/reseller/sms/sender-blocks/{id}Revendeur#

Supprime un expéditeur interdit.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X DELETE "https://api.hcloud.fr/api/reseller/sms/sender-blocks/{id}" \
  -H "Authorization: Bearer vxr_…"
GET/api/v1/smsRevendeur#

Liste des SMS (filtres : status, to, tag, since)

Avec l’en-tête X-Organization : au nom du client.

Paramètres de requête

ChampTypeDétails
pageentier1 au moins · par défaut 1
pageSizeentier100 au plus
statustexte
totexte
tagtexte
sincetextedate et heure ISO 8601
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/sms" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "items": [
    {
      "id": "…",
      "to": "+33612345678",
      "text": "…"
    }
  ],
  "total": 1,
  "page": 1
}

Champs de la réponse

ChampTypeDétails
itemsliste de objet
items[].idtexte
items[].totexteNuméro E.164
items[].texttexte
items[].status"queued" | "sent" | "delivered" | "failed"queued : en file ; sent : accepté par l’opérateur ; delivered : remis ; failed : échec
items[].providerStatustexte ou nullDernier état du fournisseur : accepted, sent, delivered, hard_bounce…
items[].messageIdtexte ou nullIdentifiant de suivi du message chez l’opérateur SMS
items[].sendertexte ou null
items[].tagtexte ou null
items[].type"transactional" | "marketing" | null
items[].segmentsentierCrédits consommés
items[].channeltexte ou null
items[].errortexte ou null
items[].createdAttextedate et heure ISO 8601
items[].sentAttexte ou null
items[].deliveredAttexte ou null
items[].eventsliste de objet
items[].events[].statustexte
items[].events[].attextedate et heure ISO 8601
totalentier
pageentier
POST/api/v1/smsRevendeur#

Envoyer un SMS : mis en file, part en quelques secondes ; statuts par webhook sms.status ou GET /api/v1/sms/{id}

Avec l’en-tête X-Organization : au nom du client.

Corps (JSON)

ChampTypeDétails
to requistexteMobile du destinataire : 0612345678, 06 12 34 56 78 ou +33612345678 (mobiles français, 06 et 07)
text requistexte160 caractères par SMS (153 par partie au-delà) ; 70 (67) avec ê, â, î, ô, û, ç minuscule ou un emoji — 1000 caractères au plus
sendertexteExpéditeur affiché (3 à 11 lettres/chiffres) ; refusé s’il figure sur une liste de blocage
tagtexteÉtiquette libre, renvoyée dans les statuts
type"transactional" | "marketing"par défaut "transactional"
channel"sms" | "whatsapp" | "auto"auto : WhatsApp si possible, sinon SMS — par défaut "sms"
inviteTexttextechannel whatsapp ou auto : SMS d’invitation envoyé si WhatsApp refuse un premier contact ({{whatsapp_lien}} y insère le lien) — 600 caractères au plus
statusCallbacktexteAdresse prévenue à chaque changement de statut de ce message (JSON signé : voir /api/v1/sms/callback-secret) — adresse web
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/sms" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"to":"+33612345678","text":"…"}'

Réponse

{
  "id": "…",
  "to": "+33612345678",
  "text": "…"
}

Champs de la réponse

ChampTypeDétails
idtexte
totexteNuméro E.164
texttexte
status"queued" | "sent" | "delivered" | "failed"queued : en file ; sent : accepté par l’opérateur ; delivered : remis ; failed : échec
providerStatustexte ou nullDernier état du fournisseur : accepted, sent, delivered, hard_bounce…
messageIdtexte ou nullIdentifiant de suivi du message chez l’opérateur SMS
sendertexte ou null
tagtexte ou null
type"transactional" | "marketing" | null
segmentsentierCrédits consommés
channeltexte ou null
errortexte ou null
createdAttextedate et heure ISO 8601
sentAttexte ou null
deliveredAttexte ou null
eventsliste de objet
events[].statustexte
events[].attextedate et heure ISO 8601
GET/api/v1/sms/{id}Revendeur#

Un SMS et ses événements de remise (accepted, sent, delivered…)

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
id requistexteIdentifiant ou messageId du fournisseur
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/sms/{id}" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "id": "…",
  "to": "+33612345678",
  "text": "…"
}

Champs de la réponse

ChampTypeDétails
idtexte
totexteNuméro E.164
texttexte
status"queued" | "sent" | "delivered" | "failed"queued : en file ; sent : accepté par l’opérateur ; delivered : remis ; failed : échec
providerStatustexte ou nullDernier état du fournisseur : accepted, sent, delivered, hard_bounce…
messageIdtexte ou nullIdentifiant de suivi du message chez l’opérateur SMS
sendertexte ou null
tagtexte ou null
type"transactional" | "marketing" | null
segmentsentierCrédits consommés
channeltexte ou null
errortexte ou null
createdAttextedate et heure ISO 8601
sentAttexte ou null
deliveredAttexte ou null
eventsliste de objet
events[].statustexte
events[].attextedate et heure ISO 8601
GET/api/v1/sms/balanceRevendeur#

Crédits SMS : forfait du mois et solde à vie

Avec l’en-tête X-Organization : au nom du client.

Exemple
curl -X GET "https://api.hcloud.fr/api/v1/sms/balance" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "monthlyLimit": 1,
  "monthlyUsed": 1,
  "monthlyLeft": 1
}

Champs de la réponse

ChampTypeDétails
monthlyLimitentierForfait du mois (remis à zéro chaque mois)
monthlyUsedentier
monthlyLeftentier
balanceentierSolde à vie (sans expiration), utilisé après le forfait du mois
availableentierForfait restant + solde
meteredobjetSMS au comptage : facturés à l’unité en fin de mois une fois le forfait et le solde épuisés
metered.enabledbooléen
metered.unitPriceCentsnombreTarif HT d’un SMS en centimes (5.8 = 0,058 €)
metered.capentier ou nullPlafond mensuel (null : sans plafond)
metered.monthUsedentier
metered.monthCentsentierMontant HT du mois
metered.leftentier ou nullSMS au comptage encore autorisés ce mois-ci
GET/api/v1/sms/callback-secretRevendeur#

Secret de signature des rappels de statut propres à un message (statusCallback) : X-VoxNova-Signature: sha256=<HMAC-SHA256 du corps>

Avec l’en-tête X-Organization : au nom du client.

Exemple
curl -X GET "https://api.hcloud.fr/api/v1/sms/callback-secret" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "secret": "…"
}

Champs de la réponse

ChampTypeDétails
secrettexte

Au nom d’un client

Routes de l’API v1 utilisées avec X-Organization : portabilité, clic pour appeler, messagerie vocale, lien de connexion. Toutes les autres routes du client sont dans la documentation « API clients ».

GET/api/v1/call-context/{token}Revendeur#

Contexte d’un appel passé par un scénario : fiche CRM, variables (code tapé, client identifié…), appelant, numéro appelé. Pour un softphone intégré à votre logiciel (webphone : option resolveContext).

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
token requistexteJeton de l’appel (en-tête SIP X-VX-Ctx reçu par le softphone)
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/call-context/{token}" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "token": "…",
  "caller": "+33612345678",
  "did": "…"
}

Champs de la réponse

ChampTypeDétails
tokentexte
callertexte
didtexte
crmUrltexte ou null
openOnAnswerbooléen
varsobjet
POST/api/v1/callbacksRevendeur#

Demander à être rappelé (file d’attente ou poste)

Avec l’en-tête X-Organization : au nom du client.

Corps (JSON)

ChampTypeDétails
phone requistexte6 à 25 caractères
nametexte100 caractères au plus
notetexte300 caractères au plus
targetType requis"queue" | "extension"
targetId requistexte
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/callbacks" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"phone":"+33612345678","targetType":"queue","targetId":"…"}'

Réponse

{}
GET/api/v1/callbacks/{id}Revendeur#

État d’une demande de rappel

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
id requistexteIdentifiant
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/callbacks/{id}" \
  -H "Authorization: Bearer vxr_…"

Réponse

{}
GET/api/v1/cdrRevendeur#

Journal des appels

Avec l’en-tête X-Organization : au nom du client.

Paramètres de requête

ChampTypeDétails
pageentier1 au moins · par défaut 1
pageSizeentierde 1 à 100 · par défaut 25
sincetextedate et heure ISO 8601
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/cdr" \
  -H "Authorization: Bearer vxr_…"

Réponse

{}
POST/api/v1/click-to-callRevendeur#

Clic pour appeler : le poste sonne, puis le numéro est appelé au décroché (droits du poste)

Avec l’en-tête X-Organization : au nom du client.

Corps (JSON)

ChampTypeDétails
to requistexteNuméro à appeler (chiffres, +, *, #)
extensiontextePoste qui sonne : identifiant ou numéro interne (ou « user »)
usertexteUtilisateur dont le poste sonne : identifiant ou e-mail (au lieu de « extension »)
autoAnswerbooléenDécroché automatique du poste (applications VoxNova, téléphones de bureau compatibles) — par défaut false
labeltexteNom affiché sur le poste qui sonne
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/click-to-call" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"to":"0612345678"}'

Réponse

{
  "callId": "…",
  "status": "ringing",
  "extension": "…"
}

Champs de la réponse

ChampTypeDétails
callIdtexteUUID
status"ringing" | "dialing" | "in_progress" | "completed" | "not_answered" | "failed"
extensiontexte
totexte
durationSecentier
hangupCausetexte
GET/api/v1/click-to-call/{id}Revendeur#

État : ringing (le poste sonne), dialing (numéro composé), in_progress, completed, not_answered, failed

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
id requistextecallId renvoyé au lancement
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/click-to-call/{id}" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "callId": "…",
  "status": "ringing",
  "extension": "…"
}

Champs de la réponse

ChampTypeDétails
callIdtexteUUID
status"ringing" | "dialing" | "in_progress" | "completed" | "not_answered" | "failed"
extensiontexte
totexte
durationSecentier
hangupCausetexte
DELETE/api/v1/click-to-call/{id}Revendeur#

Raccrocher (qu’il sonne encore ou soit en cours)

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
id requistextecallId renvoyé au lancement
Exemple
curl -X DELETE "https://api.hcloud.fr/api/v1/click-to-call/{id}" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "callId": "…",
  "cancelled": true
}

Champs de la réponse

ChampTypeDétails
callIdtexte
cancelledbooléen
POST/api/v1/login-linksRevendeur#

Lien de connexion automatique au panneau de votre entreprise (usage unique, 60 s)

Avec l’en-tête X-Organization : au nom du client.

Corps (JSON)

ChampTypeDétails
usertexteE-mail ou identifiant d’un utilisateur du client (défaut : son administrateur)
nexttextePage d’arrivée dans le panneau : chemin relatif (ex. /admin)
ttlSecondsentierde 10 à 900 · par défaut 60
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/login-links" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"user":"…","next":"…","ttlSeconds":60}'

Réponse

{
  "url": "https://exemple.fr/webhook",
  "expiresAt": "2026-12-01T09:00:00Z",
  "expiresIn": 1
}

Champs de la réponse

ChampTypeDétails
urltexteAdresse à usage unique : ouvre le panneau connecté
expiresAttextedate et heure ISO 8601
expiresInentier
userobjet
user.idtexte
user.emailtexte
user.roletexte
GET/api/v1/lookup/{number}Revendeur#

Consulter un numéro : validité, pays, type de ligne (mobile, fixe, VoIP, gratuit, surtaxé, objets connectés), formats national et international

Calculé à partir du plan de numérotation, sans service extérieur ni enregistrement. L’opérateur n’est pas indiqué (carrier: null) : avec la portabilité, l’opérateur d’origine ne dit pas qui exploite le numéro. Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
number requistexteNuméro (national ou E.164 encodé : %2B33…)
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/lookup/{number}" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "input": "…",
  "valid": true,
  "number": "+33612345678"
}

Champs de la réponse

ChampTypeDétails
inputtexte
validbooléen
numbertexte ou null
countrytexte ou null
type"mobile" | "fixed" | "voip" | "tollfree" | "premium" | "shared_cost" | "m2m" | "unknown"
detailtexte
nationalFormattexte ou null
internationalFormattexte ou null
carriernull
GET/api/v1/portingRevendeur#

Demandes de portabilité (filtres : status, number)

Avec l’en-tête X-Organization : au nom du client.

Paramètres de requête

ChampTypeDétails
pageentier1 au moins · par défaut 1
pageSizeentier100 au plus
statustexte
numbertexte
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/porting" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "items": [
    {
      "id": "…",
      "status": "AWAITING_SIGNATURE",
      "statusLabel": "…"
    }
  ],
  "total": 1,
  "page": 1
}

Champs de la réponse

ChampTypeDétails
itemsliste de objet
items[].idtexte
items[].status"AWAITING_SIGNATURE" | "SUBMITTED" | "IN_PROGRESS" | "SCHEDULED" | "DONE" | "REJECTED" | "CANCELLED"AWAITING_SIGNATURE : mandat à signer ; SUBMITTED : reçue ; IN_PROGRESS : en traitement ; SCHEDULED : date de portage fixée ; DONE : numéros portés (ajoutés au compte) ; REJECTED : refusée ; CANCELLED : annulée
items[].statusLabeltexte
items[].numbersliste de texte
items[].numberType"FIXE" | "MOBILE"
items[].holderNametexte
items[].sirettexte ou null
items[].addresstexte ou null
items[].currentOperatortexte
items[].operatorsliste de objetOpérateur actuel de chaque numéro (bases de portabilité)
items[].riotexte ou null
items[].desiredDatetexte ou nulldate et heure ISO 8601
items[].scheduledAttexte ou nullDate de portage fixée — date et heure ISO 8601
items[].contactNametexte
items[].contactEmailtexte
items[].contactPhonetexte ou null
items[].notestexte
items[].messagetexte ou nullMessage de l’équipe (motif de refus, précisions)
items[].mandateSignedbooléen
items[].awaitingSignaturebooléen
items[].filesliste de objet
items[].files[].indexentier
items[].files[].nametexte
items[].files[].sizeentier
items[].files[].typetexte
items[].historyliste de objet
items[].history[].attexte
items[].history[].statustexte
items[].history[].notetexte ou null
items[].createdAttextedate et heure ISO 8601
items[].updatedAttextedate et heure ISO 8601
totalentier
pageentier
POST/api/v1/portingRevendeur#

Demander la portabilité de numéros (JSON avec documents en base64, ou multipart : champ data + fichiers)

Avec l’en-tête X-Organization : au nom du client.

Corps (JSON)

ChampTypeDétails
numbers requisliste de texteNuméros à porter (01 23 45 67 89, +33…), 200 au plus
numberType"FIXE" | "MOBILE"par défaut "FIXE"
holderName requistexteTitulaire de la ligne chez l’opérateur actuel
sirettexte14 chiffres (professionnels)
addresstexte
currentOperatortexteFacultatif : relevé automatiquement dans les bases de portabilité
riotexteObligatoire pour les mobiles : 12 caractères (3179 depuis la ligne). La clé est vérifiée pour un numéro unique.
desiredDatetextedate et heure ISO 8601
contactName requistexte
contactEmail requistextee-mail
contactPhonetexte
notestexte
documentsliste de objetFacture récente, mandat signé… (PDF, PNG, JPEG, WebP ; 10 Mo). Inutiles quand le mandat est signé en ligne (`GET /api/v1/porting/config` : esign). — 5 éléments au plus
documents[].name requistexte
documents[].type requistexte
documents[].content requistexteContenu en base64
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/porting" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"numbers":["…"],"holderName":"Julie Martin","contactName":"Julie Martin","contactEmail":"julie.martin@exemple.fr"}'

Réponse

{
  "id": "…",
  "status": "AWAITING_SIGNATURE",
  "statusLabel": "…"
}

Champs de la réponse

ChampTypeDétails
idtexte
status"AWAITING_SIGNATURE" | "SUBMITTED" | "IN_PROGRESS" | "SCHEDULED" | "DONE" | "REJECTED" | "CANCELLED"AWAITING_SIGNATURE : mandat à signer ; SUBMITTED : reçue ; IN_PROGRESS : en traitement ; SCHEDULED : date de portage fixée ; DONE : numéros portés (ajoutés au compte) ; REJECTED : refusée ; CANCELLED : annulée
statusLabeltexte
numbersliste de texte
numberType"FIXE" | "MOBILE"
holderNametexte
sirettexte ou null
addresstexte ou null
currentOperatortexte
operatorsliste de objetOpérateur actuel de chaque numéro (bases de portabilité)
riotexte ou null
desiredDatetexte ou nulldate et heure ISO 8601
scheduledAttexte ou nullDate de portage fixée — date et heure ISO 8601
contactNametexte
contactEmailtexte
contactPhonetexte ou null
notestexte
messagetexte ou nullMessage de l’équipe (motif de refus, précisions)
mandateSignedbooléen
awaitingSignaturebooléen
filesliste de objet
files[].indexentier
files[].nametexte
files[].sizeentier
files[].typetexte
historyliste de objet
history[].attexte
history[].statustexte
history[].notetexte ou null
createdAttextedate et heure ISO 8601
updatedAttextedate et heure ISO 8601
GET/api/v1/porting/{id}Revendeur#

Une demande : état, historique, documents

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
id requistexteIdentifiant
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/porting/{id}" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "id": "…",
  "status": "AWAITING_SIGNATURE",
  "statusLabel": "…"
}

Champs de la réponse

ChampTypeDétails
idtexte
status"AWAITING_SIGNATURE" | "SUBMITTED" | "IN_PROGRESS" | "SCHEDULED" | "DONE" | "REJECTED" | "CANCELLED"AWAITING_SIGNATURE : mandat à signer ; SUBMITTED : reçue ; IN_PROGRESS : en traitement ; SCHEDULED : date de portage fixée ; DONE : numéros portés (ajoutés au compte) ; REJECTED : refusée ; CANCELLED : annulée
statusLabeltexte
numbersliste de texte
numberType"FIXE" | "MOBILE"
holderNametexte
sirettexte ou null
addresstexte ou null
currentOperatortexte
operatorsliste de objetOpérateur actuel de chaque numéro (bases de portabilité)
riotexte ou null
desiredDatetexte ou nulldate et heure ISO 8601
scheduledAttexte ou nullDate de portage fixée — date et heure ISO 8601
contactNametexte
contactEmailtexte
contactPhonetexte ou null
notestexte
messagetexte ou nullMessage de l’équipe (motif de refus, précisions)
mandateSignedbooléen
awaitingSignaturebooléen
filesliste de objet
files[].indexentier
files[].nametexte
files[].sizeentier
files[].typetexte
historyliste de objet
history[].attexte
history[].statustexte
history[].notetexte ou null
createdAttextedate et heure ISO 8601
updatedAttextedate et heure ISO 8601
POST/api/v1/porting/{id}/cancelRevendeur#

Annuler une demande (états : mandat à signer, reçue, en cours ; plus possible une fois la date de portage fixée)

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
id requistexteIdentifiant
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/porting/{id}/cancel" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "id": "…",
  "status": "AWAITING_SIGNATURE",
  "statusLabel": "…"
}

Champs de la réponse

ChampTypeDétails
idtexte
status"AWAITING_SIGNATURE" | "SUBMITTED" | "IN_PROGRESS" | "SCHEDULED" | "DONE" | "REJECTED" | "CANCELLED"AWAITING_SIGNATURE : mandat à signer ; SUBMITTED : reçue ; IN_PROGRESS : en traitement ; SCHEDULED : date de portage fixée ; DONE : numéros portés (ajoutés au compte) ; REJECTED : refusée ; CANCELLED : annulée
statusLabeltexte
numbersliste de texte
numberType"FIXE" | "MOBILE"
holderNametexte
sirettexte ou null
addresstexte ou null
currentOperatortexte
operatorsliste de objetOpérateur actuel de chaque numéro (bases de portabilité)
riotexte ou null
desiredDatetexte ou nulldate et heure ISO 8601
scheduledAttexte ou nullDate de portage fixée — date et heure ISO 8601
contactNametexte
contactEmailtexte
contactPhonetexte ou null
notestexte
messagetexte ou nullMessage de l’équipe (motif de refus, précisions)
mandateSignedbooléen
awaitingSignaturebooléen
filesliste de objet
files[].indexentier
files[].nametexte
files[].sizeentier
files[].typetexte
historyliste de objet
history[].attexte
history[].statustexte
history[].notetexte ou null
createdAttextedate et heure ISO 8601
updatedAttextedate et heure ISO 8601
GET/api/v1/porting/{id}/files/{index}Revendeur#

Télécharger un document

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
id requistexteIdentifiant
index requistextePosition du document
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/porting/{id}/files/{index}" \
  -H "Authorization: Bearer vxr_…"
GET/api/v1/porting/{id}/signRevendeur#

Lien de signature du mandat (état AWAITING_SIGNATURE)

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
id requistexteIdentifiant
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/porting/{id}/sign" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "url": "https://exemple.fr/webhook"
}

Champs de la réponse

ChampTypeDétails
urltexteadresse web
GET/api/v1/porting/configRevendeur#

Mandat signé en ligne (esign) et limites des documents

Avec l’en-tête X-Organization : au nom du client.

Exemple
curl -X GET "https://api.hcloud.fr/api/v1/porting/config" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "esign": true,
  "documents": {}
}

Champs de la réponse

ChampTypeDétails
esignbooléen
documentsobjet
GET/api/v1/porting/operatorRevendeur#

Opérateur actuel d’un numéro (bases de portabilité)

Avec l’en-tête X-Organization : au nom du client.

Paramètres de requête

ChampTypeDétails
number requistexte
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/porting/operator" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "operator": "…",
  "inProgress": true
}

Champs de la réponse

ChampTypeDétails
operatortexte ou null
inProgressbooléen ou null
POST/api/v1/verifyRevendeur#

Envoyer un code de vérification (SMS, WhatsApp, ou WhatsApp sinon SMS)

Code à usage unique tiré au hasard, jamais renvoyé ni stocké en clair. Nouveau code si une vérification est en cours pour ce numéro. Limites : 1 envoi / 30 s et 5 / heure par numéro, 1 000 / heure par entreprise ; numéros surtaxés refusés. Compté comme un SMS transactionnel (étiquette verify). Avec l’en-tête X-Organization : au nom du client.

Corps (JSON)

ChampTypeDétails
to requistexteNuméro du destinataire
channel"sms" | "whatsapp" | "auto"par défaut "sms"
codeLengthentierde 4 à 10 · par défaut 6
ttlSecondsentierde 60 à 1800 · par défaut 600
brandtexteNom affiché dans le message (défaut : votre entreprise) — 30 caractères au plus
locale"fr" | "en"par défaut "fr"
tagtexte100 caractères au plus
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/verify" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"to":"+33612345678"}'

Réponse

{
  "id": "…",
  "to": "+33612345678",
  "channel": "sms"
}

Champs de la réponse

ChampTypeDétails
idtexte
totexte
channel"sms" | "whatsapp" | "auto"
status"pending" | "approved" | "expired" | "failed" | "canceled"
attemptsLeftentier
sendsentier
tagtexte ou null
expiresAttextedate et heure ISO 8601
approvedAttexte ou nulldate et heure ISO 8601
createdAttextedate et heure ISO 8601
GET/api/v1/verify/{id}Revendeur#

État d’une vérification (pending, approved, expired, failed, canceled)

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
id requistexteIdentifiant
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/verify/{id}" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "id": "…",
  "to": "+33612345678",
  "channel": "sms"
}

Champs de la réponse

ChampTypeDétails
idtexte
totexte
channel"sms" | "whatsapp" | "auto"
status"pending" | "approved" | "expired" | "failed" | "canceled"
attemptsLeftentier
sendsentier
tagtexte ou null
expiresAttextedate et heure ISO 8601
approvedAttexte ou nulldate et heure ISO 8601
createdAttextedate et heure ISO 8601
POST/api/v1/verify/{id}/cancelRevendeur#

Annuler une vérification en cours

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
id requistexteIdentifiant
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/verify/{id}/cancel" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "id": "…",
  "to": "+33612345678",
  "channel": "sms"
}

Champs de la réponse

ChampTypeDétails
idtexte
totexte
channel"sms" | "whatsapp" | "auto"
status"pending" | "approved" | "expired" | "failed" | "canceled"
attemptsLeftentier
sendsentier
tagtexte ou null
expiresAttextedate et heure ISO 8601
approvedAttexte ou nulldate et heure ISO 8601
createdAttextedate et heure ISO 8601
POST/api/v1/verify/checkRevendeur#

Contrôler le code saisi

Par identifiant de vérification, ou par numéro (dernière vérification en cours). valid: true une seule fois ; 5 essais au plus, ensuite status: failed. Avec l’en-tête X-Organization : au nom du client.

Corps (JSON)

ChampTypeDétails
idtexte
totexte
code requistexte
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/verify/check" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"code":"…"}'

Réponse

""
GET/api/v1/voicemailRevendeur#

Boîtes vocales et messages (filtres : extension, unread)

Avec l’en-tête X-Organization : au nom du client.

Paramètres de requête

ChampTypeDétails
extensiontexteIdentifiant ou numéro du poste
unreadbooléen
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/voicemail" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "boxes": [
    {
      "extensionId": "…",
      "number": "+33612345678",
      "name": "Julie Martin"
    }
  ],
  "unread": 1
}

Champs de la réponse

ChampTypeDétails
boxesliste de objet
boxes[].extensionIdtexte
boxes[].numbertexte
boxes[].nametexte
boxes[].emailtexte ou null
boxes[].unreadentier
boxes[].messagesliste de objet
boxes[].messages[].uuidtexte
boxes[].messages[].createdAttextedate et heure ISO 8601
boxes[].messages[].readbooléen
boxes[].messages[].foldertexte
boxes[].messages[].callerNametexte
boxes[].messages[].callerNumbertexte
boxes[].messages[].secondsentier
boxes[].messages[].transcripttexte ou nullTranscription (option IA)
unreadentier
GET/api/v1/voicemail/{ext}/{uuid}Revendeur#

Un message

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
ext requistexteIdentifiant ou numéro du poste
uuid requistexteIdentifiant du message
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/voicemail/{ext}/{uuid}" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "uuid": "…",
  "createdAt": "2026-12-01T09:00:00Z",
  "read": true
}

Champs de la réponse

ChampTypeDétails
uuidtexte
createdAttextedate et heure ISO 8601
readbooléen
foldertexte
callerNametexte
callerNumbertexte
secondsentier
transcripttexte ou nullTranscription (option IA)
DELETE/api/v1/voicemail/{ext}/{uuid}Revendeur#

Supprimer un message

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
ext requistexteIdentifiant ou numéro du poste
uuid requistexteIdentifiant du message
Exemple
curl -X DELETE "https://api.hcloud.fr/api/v1/voicemail/{ext}/{uuid}" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "ok": true
}

Champs de la réponse

ChampTypeDétails
okbooléen
POST/api/v1/voicemail/{ext}/{uuid}/readRevendeur#

Marquer lu / non lu

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
ext requistextePoste
uuid requistexteMessage

Corps (JSON)

ChampTypeDétails
read requisbooléen
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/voicemail/{ext}/{uuid}/read" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"read":true}'

Réponse

{
  "ok": true
}

Champs de la réponse

ChampTypeDétails
okbooléen
POST/api/v1/voicemail/{ext}/{uuid}/urlRevendeur#

Lien d’écoute signé (5 min, lecture en continu) ; marque le message lu

Avec l’en-tête X-Organization : au nom du client.

Paramètres de chemin

ChampTypeDétails
ext requistextePoste
uuid requistexteMessage
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/voicemail/{ext}/{uuid}/url" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "url": "https://exemple.fr/webhook",
  "expiresIn": 1
}

Champs de la réponse

ChampTypeDétails
urltexte
expiresInentier

Clés d’API et webhooks

Clés vxr_ (lecture seule, adresses IP autorisées) et webhooks signés (messages vocaux, portabilité, SMS).

GET/api/reseller/api-keysRevendeur#

Vos clés d’API.

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/api-keys" \
  -H "Authorization: Bearer vxr_…"

Réponse

[]
POST/api/reseller/api-keysRevendeur#

Crée une clé vxr_ (lecture seule et adresses IP autorisées en option). Depuis le panneau seulement ; la clé est affichée une seule fois.

Corps (JSON)

ChampTypeDétails
name requistexte1 à 80 caractères
readOnlybooléenpar défaut false
allowedIpsliste de texte20 éléments au plus · par défaut []
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/api-keys" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"name":"Julie Martin"}'
PATCH/api/reseller/api-keys/{id}Revendeur#

Restreindre une clé existante : lecture seule et/ou adresses IP autorisées (liste vide : toutes).

Paramètres de chemin

ChampTypeDétails
id requistexte

Corps (JSON)

ChampTypeDétails
readOnlybooléen
allowedIpsliste de texte20 éléments au plus
Exemple
curl -X PATCH "https://api.hcloud.fr/api/reseller/api-keys/{id}" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"readOnly":true,"allowedIps":["…"]}'
DELETE/api/reseller/api-keys/{id}Revendeur#

Supprime une clé d’API.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X DELETE "https://api.hcloud.fr/api/reseller/api-keys/{id}" \
  -H "Authorization: Bearer vxr_…"
GET/api/reseller/webhooksRevendeur#

Vos webhooks (adresse, événements, état).

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/webhooks" \
  -H "Authorization: Bearer vxr_…"

Réponse

[
  {
    "id": "cmwjdjq41001gq7rrsp2vlcj9",
    "url": "https://exemple.invalid/revendeur",
    "events": [
      "sms.status"
    ],
    "enabled": true,
    "lastStatus": null,
    "createdAt": "2026-11-16T14:44:17.521Z"
  }
]
POST/api/reseller/webhooksRevendeur#

Crée un webhook : adresse HTTPS et événements (appels, messages vocaux, SMS, portabilité, numéros, factures, vie des clients) ; secret de signature renvoyé une fois.

Corps (JSON)

ChampTypeDétails
url requistexteadresse web
eventsliste de "call.completed" | "voicemail.new" | "sms.status" | "porting.status" | "number.assigned" | "invoice.created" | "invoice.paid" | "client.created" | "client.suspended" | "client.reactivated" | "client.terminated"par défaut ["sms.status"]
enabledbooléenpar défaut true
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/webhooks" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://exemple.fr/webhook"}'
PATCH/api/reseller/webhooks/{id}Revendeurpartiel#

Modifie un webhook (adresse, événements, actif).

Modification partielle : seuls les champs envoyés sont modifiés.

Paramètres de chemin

ChampTypeDétails
id requistexte

Corps (JSON)

ChampTypeDétails
urltexteadresse web
eventsliste de "call.completed" | "voicemail.new" | "sms.status" | "porting.status" | "number.assigned" | "invoice.created" | "invoice.paid" | "client.created" | "client.suspended" | "client.reactivated" | "client.terminated"
enabledbooléenpar défaut true
Exemple
curl -X PATCH "https://api.hcloud.fr/api/reseller/webhooks/{id}" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://exemple.fr/webhook","events":["call.completed"],"enabled":true}'
DELETE/api/reseller/webhooks/{id}Revendeur#

Supprime un webhook.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X DELETE "https://api.hcloud.fr/api/reseller/webhooks/{id}" \
  -H "Authorization: Bearer vxr_…"
GET/api/reseller/webhooks/{id}/deliveriesRevendeur#

Journal des envois du webhook (14 jours) : état, nombre d’essais, prochain essai, réponse reçue, contenu envoyé.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/webhooks/{id}/deliveries" \
  -H "Authorization: Bearer vxr_…"

Réponse

[]
POST/api/reseller/webhooks/{id}/deliveries/{delivery}/retryRevendeur#

Renvoie tout de suite un envoi.

Paramètres de chemin

ChampTypeDétails
id requistexte
delivery requistexte
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/webhooks/{id}/deliveries/{delivery}/retry" \
  -H "Authorization: Bearer vxr_…"
POST/api/reseller/webhooks/{id}/testRevendeur#

Envoie un événement de test au webhook.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/webhooks/{id}/test" \
  -H "Authorization: Bearer vxr_…"

Dépannage

Diagnostic d’un client et appel de test.

GET/api/reseller/troubleshoot/{orgId}Revendeur#

Diagnostic d’un client.

Paramètres de chemin

ChampTypeDétails
orgId requistexte

Paramètres de requête

ChampTypeDétails
kind"org" | "number" | "extension" | "user" | "flow"par défaut "org"
idtexte100 caractères au plus
Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/troubleshoot/{orgId}" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "kind": "org",
  "target": "Cabinet Lefèvre",
  "org": {
    "id": "cmwjdhkgh0006q7e0mrvecev1",
    "name": "Cabinet Lefèvre"
  },
  "generatedAt": "2026-11-20T22:38:57.826Z",
  "level": "error",
  "summary": "3 problèmes bloquants et 3 points d’attention",
  "path": [],
  "checks": [
    {
      "section": "Plateforme",
      "level": "error",
      "title": "Serveur téléphonique injoignable",
      "fix": "Incident en cours : notre équipe est prévenue."
    },
    {
      "section": "Plateforme",
      "level": "error",
      "title": "Passerelle SIP injoignable (connexion des postes)"
    }
  ],
  "calls": [],
  "text": "Diagnostic — Cabinet Lefèvre (Cabinet Lefèvre)\nLe 20/11/2026 23:38:57 — 3 problèmes bloquants et 3 points d’attention\n\n✖ [Plateforme] Serveur téléphonique injoi…"
}
POST/api/reseller/troubleshoot/{orgId}/callRevendeur#

Appel de test chez un client.

Paramètres de chemin

ChampTypeDétails
orgId requistexte

Corps (JSON)

ChampTypeDétails
kind requis"ring" | "between" | "inbound"
extensionIdtexte40 caractères au plus
toExtensionIdtexte40 caractères au plus
numbertexte30 caractères au plus
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/troubleshoot/{orgId}/call" \
  -H "Authorization: Bearer vxr_…" \
  -H "Content-Type: application/json" \
  -d '{"kind":"ring"}'
GET/api/reseller/troubleshoot/{orgId}/targetsRevendeur#

Cibles possibles pour l’appel de test.

Paramètres de chemin

ChampTypeDétails
orgId requistexte
Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/troubleshoot/{orgId}/targets" \
  -H "Authorization: Bearer vxr_…"

Réponse

{
  "numbers": [],
  "extensions": [],
  "flows": []
}

Comptes d’essai

Revendeurs fictifs avec leurs clients fictifs (voir le guide « Compte d’essai »).

GET/api/reseller/sandboxesRevendeur#

Vos revendeurs d’essai et leurs clients.

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/sandboxes" \
  -H "Authorization: Bearer vxr_…"

Réponse

[]
POST/api/reseller/sandboxesRevendeur#

Crée un revendeur d’essai avec deux clients fictifs équipés. Renvoie une seule fois la clé vxr_test_…, l’accès au panneau (e-mail, mot de passe) et la console d’essai.

Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/sandboxes" \
  -H "Authorization: Bearer vxr_…"
DELETE/api/reseller/sandboxes/{id}Revendeur#

Supprime un revendeur d’essai et ses clients.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X DELETE "https://api.hcloud.fr/api/reseller/sandboxes/{id}" \
  -H "Authorization: Bearer vxr_…"
POST/api/reseller/sandboxes/{id}/resetRevendeur#

Remet le revendeur d’essai à zéro (deux nouveaux clients fictifs) ; clé, panneau et console inchangés.

Paramètres de chemin

ChampTypeDétails
id requistexte
Exemple
curl -X POST "https://api.hcloud.fr/api/reseller/sandboxes/{id}/reset" \
  -H "Authorization: Bearer vxr_…"

Autres

GET/api/reseller/mobile/linesRevendeur#

Lignes mobiles de tous vos clients (organization), avec consommation et eSIM. Pour agir sur une ligne : routes /api/org/mobile-lines avec X-Organization.

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/mobile/lines" \
  -H "Authorization: Bearer vxr_…"

Réponse

[]
GET/api/reseller/mobile/offersRevendeur#

Forfaits mobiles proposés à vos clients et leur prix HT mensuel (ce que vous paie le client ; votre propre marge se fixe dans vos offres).

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/mobile/offers" \
  -H "Authorization: Bearer vxr_…"

Réponse

[]
GET/api/reseller/mobile/ordersRevendeur#

Commandes de lignes mobiles de tous vos clients. Pour commander au nom d’un client : POST /api/org/mobile-lines/orders avec X-Organization.

Exemple
curl -X GET "https://api.hcloud.fr/api/reseller/mobile/orders" \
  -H "Authorization: Bearer vxr_…"

Réponse

[]