Démarrer
Tout ce que vous faites dans le panneau d'administration et dans les applications se fait aussi par l'API : utilisateurs, postes, numéros (achat compris), files d'attente, standard vocal, horaires, scénarios, messageries, SMS, journal des appels, abonnement… Cette page en donne la référence complète.
- Adresse :
https://api.hcloud.fr
- JSON en entrée et en sortie (
Content-Type: application/json), sauf envoi de fichiers (multipart/form-data).
- Dates ISO 8601, montants en centimes, numéros au format international (
+33612345678) ; les numéros à 10 chiffres sont acceptés en entrée.
#Clé d'API
Un administrateur crée la clé dans le panneau, rubrique Développeurs (/admin/developer), ou par POST /api/centrex/api-keys. Elle n'est affichée qu'une fois. Envoyez-la à chaque requête :
curl "https://api.hcloud.fr/api/org/users" -H "Authorization: Bearer vxk_…"
La clé agit comme l'administrateur de l'entreprise. Pour agir comme un utilisateur précis (routes /api/me/… : son softphone, ses renvois, sa messagerie vocale, ses files…), ajoutez l'en-tête X-User (identifiant ou e-mail) :
curl "https://api.hcloud.fr/api/me/centrex" -H "Authorization: Bearer vxk_…" -H "X-User: julie.martin@exemple.fr"
Les actions faites avec une clé figurent au journal d'audit (GET /api/org/audit). Révoquez une clé avec DELETE /api/centrex/api-keys/{id}.
Chaque route indique son niveau de droits : Utilisateur (tout membre, ou X-User) ou Administrateur.
#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 ont leur propre limite (achats, envois). Au-delà : 429.
#Requêtes rejouables
Pour une écriture que vous risquez d'envoyer deux fois (coupure réseau, nouvel essai), ajoutez Idempotency-Key: <identifiant unique, 8 à 200 caractères> : la même clé renvoie la même réponse sans refaire l'action (un numéro n'est pas acheté deux fois). Réutiliser la clé pour une requête différente renvoie 422.
#Développer sans risque
Créez un compte d'essai (POST /api/org/sandboxes) : une entreprise fictive, déjà équipée, où rien n'a d'effet réel. Voir le guide « Compte d'essai ».
Parcours : numéro, file d’attente et horaires
1. Créer un utilisateur et son poste
curl -X POST "https://api.hcloud.fr/api/org/users" -H "Authorization: Bearer vxk_…" -H "Content-Type: application/json" \
-d '{"email":"julie@exemple.fr","name":"Julie Martin","role":"USER","sendInvite":true}'
Le standard hébergé crée le poste (POST /api/org/extensions pour en ajouter). GET /api/org/extensions donne les identifiants des postes.
2. Acheter un numéro (identification de l'entreprise validée et abonnement en cours) :
curl "https://api.hcloud.fr/api/billing/numbers?area=01" -H "Authorization: Bearer vxk_…"
curl -X POST "https://api.hcloud.fr/api/billing/numbers" -H "Authorization: Bearer vxk_…" -H "Content-Type: application/json" -d '{"number":"+33184000000"}'
Le numéro est attribué tout de suite. S'il n'est pas inclus dans l'offre, il est facturé au prorata (paiement selon votre moyen habituel).
3. Créer la file d'attente :
curl -X POST "https://api.hcloud.fr/api/centrex/queues" -H "Authorization: Bearer vxk_…" -H "Content-Type: application/json" \
-d '{"number":"600","name":"Service client","strategy":"longest-idle-agent","members":["<poste 1>","<poste 2>"],"maxWaitSeconds":300,"maxWaitNoAgent":120}'
Pour ajouter ou retirer un agent, envoyez la nouvelle liste members (PUT /api/centrex/queues/{id}, seuls les champs envoyés changent). Un agent se connecte ou se met en pause avec POST /api/me/queues/status (en-tête X-User) ou POST /api/centrex/queues/{id}/agents/{poste}/status.
4. Horaires : POST /api/centrex/time-conditions (jours et heures d'ouverture, destination en heures ouvrées et en dehors).
5. Router le numéro vers l'horaire, la file, un standard vocal… :
curl -X PUT "https://api.hcloud.fr/api/centrex/numbers/{id}" -H "Authorization: Bearer vxk_…" -H "Content-Type: application/json" -d '{"destType":"QUEUE","destId":"<id de la file>"}'
GET /api/centrex/destinations liste toutes les destinations possibles de l'entreprise.
6. Configurer un softphone : GET /api/me/sip-accounts (avec X-User) renvoie le compte SIP prêt à l'emploi (serveur, identifiant, mot de passe, WebSocket pour un softphone navigateur).
7. Appeler depuis votre logiciel : POST /api/v1/click-to-call (to, extension ou user) fait sonner le poste puis compose le numéro ; GET /api/v1/click-to-call/{id} suit l'appel.
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. Tout ce qui est disponible ici l’est aussi dans l’API habituelle.
#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
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' });
$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']);
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é.
Compte d’essai (sandbox)
Un compte d'essai est une entreprise fictive déjà équipée (4 utilisateurs, 4 postes, une file d’attente, un groupe d’appel, un standard vocal, des horaires, 2 numéros fictifs, des contacts et un historique d’appels). 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 le panneau (administrateur) ou avec votre clé :
curl -X POST "https://api.hcloud.fr/api/org/sandboxes" -H "Authorization: Bearer vxk_…" -H "Content-Type: application/json" -d '{"name":"Mon intégration"}'
Réponse (la clé n'est affichée qu'une fois) :
{ "id": "…", "slug": "essai-…", "name": "Mon intégration", "sandbox": true, "apiKey": "vxk_test_…", "consoleUrl": "https://api.hcloud.fr/api/sandbox/console/o.…" }
POST /api/org/sandboxes/{id}/login-link ouvre son panneau ; trois comptes d'essai au plus ; DELETE /api/org/sandboxes/{id} le supprime.
#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 :
curl "https://api.hcloud.fr/api/sandbox/console/<jeton>/state"
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
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.
Authentification et sécurité
Connexion par mot de passe, double authentification, clés d’accès (passkeys), cartes de connexion et jetons de session. Avec une clé d’API, seules les lectures sont permises ici : mot de passe, double authentification, clés d’accès, cartes de connexion, clés d’API et connexion unique ne se modifient que depuis le panneau (403 sinon).
POST/api/auth/accept-inviteUtilisateur#
Accepte une invitation : choix du mot de passe, compte activé.
Corps (JSON)
| Champ | Type | Détails |
|---|
token requis | texte | |
password requis | texte | 10 à 200 caractères |
name | texte | 2 caractères au moins |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/accept-invite" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"token":"…","password":"Un-mot-de-passe-solide"}'
POST/api/auth/forgotUtilisateur#
Envoie un lien de réinitialisation du mot de passe.
Corps (JSON)
| Champ | Type | Détails |
|---|
email requis | texte | e-mail |
captcha | texte | 4000 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/forgot" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"email":"julie.martin@exemple.fr"}'
POST/api/auth/loginUtilisateur#
Connexion par e-mail et mot de passe : jeton de session (12 h) et jeton de renouvellement, ou étape de double authentification.
Corps (JSON)
| Champ | Type | Détails |
|---|
email requis | texte | e-mail |
password requis | texte | 1 caractères au moins |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/login" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"email":"julie.martin@exemple.fr","password":"Un-mot-de-passe-solide"}'
POST/api/auth/login-linkUtilisateur#
Consommation d'un lien de connexion automatique : ouvre la session (une seule fois). Appelée par la page /sso du panneau.
Corps (JSON)
| Champ | Type | Détails |
|---|
token requis | texte | 20 à 200 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/login-link" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"token":"…"}'
POST/api/auth/login/cardUtilisateur#
Connexion par carte de connexion (QR code).
Corps (JSON)
| Champ | Type | Détails |
|---|
key requis | texte | 40 à 100 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/login/card" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"key":"…"}'
POST/api/auth/login/mfaUtilisateur#
Seconde étape de la connexion : code de l'application d'authentification (ou code de secours).
Corps (JSON)
| Champ | Type | Détails |
|---|
mfaToken requis | texte | 10 caractères au moins |
code requis | texte | 6 à 20 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/login/mfa" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"mfaToken":"…","code":"…"}'
POST/api/auth/login/passkeyUtilisateur#
Connexion par clé d’accès (passkey).
Corps (JSON)
| Champ | Type | Détails |
|---|
mfaToken | texte | 10 caractères au moins |
token requis | texte | 10 caractères au moins |
response requis | objet | |
response.id requis | texte | 10 à 1500 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/login/passkey" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"token":"…","response":{"id":"…"}}'
POST/api/auth/login/passkey/optionsUtilisateur#
Prépare une connexion par clé d’accès (défi WebAuthn).
Corps (JSON)
| Champ | Type | Détails |
|---|
mfaToken | texte | 10 caractères au moins |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/login/passkey/options" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"mfaToken":"…"}'
POST/api/auth/logoutUtilisateur#
Déconnexion : jeton de renouvellement révoqué.
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/logout" \
-H "Authorization: Bearer vxk_…"
GET/api/auth/meUtilisateur#
Utilisateur connecté, son entreprise et ses droits.
Exemple
curl -X GET "https://api.hcloud.fr/api/auth/me" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"user": {
"id": "cmwjdhkg40001q7e0y8y40faf",
"email": "demo-utilisateur@hcloud.invalid",
"name": "Thomas Bernard",
"role": "USER",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"locale": "fr",
"status": "ACTIVE",
"permissions": [],
"emailVerified": false,
"newsletterOptOut": false
},
"org": {
"id": "cmv8684q90000q7abs5rcqq3y",
"sandbox": false,
"sandboxOwnerId": null,
"name": "Boulangerie Martin",
"slug": "demo-documentation",
"sipDomain": "demo-documentation.demo.invalid",
"status": "ACTIVE",
"billingEmail": null,
"vatNumber": null,
"address": null,
"country": "FR",
"trialEndsAt": null,
"settings": {
"phonebookToken": "••••••••"
},
"centrexEnabled": true,
"timezone": "Europe/Paris",
"defaultCallerId": null,
"recordingRetentionDays": 90,
"maxChannels": null,
"pbxNodeId": null,
"pbxHomeNodeId": null,
"pbxPinned": false,
"lat": null,
"lon": null,
"telecomBilledMonth": "2026-10",
"apps": [
"radio",
"hotel"
],
"mohId": null,
"announceOverMusic": false,
"announceMode": "alone",
"announceMusicLevel": 25,
"simpleMode": false,
"product": "CENTREX",
"onboardingDone": true,
"aiGranted": false,
"postalCode": "69002",
"inseeCode": "69382",
"city": "Lyon",
"blockPremium": true,
"blockShortNumbers": true,
"specialCapCents": 3000,
"internationalCapCents": 3000
},
"brand": {
"name": "VoxNova",
"logoUrl": null,
"primaryColor": null,
"supportEmail": null,
"supportPhone": null,
"website": null,
"supportUrl": null,
"centrexHostedName": "Centrex by VoxNova",
"url": "http://localhost:5173",
"whiteLabel": false,
"resellerId": null
},
"reseller": null,
"impersonatorId": null
}
PATCH/api/auth/meUtilisateur#
Modifie son profil (nom, mot de passe, langue…).
Corps (JSON)
| Champ | Type | Détails |
|---|
name | texte | 2 à 100 caractères |
locale | "fr" | "en" | |
newsletterOptOut | booléen | |
currentPassword | texte | |
newPassword | texte | 10 à 200 caractères |
Exemple
curl -X PATCH "https://api.hcloud.fr/api/auth/me" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin","locale":"fr","newsletterOptOut":true}'
POST/api/auth/provisionUtilisateur#
Connexion d'une application mobile/bureau par QR code (jeton à usage unique)
Corps (JSON)
| Champ | Type | Détails |
|---|
token requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/provision" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"token":"…"}'
POST/api/auth/refreshUtilisateur#
Renouvelle le jeton de session avec le jeton de renouvellement.
Corps (JSON)
| Champ | Type | Détails |
|---|
refreshToken requis | texte | 10 caractères au moins |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/refresh" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"refreshToken":"…"}'
POST/api/auth/resetUtilisateur#
Choisit un nouveau mot de passe avec le lien reçu par e-mail.
Corps (JSON)
| Champ | Type | Détails |
|---|
token requis | texte | |
password requis | texte | 10 à 200 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/reset" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"token":"…","password":"Un-mot-de-passe-solide"}'
POST/api/auth/signupUtilisateur#
Inscription d’une nouvelle entreprise (période d’essai).
Corps (JSON)
| Champ | Type | Détails |
|---|
company requis | texte | 2 à 100 caractères |
name requis | texte | 2 à 100 caractères |
email requis | texte | e-mail |
phone | texte | format ^[+0-9 ().-]{6,25}$ |
password requis | texte | 10 à 200 caractères |
product | "CENTREX_HOSTED" | "CENTREX" | "RELAY" | "TRUNK" | "DEVELOPER" | par défaut "RELAY" |
postalCode | texte | 10 caractères au plus |
inseeCode | texte | 5 caractères au plus |
usage | texte | 40 caractères au plus |
captcha | texte | 4000 caractères au plus |
referral | texte | 20 caractères au plus |
acquisition | objet | |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/signup" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"company":"Julie Martin","name":"Julie Martin","email":"julie.martin@exemple.fr","password":"Un-mot-de-passe-solide"}'
POST/api/auth/sso/app-handoffUtilisateur#
Application mobile : code à usage unique (5 min) échangé par l'application contre sa propre session.
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/sso/app-handoff" \
-H "Authorization: Bearer vxk_…"
GET/api/auth/sso/callbackUtilisateur#
Retour de l’authentification unique (SSO) de l’entreprise.
Exemple
curl -X GET "https://api.hcloud.fr/api/auth/sso/callback" \
-H "Authorization: Bearer vxk_…"
POST/api/auth/sso/startUtilisateur#
Démarre une connexion par l’authentification unique (SSO) de l’entreprise.
Corps (JSON)
| Champ | Type | Détails |
|---|
email requis | texte | e-mail |
origin requis | texte | 200 caractères au plus |
next | texte | 300 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/sso/start" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"email":"julie.martin@exemple.fr","origin":"…"}'
POST/api/auth/stop-impersonationUtilisateur#
Fin d'usurpation d'identité (retour au compte super-admin)
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/stop-impersonation" \
-H "Authorization: Bearer vxk_…"
POST/api/auth/verify-emailUtilisateur#
Confirme l’adresse e-mail avec le lien reçu.
Corps (JSON)
| Champ | Type | Détails |
|---|
token requis | texte | 10 à 200 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/verify-email" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"token":"…"}'
POST/api/auth/verify-email/changeUtilisateur#
Adresse saisie avec une faute : l'utilisateur la corrige tant qu'elle n'est pas confirmée.
Corps (JSON)
| Champ | Type | Détails |
|---|
email requis | texte | e-mail · 200 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/verify-email/change" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"email":"julie.martin@exemple.fr"}'
POST/api/auth/verify-email/resendUtilisateur#
Renvoie l’e-mail de confirmation.
Exemple
curl -X POST "https://api.hcloud.fr/api/auth/verify-email/resend" \
-H "Authorization: Bearer vxk_…"
GET/api/me/2faUtilisateur#
État de la double authentification.
Exemple
curl -X GET "https://api.hcloud.fr/api/me/2fa" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"enabled": false,
"recoveryCodesLeft": 0,
"passkeys": 0
}
POST/api/me/2fa/disableUtilisateur#
Désactive la double authentification.
Corps (JSON)
| Champ | Type | Détails |
|---|
password requis | texte | 1 caractères au moins |
code requis | texte | 6 à 20 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/2fa/disable" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"password":"Un-mot-de-passe-solide","code":"…"}'
POST/api/me/2fa/enableUtilisateur#
Active la double authentification (code de l’application d’authentification).
Corps (JSON)
| Champ | Type | Détails |
|---|
code requis | texte | 6 à 10 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/2fa/enable" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"code":"…"}'
POST/api/me/2fa/setupUtilisateur#
Nouveau secret (en attente de confirmation par un premier code).
Exemple
curl -X POST "https://api.hcloud.fr/api/me/2fa/setup" \
-H "Authorization: Bearer vxk_…"
GET/api/me/login-cardsUtilisateur#
Cartes de connexion.
Exemple
curl -X GET "https://api.hcloud.fr/api/me/login-cards" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
POST/api/me/login-cardsAdministrateur#
Crée une carte de connexion.
Corps (JSON)
| Champ | Type | Détails |
|---|
password requis | texte | 1 caractères au moins |
name requis | texte | 1 à 60 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/login-cards" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"password":"Un-mot-de-passe-solide","name":"Julie Martin"}'
DELETE/api/me/login-cards/{id}Utilisateur#
Supprime une carte de connexion.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/me/login-cards/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/me/passkeysUtilisateur#
Clés d’accès (passkeys).
Exemple
curl -X GET "https://api.hcloud.fr/api/me/passkeys" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
POST/api/me/passkeysUtilisateur#
Crée une clé d’accès.
Corps (JSON)
| Champ | Type | Détails |
|---|
token requis | texte | 10 caractères au moins |
response requis | objet | |
response.id requis | texte | 10 à 1500 caractères |
name requis | texte | 1 à 60 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/passkeys" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"token":"…","response":{"id":"…"},"name":"Julie Martin"}'
DELETE/api/me/passkeys/{id}Utilisateur#
Supprime une clé d’accès.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
password requis | texte | 1 caractères au moins |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/me/passkeys/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"password":"Un-mot-de-passe-solide"}'
POST/api/me/passkeys/optionsUtilisateur#
Ajout : le mot de passe est redemandé (une session volée ne doit pas pouvoir ajouter sa propre clé).
Corps (JSON)
| Champ | Type | Détails |
|---|
password requis | texte | 1 caractères au moins |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/passkeys/options" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"password":"Un-mot-de-passe-solide"}'
Entreprise et réglages
Fiche de l’entreprise, mode simple ou avancé, type de service, identification (obligatoire avant d’obtenir des numéros), domaine SIP, sonneries, fonctions activées, journal d’audit.
POST/api/centrex/enableAdministrateur#
Active le standard hébergé (création des postes pour les utilisateurs, premier numéro interne).
Corps (JSON)
| Champ | Type | Détails |
|---|
createForUsers | booléen | par défaut true |
firstNumber | texte | format ^\d{2,6}$ · par défaut "100" |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/enable" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"createForUsers":true,"firstNumber":"100"}'
PATCH/api/centrex/settingsAdministrateur#
Réglages du standard : fuseau horaire, numéro présenté par défaut, conservation des messages et enregistrements, musique d’attente.
Corps (JSON)
| Champ | Type | Détails |
|---|
voicemailRetentionDays | entier | de 0 à 3650 |
timezone | texte | 60 caractères au plus |
defaultCallerId | texte ou null | |
recordingRetentionDays | entier | de 1 à 180 |
recordingStopCode | texte | format ^\*\d$ |
country | texte | 2 à 2 caractères |
mohId | texte ou null | |
announceOverMusic | booléen | |
announceMode | "alone" | "restart" | "continuous" | |
announceMusicLevel | entier | de 5 à 80 |
Exemple
curl -X PATCH "https://api.hcloud.fr/api/centrex/settings" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"voicemailRetentionDays":0,"timezone":"…","defaultCallerId":"…"}'
GET/api/centrex/statsAdministrateur#
Statistiques du standard (appels, durées, postes les plus actifs).
Paramètres de requête
| Champ | Type | Détails |
|---|
days | entier | de 1 à 365 · par défaut 30 |
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/stats" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"total": 0,
"answered": 0,
"asr": 0,
"acdSec": 0,
"talkSec": 0,
"inboundMissed": 0,
"costCents": 0,
"perDay": [
{
"day": "2026-10-22",
"inbound": 0,
"outbound": 0,
"internal": 0,
"missed": 0
},
{
"day": "2026-10-23",
"inbound": 0,
"outbound": 0,
"internal": 0,
"missed": 0
}
],
"byHour": [
{
"hour": 0,
"calls": 0
},
{
"hour": 1,
"calls": 0
}
],
"byDid": []
}
GET/api/centrex/statusAdministrateur#
État du standard : activé, nombre de postes, numéros, groupes, files, menus.
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/status" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"enabled": true,
"settings": {
"voicemailRetentionDays": 0,
"blockPremium": true,
"blockShortNumbers": true,
"postalCode": "69002",
"inseeCode": "69382",
"city": "Lyon",
"timezone": "Europe/Paris",
"defaultCallerId": null,
"recordingRetentionDays": 90,
"recordingStopCode": "*5",
"maxRetentionDays": 180,
"maxChannels": null,
"country": "FR",
"mohId": null,
"announceOverMusic": false,
"announceMode": "alone",
"announceMusicLevel": 25
},
"engine": {
"online": false,
"activeCalls": 0
},
"outboundTrunks": 7,
"counts": {
"extensions": 5,
"numbers": 1,
"trunks": 1,
"ringGroups": 1,
"ivrs": 1,
"queues": 1
}
}
PATCH/api/orgAdministrateur#
Modifie la fiche de l’entreprise (nom, adresse, e-mail de facturation, SIRET…).
Corps (JSON)
| Champ | Type | Détails |
|---|
name | texte | 2 à 100 caractères |
billingEmail | texte ou null | |
vatNumber | texte ou null | |
address | texte ou null | |
country | texte | 2 à 2 caractères |
settings | objet | |
postalCode | texte | 10 caractères au plus |
inseeCode | texte ou null | |
blockPremium | booléen | |
blockShortNumbers | booléen | |
rejectAnonymous | booléen | |
rejectNpv | booléen | |
Exemple
curl -X PATCH "https://api.hcloud.fr/api/org" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin","billingEmail":"julie.martin@exemple.fr","vatNumber":"…"}'
GET/api/org/auditAdministrateur#
Journal d’audit : qui a fait quoi, quand (actions faites avec une clé d’API comprises).
Paramètres de requête
| Champ | Type | Détails |
|---|
page | entier | de 1 à 9007199254740991 · par défaut 1 |
pageSize | entier | de 1 à 200 · par défaut 50 |
Exemple
curl -X GET "https://api.hcloud.fr/api/org/audit" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwpjb4iy0007q7koj4nlalkq",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"userId": "cmv8684t7000eq7aboj5azw5o",
"action": "extension.sip_account",
"target": "100",
"meta": null,
"ip": "127.0.0.1",
"createdAt": "2026-11-20T22:12:11.050Z"
},
{
"id": "cmwp5b8fk0007q74qrfz0kzed",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"userId": "cmv8684t7000eq7aboj5azw5o",
"action": "extension.sip_account",
"target": "100",
"meta": null,
"ip": "127.0.0.1",
"createdAt": "2026-11-20T15:40:21.489Z"
}
]
GET/api/org/domainAdministrateur#
Domaine SIP de l’entreprise.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/domain" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"current": "demo-documentation.demo.invalid",
"bases": [
"sip.localhost"
],
"default": "sip.localhost",
"base": null,
"label": null,
"custom": true,
"verifyToken": "••••••••",
"targetIp": "127.0.0.1",
"sipPort": 5066,
"phones": 5
}
PUT/api/org/domainAdministrateur#
Change le domaine SIP (sous-domaine de la plateforme ou domaine personnalisé).
Corps (JSON)
| Champ | Type | Détails |
|---|
label | texte | |
base | texte | |
custom | texte | 100 caractères au plus |
Exemple
curl -X PUT "https://api.hcloud.fr/api/org/domain" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"label":"…","base":"…","custom":"…"}'
POST/api/org/domain/checkAdministrateur#
Vérifie qu’un domaine personnalisé pointe bien vers la plateforme.
Corps (JSON)
| Champ | Type | Détails |
|---|
domain requis | texte | 100 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/domain/check" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"domain":"…"}'
GET/api/org/featuresAdministrateur#
Fonctions activées ou masquées dans l’entreprise.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/features" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"key": "••••••••",
"label": "Rappels",
"description": "Bouton « Être rappelé » sur votre site, API et file virtuelle de rappel",
"kind": "free",
"group": "Accueil des appels",
"available": true,
"active": false
},
{
"key": "••••••••",
"label": "SMS et WhatsApp",
"description": "Envoi automatique de SMS ou de messages WhatsApp depuis vos scénarios",
"kind": "granted",
"group": "Accueil des appels",
"available": true,
"active": true
}
]
PUT/api/org/features/{key}Administrateur#
Active ou masque une fonction.
Paramètres de chemin
| Champ | Type | Détails |
|---|
key requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
on requis | booléen | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/org/features/{key}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"on":true}'
GET/api/org/kycAdministrateur#
Identification de l’entreprise : état du dossier et pièces déposées.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/kyc" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"allowIndividual": false,
"type": null,
"status": "legacy",
"data": {},
"submittedAt": null,
"decidedAt": null,
"note": null,
"documents": []
}
POST/api/org/kycAdministrateur#
Dépose le dossier d’identification (type de client, représentant, adresse). Obligatoire avant l’attribution d’un numéro.
Corps (JSON)
| Champ | Type | Détails |
|---|
type requis | "pro" | "asso" | "particulier" | |
legalName | texte | 200 caractères au plus |
siret | texte | 20 caractères au plus |
rna | texte | 12 caractères au plus |
firstName requis | texte | 1 à 80 caractères |
lastName requis | texte | 1 à 80 caractères |
role | texte | 80 caractères au plus |
birthDate | texte | 10 caractères au plus |
address requis | texte | 3 à 200 caractères |
postalCode requis | texte | 4 à 10 caractères |
city requis | texte | 1 à 100 caractères |
country | "FR" | "CH" | "BE" | "LU" | "MC" | par défaut "FR" |
certify requis | true | |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/kyc" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"type":"pro","firstName":"…","lastName":"…","address":"…","postalCode":"…","city":"…","certify":true}'
POST/api/org/kyc/documentsAdministrateur#
Ajoute une pièce justificative (multipart : champs kind et file ; PDF, PNG, JPEG ; 10 Mo).
Corps (multipart/form-data)
| Champ | Type | Détails |
|---|
kind requis | "kbis" | "id" | "address" | "other" | Nature de la pièce |
file requis | fichier | PDF, PNG ou JPEG, 10 Mo |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/kyc/documents" \
-H "Authorization: Bearer vxk_…" \
-F "kind=…" \
-F "file=@fichier"
DELETE/api/org/kyc/documents/{id}Administrateur#
Retire une pièce justificative.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/org/kyc/documents/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/org/kyc/onlineAdministrateur#
Vérification d’identité en ligne : disponibilité et dernière vérification (état, score).
Exemple
curl -X GET "https://api.hcloud.fr/api/org/kyc/online" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"available": false,
"last": null
}
POST/api/org/kyc/onlineAdministrateur#
Démarre la vérification en ligne (type pro, asso ou particulier). Identité imposée facultative : firstName, lastName, birthDate, siren, rna, legalName — la pièce doit être à ce nom et la structure conforme au registre : renvoie l’adresse de la page sécurisée où le représentant filme sa pièce d’identité. Entreprise et association : contrôle du registre et du dirigeant (KYB).
Corps (JSON)
| Champ | Type | Détails |
|---|
type requis | "pro" | "asso" | "particulier" | |
siren | texte | 20 caractères au plus |
rna | texte | 12 caractères au plus |
legalName | texte | 200 caractères au plus |
firstName | texte | 80 caractères au plus |
lastName | texte | 80 caractères au plus |
birthDate | texte | 10 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/kyc/online" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"type":"pro"}'
POST/api/org/kyc/online/refreshAdministrateur#
Relit le résultat de la vérification en ligne (au retour de la page) et renvoie l’état de l’identification.
Exemple
curl -X POST "https://api.hcloud.fr/api/org/kyc/online/refresh" \
-H "Authorization: Bearer vxk_…"
GET/api/org/labelAdministrateur#
Nom affiché de l’entreprise et identifiant court.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/label" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"available": true,
"enabled": false,
"stats": {
"calls": 0,
"answered": 0,
"rate": 0,
"avgSec": null,
"measured": false,
"since": "2026-10-21T22:38:56.797Z"
},
"page": null,
"svg": null,
"embed": null
}
PUT/api/org/labelAdministrateur#
Change le nom affiché.
Corps (JSON)
| Champ | Type | Détails |
|---|
enabled requis | booléen | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/org/label" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"enabled":true}'
POST/api/org/modeAdministrateur#
Passe du mode simple au mode avancé (ou l’inverse).
Corps (JSON)
| Champ | Type | Détails |
|---|
simple requis | booléen | |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/mode" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"simple":true}'
GET/api/org/onboardingAdministrateur#
Étapes de mise en route restantes.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/onboarding" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"product": "CENTREX",
"steps": [
{
"key": "••••••••",
"title": "Raccorder vos lignes",
"text": "Ajoutez votre trunk SIP (hébergeur, hébergeur…) et déclarez vos numéros, ou utilisez les nôtres.",
"to": "/admin/centrex/trunks",
"done": true
},
{
"key": "••••••••",
"title": "Ajouter vos collaborateurs",
"text": "Chaque utilisateur reçoit un poste du standard hébergé.",
"to": "/admin/users",
"done": true
}
],
"dismissed": true,
"completed": false,
"centrexHostedName": "Centrex by VoxNova"
}
POST/api/org/onboardingAdministrateur#
Termine la mise en route.
Corps (JSON)
| Champ | Type | Détails |
|---|
done requis | booléen | |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/onboarding" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"done":true}'
GET/api/org/overviewAdministrateur#
Tableau de bord : appels des 30 derniers jours, postes, numéros, consommation.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/overview" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"org": {
"id": "cmv8684q90000q7abs5rcqq3y",
"sandbox": false,
"sandboxOwnerId": null,
"name": "Boulangerie Martin",
"slug": "demo-documentation",
"sipDomain": "demo-documentation.demo.invalid",
"status": "ACTIVE",
"billingEmail": null,
"vatNumber": null,
"address": null,
"country": "FR",
"trialEndsAt": null,
"settings": {
"phonebookToken": "••••••••"
},
"centrexEnabled": true,
"timezone": "Europe/Paris",
"defaultCallerId": null,
"recordingRetentionDays": 90,
"maxChannels": null,
"pbxNodeId": null,
"pbxHomeNodeId": null,
"pbxPinned": false,
"lat": null,
"lon": null,
"telecomBilledMonth": "2026-10",
"apps": [
"radio",
"hotel"
],
"mohId": null,
"announceOverMusic": false,
"announceMode": "alone",
"announceMusicLevel": 25,
"simpleMode": false,
"product": "CENTREX",
"onboardingDone": true,
"aiGranted": false,
"postalCode": "69002",
"inseeCode": "69382",
"city": "Lyon",
"blockPremium": true,
"blockShortNumbers": true,
"specialCapCents": 3000,
"internationalCapCents": 3000
},
"usage": {
"used": 2,
"seats": 0,
"available": 0
},
"service": {
"ok": true
},
"license": null,
"counts": {
"sipServers": 1,
"extensions": 5,
"devices": 4,
"calls30d": 0,
"talkTimeSec": 0
},
"callsPerDay": [
{
"day": "2026-10-22",
"inbound": 0,
"outbound": 0,
"missed": 0
},
{
"day": "2026-10-23",
"inbound": 0,
"outbound": 0,
"missed": 0
}
]
}
GET/api/org/permissionsAdministrateur#
Liste des droits attribuables aux utilisateurs.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/permissions" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"cdr": "Journal des appels",
"stats": "Statistiques",
"supervision": "Supervision en direct",
"satisfaction": "Satisfaction client"
}
POST/api/org/productAdministrateur#
Change le type de service (standard hébergé, relais vers votre PBX, trunk, plateforme développeurs).
Corps (JSON)
| Champ | Type | Détails |
|---|
product requis | "CENTREX_HOSTED" | "CENTREX" | "RELAY" | "TRUNK" | "DEVELOPER" | |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/product" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"product":"CENTREX_HOSTED"}'
GET/api/org/referralAdministrateur#
Lien de parrainage et filleuls.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/referral" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"code": "UJVS6MW",
"link": "http://localhost:5173/signup?parrain=UJVS6MW",
"reward": "1 mois offert pour vous et pour votre filleul dès qu’il devient client",
"referrals": []
}
PUT/api/org/ringtoneAdministrateur#
Sonnerie par défaut de l’entreprise.
Corps (JSON)
| Champ | Type | Détails |
|---|
ringtone requis | "classic" | "double" | "modern" | "soft" | "digital" | "marimba" | "custom" | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/org/ringtone" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"ringtone":"classic"}'
GET/api/org/ringtone/fileUtilisateur#
Écoute la sonnerie personnalisée de l’entreprise.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/ringtone/file" \
-H "Authorization: Bearer vxk_…"
POST/api/org/ringtone/fileAdministrateur#
Sonnerie personnalisée (multipart : file, audio).
Corps (multipart/form-data)
| Champ | Type | Détails |
|---|
file requis | fichier | Sonnerie (audio, 2 Mo) |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/ringtone/file" \
-H "Authorization: Bearer vxk_…" \
-F "file=@fichier"
DELETE/api/org/ringtone/fileAdministrateur#
Supprime la sonnerie personnalisée de l’entreprise.
Exemple
curl -X DELETE "https://api.hcloud.fr/api/org/ringtone/file" \
-H "Authorization: Bearer vxk_…"
GET/api/org/rioAdministrateur#
RIO de vos numéros (pour les transférer vers un autre opérateur).
Exemple
curl -X GET "https://api.hcloud.fr/api/org/rio" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"number": "+33199001234",
"rio": null
}
]
GET/api/org/specialsAdministrateur#
Numéros spéciaux et courts : blocage et plafond mensuel.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/specials" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"blockPremium": true,
"blockShortNumbers": true,
"capCents": 3000,
"spentCents": 0,
"defaultPerMinute": 0.8
}
GET/api/org/telecomAdministrateur#
Numéros présentables et lignes (pour configurer un PBX).
Exemple
curl -X GET "https://api.hcloud.fr/api/org/telecom" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"month": "2026-11",
"label": "novembre 2026",
"lines": [],
"subtotalCents": 0
}
GET/api/org/trialUtilisateur#
Période d’essai : jours et minutes restants.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/trial" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"isTrial": false,
"trialEndsAt": null,
"minutesAllowed": 35,
"minutesUsed": 0,
"requests": []
}
GET/api/org/trial/free-numbersAdministrateur#
Numéros libres proposés au client (il choisit ; l'éditeur valide).
Paramètres de requête
| Champ | Type | Détails |
|---|
area | texte | 12 caractères au plus · par défaut "01" |
Exemple
curl -X GET "https://api.hcloud.fr/api/org/trial/free-numbers" \
-H "Authorization: Bearer vxk_…"
Réponse
[
"+33170489735",
"+33171048584"
]
POST/api/org/trial/requestsAdministrateur#
Demande un numéro ou une démo étendue pendant l’essai.
Corps (JSON)
| Champ | Type | Détails |
|---|
kind requis | "number" | "extension" | "telemarketing" | |
area | "01" | "02" | "03" | "04" | "05" | "09" | |
number | texte | format ^\+33\d{9}$ |
note | texte | 1000 caractères au plus · par défaut "" |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/trial/requests" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"kind":"number"}'
GET/api/simple/overviewAdministrateur#
Mode simple : vue d’ensemble (utilisateurs, numéros, accueil, appels en cours).
Exemple
curl -X GET "https://api.hcloud.fr/api/simple/overview" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"org": {
"id": "cmv8684q90000q7abs5rcqq3y",
"name": "Boulangerie Martin",
"sipDomain": "demo-documentation.demo.invalid",
"status": "ACTIVE",
"trialEndsAt": null,
"maxChannels": null,
"mohId": null,
"simpleMode": false
},
"license": null,
"usage": {
"users": 5,
"seats": 0,
"numbers": 1,
"liveCalls": 0,
"phonesOnline": 0
},
"users": [
{
"extensionId": "cmv8684rr0004q7abx95vduea",
"number": "100",
"name": "Accueil",
"enabled": true,
"outboundCallerId": null,
"voicemailEmail": null,
"forwardNoAnswer": null,
"dnd": false,
"emergencyPostalCode": null,
"emergencyInsee": null,
"emergencyCity": null,
"user": null,
"appOnline": false,
"phones": []
},
{
"extensionId": "cmv8684s40006q7abi97pyqu8",
"number": "101",
"name": "Julie Martin",
"enabled": true,
"outboundCallerId": null,
"voicemailEmail": null,
"forwardNoAnswer": null,
"dnd": false,
"emergencyPostalCode": null,
"emergencyInsee": null,
"emergencyCity": null,
"user": null,
"appOnline": false,
"phones": []
}
],
"numbers": [
{
"id": "cmwjdjq2h000bq7rrooociqwr",
"number": "+33199001234",
"label": "Accueil",
"mode": "none",
"extIds": [],
"summary": "Non attribué"
}
],
"holdMusic": [],
"nextNumber": "105"
}
Postes et téléphones
Postes (comptes SIP), renvois, messagerie vocale, droits d’appel, numéro présenté, téléphones de bureau associés par adresse MAC (configuration automatique), annuaire des téléphones.
POST/api/me/provisioningUtilisateur#
QR code de connexion d'une application mobile/bureau (valable 15 minutes, usage unique).
Exemple
curl -X POST "https://api.hcloud.fr/api/me/provisioning" \
-H "Authorization: Bearer vxk_…"
GET/api/org/devicesAdministrateur#
Appareils (applications) des utilisateurs de l’entreprise.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/devices" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwk30kr10007q76a1mfjdvj6",
"userId": "cmv8684t7000eq7aboj5azw5o",
"platform": "WEB",
"pushType": "NONE",
"pushToken": null,
"bundleId": null,
"name": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/153.0.8010.12 Safari/537.36",
"appVersion": "1.0.0",
"sandbox": false,
"lastSeenAt": "2026-11-17T02:37:14.126Z",
"lastPushAt": null,
"missedWakes": 0,
"createdAt": "2026-11-17T02:37:14.126Z",
"user": {
"name": "Julie Martin",
"email": "demo-documentation@hcloud.invalid"
}
},
{
"id": "cmwk30jbg0005q76a913c30vj",
"userId": "cmv8684t7000eq7aboj5azw5o",
"platform": "WEB",
"pushType": "NONE",
"pushToken": null,
"bundleId": null,
"name": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) HeadlessChrome/153.0.8010.12 Safari/537.36",
"appVersion": "1.0.0",
"sandbox": false,
"lastSeenAt": "2026-11-17T02:37:12.268Z",
"lastPushAt": null,
"missedWakes": 0,
"createdAt": "2026-11-17T02:37:12.268Z",
"user": {
"name": "Julie Martin",
"email": "demo-documentation@hcloud.invalid"
}
}
]
GET/api/org/extensionsAdministrateur#
Postes.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/extensions" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmv8684rr0004q7abx95vduea",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"sipServerId": "cmv8684qp0002q7abqpr2oefx",
"userId": null,
"number": "100",
"displayName": "Accueil",
"authUsername": "100",
"callerId": null,
"gatewayUuid": "gwsumkctr94pa5vljk",
"enabled": true,
"voicemailEnabled": true,
"voicemailPin": "••••••••",
"voicemailEmail": null,
"voicemailGreeting": null,
"forwardAlways": null,
"forwardBusy": null,
"forwardNoAnswer": null,
"noAnswerSeconds": 25,
"dnd": false,
"recordCalls": false,
"outboundCallerId": null,
"callPermission": "NATIONAL",
"emergencyPostalCode": null,
"emergencyInsee": null,
"emergencyCity": null,
"teamsNumber": null,
"voiceAppId": null,
"createdAt": "2026-10-14T13:54:09.064Z",
"updatedAt": "2026-10-14T13:54:09.064Z",
"user": null,
"sipServer": {
"id": "cmv8684qp0002q7abqpr2oefx",
"name": "Centrex VoxNova",
"mode": "GATEWAY",
"kind": "HOSTED"
}
},
{
"id": "cmv8684s40006q7abi97pyqu8",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"sipServerId": "cmv8684qp0002q7abqpr2oefx",
"userId": null,
"number": "101",
"displayName": "Julie Martin",
"authUsername": "101",
"callerId": null,
"gatewayUuid": "gw1mf8atsdxtbsonto",
"enabled": true,
"voicemailEnabled": true,
"voicemailPin": "••••••••",
"voicemailEmail": null,
"voicemailGreeting": null,
"forwardAlways": null,
"forwardBusy": null,
"forwardNoAnswer": null,
"noAnswerSeconds": 25,
"dnd": false,
"recordCalls": false,
"outboundCallerId": null,
"callPermission": "NATIONAL",
"emergencyPostalCode": null,
"emergencyInsee": null,
"emergencyCity": null,
"teamsNumber": null,
"voiceAppId": null,
"createdAt": "2026-10-14T13:54:09.076Z",
"updatedAt": "2026-10-14T13:54:09.076Z",
"user": null,
"sipServer": {
"id": "cmv8684qp0002q7abqpr2oefx",
"name": "Centrex VoxNova",
"mode": "GATEWAY",
"kind": "HOSTED"
}
}
]
POST/api/org/extensionsAdministrateur#
Crée un poste.
Corps (JSON)
| Champ | Type | Détails |
|---|
sipServerId requis | texte | |
userId | texte ou null | |
number requis | texte | 1 à 20 caractères · format ^[0-9*#+]+$ |
displayName requis | texte | 1 à 100 caractères |
authUsername requis | texte | 1 à 100 caractères |
password | texte | 1 à 200 caractères |
callerId | texte ou null | |
enabled | booléen | par défaut true |
voicemailEnabled | booléen | |
voicemailPin | texte | format ^\d{4,10}$ |
voicemailEmail | texte ou null | |
forwardAlways | texte ou null | |
forwardBusy | texte ou null | |
forwardNoAnswer | texte ou null | |
noAnswerSeconds | entier | de 5 à 120 |
dnd | booléen | |
recordCalls | booléen | |
outboundCallerId | texte ou null | |
callPermission | "INTERNAL" | "NATIONAL" | "INTERNATIONAL" | |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/extensions" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"sipServerId":"…","number":"+33612345678","displayName":"Julie Martin","authUsername":"…"}'
PUT/api/org/extensions/{id}Administrateurpartiel#
Modifie un poste.
Modification partielle : seuls les champs envoyés sont modifiés.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
sipServerId | texte | |
userId | texte ou null | |
number | texte | 1 à 20 caractères · format ^[0-9*#+]+$ |
displayName | texte | 1 à 100 caractères |
authUsername | texte | 1 à 100 caractères |
password | texte | 1 à 200 caractères |
callerId | texte ou null | |
enabled | booléen | par défaut true |
voicemailEnabled | booléen | |
voicemailPin | texte | format ^\d{4,10}$ |
voicemailEmail | texte ou null | |
forwardAlways | texte ou null | |
forwardBusy | texte ou null | |
forwardNoAnswer | texte ou null | |
noAnswerSeconds | entier | de 5 à 120 |
dnd | booléen | |
recordCalls | booléen | |
outboundCallerId | texte ou null | |
callPermission | "INTERNAL" | "NATIONAL" | "INTERNATIONAL" | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/org/extensions/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"sipServerId":"…","userId":"…","number":"+33612345678"}'
DELETE/api/org/extensions/{id}Administrateur#
Supprime un poste.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/org/extensions/{id}" \
-H "Authorization: Bearer vxk_…"
PUT/api/org/extensions/{id}/locationAdministrateur#
Site du poste (télétravail, agence) pour les appels d'urgence ; null = commune de l'entreprise.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
postalCode requis | texte ou null | |
inseeCode | texte ou null | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/org/extensions/{id}/location" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"postalCode":"…"}'
POST/api/org/extensions/{id}/phoneAdministrateur#
Associe un téléphone de bureau au poste par son adresse MAC : il se configure tout seul au branchement (constructeur détecté d’après la MAC, ou précisé).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
provider | texte | 40 caractères au plus |
mac requis | texte | 12 à 17 caractères |
model | texte | 100 caractères au plus |
serial | texte | 64 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/extensions/{id}/phone" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"mac":"…"}'
DELETE/api/org/extensions/{id}/phone/{provider}/{mac}Administrateur#
Dissocie un téléphone de bureau du poste.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
provider requis | texte | |
mac requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/org/extensions/{id}/phone/{provider}/{mac}" \
-H "Authorization: Bearer vxk_…"
GET/api/org/extensions/{id}/sip-accountAdministrateur#
Paramètres SIP du poste à saisir dans un téléphone de bureau ou une application SIP.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/org/extensions/{id}/sip-account" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"extensionId": "cmv8684rr0004q7abx95vduea",
"number": "100",
"displayName": "Accueil",
"username": "100",
"authUsername": "100",
"password": "••••••••",
"domain": "demo-documentation.demo.invalid",
"server": "localhost",
"port": 5066,
"transports": [
"UDP",
"TCP"
],
"outboundProxy": "localhost:5066",
"voicemailNumber": "*97",
"codecs": [
"G.722",
"G.711 A (PCMA)"
],
"registrations": []
}
POST/api/org/extensions/{id}/sip-passwordAdministrateur#
Nouveau mot de passe SIP : les téléphones configurés avec l'ancien sont déconnectés.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/extensions/{id}/sip-password" \
-H "Authorization: Bearer vxk_…"
GET/api/org/extensions/{id}/statusAdministrateur#
État d'enregistrement de la passerelle auprès du PBX pour cette extension.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/org/extensions/{id}/status" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"registered": false,
"error": "KAMAILIO_RPC_URL non configurée"
}
PUT/api/org/extensions/{id}/teamsAdministrateur#
Numéro Teams d'un collaborateur (attribué dans Teams par Set-CsPhoneNumberAssignment).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
teamsNumber requis | texte ou null | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/org/extensions/{id}/teams" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"teamsNumber":"…"}'
GET/api/org/phonebookAdministrateur#
Adresse de l’annuaire pour téléphones de bureau.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/phonebook" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"urls": {
"yealink": "http://localhost:5173/api/public/phonebook/1OWydKJT6cpxAwN78FHrDN4tcSHtpGFH/yealink.xml",
"snom": "http://localhost:5173/api/public/phonebook/1OWydKJT6cpxAwN78FHrDN4tcSHtpGFH/snom.xml",
"grandstream": "http://localhost:5173/api/public/phonebook/1OWydKJT6cpxAwN78FHrDN4tcSHtpGFH/grandstream.xml"
}
}
POST/api/org/phonebook/rotateAdministrateur#
Renouvelle l’adresse secrète de l’annuaire.
Exemple
curl -X POST "https://api.hcloud.fr/api/org/phonebook/rotate" \
-H "Authorization: Bearer vxk_…"
GET/api/org/phonesAdministrateur#
Téléphones enregistrés (appareil, adresse IP, poste).
Exemple
curl -X GET "https://api.hcloud.fr/api/org/phones" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
POST/api/org/phones/importAdministrateur#
Import en masse : [{extension: "101", mac, serial?, provider?}] (200 lignes maximum), résultat ligne par ligne.
Corps (JSON)
| Champ | Type | Détails |
|---|
provider | texte | 40 caractères au plus |
rows requis | liste de objet | 200 éléments au plus |
rows[].extension requis | texte | 1 à 20 caractères |
rows[].mac requis | texte | 12 à 17 caractères |
rows[].serial | texte | 64 caractères au plus |
rows[].provider | texte | 40 caractères au plus |
rows[].model | texte | 100 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/phones/import" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"rows":[{"extension":"…","mac":"…"}]}'
GET/api/org/provisioned-phonesAdministrateur#
Téléphones de bureau associés (MAC, poste, dernière configuration récupérée).
Exemple
curl -X GET "https://api.hcloud.fr/api/org/provisioned-phones" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
GET/api/org/provisioning/{provider}/modelsAdministrateur#
Modèles de téléphones d’un constructeur.
Paramètres de chemin
| Champ | Type | Détails |
|---|
provider requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/org/provisioning/{provider}/models" \
-H "Authorization: Bearer vxk_…"
GET/api/org/provisioning/providersAdministrateur#
Fournisseurs activés par l'éditeur, avec ce qu'il faut choisir (modèle, gamme).
Exemple
curl -X GET "https://api.hcloud.fr/api/org/provisioning/providers" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
GET/api/org/sip-serversAdministrateur#
Serveurs SIP (PBX raccordés).
Exemple
curl -X GET "https://api.hcloud.fr/api/org/sip-servers" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmv8684qp0002q7abqpr2oefx",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"name": "Centrex VoxNova",
"kind": "HOSTED",
"host": "127.0.0.1",
"port": 5082,
"transport": "UDP",
"domain": "demo-documentation.demo.invalid",
"outboundProxy": null,
"mode": "GATEWAY",
"wssUrl": null,
"registerExpires": 3600,
"voicemailNumber": "*97",
"notes": null,
"lastCheckAt": null,
"lastCheckOk": null,
"lastCheckInfo": null,
"createdAt": "2026-10-14T13:54:09.025Z",
"updatedAt": "2026-10-14T13:54:09.104Z",
"_count": {
"extensions": 5
}
}
]
POST/api/org/sip-serversAdministrateur#
Crée un serveur SIP.
Corps (JSON)
| Champ | Type | Détails |
|---|
name requis | texte | 1 à 100 caractères |
host requis | texte | 1 à 255 caractères · format ^[a-zA-Z0-9.\-:[\]]+$ |
port | entier | de 1 à 65535 · par défaut 5060 |
transport | "UDP" | "TCP" | "TLS" | par défaut "UDP" |
domain | texte ou null | |
outboundProxy | texte ou null | |
mode | "GATEWAY" | "DIRECT" | par défaut "GATEWAY" |
wssUrl | texte ou null ou "" | |
registerExpires | entier | de 60 à 7200 · par défaut 600 |
voicemailNumber | texte ou null | |
notes | texte ou null | |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/sip-servers" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin","host":"…"}'
PUT/api/org/sip-servers/{id}Administrateur#
Modifie un serveur SIP.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/org/sip-servers/{id}" \
-H "Authorization: Bearer vxk_…"
DELETE/api/org/sip-servers/{id}Administrateur#
Supprime un serveur SIP.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/org/sip-servers/{id}" \
-H "Authorization: Bearer vxk_…"
POST/api/org/sip-servers/{id}/testAdministrateur#
Teste la connectivité avec le PBX (SIP OPTIONS) et, si demandé, l'URL WebSocket.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/sip-servers/{id}/test" \
-H "Authorization: Bearer vxk_…"
Numéros
Lignes mobiles de l’entreprise (consommation data, options appels, SMS, MMS, messagerie, conférence, reconnexion). Achat d’un numéro (liste des numéros disponibles par zone, attribution immédiate), routage d’un numéro vers un poste, un groupe, une file d’attente, un standard vocal, un horaire, un scénario, une messagerie ou un numéro externe.
GET/api/billing/numbersAdministrateur#
Numéros disponibles à l’achat dans une zone (?area=01…05 ou 09), prix et nombre de numéros inclus dans l’offre.
Exemple
curl -X GET "https://api.hcloud.fr/api/billing/numbers" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"eligible": false,
"reason": "Souscrivez d’abord une offre (menu Abonnement) : vos numéros se choisissent à la souscription.",
"areas": {
"01": "Île-de-France",
"02": "Nord-Ouest",
"03": "Nord-Est",
"04": "Sud-Est",
"05": "Sud-Ouest",
"09": "Non géographique"
}
}
POST/api/billing/numbersAdministrateur#
Achète un numéro de la liste : attribution immédiate, facturé au prorata s’il n’est pas inclus dans l’offre.
Corps (JSON)
| Champ | Type | Détails |
|---|
number requis | texte | format ^\+33\d{9}$ |
Exemple
curl -X POST "https://api.hcloud.fr/api/billing/numbers" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"number":"+33612345678"}'
GET/api/centrex/numbersAdministrateur#
Numéros de l’entreprise.
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/numbers" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwjdjq2h000bq7rrooociqwr",
"number": "+33199001234",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"trunkId": null,
"label": "Accueil",
"destType": null,
"destId": null,
"destValue": null,
"monthlyPriceCents": 0,
"rio": null,
"assignedAt": null,
"previousOrgId": null,
"quarantineUntil": null,
"createdAt": "2026-11-16T14:44:17.466Z",
"updatedAt": "2026-11-16T14:44:17.466Z",
"trunk": null
}
]
POST/api/centrex/numbersAdministrateur#
Ajout d'un numéro porté par un trunk de l'entreprise (les numéros de la plateforme sont attribués par l'éditeur).
Corps (JSON)
| Champ | Type | Détails |
|---|
number requis | texte | 4 caractères au moins |
trunkId requis | texte | |
label | texte | 100 caractères au plus · par défaut "" |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/numbers" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"number":"+33612345678","trunkId":"…"}'
PUT/api/centrex/numbers/{id}Administrateur#
Modifie un numéro.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
label | texte | 100 caractères au plus |
destType | "EXTENSION" | "RING_GROUP" | "IVR" | "QUEUE" | "VOICEMAIL" | "CONFERENCE" | "TIME_CONDITION" | "EXTERNAL" | "HANGUP" | "FLOW" | "RADIO" | "APPLICATION" | "SHARED_VOICEMAIL" | "AI_AGENT" ou null | |
destId | texte ou null | |
destValue | texte ou null | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/centrex/numbers/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"label":"…","destType":"EXTENSION","destId":"…"}'
DELETE/api/centrex/numbers/{id}Administrateur#
Supprime un numéro.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/centrex/numbers/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/org/mobile-linesAdministrateur#
Lignes mobiles de l’entreprise : numéro, carte SIM, offre, état, consommation data du jour et du mois, quota.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/mobile-lines" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
GET/api/org/mobile-lines/{id}Administrateur#
Détail d’une ligne mobile, relu chez l’opérateur : consommation à jour et options (appels, SMS, MMS, messagerie, conférence).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/org/mobile-lines/{id}" \
-H "Authorization: Bearer vxk_…"
PATCH/api/org/mobile-lines/{id}Administrateur#
Nom de la ligne (label) et utilisateur raccordé (userId) : la ligne apparaît dans son espace, il reçoit l’e-mail de l’eSIM et les alertes data (80 %, 100 %), ses appels depuis ce mobile sont reconnus. ringMode : off, simultaneous (le mobile sonne avec son poste) ou delayed (après ringDelaySec secondes).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X PATCH "https://api.hcloud.fr/api/org/mobile-lines/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/org/mobile-lines/{id}/esimAdministrateur#
eSIM : code d’activation (code) et contenu du QR code à scanner sur le téléphone (qr, chaîne LPA). 404 tant que l’opérateur n’a pas préparé la carte (esim.available dans la liste). Chaque lecture est inscrite au journal d’audit.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/org/mobile-lines/{id}/esim" \
-H "Authorization: Bearer vxk_…"
PUT/api/org/mobile-lines/{id}/optionsAdministrateur#
Active ou coupe les options : incomingCalls, outgoingCalls, incomingSms, outgoingSms, mms, voicemail, conferenceCalls (booléens, les absents restent inchangés). Appliqué en quelques minutes (messagerie : le lendemain), de 5 h 05 à 21 h 55.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/org/mobile-lines/{id}/options" \
-H "Authorization: Bearer vxk_…"
POST/api/org/mobile-lines/{id}/reconnectAdministrateur#
Reconnecte la carte SIM au réseau (prise en compte d’un changement, souci de connexion data).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/mobile-lines/{id}/reconnect" \
-H "Authorization: Bearer vxk_…"
GET/api/org/mobile-lines/offersAdministrateur#
Forfaits mobiles proposés : data, réseau (4G/5G), eSIM ou carte SIM, appels et SMS, prix HT par mois (priceCents) et mise en service (setupCents). Liste vide si la vente n’est pas ouverte.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/mobile-lines/offers" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
GET/api/org/mobile-lines/ordersAdministrateur#
Commandes de lignes mobiles de l’entreprise et leur état : pending (validation), ordering, ordered (activation en cours), active, failed (le support reprend la main), rejected, cancelled.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/mobile-lines/orders" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
POST/api/org/mobile-lines/ordersAdministrateur#
Commande une ligne mobile (offerId d’une offre de /offers). Prix figés à la commande, facturés chaque mois sur la facture télécom (au prorata le premier mois). eSIM : le QR code apparaît dans la ligne (/mobile-lines/{id}/esim) dès qu’elle est prête.
Corps (JSON)
| Champ | Type | Détails |
|---|
offerId requis | texte | UUID |
lineLabel | texte | 100 caractères au plus |
contactName | texte | 100 caractères au plus |
contactEmail | texte | e-mail · 200 caractères au plus |
contactPhone | texte | 30 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/mobile-lines/orders" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"offerId":"…"}'
DELETE/api/org/mobile-lines/orders/{id}Administrateur#
Annule une commande encore en attente de validation.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/org/mobile-lines/orders/{id}" \
-H "Authorization: Bearer vxk_…"
PUT/api/simple/numbers/{id}Administrateur#
Destination d'un numéro : un utilisateur, plusieurs (sonnerie simultanée) ou une messagerie.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
mode requis | "user" | "group" | "voicemail" | "none" | |
extIds | liste de texte | 50 éléments au plus · par défaut [] |
label | texte | 100 caractères au plus |
Exemple
curl -X PUT "https://api.hcloud.fr/api/simple/numbers/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"mode":"user"}'
GET/api/v1/lookup/{number}Administrateur#
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.
Paramètres de chemin
| Champ | Type | Détails |
|---|
number requis | texte | Numéro (national ou E.164 encodé : %2B33…) |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/lookup/{number}" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"input": "…",
"valid": true,
"number": "+33612345678"
}
Champs de la réponse
| Champ | Type | Détails |
|---|
input | texte | |
valid | booléen | |
number | texte ou null | |
country | texte ou null | |
type | "mobile" | "fixed" | "voip" | "tollfree" | "premium" | "shared_cost" | "m2m" | "unknown" | |
detail | texte | |
nationalFormat | texte ou null | |
internationalFormat | texte ou null | |
carrier | null | |
Portabilité
Transfert de vos numéros depuis votre opérateur actuel : demande, mandat signé en ligne, suivi des étapes, annulation. Les numéros portés sont ajoutés au compte le jour du portage.
GET/api/portingAdministrateur#
Demandes de portabilité de l’entreprise.
Exemple
curl -X GET "https://api.hcloud.fr/api/porting" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwjdk0xj0007q7ejkmv67086",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"numbers": [
"+33478112233"
],
"numberType": "FIXE",
"holderName": "Boulangerie Martin",
"siret": "",
"address": "",
"currentOperator": "Opérateur actuel",
"rio": "",
"desiredDate": null,
"contactName": "Julie Martin",
"contactEmail": "demo-documentation@hcloud.invalid",
"contactPhone": "",
"notes": "",
"files": [],
"operatorLookup": [],
"signDocumentId": null,
"signRecipientId": null,
"signUrl": null,
"signSentAt": null,
"signedAt": null,
"signReminders": 0,
"status": "SUBMITTED",
"scheduledAt": null,
"adminNote": "",
"history": [],
"createdBy": "demo",
"createdAt": "2026-11-16T14:44:31.543Z",
"updatedAt": "2026-11-16T14:44:31.543Z"
}
]
POST/api/portingAdministrateur#
Nouvelle demande : formulaire (champ « data », JSON) + documents (facture, mandat signé ; PDF ou image, 10 Mo).
Corps (multipart/form-data)
| Champ | Type | Détails |
|---|
numbers requis | texte | Numéros à porter, séparés par des virgules (200 au plus) |
numberType | "FIXE" | "MOBILE" | par défaut "FIXE" |
holderName requis | texte | Titulaire de la ligne chez l’opérateur actuel |
siret | texte | |
address | texte | |
rio | texte | Obligatoire pour un mobile (12 caractères) |
desiredDate | texte | date AAAA-MM-JJ |
contactName requis | texte | |
contactEmail requis | texte | e-mail |
contactPhone | texte | |
notes | texte | |
file | fichier | Facture récente ou mandat signé (facultatif quand le mandat est signé en ligne), jusqu’à 5 fichiers |
Exemple
curl -X POST "https://api.hcloud.fr/api/porting" \
-H "Authorization: Bearer vxk_…" \
-F "numbers=…" \
-F "numberType=…" \
-F "holderName=…" \
-F "siret=…"
POST/api/porting/{id}/cancelAdministrateur#
Annule une demande de portabilité (avant la date fixée).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/porting/{id}/cancel" \
-H "Authorization: Bearer vxk_…"
POST/api/porting/{id}/check-signatureAdministrateur#
Retour du client après signature : état vérifié tout de suite (sans attendre le webhook).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/porting/{id}/check-signature" \
-H "Authorization: Bearer vxk_…"
GET/api/porting/{id}/files/{index}Administrateur#
Document joint (client propriétaire ou éditeur).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
index requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/porting/{id}/files/{index}" \
-H "Authorization: Bearer vxk_…"
GET/api/porting/{id}/signAdministrateur#
Lien de signature du mandat (reprise d'une signature commencée).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/porting/{id}/sign" \
-H "Authorization: Bearer vxk_…"
GET/api/porting/configAdministrateur#
Réglages utiles au formulaire : mandat signé en ligne (pas de document à joindre).
Exemple
curl -X GET "https://api.hcloud.fr/api/porting/config" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"esign": true
}
GET/api/porting/operatorAdministrateur#
Opérateur actuel d'un numéro, pendant la saisie de la demande (bases de portabilité).
Paramètres de requête
| Champ | Type | Détails |
|---|
number requis | texte | 9 à 20 caractères |
Exemple
curl -X GET "https://api.hcloud.fr/api/porting/operator" \
-H "Authorization: Bearer vxk_…"
GET/api/v1/portingAdministrateur#
Demandes de portabilité (filtres : status, number)
Paramètres de requête
| Champ | Type | Détails |
|---|
page | entier | 1 au moins · par défaut 1 |
pageSize | entier | 100 au plus |
status | texte | |
number | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/porting" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"items": [
{
"id": "…",
"status": "AWAITING_SIGNATURE",
"statusLabel": "…"
}
],
"total": 1,
"page": 1
}
Champs de la réponse
| Champ | Type | Détails |
|---|
items | liste de objet | |
items[].id | texte | |
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[].statusLabel | texte | |
items[].numbers | liste de texte | |
items[].numberType | "FIXE" | "MOBILE" | |
items[].holderName | texte | |
items[].siret | texte ou null | |
items[].address | texte ou null | |
items[].currentOperator | texte | |
items[].operators | liste de objet | Opérateur actuel de chaque numéro (bases de portabilité) |
items[].rio | texte ou null | |
items[].desiredDate | texte ou null | date et heure ISO 8601 |
items[].scheduledAt | texte ou null | Date de portage fixée — date et heure ISO 8601 |
items[].contactName | texte | |
items[].contactEmail | texte | |
items[].contactPhone | texte ou null | |
items[].notes | texte | |
items[].message | texte ou null | Message de l’équipe (motif de refus, précisions) |
items[].mandateSigned | booléen | |
items[].awaitingSignature | booléen | |
items[].files | liste de objet | |
items[].files[].index | entier | |
items[].files[].name | texte | |
items[].files[].size | entier | |
items[].files[].type | texte | |
items[].history | liste de objet | |
items[].history[].at | texte | |
items[].history[].status | texte | |
items[].history[].note | texte ou null | |
items[].createdAt | texte | date et heure ISO 8601 |
items[].updatedAt | texte | date et heure ISO 8601 |
total | entier | |
page | entier | |
POST/api/v1/portingAdministrateur#
Demander la portabilité de numéros (JSON avec documents en base64, ou multipart : champ data + fichiers)
Corps (JSON)
| Champ | Type | Détails |
|---|
numbers requis | liste de texte | Numéros à porter (01 23 45 67 89, +33…), 200 au plus |
numberType | "FIXE" | "MOBILE" | par défaut "FIXE" |
holderName requis | texte | Titulaire de la ligne chez l’opérateur actuel |
siret | texte | 14 chiffres (professionnels) |
address | texte | |
currentOperator | texte | Facultatif : relevé automatiquement dans les bases de portabilité |
rio | texte | Obligatoire pour les mobiles : 12 caractères (3179 depuis la ligne). La clé est vérifiée pour un numéro unique. |
desiredDate | texte | date et heure ISO 8601 |
contactName requis | texte | |
contactEmail requis | texte | e-mail |
contactPhone | texte | |
notes | texte | |
documents | liste de objet | Facture 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 requis | texte | |
documents[].type requis | texte | |
documents[].content requis | texte | Contenu en base64 |
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/porting" \
-H "Authorization: Bearer vxk_…" \
-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
| Champ | Type | Détails |
|---|
id | texte | |
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 |
statusLabel | texte | |
numbers | liste de texte | |
numberType | "FIXE" | "MOBILE" | |
holderName | texte | |
siret | texte ou null | |
address | texte ou null | |
currentOperator | texte | |
operators | liste de objet | Opérateur actuel de chaque numéro (bases de portabilité) |
rio | texte ou null | |
desiredDate | texte ou null | date et heure ISO 8601 |
scheduledAt | texte ou null | Date de portage fixée — date et heure ISO 8601 |
contactName | texte | |
contactEmail | texte | |
contactPhone | texte ou null | |
notes | texte | |
message | texte ou null | Message de l’équipe (motif de refus, précisions) |
mandateSigned | booléen | |
awaitingSignature | booléen | |
files | liste de objet | |
files[].index | entier | |
files[].name | texte | |
files[].size | entier | |
files[].type | texte | |
history | liste de objet | |
history[].at | texte | |
history[].status | texte | |
history[].note | texte ou null | |
createdAt | texte | date et heure ISO 8601 |
updatedAt | texte | date et heure ISO 8601 |
GET/api/v1/porting/{id}Administrateur#
Une demande : état, historique, documents
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | Identifiant |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/porting/{id}" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"id": "…",
"status": "AWAITING_SIGNATURE",
"statusLabel": "…"
}
Champs de la réponse
| Champ | Type | Détails |
|---|
id | texte | |
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 |
statusLabel | texte | |
numbers | liste de texte | |
numberType | "FIXE" | "MOBILE" | |
holderName | texte | |
siret | texte ou null | |
address | texte ou null | |
currentOperator | texte | |
operators | liste de objet | Opérateur actuel de chaque numéro (bases de portabilité) |
rio | texte ou null | |
desiredDate | texte ou null | date et heure ISO 8601 |
scheduledAt | texte ou null | Date de portage fixée — date et heure ISO 8601 |
contactName | texte | |
contactEmail | texte | |
contactPhone | texte ou null | |
notes | texte | |
message | texte ou null | Message de l’équipe (motif de refus, précisions) |
mandateSigned | booléen | |
awaitingSignature | booléen | |
files | liste de objet | |
files[].index | entier | |
files[].name | texte | |
files[].size | entier | |
files[].type | texte | |
history | liste de objet | |
history[].at | texte | |
history[].status | texte | |
history[].note | texte ou null | |
createdAt | texte | date et heure ISO 8601 |
updatedAt | texte | date et heure ISO 8601 |
POST/api/v1/porting/{id}/cancelAdministrateur#
Annuler une demande (états : mandat à signer, reçue, en cours ; plus possible une fois la date de portage fixée)
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | Identifiant |
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/porting/{id}/cancel" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"id": "…",
"status": "AWAITING_SIGNATURE",
"statusLabel": "…"
}
Champs de la réponse
| Champ | Type | Détails |
|---|
id | texte | |
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 |
statusLabel | texte | |
numbers | liste de texte | |
numberType | "FIXE" | "MOBILE" | |
holderName | texte | |
siret | texte ou null | |
address | texte ou null | |
currentOperator | texte | |
operators | liste de objet | Opérateur actuel de chaque numéro (bases de portabilité) |
rio | texte ou null | |
desiredDate | texte ou null | date et heure ISO 8601 |
scheduledAt | texte ou null | Date de portage fixée — date et heure ISO 8601 |
contactName | texte | |
contactEmail | texte | |
contactPhone | texte ou null | |
notes | texte | |
message | texte ou null | Message de l’équipe (motif de refus, précisions) |
mandateSigned | booléen | |
awaitingSignature | booléen | |
files | liste de objet | |
files[].index | entier | |
files[].name | texte | |
files[].size | entier | |
files[].type | texte | |
history | liste de objet | |
history[].at | texte | |
history[].status | texte | |
history[].note | texte ou null | |
createdAt | texte | date et heure ISO 8601 |
updatedAt | texte | date et heure ISO 8601 |
GET/api/v1/porting/{id}/files/{index}Administrateur#
Télécharger un document
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | Identifiant |
index requis | texte | Position du document |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/porting/{id}/files/{index}" \
-H "Authorization: Bearer vxk_…"
GET/api/v1/porting/{id}/signAdministrateur#
Lien de signature du mandat (état AWAITING_SIGNATURE)
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | Identifiant |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/porting/{id}/sign" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"url": "https://exemple.fr/webhook"
}
Champs de la réponse
| Champ | Type | Détails |
|---|
url | texte | adresse web |
GET/api/v1/porting/configAdministrateur#
Mandat signé en ligne (esign) et limites des documents
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/porting/config" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"esign": true,
"documents": {}
}
Champs de la réponse
| Champ | Type | Détails |
|---|
esign | booléen | |
documents | objet | |
GET/api/v1/porting/operatorAdministrateur#
Opérateur actuel d’un numéro (bases de portabilité)
Paramètres de requête
| Champ | Type | Détails |
|---|
number requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/porting/operator" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"operator": "…",
"inProgress": true
}
Champs de la réponse
| Champ | Type | Détails |
|---|
operator | texte ou null | |
inProgress | booléen ou null | |
Accueil des appels
Files d’attente (agents, stratégie, attente maximale, musique, annonces), groupes d’appel, standards vocaux (menus « tapez 1 »), horaires et jours fériés, conférences, scénarios d’appel, messageries partagées, fichiers audio et musiques d’attente.
GET/api/centrex/audioAdministrateur#
Fichiers audio (annonces, musiques).
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/audio" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "demo-sat-audio",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"resellerId": null,
"name": "Question satisfaction",
"kind": "GREETING",
"path": "/tmp/x.wav",
"url": null,
"durationSec": 3,
"createdAt": "2026-10-14T17:28:39.576Z"
}
]
POST/api/centrex/audioAdministrateur#
Crée un fichier audio.
Corps (multipart/form-data)
| Champ | Type | Détails |
|---|
file requis | fichier | Fichier audio (WAV, MP3, OGG ; converti automatiquement) |
name | texte | Nom affiché |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/audio" \
-H "Authorization: Bearer vxk_…" \
-F "file=@fichier" \
-F "name=…"
DELETE/api/centrex/audio/{id}Administrateur#
Supprime un fichier audio.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/centrex/audio/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/centrex/audio/{id}/fileAdministrateur#
Télécharge un fichier audio.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/audio/{id}/file" \
-H "Authorization: Bearer vxk_…"
GET/api/centrex/audio/{id}/listenAdministrateur#
Écoute d'un flux radio dans le navigateur (jeton en paramètre : balise <audio>).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/audio/{id}/listen" \
-H "Authorization: Bearer vxk_…"
POST/api/centrex/audio/streamAdministrateur#
Flux radio (Icecast, Shoutcast, MP3, AAC, HLS) utilisé comme musique d'attente.
Corps (JSON)
| Champ | Type | Détails |
|---|
name requis | texte | 1 à 100 caractères |
url requis | texte | adresse web · 500 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/audio/stream" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin","url":"https://exemple.fr/webhook"}'
GET/api/centrex/conferencesAdministrateur#
Salles de conférence.
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/conferences" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwjdjq2c0007q7rrmch43cbn",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"number": "800",
"name": "Réunion d’équipe",
"pin": null,
"moderatorPin": null,
"waitForModerator": false,
"muteOnEntry": false,
"endWithModerator": false,
"maxMembers": null,
"announceCount": true,
"record": false,
"createdAt": "2026-11-16T14:44:17.460Z"
}
]
POST/api/centrex/conferencesAdministrateur#
Crée une salle de conférence.
Corps (JSON)
| Champ | Type | Détails |
|---|
number requis | texte | format ^\d{2,6}$ |
name requis | texte | 1 à 100 caractères |
pin | texte ou null | |
moderatorPin | texte ou null | |
waitForModerator | booléen | par défaut false |
muteOnEntry | booléen | par défaut false |
endWithModerator | booléen | par défaut false |
maxMembers | entier ou null | |
announceCount | booléen | par défaut true |
record | booléen | par défaut false |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/conferences" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"number":"+33612345678","name":"Julie Martin"}'
PUT/api/centrex/conferences/{id}Administrateurpartiel#
Modifie une salle de conférence.
Modification partielle : seuls les champs envoyés sont modifiés.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
number | texte | format ^\d{2,6}$ |
name | texte | 1 à 100 caractères |
pin | texte ou null | |
moderatorPin | texte ou null | |
waitForModerator | booléen | par défaut false |
muteOnEntry | booléen | par défaut false |
endWithModerator | booléen | par défaut false |
maxMembers | entier ou null | |
announceCount | booléen | par défaut true |
record | booléen | par défaut false |
Exemple
curl -X PUT "https://api.hcloud.fr/api/centrex/conferences/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"number":"+33612345678","name":"Julie Martin","pin":"…"}'
DELETE/api/centrex/conferences/{id}Administrateur#
Supprime une salle de conférence.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/centrex/conferences/{id}" \
-H "Authorization: Bearer vxk_…"
POST/api/centrex/conferences/{id}/actionAdministrateur#
Action sur une conférence en cours : couper ou rétablir le micro d’un participant, l’exclure, verrouiller la salle.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
action requis | "mute" | "unmute" | "kick" | "deaf" | "undeaf" | "lock" | "unlock" | "record" | "norecord" | "dial" | "muteall" | "unmuteall" | |
member | entier | de -9007199254740991 à 9007199254740991 |
number | texte | 30 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/conferences/{id}/action" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"action":"mute"}'
GET/api/centrex/conferences/{id}/liveAdministrateur#
Participants d’une conférence en cours.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/conferences/{id}/live" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"online": false,
"running": false,
"members": []
}
GET/api/centrex/destinationsAdministrateur#
Toutes les destinations possibles (listes déroulantes de l'interface).
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/destinations" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"SHARED_VOICEMAIL": [
{
"id": "cmwjdjq2k000dq7rr0gnctv94",
"label": "Messagerie commune"
}
],
"AI_AGENT": [
{
"id": "cmwjdhlt6000aq7e0vgnn3tdp",
"label": "Standardiste IA (Léa)"
}
],
"EXTENSION": [
{
"id": "cmv8684rr0004q7abx95vduea",
"label": "100 — Accueil"
},
{
"id": "cmv8684s40006q7abi97pyqu8",
"label": "101 — Julie Martin"
}
],
"VOICEMAIL": [
{
"id": "cmv8684rr0004q7abx95vduea",
"label": "Messagerie 100 — Accueil"
},
{
"id": "cmv8684s40006q7abi97pyqu8",
"label": "Messagerie 101 — Julie Martin"
}
],
"RING_GROUP": [
{
"id": "cmv8684tc000iq7abd6ovdmis",
"label": "500 — Boutique"
}
],
"IVR": [
{
"id": "cmv8684th000kq7ab1fi9t85y",
"label": "700 — Accueil principal"
}
],
"QUEUE": [
{
"id": "cmv8684ta000gq7abhezk2dgn",
"label": "600 — Service client"
}
],
"TIME_CONDITION": [
{
"id": "cmv8684tj000mq7abf58lstdi",
"label": "Horaires de la boutique"
}
],
"CONFERENCE": [
{
"id": "cmwjdjq2c0007q7rrmch43cbn",
"label": "800 — Réunion d’équipe"
}
],
"FLOW": [
{
"id": "cmwjdjq2o000hq7rrofua0gzt",
"label": "Accueil horaires"
}
],
"RADIO": [
{
"id": "cmwjdjq3c000zq7rrdkbtrcem",
"label": "Matinale"
}
],
"APPLICATION": [
{
"id": "cmwjdjq2r000jq7rrcw2qr5p2",
"label": "Application vocale"
}
]
}
GET/api/centrex/flowsAdministrateur#
Scénarios d’appel.
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/flows" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwjdjq2o000hq7rrofua0gzt",
"name": "Accueil horaires",
"number": null,
"description": "",
"enabled": true,
"updatedAt": "2026-11-16T14:44:17.472Z"
}
]
POST/api/centrex/flowsAdministrateur#
Crée un scénario d’appel.
Corps (JSON)
| Champ | Type | Détails |
|---|
name requis | texte | 1 à 100 caractères |
description | texte | 500 caractères au plus · par défaut "" |
number | texte ou null | |
enabled | booléen | par défaut true |
graph requis | objet | |
graph.nodes requis | liste de objet | 300 éléments au plus |
graph.nodes[].id requis | texte | format ^[\w]{1,40}$ |
graph.nodes[].type requis | "start" | "play" | "menu" | "collect" | "http" | "condition" | "time" | "set" | "split" | "notify" | "queue" | "transfer" | "voicemail" | "hangup" | "support" | "assigned" | "callback" | "message" | |
graph.nodes[].position | objet | |
graph.nodes[].data | objet | |
graph.edges requis | liste de objet | 1000 éléments au plus |
graph.edges[].id | texte | |
graph.edges[].source requis | texte | |
graph.edges[].sourceHandle | texte ou null | |
graph.edges[].target requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/flows" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin","graph":{"nodes":[{"id":null,"type":null}],"edges":[{"source":null,"target":null}]}}'
GET/api/centrex/flows/{id}Administrateur#
Détail d’un scénario d’appel.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/flows/{id}" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"id": "cmwjdjq2o000hq7rrofua0gzt",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"number": null,
"name": "Accueil horaires",
"description": "",
"graph": {
"edges": [],
"nodes": []
},
"enabled": true,
"createdAt": "2026-11-16T14:44:17.472Z",
"updatedAt": "2026-11-16T14:44:17.472Z"
}
PUT/api/centrex/flows/{id}Administrateur#
Modifie un scénario d’appel.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
name requis | texte | 1 à 100 caractères |
description | texte | 500 caractères au plus · par défaut "" |
number | texte ou null | |
enabled | booléen | par défaut true |
graph requis | objet | |
graph.nodes requis | liste de objet | 300 éléments au plus |
graph.nodes[].id requis | texte | format ^[\w]{1,40}$ |
graph.nodes[].type requis | "start" | "play" | "menu" | "collect" | "http" | "condition" | "time" | "set" | "split" | "notify" | "queue" | "transfer" | "voicemail" | "hangup" | "support" | "assigned" | "callback" | "message" | |
graph.nodes[].position | objet | |
graph.nodes[].data | objet | |
graph.edges requis | liste de objet | 1000 éléments au plus |
graph.edges[].id | texte | |
graph.edges[].source requis | texte | |
graph.edges[].sourceHandle | texte ou null | |
graph.edges[].target requis | texte | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/centrex/flows/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin","graph":{"nodes":[{"id":null,"type":null}],"edges":[{"source":null,"target":null}]}}'
DELETE/api/centrex/flows/{id}Administrateur#
Supprime un scénario d’appel.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/centrex/flows/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/centrex/flows/aiAdministrateur#
Assistant de création de scénario : disponibilité.
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/flows/ai" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"available": true,
"dailyLimit": 30
}
POST/api/centrex/flows/aiAdministrateur#
Crée un scénario d’appel à partir d’une description en français.
Corps (JSON)
| Champ | Type | Détails |
|---|
prompt requis | texte | 15 à 2000 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/flows/ai" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"prompt":"…"}'
POST/api/centrex/flows/chatAdministrateur#
Assistant conversationnel de l'éditeur : propose le scénario modifié, enregistré seulement par l'administrateur.
Corps (JSON)
| Champ | Type | Détails |
|---|
messages requis | liste de objet | 40 éléments au plus |
messages[].role requis | "user" | "assistant" | |
messages[].text requis | texte | 1 à 3000 caractères |
graph | objet ou null | par défaut null |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/flows/chat" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"messages":[{"role":"user","text":"…"}]}'
POST/api/centrex/flows/simulateAdministrateur#
Simulation : exécute le scénario (requêtes HTTP réelles) avec des saisies fournies.
Corps (JSON)
| Champ | Type | Détails |
|---|
graph requis | objet | |
graph.nodes requis | liste de objet | 300 éléments au plus |
graph.nodes[].id requis | texte | format ^[\w]{1,40}$ |
graph.nodes[].type requis | "start" | "play" | "menu" | "collect" | "http" | "condition" | "time" | "set" | "split" | "notify" | "queue" | "transfer" | "voicemail" | "hangup" | "support" | "assigned" | "callback" | "message" | |
graph.nodes[].position | objet | |
graph.nodes[].data | objet | |
graph.edges requis | liste de objet | 1000 éléments au plus |
graph.edges[].id | texte | |
graph.edges[].source requis | texte | |
graph.edges[].sourceHandle | texte ou null | |
graph.edges[].target requis | texte | |
caller | texte | par défaut "0612345678" |
callerName | texte | |
did | texte | |
digits | liste de texte | 30 éléments au plus · par défaut [] |
at | | |
queueResult | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/flows/simulate" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"graph":{"nodes":[{"id":null,"type":null}],"edges":[{"source":null,"target":null}]}}'
POST/api/centrex/flows/validateAdministrateur#
Vérifie un graphe sans l'enregistrer (erreurs affichées dans l'éditeur).
Corps (JSON)
| Champ | Type | Détails |
|---|
graph requis | objet | |
graph.nodes requis | liste de objet | 300 éléments au plus |
graph.nodes[].id requis | texte | format ^[\w]{1,40}$ |
graph.nodes[].type requis | "start" | "play" | "menu" | "collect" | "http" | "condition" | "time" | "set" | "split" | "notify" | "queue" | "transfer" | "voicemail" | "hangup" | "support" | "assigned" | "callback" | "message" | |
graph.nodes[].position | objet | |
graph.nodes[].data | objet | |
graph.edges requis | liste de objet | 1000 éléments au plus |
graph.edges[].id | texte | |
graph.edges[].source requis | texte | |
graph.edges[].sourceHandle | texte ou null | |
graph.edges[].target requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/flows/validate" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"graph":{"nodes":[{"id":null,"type":null}],"edges":[{"source":null,"target":null}]}}'
GET/api/centrex/ivrAdministrateur#
Standards vocaux (menus).
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/ivr" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmv8684th000kq7ab1fi9t85y",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"number": "700",
"name": "Accueil principal",
"greetingId": null,
"options": [
{
"digit": "1",
"destId": "cmv8684ta000gq7abhezk2dgn",
"destType": "QUEUE"
},
{
"digit": "2",
"destId": "cmv8684s40006q7abi97pyqu8",
"destType": "EXTENSION"
}
],
"timeoutSeconds": 5,
"maxFailures": 3,
"directDial": false,
"fallbackType": null,
"fallbackId": null,
"fallbackValue": null,
"createdAt": "2026-10-14T13:54:09.125Z"
}
]
POST/api/centrex/ivrAdministrateur#
Crée un standard vocal.
Corps (JSON)
| Champ | Type | Détails |
|---|
number requis | texte | format ^\d{2,6}$ |
name requis | texte | 1 à 100 caractères |
greetingId | texte ou null | |
options | liste de objet | 12 éléments au plus · par défaut [] |
options[].digit requis | texte | format ^[0-9*#]$ |
options[].destType requis | "EXTENSION" | "RING_GROUP" | "IVR" | "QUEUE" | "VOICEMAIL" | "CONFERENCE" | "TIME_CONDITION" | "EXTERNAL" | "HANGUP" | "FLOW" | "RADIO" | "APPLICATION" | "SHARED_VOICEMAIL" | "AI_AGENT" | |
options[].destId | texte ou null | |
options[].destValue | texte ou null | |
timeoutSeconds | entier | de 1 à 30 · par défaut 5 |
maxFailures | entier | de 1 à 10 · par défaut 3 |
directDial | booléen | par défaut false |
fallbackType | "EXTENSION" | "RING_GROUP" | "IVR" | "QUEUE" | "VOICEMAIL" | "CONFERENCE" | "TIME_CONDITION" | "EXTERNAL" | "HANGUP" | "FLOW" | "RADIO" | "APPLICATION" | "SHARED_VOICEMAIL" | "AI_AGENT" ou null | |
fallbackId | texte ou null | |
fallbackValue | texte ou null | |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/ivr" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"number":"+33612345678","name":"Julie Martin"}'
PUT/api/centrex/ivr/{id}Administrateurpartiel#
Modifie un standard vocal.
Modification partielle : seuls les champs envoyés sont modifiés.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
number | texte | format ^\d{2,6}$ |
name | texte | 1 à 100 caractères |
greetingId | texte ou null | |
options | liste de objet | 12 éléments au plus · par défaut [] |
options[].digit requis | texte | format ^[0-9*#]$ |
options[].destType requis | "EXTENSION" | "RING_GROUP" | "IVR" | "QUEUE" | "VOICEMAIL" | "CONFERENCE" | "TIME_CONDITION" | "EXTERNAL" | "HANGUP" | "FLOW" | "RADIO" | "APPLICATION" | "SHARED_VOICEMAIL" | "AI_AGENT" | |
options[].destId | texte ou null | |
options[].destValue | texte ou null | |
timeoutSeconds | entier | de 1 à 30 · par défaut 5 |
maxFailures | entier | de 1 à 10 · par défaut 3 |
directDial | booléen | par défaut false |
fallbackType | "EXTENSION" | "RING_GROUP" | "IVR" | "QUEUE" | "VOICEMAIL" | "CONFERENCE" | "TIME_CONDITION" | "EXTERNAL" | "HANGUP" | "FLOW" | "RADIO" | "APPLICATION" | "SHARED_VOICEMAIL" | "AI_AGENT" ou null | |
fallbackId | texte ou null | |
fallbackValue | texte ou null | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/centrex/ivr/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"number":"+33612345678","name":"Julie Martin","greetingId":"…"}'
DELETE/api/centrex/ivr/{id}Administrateur#
Supprime un standard vocal.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/centrex/ivr/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/centrex/queuesAdministrateur#
Files d’attente.
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/queues" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmv8684ta000gq7abhezk2dgn",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"number": "600",
"name": "Service client",
"strategy": "longest-idle-agent",
"members": [
"cmv8684s40006q7abi97pyqu8",
"cmv8684sf0008q7abh4b8ftyw"
],
"memberLevels": {
"cmv8684so000aq7ab7xldoinc": 2
},
"loggedOut": [],
"maxWaitSeconds": 300,
"maxWaitNoAgent": 120,
"mohId": null,
"announceId": null,
"periodicAnnounceId": null,
"announceFrequency": 45,
"periodicAnnounceIds": [],
"announceFirstDelay": 30,
"announceMaxPlays": 0,
"announceOrder": "sequence",
"exitKey": null,
"wrapUpSeconds": 5,
"maxNoAnswer": 3,
"ringTimeout": 20,
"serviceLevelSeconds": 20,
"fallbackType": null,
"fallbackId": null,
"fallbackValue": null,
"createdAt": "2026-10-14T13:54:09.118Z"
}
]
POST/api/centrex/queuesAdministrateur#
Crée une file d’attente.
Corps (JSON)
| Champ | Type | Détails |
|---|
number requis | texte | format ^\d{2,6}$ |
name requis | texte | 1 à 100 caractères |
strategy | "ring-all" | "longest-idle-agent" | "round-robin" | "top-down" | "agent-with-least-talk-time" | "random" | par défaut "longest-idle-agent" |
members | liste de texte | 100 éléments au plus · par défaut [] |
memberLevels | objet | |
maxWaitSeconds | entier | de 10 à 3600 · par défaut 300 |
maxWaitNoAgent | entier | de 5 à 3600 · par défaut 120 |
mohId | texte ou null | |
announceId | texte ou null | |
periodicAnnounceId | texte ou null | |
announceFrequency | entier | de 5 à 600 · par défaut 45 |
periodicAnnounceIds | liste de texte | 10 éléments au plus · par défaut [] |
announceFirstDelay | entier | de 0 à 600 · par défaut 30 |
announceMaxPlays | entier | de 0 à 100 · par défaut 0 |
announceOrder | "sequence" | "random" | par défaut "sequence" |
exitKey | texte ou null | |
wrapUpSeconds | entier | de 0 à 600 · par défaut 5 |
maxNoAnswer | entier | de 0 à 20 · par défaut 3 |
ringTimeout | entier | de 5 à 120 · par défaut 20 |
serviceLevelSeconds | entier | de 5 à 600 · par défaut 20 |
fallbackType | "EXTENSION" | "RING_GROUP" | "IVR" | "QUEUE" | "VOICEMAIL" | "CONFERENCE" | "TIME_CONDITION" | "EXTERNAL" | "HANGUP" | "FLOW" | "RADIO" | "APPLICATION" | "SHARED_VOICEMAIL" | "AI_AGENT" ou null | |
fallbackId | texte ou null | |
fallbackValue | texte ou null | |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/queues" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"number":"+33612345678","name":"Julie Martin"}'
PUT/api/centrex/queues/{id}Administrateurpartiel#
Modifie une file d’attente.
Modification partielle : seuls les champs envoyés sont modifiés.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
number | texte | format ^\d{2,6}$ |
name | texte | 1 à 100 caractères |
strategy | "ring-all" | "longest-idle-agent" | "round-robin" | "top-down" | "agent-with-least-talk-time" | "random" | par défaut "longest-idle-agent" |
members | liste de texte | 100 éléments au plus · par défaut [] |
memberLevels | objet | |
maxWaitSeconds | entier | de 10 à 3600 · par défaut 300 |
maxWaitNoAgent | entier | de 5 à 3600 · par défaut 120 |
mohId | texte ou null | |
announceId | texte ou null | |
periodicAnnounceId | texte ou null | |
announceFrequency | entier | de 5 à 600 · par défaut 45 |
periodicAnnounceIds | liste de texte | 10 éléments au plus · par défaut [] |
announceFirstDelay | entier | de 0 à 600 · par défaut 30 |
announceMaxPlays | entier | de 0 à 100 · par défaut 0 |
announceOrder | "sequence" | "random" | par défaut "sequence" |
exitKey | texte ou null | |
wrapUpSeconds | entier | de 0 à 600 · par défaut 5 |
maxNoAnswer | entier | de 0 à 20 · par défaut 3 |
ringTimeout | entier | de 5 à 120 · par défaut 20 |
serviceLevelSeconds | entier | de 5 à 600 · par défaut 20 |
fallbackType | "EXTENSION" | "RING_GROUP" | "IVR" | "QUEUE" | "VOICEMAIL" | "CONFERENCE" | "TIME_CONDITION" | "EXTERNAL" | "HANGUP" | "FLOW" | "RADIO" | "APPLICATION" | "SHARED_VOICEMAIL" | "AI_AGENT" ou null | |
fallbackId | texte ou null | |
fallbackValue | texte ou null | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/centrex/queues/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"number":"+33612345678","name":"Julie Martin","strategy":"longest-idle-agent"}'
DELETE/api/centrex/queues/{id}Administrateur#
Supprime une file d’attente.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/centrex/queues/{id}" \
-H "Authorization: Bearer vxk_…"
POST/api/centrex/queues/{id}/agents/{extId}/statusAdministrateur#
Connecte, met en pause ou déconnecte un agent de la file.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
extId requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/queues/{id}/agents/{extId}/status" \
-H "Authorization: Bearer vxk_…"
GET/api/centrex/queues/{id}/liveAdministrateur#
File d’attente en direct : appels en attente, agents et leur état.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/queues/{id}/live" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"online": false,
"waiting": [],
"agents": []
}
GET/api/centrex/queues/{id}/statsAdministrateur#
Statistiques de la file : appels reçus, servis, abandonnés, temps d’attente.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Paramètres de requête
| Champ | Type | Détails |
|---|
days | entier | de 1 à 365 · par défaut 7 |
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/queues/{id}/stats" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"offered": 0,
"answered": 0,
"abandoned": 0,
"timeout": 0,
"exited": 0,
"avgWaitSec": 0,
"maxWaitSec": 0,
"avgTalkSec": 0,
"serviceLevel": 0,
"serviceLevelSeconds": 20,
"byAgent": []
}
POST/api/centrex/queues/{id}/syncAdministrateur#
resynchronisation d'une file après modification des niveaux
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/queues/{id}/sync" \
-H "Authorization: Bearer vxk_…"
GET/api/centrex/ring-groupsAdministrateur#
Groupes d’appel.
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/ring-groups" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmv8684tc000iq7abd6ovdmis",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"number": "500",
"name": "Boutique",
"strategy": "SIMULTANEOUS",
"members": [
{
"id": "cmv8684rr0004q7abx95vduea",
"type": "extension"
},
{
"id": "cmv8684sy000cq7ab78dozpu3",
"type": "extension"
}
],
"ringSeconds": 25,
"mohId": null,
"fallbackType": null,
"fallbackId": null,
"fallbackValue": null,
"createdAt": "2026-10-14T13:54:09.121Z"
}
]
POST/api/centrex/ring-groupsAdministrateur#
Crée un groupe d’appel.
Corps (JSON)
| Champ | Type | Détails |
|---|
number requis | texte | format ^\d{2,6}$ |
name requis | texte | 1 à 100 caractères |
strategy | "SIMULTANEOUS" | "SEQUENTIAL" | par défaut "SIMULTANEOUS" |
members | liste de objet | 50 éléments au plus · par défaut [] |
members[].type requis | "extension" | "external" | |
members[].id | texte | |
members[].value | texte | |
ringSeconds | entier | de 5 à 300 · par défaut 25 |
mohId | texte ou null | |
fallbackType | "EXTENSION" | "RING_GROUP" | "IVR" | "QUEUE" | "VOICEMAIL" | "CONFERENCE" | "TIME_CONDITION" | "EXTERNAL" | "HANGUP" | "FLOW" | "RADIO" | "APPLICATION" | "SHARED_VOICEMAIL" | "AI_AGENT" ou null | |
fallbackId | texte ou null | |
fallbackValue | texte ou null | |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/ring-groups" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"number":"+33612345678","name":"Julie Martin"}'
PUT/api/centrex/ring-groups/{id}Administrateurpartiel#
Modifie un groupe d’appel.
Modification partielle : seuls les champs envoyés sont modifiés.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
number | texte | format ^\d{2,6}$ |
name | texte | 1 à 100 caractères |
strategy | "SIMULTANEOUS" | "SEQUENTIAL" | par défaut "SIMULTANEOUS" |
members | liste de objet | 50 éléments au plus · par défaut [] |
members[].type requis | "extension" | "external" | |
members[].id | texte | |
members[].value | texte | |
ringSeconds | entier | de 5 à 300 · par défaut 25 |
mohId | texte ou null | |
fallbackType | "EXTENSION" | "RING_GROUP" | "IVR" | "QUEUE" | "VOICEMAIL" | "CONFERENCE" | "TIME_CONDITION" | "EXTERNAL" | "HANGUP" | "FLOW" | "RADIO" | "APPLICATION" | "SHARED_VOICEMAIL" | "AI_AGENT" ou null | |
fallbackId | texte ou null | |
fallbackValue | texte ou null | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/centrex/ring-groups/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"number":"+33612345678","name":"Julie Martin","strategy":"SIMULTANEOUS"}'
DELETE/api/centrex/ring-groups/{id}Administrateur#
Supprime un groupe d’appel.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/centrex/ring-groups/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/centrex/time-conditionsAdministrateur#
Horaires.
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/time-conditions" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmv8684tj000mq7abf58lstdi",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"name": "Horaires de la boutique",
"rules": [
{
"to": "19:30",
"days": [
2,
3
],
"from": "07:00"
},
{
"to": "13:00",
"days": [
7
],
"from": "07:00"
}
],
"holidays": [],
"matchType": null,
"matchId": null,
"matchValue": null,
"elseType": null,
"elseId": null,
"elseValue": null,
"createdAt": "2026-10-14T13:54:09.127Z"
}
]
POST/api/centrex/time-conditionsAdministrateur#
Crée un horaire.
Corps (JSON)
| Champ | Type | Détails |
|---|
name requis | texte | 1 à 100 caractères |
rules | liste de objet | 20 éléments au plus · par défaut [] |
rules[].days requis | liste de entier | |
rules[].from requis | texte | format ^\d{2}:\d{2}$ |
rules[].to requis | texte | format ^\d{2}:\d{2}$ |
holidays | liste de texte | 100 éléments au plus · par défaut [] |
matchType | "EXTENSION" | "RING_GROUP" | "IVR" | "QUEUE" | "VOICEMAIL" | "CONFERENCE" | "TIME_CONDITION" | "EXTERNAL" | "HANGUP" | "FLOW" | "RADIO" | "APPLICATION" | "SHARED_VOICEMAIL" | "AI_AGENT" ou null | |
matchId | texte ou null | |
matchValue | texte ou null | |
elseType | "EXTENSION" | "RING_GROUP" | "IVR" | "QUEUE" | "VOICEMAIL" | "CONFERENCE" | "TIME_CONDITION" | "EXTERNAL" | "HANGUP" | "FLOW" | "RADIO" | "APPLICATION" | "SHARED_VOICEMAIL" | "AI_AGENT" ou null | |
elseId | texte ou null | |
elseValue | texte ou null | |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/time-conditions" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin"}'
PUT/api/centrex/time-conditions/{id}Administrateurpartiel#
Modifie un horaire.
Modification partielle : seuls les champs envoyés sont modifiés.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
name | texte | 1 à 100 caractères |
rules | liste de objet | 20 éléments au plus · par défaut [] |
rules[].days requis | liste de entier | |
rules[].from requis | texte | format ^\d{2}:\d{2}$ |
rules[].to requis | texte | format ^\d{2}:\d{2}$ |
holidays | liste de texte | 100 éléments au plus · par défaut [] |
matchType | "EXTENSION" | "RING_GROUP" | "IVR" | "QUEUE" | "VOICEMAIL" | "CONFERENCE" | "TIME_CONDITION" | "EXTERNAL" | "HANGUP" | "FLOW" | "RADIO" | "APPLICATION" | "SHARED_VOICEMAIL" | "AI_AGENT" ou null | |
matchId | texte ou null | |
matchValue | texte ou null | |
elseType | "EXTENSION" | "RING_GROUP" | "IVR" | "QUEUE" | "VOICEMAIL" | "CONFERENCE" | "TIME_CONDITION" | "EXTERNAL" | "HANGUP" | "FLOW" | "RADIO" | "APPLICATION" | "SHARED_VOICEMAIL" | "AI_AGENT" ou null | |
elseId | texte ou null | |
elseValue | texte ou null | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/centrex/time-conditions/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin","rules":[],"holidays":[]}'
DELETE/api/centrex/time-conditions/{id}Administrateur#
Supprime un horaire.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/centrex/time-conditions/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/centrex/voiceboxesAdministrateur#
Messageries partagées.
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/voiceboxes" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwjdjq2k000dq7rr0gnctv94",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"name": "Messagerie commune",
"number": null,
"greetingAudioId": null,
"memberExtensionIds": [],
"notifyEmails": "",
"notifyMembers": true,
"maxSeconds": 120,
"membersCanDelete": false,
"retentionDays": 90,
"enabled": true,
"createdAt": "2026-11-16T14:44:17.468Z",
"members": [],
"counts": {
"total": 0,
"pending": 0
}
}
]
POST/api/centrex/voiceboxesAdministrateur#
Crée une messagerie partagée.
Corps (JSON)
| Champ | Type | Détails |
|---|
name requis | texte | 2 à 80 caractères |
number | texte ou null ou "" | |
greetingAudioId | texte ou null | |
memberExtensionIds requis | liste de texte | 500 éléments au plus |
notifyEmails | texte | 1000 caractères au plus · par défaut "" |
notifyMembers | booléen | par défaut true |
maxSeconds | entier | de 15 à 600 · par défaut 120 |
membersCanDelete | booléen | par défaut false |
retentionDays | entier | de 1 à 3650 · par défaut 90 |
enabled | booléen | par défaut true |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/voiceboxes" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin","memberExtensionIds":["…"]}'
PUT/api/centrex/voiceboxes/{id}Administrateur#
Modifie une messagerie partagée.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
name requis | texte | 2 à 80 caractères |
number | texte ou null ou "" | |
greetingAudioId | texte ou null | |
memberExtensionIds requis | liste de texte | 500 éléments au plus |
notifyEmails | texte | 1000 caractères au plus · par défaut "" |
notifyMembers | booléen | par défaut true |
maxSeconds | entier | de 15 à 600 · par défaut 120 |
membersCanDelete | booléen | par défaut false |
retentionDays | entier | de 1 à 3650 · par défaut 90 |
enabled | booléen | par défaut true |
Exemple
curl -X PUT "https://api.hcloud.fr/api/centrex/voiceboxes/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin","memberExtensionIds":["…"]}'
DELETE/api/centrex/voiceboxes/{id}Administrateur#
Supprime une messagerie partagée.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/centrex/voiceboxes/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/musicAdministrateur#
Catalogue de musiques d’attente libres de droits.
Exemple
curl -X GET "https://api.hcloud.fr/api/music" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwhtzmc1000pq7zqiiwf3ts2",
"name": "Douce mwhtzkhd",
"artist": "",
"genre": "Piano",
"description": "",
"durationSec": 40,
"priceCents": 0,
"active": true,
"sort": 0,
"owned": false,
"inLibrary": false
}
]
POST/api/music/{id}/acquireAdministrateur#
Acquisition : gratuite, ou achat unique (facturé sur la prochaine facture télécom) ; copie dans les musiques.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
confirmPriceCents | entier | de 0 à 9007199254740991 |
setDefault | booléen | par défaut false |
Exemple
curl -X POST "https://api.hcloud.fr/api/music/{id}/acquire" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"confirmPriceCents":0,"setDefault":false}'
GET/api/music/{id}/previewUtilisateur#
extrait (30 s) : écoute libre pour les utilisateurs connectés
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/music/{id}/preview" \
-H "Authorization: Bearer vxk_…"
Appels et journal
Appels en cours (raccrocher, écouter), journal des appels avec enregistrements, export, statistiques, appel lancé depuis l’API (le poste sonne puis le numéro est composé).
GET/api/callsUtilisateur#
Historique personnel des appels de l’utilisateur (applications et softphone) : page, sens, état, recherche.
Paramètres de requête
| Champ | Type | Détails |
|---|
page | entier | de 1 à 9007199254740991 · par défaut 1 |
pageSize | entier | de 1 à 200 · par défaut 50 |
direction | "INBOUND" | "OUTBOUND" | |
status | texte | |
q | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/calls" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"items": [],
"total": 0,
"page": 1,
"pageSize": 50
}
POST/api/callsUtilisateur#
Enregistre un appel terminé (envoyé par les applications). Idempotent par Call-ID.
Corps (JSON)
| Champ | Type | Détails |
|---|
extensionId | texte | |
direction requis | "INBOUND" | "OUTBOUND" | |
status requis | "ANSWERED" | "MISSED" | "REJECTED" | "BUSY" | "FAILED" | "CANCELLED" | |
remoteNumber requis | texte | 1 à 100 caractères |
remoteName | texte | 200 caractères au plus |
sipCallId | texte | 300 caractères au plus |
startedAt requis | | |
answeredAt | | |
endedAt | | |
platform | "IOS" | "ANDROID" | "WEB" | "DESKTOP" | |
quality | objet | |
notes | texte | 2000 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/calls" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"direction":"INBOUND","status":"ANSWERED","remoteNumber":"…","startedAt":"…"}'
DELETE/api/callsUtilisateur#
Vide son historique d’appels.
Exemple
curl -X DELETE "https://api.hcloud.fr/api/calls" \
-H "Authorization: Bearer vxk_…"
PATCH/api/calls/{id}Utilisateur#
Ajoute ou modifie la note d’un appel de son historique.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
notes requis | texte | 2000 caractères au plus |
Exemple
curl -X PATCH "https://api.hcloud.fr/api/calls/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"notes":"…"}'
DELETE/api/calls/{id}Utilisateur#
Retire un appel de son historique.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/calls/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/calls/statsUtilisateur#
Statistiques de ses appels (volumes, durées, appels manqués).
Exemple
curl -X GET "https://api.hcloud.fr/api/calls/stats" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"total": 0,
"inbound": 0,
"outbound": 0,
"missed": 0,
"talkTimeSec": 0
}
GET/api/centrex/cdrAdministrateur#
Journal détaillé des appels (filtres : dates, poste, sens, numéro, appels manqués), avec enregistrements.
Paramètres de requête
| Champ | Type | Détails |
|---|
page | entier | de 1 à 9007199254740991 · par défaut 1 |
pageSize | entier | de 1 à 200 · par défaut 50 |
from | | |
to | | |
direction | "INBOUND" | "OUTBOUND" | "INTERNAL" | |
q | texte | |
answered | "yes" | "no" | |
recorded | booléen | |
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/cdr" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"items": [
{
"id": "cmv8684tl000oq7abbtm6lx4x",
"uuid": "demo-cmv8684q90000q7abs5rcqq3y-1",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"direction": "INBOUND",
"callerNumber": "+33612345678",
"callerName": null,
"destination": "101",
"did": null,
"trunkId": null,
"extension": "101",
"startedAt": "2026-10-14T13:07:09.129Z",
"answeredAt": "2026-10-14T13:07:15.129Z",
"endedAt": "2026-10-14T13:10:20.129Z",
"durationSec": 191,
"billSec": 185,
"hangupCause": null,
"costCents": 0,
"costPending": false,
"costCorrectedAt": null,
"queueId": null,
"queueWaitSec": null,
"queueOutcome": null,
"agent": null,
"sipTrunkId": null,
"flowId": null,
"category": null,
"locationInsee": null,
"locationSource": null,
"createdAt": "2026-10-14T13:54:09.130Z",
"analysis": null,
"callerContact": null,
"destinationContact": "Julie Martin",
"contactName": null,
"hasRecording": false
},
{
"id": "cmv8684tn000qq7abo48c2drr",
"uuid": "demo-cmv8684q90000q7abs5rcqq3y-2",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"direction": "OUTBOUND",
"callerNumber": "101",
"callerName": null,
"destination": "+33478112233",
"did": null,
"trunkId": null,
"extension": "101",
"startedAt": "2026-10-14T12:20:09.129Z",
"answeredAt": "2026-10-14T12:20:15.129Z",
"endedAt": "2026-10-14T12:25:57.129Z",
"durationSec": 348,
"billSec": 342,
"hangupCause": null,
"costCents": 0,
"costPending": false,
"costCorrectedAt": null,
"queueId": null,
"queueWaitSec": null,
"queueOutcome": null,
"agent": null,
"sipTrunkId": null,
"flowId": null,
"category": null,
"locationInsee": null,
"locationSource": null,
"createdAt": "2026-10-14T13:54:09.131Z",
"analysis": null,
"callerContact": "Julie Martin",
"destinationContact": null,
"contactName": null,
"hasRecording": false
}
],
"total": 5,
"billSec": 684,
"costCents": 0
}
POST/api/centrex/cdr/{id}/listenAdministrateur#
Écoute d'un enregistrement : lien de lecture signé (quelques minutes), sans téléchargement (RGPD).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/cdr/{id}/listen" \
-H "Authorization: Bearer vxk_…"
DELETE/api/centrex/cdr/{id}/recordingAdministrateur#
Supprime l’enregistrement d’un appel.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/centrex/cdr/{id}/recording" \
-H "Authorization: Bearer vxk_…"
GET/api/centrex/cdr/export.csvAdministrateur#
Export CSV du journal des appels.
Paramètres de requête
| Champ | Type | Détails |
|---|
page | entier | de 1 à 9007199254740991 · par défaut 1 |
pageSize | entier | de 1 à 200 · par défaut 50 |
from | | |
to | | |
direction | "INBOUND" | "OUTBOUND" | "INTERNAL" | |
q | texte | |
answered | "yes" | "no" | |
recorded | booléen | |
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/cdr/export.csv" \
-H "Authorization: Bearer vxk_…"
GET/api/centrex/liveAdministrateur#
Appels en cours dans l’entreprise.
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/live" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"online": false,
"calls": []
}
POST/api/centrex/live/{uuid}/hangupAdministrateur#
Raccroche un appel en cours.
Paramètres de chemin
| Champ | Type | Détails |
|---|
uuid requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/live/{uuid}/hangup" \
-H "Authorization: Bearer vxk_…"
POST/api/centrex/live/{uuid}/spyAdministrateur#
Superviseur : écouter, chuchoter à l'agent ou intervenir dans un appel en cours.
Paramètres de chemin
| Champ | Type | Détails |
|---|
uuid requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
extensionId requis | texte | |
mode requis | "listen" | "whisper" | "barge" | |
autoAnswer | booléen | par défaut true |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/live/{uuid}/spy" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"extensionId":"…","mode":"listen"}'
POST/api/centrex/originateAdministrateur#
Lance un appel : le poste sonne, puis le numéro est composé.
Corps (JSON)
| Champ | Type | Détails |
|---|
extensionId requis | texte | |
to requis | texte | 2 à 30 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/originate" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"extensionId":"…","to":"+33612345678"}'
GET/api/me/calls/{callId}/stateUtilisateur#
État d'un appel entrant (utilisé par l'app réveillée par push pour détecter une annulation).
Paramètres de chemin
| Champ | Type | Détails |
|---|
callId requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/me/calls/{callId}/state" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"callId": "exemple",
"state": "unknown"
}
POST/api/me/click-to-callUtilisateur#
Appelle un numéro depuis son poste (le poste sonne puis le numéro est composé).
Corps (JSON)
| Champ | Type | Détails |
|---|
to requis | texte | 2 à 40 caractères |
extension | texte | 40 caractères au plus |
autoAnswer | booléen | par défaut false |
label | texte | 40 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/click-to-call" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"to":"+33612345678"}'
GET/api/me/click-to-call/{id}Administrateur#
État d’un appel lancé (sonnerie, numérotation, en cours, terminé).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/me/click-to-call/{id}" \
-H "Authorization: Bearer vxk_…"
DELETE/api/me/click-to-call/{id}Administrateur#
Raccroche un appel lancé.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/me/click-to-call/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/org/callsAdministrateur#
Historiques d’appels des applications de tous les utilisateurs (filtre userId) ; le journal complet du standard est GET /api/centrex/cdr.
Paramètres de requête
| Champ | Type | Détails |
|---|
page | entier | de 1 à 9007199254740991 · par défaut 1 |
pageSize | entier | de 1 à 200 · par défaut 50 |
userId | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/org/calls" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"items": [],
"total": 0
}
GET/api/v1/call-context/{token}Administrateur#
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).
Paramètres de chemin
| Champ | Type | Détails |
|---|
token requis | texte | Jeton 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 vxk_…"
Réponse
{
"token": "…",
"caller": "+33612345678",
"did": "…"
}
Champs de la réponse
| Champ | Type | Détails |
|---|
token | texte | |
caller | texte | |
did | texte | |
crmUrl | texte ou null | |
openOnAnswer | booléen | |
vars | objet | |
POST/api/v1/callbacksAdministrateur#
Demander à être rappelé (file d’attente ou poste)
Corps (JSON)
| Champ | Type | Détails |
|---|
phone requis | texte | 6 à 25 caractères |
name | texte | 100 caractères au plus |
note | texte | 300 caractères au plus |
targetType requis | "queue" | "extension" | |
targetId requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/callbacks" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"phone":"+33612345678","targetType":"queue","targetId":"…"}'
Réponse
{}
GET/api/v1/callbacks/{id}Administrateur#
État d’une demande de rappel
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | Identifiant |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/callbacks/{id}" \
-H "Authorization: Bearer vxk_…"
Réponse
{}
GET/api/v1/cdrAdministrateur#
Journal des appels
Paramètres de requête
| Champ | Type | Détails |
|---|
page | entier | 1 au moins · par défaut 1 |
pageSize | entier | de 1 à 100 · par défaut 25 |
since | texte | date et heure ISO 8601 |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/cdr" \
-H "Authorization: Bearer vxk_…"
Réponse
{}
POST/api/v1/click-to-callAdministrateur#
Clic pour appeler : le poste sonne, puis le numéro est appelé au décroché (droits du poste)
Corps (JSON)
| Champ | Type | Détails |
|---|
to requis | texte | Numéro à appeler (chiffres, +, *, #) |
extension | texte | Poste qui sonne : identifiant ou numéro interne (ou « user ») |
user | texte | Utilisateur dont le poste sonne : identifiant ou e-mail (au lieu de « extension ») |
autoAnswer | booléen | Décroché automatique du poste (applications VoxNova, téléphones de bureau compatibles) — par défaut false |
label | texte | Nom affiché sur le poste qui sonne |
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/click-to-call" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"to":"0612345678"}'
Réponse
{
"callId": "…",
"status": "ringing",
"extension": "…"
}
Champs de la réponse
| Champ | Type | Détails |
|---|
callId | texte | UUID |
status | "ringing" | "dialing" | "in_progress" | "completed" | "not_answered" | "failed" | |
extension | texte | |
to | texte | |
durationSec | entier | |
hangupCause | texte | |
GET/api/v1/click-to-call/{id}Administrateur#
État : ringing (le poste sonne), dialing (numéro composé), in_progress, completed, not_answered, failed
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | callId renvoyé au lancement |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/click-to-call/{id}" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"callId": "…",
"status": "ringing",
"extension": "…"
}
Champs de la réponse
| Champ | Type | Détails |
|---|
callId | texte | UUID |
status | "ringing" | "dialing" | "in_progress" | "completed" | "not_answered" | "failed" | |
extension | texte | |
to | texte | |
durationSec | entier | |
hangupCause | texte | |
DELETE/api/v1/click-to-call/{id}Administrateur#
Raccrocher (qu’il sonne encore ou soit en cours)
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | callId renvoyé au lancement |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/v1/click-to-call/{id}" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"callId": "…",
"cancelled": true
}
Champs de la réponse
| Champ | Type | Détails |
|---|
callId | texte | |
cancelled | booléen | |
GET/api/v1/recordingsAdministrateur#
Enregistrements (instruction record)
Paramètres de requête
| Champ | Type | Détails |
|---|
page | entier | 1 au moins · par défaut 1 |
pageSize | entier | de 1 à 100 · par défaut 25 |
callId | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/recordings" \
-H "Authorization: Bearer vxk_…"
Réponse
{}
DELETE/api/v1/recordings/{id}Administrateur#
Supprimer
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | Identifiant |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/v1/recordings/{id}" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"ok": true
}
Champs de la réponse
| Champ | Type | Détails |
|---|
ok | booléen | |
POST/api/v1/recordings/{id}/urlAdministrateur#
Lien d’écoute signé (5 min, lecture en continu)
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | Identifiant |
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/recordings/{id}/url" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"url": "https://exemple.fr/webhook",
"expiresIn": 1
}
Champs de la réponse
| Champ | Type | Détails |
|---|
url | texte | |
expiresIn | entier | |
Espace utilisateur
Tout ce qu’un utilisateur fait dans son espace et ses applications : comptes SIP du softphone, présence, renvois, messagerie vocale, files d’attente (connexion, pause), contacts, annuaire, messagerie instantanée, recherche. Avec une clé d’API, ajoutez l’en-tête X-User pour agir comme un utilisateur précis.
GET/api/contactsUtilisateur#
Contacts.
Paramètres de requête
| Champ | Type | Détails |
|---|
q | texte | |
scope | "all" | "personal" | "shared" | par défaut "all" |
favorites | booléen | |
Exemple
curl -X GET "https://api.hcloud.fr/api/contacts" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwjdk0wz0005q7ejuck81c7i",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"ownerId": null,
"firstName": "Paul",
"lastName": "Martin",
"company": "Société Martin & Fils",
"jobTitle": "",
"emails": [],
"phones": [
{
"label": "Bureau",
"number": "+33472102030"
}
],
"favorite": false,
"notes": "",
"tags": [],
"createdAt": "2026-11-16T14:44:31.524Z",
"updatedAt": "2026-11-16T14:44:31.524Z",
"shared": true
}
]
POST/api/contactsUtilisateur#
Crée un contact.
Corps (JSON)
| Champ | Type | Détails |
|---|
firstName | texte | 100 caractères au plus · par défaut "" |
lastName | texte | 100 caractères au plus · par défaut "" |
company | texte | 150 caractères au plus · par défaut "" |
jobTitle | texte | 150 caractères au plus · par défaut "" |
emails | liste de texte | 10 éléments au plus · par défaut [] |
phones | liste de objet | 10 éléments au plus · par défaut [] |
phones[].label | texte | 40 caractères au plus · par défaut "Mobile" |
phones[].number requis | texte | 1 à 40 caractères |
favorite | booléen | par défaut false |
notes | texte | 5000 caractères au plus · par défaut "" |
tags | liste de texte | 20 éléments au plus · par défaut [] |
shared | booléen | par défaut false |
Exemple
curl -X POST "https://api.hcloud.fr/api/contacts" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"firstName":"","lastName":"","company":""}'
PUT/api/contacts/{id}Utilisateurpartiel#
Modifie un contact.
Modification partielle : seuls les champs envoyés sont modifiés.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
firstName | texte | 100 caractères au plus · par défaut "" |
lastName | texte | 100 caractères au plus · par défaut "" |
company | texte | 150 caractères au plus · par défaut "" |
jobTitle | texte | 150 caractères au plus · par défaut "" |
emails | liste de texte | 10 éléments au plus · par défaut [] |
phones | liste de objet | 10 éléments au plus · par défaut [] |
phones[].label | texte | 40 caractères au plus · par défaut "Mobile" |
phones[].number requis | texte | 1 à 40 caractères |
favorite | booléen | par défaut false |
notes | texte | 5000 caractères au plus · par défaut "" |
tags | liste de texte | 20 éléments au plus · par défaut [] |
shared | booléen | par défaut false |
Exemple
curl -X PUT "https://api.hcloud.fr/api/contacts/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"firstName":"","lastName":"","company":""}'
DELETE/api/contacts/{id}Administrateur#
Supprime un contact.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/contacts/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/contacts/{id}/callsUtilisateur#
Appels passés et reçus avec un contact : historique de l'utilisateur, et journal de l'entreprise pour les administrateurs.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/contacts/{id}/calls" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"mine": [],
"company": null
}
GET/api/contacts/export.csvUtilisateur#
Export CSV des contacts.
Exemple
curl -X GET "https://api.hcloud.fr/api/contacts/export.csv" \
-H "Authorization: Bearer vxk_…"
POST/api/contacts/importUtilisateur#
Import CSV : colonnes reconnues prénom, nom, société, fonction, email, téléphone, mobile.
Corps (JSON)
| Champ | Type | Détails |
|---|
csv requis | texte | 1 caractères au moins |
shared | booléen | par défaut false |
Exemple
curl -X POST "https://api.hcloud.fr/api/contacts/import" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"csv":"…"}'
GET/api/contacts/lookupUtilisateur#
Recherche de l'appelant à partir d'un numéro (affichage du nom lors d'un appel entrant).
Paramètres de requête
| Champ | Type | Détails |
|---|
number requis | texte | 1 caractères au moins |
Exemple
curl -X GET "https://api.hcloud.fr/api/contacts/lookup" \
-H "Authorization: Bearer vxk_…"
GET/api/devicesUtilisateur#
Appareils (applications mobiles et de bureau).
Exemple
curl -X GET "https://api.hcloud.fr/api/devices" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
POST/api/devicesUtilisateur#
Crée un appareil.
Corps (JSON)
| Champ | Type | Détails |
|---|
platform requis | "IOS" | "ANDROID" | "WEB" | "DESKTOP" | |
pushType | "APNS_VOIP" | "FCM" | "NONE" | par défaut "NONE" |
pushToken | texte | 10 à 4096 caractères |
bundleId | texte | 200 caractères au plus |
name | texte | 200 caractères au plus · par défaut "" |
appVersion | texte | 50 caractères au plus |
sandbox | booléen | par défaut false |
Exemple
curl -X POST "https://api.hcloud.fr/api/devices" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"platform":"IOS"}'
DELETE/api/devices/{id}Utilisateur#
Supprime un appareil.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/devices/{id}" \
-H "Authorization: Bearer vxk_…"
POST/api/devices/errorUtilisateur#
Erreurs de l'application mobile (exception non rattrapée, écran en échec) : tracées dans le journal du serveur (recherche « erreur application ») pour comprendre les plantages signalés. Limité : 20 par minute et par compte.
Corps (JSON)
| Champ | Type | Détails |
|---|
message requis | texte | 500 caractères au plus |
stack | texte | 3000 caractères au plus |
fatal | booléen | |
where | texte | 80 caractères au plus |
platform | texte | 20 caractères au plus |
version | texte | 20 caractères au plus |
state | objet | |
Exemple
curl -X POST "https://api.hcloud.fr/api/devices/error" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"message":"…"}'
POST/api/devices/test-pushUtilisateur#
Envoie un appel de test sur les téléphones de l'utilisateur (vérifie le réveil).
Exemple
curl -X POST "https://api.hcloud.fr/api/devices/test-push" \
-H "Authorization: Bearer vxk_…"
POST/api/devices/unregisterUtilisateur#
Déconnexion de l'application : le téléphone n'est plus réveillé pour ce compte.
Corps (JSON)
| Champ | Type | Détails |
|---|
pushToken requis | texte | 10 à 4096 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/devices/unregister" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"pushToken":"…"}'
GET/api/directoryUtilisateur#
Annuaire des collègues (extensions de l'entreprise) avec présence en temps réel.
Exemple
curl -X GET "https://api.hcloud.fr/api/directory" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmv8684t7000eq7aboj5azw5o",
"name": "Julie Martin",
"email": "demo-documentation@hcloud.invalid",
"extensions": [],
"presence": "offline"
},
{
"id": "cmwjdhkg40001q7e0y8y40faf",
"name": "Thomas Bernard",
"email": "demo-utilisateur@hcloud.invalid",
"extensions": [
"102"
],
"presence": "offline"
}
]
GET/api/me/aiUtilisateur#
Analyses IA de ses propres appels.
Exemple
curl -X GET "https://api.hcloud.fr/api/me/ai" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"available": false,
"avgScore": null,
"items": []
}
GET/api/me/ai/{id}Utilisateur#
Analyse IA d’un de ses appels.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/me/ai/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/me/call-contextUtilisateur#
Contexte d’un appel entrant passé par un scénario : par jeton (en-tête SIP X-VX-Ctx de l’appel) ou, à défaut, l’appel le plus récent de ce numéro (3 minutes). Renvoie la fiche CRM, l’ouverture au décroché et les variables du scénario. null si aucun.
Paramètres de requête
| Champ | Type | Détails |
|---|
token | texte | format ^[\w-]{32}$ |
caller | texte | 40 caractères au plus |
Exemple
curl -X GET "https://api.hcloud.fr/api/me/call-context" \
-H "Authorization: Bearer vxk_…"
POST/api/me/call-context/{token}/answeredUtilisateur#
L’utilisateur a décroché : le premier qui répond déclenche la requête configurée vers le CRM (une seule fois par appel, signée) ; renvoie la fiche et first: true/false.
Paramètres de chemin
| Champ | Type | Détails |
|---|
token requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/call-context/{token}/answered" \
-H "Authorization: Bearer vxk_…"
GET/api/me/centrexUtilisateur#
Ses postes : renvois, ne pas déranger, messagerie vocale.
Exemple
curl -X GET "https://api.hcloud.fr/api/me/centrex" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmv8684sf0008q7abh4b8ftyw",
"number": "102",
"displayName": "Thomas Bernard",
"dnd": false,
"forwardAlways": null,
"forwardBusy": null,
"forwardNoAnswer": null,
"noAnswerSeconds": 25,
"voicemailEnabled": true,
"voicemailEmail": null,
"recordCalls": false
}
]
PATCH/api/me/centrex/{id}Utilisateur#
Modifie un de ses postes : renvoi immédiat, sur occupation, sans réponse, ne pas déranger.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X PATCH "https://api.hcloud.fr/api/me/centrex/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/me/mobile-linesUtilisateur#
Lignes mobiles attribuées à l’utilisateur connecté : numéro, offre, consommation, sonnerie avec son poste, eSIM.
Exemple
curl -X GET "https://api.hcloud.fr/api/me/mobile-lines" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
PATCH/api/me/mobile-lines/{id}Utilisateur#
L’utilisateur règle la sonnerie de son mobile pour les appels de son poste : ringMode off, simultaneous ou delayed (ringDelaySec).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X PATCH "https://api.hcloud.fr/api/me/mobile-lines/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/me/mobile-lines/{id}/esimUtilisateur#
QR code eSIM de la ligne de l’utilisateur (contenu LPA et code de saisie manuelle). Tracé dans le journal d’audit.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/me/mobile-lines/{id}/esim" \
-H "Authorization: Bearer vxk_…"
GET/api/me/presenceUtilisateur#
Sa présence (disponible, occupé, absent…).
Exemple
curl -X GET "https://api.hcloud.fr/api/me/presence" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"status": "offline"
}
PUT/api/me/presenceUtilisateur#
Change sa présence.
Corps (JSON)
| Champ | Type | Détails |
|---|
status requis | "available" | "busy" | "dnd" | "away" | "on-call" | "offline" | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/me/presence" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"status":"available"}'
GET/api/me/queuesUtilisateur#
Ses files d’attente et son état dans chacune (connecté, en pause).
Exemple
curl -X GET "https://api.hcloud.fr/api/me/queues" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"online": false,
"queues": [
{
"id": "cmv8684ta000gq7abhezk2dgn",
"name": "Service client",
"number": "600",
"extensionId": "cmv8684sf0008q7abh4b8ftyw",
"extension": "102",
"active": true,
"waiting": 0
}
],
"agents": [
{
"extensionId": "cmv8684sf0008q7abh4b8ftyw",
"number": "102",
"status": "Logged Out"
}
]
}
PUT/api/me/queuesUtilisateur#
Choix en une fois : `active` = files gardées (toutes les autres sont quittées ; [] = absent de toutes).
Corps (JSON)
| Champ | Type | Détails |
|---|
active requis | liste de texte | 200 éléments au plus |
Exemple
curl -X PUT "https://api.hcloud.fr/api/me/queues" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"active":["…"]}'
PUT/api/me/queues/{id}Utilisateur#
Entrer dans une file ou en sortir.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
active requis | booléen | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/me/queues/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"active":true}'
POST/api/me/queues/statusUtilisateur#
Se connecte, se met en pause ou se déconnecte de ses files.
Corps (JSON)
| Champ | Type | Détails |
|---|
status requis | "Available" | "On Break" | "Logged Out" | |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/queues/status" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"status":"Available"}'
GET/api/me/ringtoneUtilisateur#
Sa sonnerie (interne et externe).
Exemple
curl -X GET "https://api.hcloud.fr/api/me/ringtone" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"org": {
"ringtone": "classic",
"file": 0
},
"user": {
"ringtone": "",
"ringtoneInternal": "",
"ringCrescendo": false,
"ringMaxSec": 0,
"waitingTone": true,
"ringWhenDnd": false,
"file": 0
}
}
PUT/api/me/ringtoneUtilisateur#
Change sa sonnerie.
Corps (JSON)
| Champ | Type | Détails |
|---|
ringtone | "" | "classic" | "double" | "modern" | "soft" | "digital" | "marimba" | "custom" | par défaut "" |
ringtoneInternal | "" | "classic" | "double" | "modern" | "soft" | "digital" | "marimba" | "custom" | par défaut "" |
ringCrescendo | booléen | par défaut false |
ringMaxSec | entier | de 0 à 120 · par défaut 0 |
waitingTone | booléen | par défaut true |
ringWhenDnd | booléen | par défaut false |
Exemple
curl -X PUT "https://api.hcloud.fr/api/me/ringtone" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"ringtone":"","ringtoneInternal":"","ringCrescendo":false}'
GET/api/me/ringtone/fileUtilisateur#
Écoute sa sonnerie personnalisée.
Exemple
curl -X GET "https://api.hcloud.fr/api/me/ringtone/file" \
-H "Authorization: Bearer vxk_…"
POST/api/me/ringtone/fileUtilisateur#
Choisit sa sonnerie personnalisée (multipart : file, audio, 2 Mo).
Corps (multipart/form-data)
| Champ | Type | Détails |
|---|
file requis | fichier | Sonnerie (audio, 2 Mo) |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/ringtone/file" \
-H "Authorization: Bearer vxk_…" \
-F "file=@fichier"
DELETE/api/me/ringtone/fileUtilisateur#
Supprime sa sonnerie personnalisée.
Exemple
curl -X DELETE "https://api.hcloud.fr/api/me/ringtone/file" \
-H "Authorization: Bearer vxk_…"
GET/api/me/sip-accountsUtilisateur#
Réglages Centrex personnels : renvois, ne pas déranger, messagerie vocale. Mes comptes SIP (postes du standard hébergé) pour un téléphone de bureau ou une application tierce.
Exemple
curl -X GET "https://api.hcloud.fr/api/me/sip-accounts" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"extensionId": "cmv8684sf0008q7abh4b8ftyw",
"number": "102",
"displayName": "Thomas Bernard",
"username": "102",
"authUsername": "102",
"password": "••••••••",
"domain": "demo-documentation.demo.invalid",
"server": "localhost",
"port": 5066,
"transports": [
"UDP",
"TCP"
],
"outboundProxy": "localhost:5066",
"voicemailNumber": "*97",
"codecs": [
"G.722",
"G.711 A (PCMA)"
],
"registrations": []
}
]
GET/api/me/softphoneUtilisateur#
Configuration complète du softphone (comptes SIP, serveurs WebSocket, ICE/TURN).
Exemple
curl -X GET "https://api.hcloud.fr/api/me/softphone" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"user": {
"id": "cmwjdhkg40001q7e0y8y40faf",
"name": "Thomas Bernard",
"email": "demo-utilisateur@hcloud.invalid",
"role": "USER"
},
"org": {
"id": "cmv8684q90000q7abs5rcqq3y",
"name": "Boulangerie Martin",
"status": "ACTIVE",
"sipDomain": "demo-documentation.demo.invalid",
"apps": [
"radio",
"hotel"
],
"centrexEnabled": true
},
"service": {
"ok": true
},
"features": {
"web": true,
"chat": true,
"push": true,
"mobile": true,
"desktop": true,
"gateway": true,
"presence": true,
"recording": true,
"conference": true,
"maxSipServers": 5,
"video": false
},
"accounts": [
{
"extensionId": "cmv8684sf0008q7abh4b8ftyw",
"number": "102",
"displayName": "Thomas Bernard",
"callerId": null,
"serverName": "Centrex VoxNova",
"mode": "GATEWAY",
"pushCapable": true,
"wsServers": [
"ws://127.0.0.1:18080"
],
"uri": "sip:102@demo-documentation.demo.invalid",
"authorizationUser": "102",
"password": "••••••••",
"realm": "demo-documentation.demo.invalid",
"voicemailNumber": "*97",
"registerExpires": 300
}
],
"iceServers": [
{
"urls": [
"stun:stun.l.google.com:19302"
]
}
],
"brandName": "VoxNova",
"serverTime": "2026-11-20T22:38:56.620Z"
}
GET/api/me/voiceboxesUtilisateur#
Messageries partagées dont il est membre et leurs messages.
Exemple
curl -X GET "https://api.hcloud.fr/api/me/voiceboxes" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
DELETE/api/me/voiceboxes/messages/{id}Utilisateur#
Supprime un message d’une messagerie partagée.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/me/voiceboxes/messages/{id}" \
-H "Authorization: Bearer vxk_…"
POST/api/me/voiceboxes/messages/{id}/handledUtilisateur#
Traité / à traiter, avec une note facultative (« rappelé, devis envoyé »).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/voiceboxes/messages/{id}/handled" \
-H "Authorization: Bearer vxk_…"
POST/api/me/voiceboxes/messages/{id}/listenUtilisateur#
Écoute : lien signé de quelques minutes, écoute notée (qui et quand).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/voiceboxes/messages/{id}/listen" \
-H "Authorization: Bearer vxk_…"
GET/api/me/voicemailUtilisateur#
Ses messages vocaux (tous ses postes).
Exemple
curl -X GET "https://api.hcloud.fr/api/me/voicemail" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"boxes": [
{
"extensionId": "cmv8684sf0008q7abh4b8ftyw",
"number": "102",
"name": "Thomas Bernard",
"emailNotify": null,
"settings": {
"enabled": true,
"email": null,
"noAnswerSeconds": 25,
"hasGreeting": false
},
"messages": []
}
],
"unread": 0
}
DELETE/api/me/voicemail/{ext}/{uuid}Utilisateur#
Supprime un de ses messages vocaux.
Paramètres de chemin
| Champ | Type | Détails |
|---|
ext requis | texte | |
uuid requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/me/voicemail/{ext}/{uuid}" \
-H "Authorization: Bearer vxk_…"
POST/api/me/voicemail/{ext}/{uuid}/listenUtilisateur#
Écoute : lien signé et message marqué lu.
Paramètres de chemin
| Champ | Type | Détails |
|---|
ext requis | texte | |
uuid requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/voicemail/{ext}/{uuid}/listen" \
-H "Authorization: Bearer vxk_…"
POST/api/me/voicemail/{ext}/{uuid}/readUtilisateur#
Marque un message vocal comme écouté.
Paramètres de chemin
| Champ | Type | Détails |
|---|
ext requis | texte | |
uuid requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/voicemail/{ext}/{uuid}/read" \
-H "Authorization: Bearer vxk_…"
POST/api/me/voicemail/{ext}/greetingUtilisateur#
Annonce personnelle : fichier (MP3, WAV, AAC, M4A…) ou enregistrement fait dans le navigateur (WebM / Ogg).
Paramètres de chemin
| Champ | Type | Détails |
|---|
ext requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/voicemail/{ext}/greeting" \
-H "Authorization: Bearer vxk_…"
DELETE/api/me/voicemail/{ext}/greetingUtilisateur#
Retour à l'annonce standard.
Paramètres de chemin
| Champ | Type | Détails |
|---|
ext requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/me/voicemail/{ext}/greeting" \
-H "Authorization: Bearer vxk_…"
POST/api/me/voicemail/{ext}/greeting/listenUtilisateur#
Écoute son annonce d’accueil (lien d’écoute de quelques minutes).
Paramètres de chemin
| Champ | Type | Détails |
|---|
ext requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/me/voicemail/{ext}/greeting/listen" \
-H "Authorization: Bearer vxk_…"
PUT/api/me/voicemail/{ext}/settingsUtilisateur#
Activation, code d'accès (consultation par *97 / *98), copie par courriel, délai avant la messagerie.
Paramètres de chemin
| Champ | Type | Détails |
|---|
ext requis | texte | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/me/voicemail/{ext}/settings" \
-H "Authorization: Bearer vxk_…"
GET/api/mediaAdministrateur#
Lecture en continu par lien signé (balise <audio>) : pas de session nécessaire, lien de quelques minutes.
Exemple
curl -X GET "https://api.hcloud.fr/api/media" \
-H "Authorization: Bearer vxk_…"
POST/api/messagesUtilisateur#
Envoie un message instantané à un collègue.
Corps (JSON)
| Champ | Type | Détails |
|---|
peer requis | texte | 1 à 100 caractères |
body requis | texte | 1 à 5000 caractères |
direction requis | "INBOUND" | "OUTBOUND" | |
Exemple
curl -X POST "https://api.hcloud.fr/api/messages" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"peer":"…","body":"…","direction":"INBOUND"}'
GET/api/messages/{peer}Utilisateur#
Conversation avec un collègue.
Paramètres de chemin
| Champ | Type | Détails |
|---|
peer requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/messages/{peer}" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
POST/api/messages/{peer}/readUtilisateur#
Marque la conversation comme lue.
Paramètres de chemin
| Champ | Type | Détails |
|---|
peer requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/messages/{peer}/read" \
-H "Authorization: Bearer vxk_…"
GET/api/messages/conversationsUtilisateur#
Conversations de messagerie instantanée.
Exemple
curl -X GET "https://api.hcloud.fr/api/messages/conversations" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
GET/api/searchUtilisateur#
Recherche globale (contacts, collègues, appels, numéros).
Paramètres de requête
| Champ | Type | Détails |
|---|
q requis | texte | 2 à 100 caractères |
Exemple
curl -X GET "https://api.hcloud.fr/api/search" \
-H "Authorization: Bearer vxk_…"
GET/api/v1/voicemailAdministrateur#
Boîtes vocales et messages (filtres : extension, unread)
Paramètres de requête
| Champ | Type | Détails |
|---|
extension | texte | Identifiant ou numéro du poste |
unread | booléen | |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/voicemail" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"boxes": [
{
"extensionId": "…",
"number": "+33612345678",
"name": "Julie Martin"
}
],
"unread": 1
}
Champs de la réponse
| Champ | Type | Détails |
|---|
boxes | liste de objet | |
boxes[].extensionId | texte | |
boxes[].number | texte | |
boxes[].name | texte | |
boxes[].email | texte ou null | |
boxes[].unread | entier | |
boxes[].messages | liste de objet | |
boxes[].messages[].uuid | texte | |
boxes[].messages[].createdAt | texte | date et heure ISO 8601 |
boxes[].messages[].read | booléen | |
boxes[].messages[].folder | texte | |
boxes[].messages[].callerName | texte | |
boxes[].messages[].callerNumber | texte | |
boxes[].messages[].seconds | entier | |
boxes[].messages[].transcript | texte ou null | Transcription (option IA) |
unread | entier | |
GET/api/v1/voicemail/{ext}/{uuid}Administrateur#
Un message
Paramètres de chemin
| Champ | Type | Détails |
|---|
ext requis | texte | Identifiant ou numéro du poste |
uuid requis | texte | Identifiant du message |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/voicemail/{ext}/{uuid}" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"uuid": "…",
"createdAt": "2026-12-01T09:00:00Z",
"read": true
}
Champs de la réponse
| Champ | Type | Détails |
|---|
uuid | texte | |
createdAt | texte | date et heure ISO 8601 |
read | booléen | |
folder | texte | |
callerName | texte | |
callerNumber | texte | |
seconds | entier | |
transcript | texte ou null | Transcription (option IA) |
DELETE/api/v1/voicemail/{ext}/{uuid}Administrateur#
Supprimer un message
Paramètres de chemin
| Champ | Type | Détails |
|---|
ext requis | texte | Identifiant ou numéro du poste |
uuid requis | texte | Identifiant du message |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/v1/voicemail/{ext}/{uuid}" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"ok": true
}
Champs de la réponse
| Champ | Type | Détails |
|---|
ok | booléen | |
POST/api/v1/voicemail/{ext}/{uuid}/readAdministrateur#
Marquer lu / non lu
Paramètres de chemin
| Champ | Type | Détails |
|---|
ext requis | texte | Poste |
uuid requis | texte | Message |
Corps (JSON)
| Champ | Type | Détails |
|---|
read requis | booléen | |
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/voicemail/{ext}/{uuid}/read" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"read":true}'
Réponse
{
"ok": true
}
Champs de la réponse
| Champ | Type | Détails |
|---|
ok | booléen | |
POST/api/v1/voicemail/{ext}/{uuid}/urlAdministrateur#
Lien d’écoute signé (5 min, lecture en continu) ; marque le message lu
Paramètres de chemin
| Champ | Type | Détails |
|---|
ext requis | texte | Poste |
uuid requis | texte | Message |
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/voicemail/{ext}/{uuid}/url" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"url": "https://exemple.fr/webhook",
"expiresIn": 1
}
Champs de la réponse
| Champ | Type | Détails |
|---|
url | texte | |
expiresIn | entier | |
SMS et WhatsApp
Envoyer un SMS : POST /api/v1/sms (voir le guide « Envoyer un SMS »). Suivi de remise (GET /api/v1/sms/{id}, webhook sms.status), crédits et comptage (GET /api/v1/sms/balance), historique, WhatsApp de l’entreprise, réponses automatiques.
GET/api/org/messagingAdministrateur#
SMS et WhatsApp : plafonds, consommation, crédits, état de WhatsApp, journal des envois.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/messaging" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"limits": {
"sms": 0,
"whatsapp": 0
},
"usage": {
"sms": 0,
"whatsapp": 0
},
"sender": null,
"smsReady": false,
"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
}
},
"session": {
"status": "off"
},
"logs": [],
"diagnostic": {
"tokens": 0,
"lidMappings": 0,
"logs": []
}
}
GET/api/org/messaging/auto-repliesAdministrateur#
Réponses automatiques WhatsApp (par mot-clé).
Exemple
curl -X GET "https://api.hcloud.fr/api/org/messaging/auto-replies" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
PUT/api/org/messaging/auto-repliesAdministrateur#
Modifie les réponses automatiques WhatsApp.
Corps (JSON)
| Champ | Type | Détails |
|---|
rules requis | liste de objet | 30 éléments au plus |
rules[].keyword requis | texte | 2 à 40 caractères |
rules[].text requis | texte | 1 à 1000 caractères |
Exemple
curl -X PUT "https://api.hcloud.fr/api/org/messaging/auto-replies" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"rules":[{"keyword":"…","text":"…"}]}'
GET/api/org/messaging/historyAdministrateur#
Historique complet des SMS et WhatsApp, page par page (?month=AAAA-MM, channel, status, q) : crédits utilisés et montant au comptage de chaque SMS, totaux de la période.
Paramètres de requête
| Champ | Type | Détails |
|---|
month | texte | format ^\d{4}-\d{2}$ |
channel | "sms" | "whatsapp" | |
status | texte | 20 caractères au plus |
q | texte | 60 caractères au plus |
page | entier | de 1 à 9007199254740991 · par défaut 1 |
pageSize | entier | de 1 à 200 · par défaut 50 |
Exemple
curl -X GET "https://api.hcloud.fr/api/org/messaging/history" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"items": [],
"total": 0,
"page": 1,
"pageSize": 50,
"totals": {
"smsSegments": 0,
"meteredSegments": 0,
"meteredCents": 0
}
}
POST/api/org/messaging/testAdministrateur#
Envoie un SMS ou un WhatsApp de test.
Corps (JSON)
| Champ | Type | Détails |
|---|
to requis | texte | 6 à 25 caractères |
text requis | texte | 1 à 1000 caractères |
pref requis | "wa_sms" | "sms" | "wa" | |
inviteText | texte | 600 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/messaging/test" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"to":"+33612345678","text":"…","pref":"wa_sms"}'
POST/api/org/messaging/whatsapp/connectAdministrateur#
Connecte WhatsApp (QR code à scanner, voir GET /api/org/messaging).
Exemple
curl -X POST "https://api.hcloud.fr/api/org/messaging/whatsapp/connect" \
-H "Authorization: Bearer vxk_…"
POST/api/org/messaging/whatsapp/logoutAdministrateur#
Déconnecte WhatsApp.
Exemple
curl -X POST "https://api.hcloud.fr/api/org/messaging/whatsapp/logout" \
-H "Authorization: Bearer vxk_…"
GET/api/org/smsAdministrateur#
SMS : crédits, expéditeur, réglages.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/sms" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"enabled": true,
"sender": null,
"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
}
},
"packs": [
{
"id": "cmwl0zk2t0007q77z855uoci3",
"resellerId": null,
"name": "Pack 500",
"kind": "LIFETIME",
"credits": 500,
"priceCents": 3000,
"active": true,
"createdAt": "2026-11-17T18:28:13.542Z"
},
{
"id": "cmwl12icy0007q7lxfx1mvsfi",
"resellerId": null,
"name": "Pack 500",
"kind": "LIFETIME",
"credits": 500,
"priceCents": 3000,
"active": true,
"createdAt": "2026-11-17T18:30:31.283Z"
}
]
}
GET/api/org/sms/messages/{id}Administrateur#
Détail d’un SMS envoyé (statut de remise).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/org/sms/messages/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/v1/smsAdministrateur#
Liste des SMS (filtres : status, to, tag, since)
Paramètres de requête
| Champ | Type | Détails |
|---|
page | entier | 1 au moins · par défaut 1 |
pageSize | entier | 100 au plus |
status | texte | |
to | texte | |
tag | texte | |
since | texte | date et heure ISO 8601 |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/sms" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"items": [
{
"id": "…",
"to": "+33612345678",
"text": "…"
}
],
"total": 1,
"page": 1
}
Champs de la réponse
| Champ | Type | Détails |
|---|
items | liste de objet | |
items[].id | texte | |
items[].to | texte | Numéro E.164 |
items[].text | texte | |
items[].status | "queued" | "sent" | "delivered" | "failed" | queued : en file ; sent : accepté par l’opérateur ; delivered : remis ; failed : échec |
items[].providerStatus | texte ou null | Dernier état du fournisseur : accepted, sent, delivered, hard_bounce… |
items[].messageId | texte ou null | Identifiant de suivi du message chez l’opérateur SMS |
items[].sender | texte ou null | |
items[].tag | texte ou null | |
items[].type | "transactional" | "marketing" | null | |
items[].segments | entier | Crédits consommés |
items[].channel | texte ou null | |
items[].error | texte ou null | |
items[].createdAt | texte | date et heure ISO 8601 |
items[].sentAt | texte ou null | |
items[].deliveredAt | texte ou null | |
items[].events | liste de objet | |
items[].events[].status | texte | |
items[].events[].at | texte | date et heure ISO 8601 |
total | entier | |
page | entier | |
POST/api/v1/smsAdministrateur#
Envoyer un SMS : mis en file, part en quelques secondes ; statuts par webhook sms.status ou GET /api/v1/sms/{id}
Corps (JSON)
| Champ | Type | Détails |
|---|
to requis | texte | Mobile du destinataire : 0612345678, 06 12 34 56 78 ou +33612345678 (mobiles français, 06 et 07) |
text requis | texte | 160 caractères par SMS (153 par partie au-delà) ; 70 (67) avec ê, â, î, ô, û, ç minuscule ou un emoji — 1000 caractères au plus |
sender | texte | Expéditeur affiché (3 à 11 lettres/chiffres) ; refusé s’il figure sur une liste de blocage |
tag | texte | É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" |
inviteText | texte | channel 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 |
statusCallback | texte | Adresse 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 vxk_…" \
-H "Content-Type: application/json" \
-d '{"to":"+33612345678","text":"…"}'
Réponse
{
"id": "…",
"to": "+33612345678",
"text": "…"
}
Champs de la réponse
| Champ | Type | Détails |
|---|
id | texte | |
to | texte | Numéro E.164 |
text | texte | |
status | "queued" | "sent" | "delivered" | "failed" | queued : en file ; sent : accepté par l’opérateur ; delivered : remis ; failed : échec |
providerStatus | texte ou null | Dernier état du fournisseur : accepted, sent, delivered, hard_bounce… |
messageId | texte ou null | Identifiant de suivi du message chez l’opérateur SMS |
sender | texte ou null | |
tag | texte ou null | |
type | "transactional" | "marketing" | null | |
segments | entier | Crédits consommés |
channel | texte ou null | |
error | texte ou null | |
createdAt | texte | date et heure ISO 8601 |
sentAt | texte ou null | |
deliveredAt | texte ou null | |
events | liste de objet | |
events[].status | texte | |
events[].at | texte | date et heure ISO 8601 |
GET/api/v1/sms/{id}Administrateur#
Un SMS et ses événements de remise (accepted, sent, delivered…)
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | Identifiant ou messageId du fournisseur |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/sms/{id}" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"id": "…",
"to": "+33612345678",
"text": "…"
}
Champs de la réponse
| Champ | Type | Détails |
|---|
id | texte | |
to | texte | Numéro E.164 |
text | texte | |
status | "queued" | "sent" | "delivered" | "failed" | queued : en file ; sent : accepté par l’opérateur ; delivered : remis ; failed : échec |
providerStatus | texte ou null | Dernier état du fournisseur : accepted, sent, delivered, hard_bounce… |
messageId | texte ou null | Identifiant de suivi du message chez l’opérateur SMS |
sender | texte ou null | |
tag | texte ou null | |
type | "transactional" | "marketing" | null | |
segments | entier | Crédits consommés |
channel | texte ou null | |
error | texte ou null | |
createdAt | texte | date et heure ISO 8601 |
sentAt | texte ou null | |
deliveredAt | texte ou null | |
events | liste de objet | |
events[].status | texte | |
events[].at | texte | date et heure ISO 8601 |
GET/api/v1/sms/balanceAdministrateur#
Crédits SMS : forfait du mois et solde à vie
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/sms/balance" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"monthlyLimit": 1,
"monthlyUsed": 1,
"monthlyLeft": 1
}
Champs de la réponse
| Champ | Type | Détails |
|---|
monthlyLimit | entier | Forfait du mois (remis à zéro chaque mois) |
monthlyUsed | entier | |
monthlyLeft | entier | |
balance | entier | Solde à vie (sans expiration), utilisé après le forfait du mois |
available | entier | Forfait restant + solde |
metered | objet | SMS au comptage : facturés à l’unité en fin de mois une fois le forfait et le solde épuisés |
metered.enabled | booléen | |
metered.unitPriceCents | nombre | Tarif HT d’un SMS en centimes (5.8 = 0,058 €) |
metered.cap | entier ou null | Plafond mensuel (null : sans plafond) |
metered.monthUsed | entier | |
metered.monthCents | entier | Montant HT du mois |
metered.left | entier ou null | SMS au comptage encore autorisés ce mois-ci |
GET/api/v1/sms/callback-secretAdministrateur#
Secret de signature des rappels de statut propres à un message (statusCallback) : X-VoxNova-Signature: sha256=<HMAC-SHA256 du corps>
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/sms/callback-secret" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"secret": "…"
}
Champs de la réponse
| Champ | Type | Détails |
|---|
secret | texte | |
POST/api/v1/verifyAdministrateur#
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).
Corps (JSON)
| Champ | Type | Détails |
|---|
to requis | texte | Numéro du destinataire |
channel | "sms" | "whatsapp" | "auto" | par défaut "sms" |
codeLength | entier | de 4 à 10 · par défaut 6 |
ttlSeconds | entier | de 60 à 1800 · par défaut 600 |
brand | texte | Nom affiché dans le message (défaut : votre entreprise) — 30 caractères au plus |
locale | "fr" | "en" | par défaut "fr" |
tag | texte | 100 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/verify" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"to":"+33612345678"}'
Réponse
{
"id": "…",
"to": "+33612345678",
"channel": "sms"
}
Champs de la réponse
| Champ | Type | Détails |
|---|
id | texte | |
to | texte | |
channel | "sms" | "whatsapp" | "auto" | |
status | "pending" | "approved" | "expired" | "failed" | "canceled" | |
attemptsLeft | entier | |
sends | entier | |
tag | texte ou null | |
expiresAt | texte | date et heure ISO 8601 |
approvedAt | texte ou null | date et heure ISO 8601 |
createdAt | texte | date et heure ISO 8601 |
GET/api/v1/verify/{id}Administrateur#
État d’une vérification (pending, approved, expired, failed, canceled)
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | Identifiant |
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/verify/{id}" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"id": "…",
"to": "+33612345678",
"channel": "sms"
}
Champs de la réponse
| Champ | Type | Détails |
|---|
id | texte | |
to | texte | |
channel | "sms" | "whatsapp" | "auto" | |
status | "pending" | "approved" | "expired" | "failed" | "canceled" | |
attemptsLeft | entier | |
sends | entier | |
tag | texte ou null | |
expiresAt | texte | date et heure ISO 8601 |
approvedAt | texte ou null | date et heure ISO 8601 |
createdAt | texte | date et heure ISO 8601 |
POST/api/v1/verify/{id}/cancelAdministrateur#
Annuler une vérification en cours
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | Identifiant |
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/verify/{id}/cancel" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"id": "…",
"to": "+33612345678",
"channel": "sms"
}
Champs de la réponse
| Champ | Type | Détails |
|---|
id | texte | |
to | texte | |
channel | "sms" | "whatsapp" | "auto" | |
status | "pending" | "approved" | "expired" | "failed" | "canceled" | |
attemptsLeft | entier | |
sends | entier | |
tag | texte ou null | |
expiresAt | texte | date et heure ISO 8601 |
approvedAt | texte ou null | date et heure ISO 8601 |
createdAt | texte | date et heure ISO 8601 |
POST/api/v1/verify/checkAdministrateur#
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.
Corps (JSON)
| Champ | Type | Détails |
|---|
id | texte | |
to | texte | |
code requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/verify/check" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"code":"…"}'
Réponse
""
Applications métier
Centre d’appels (campagnes, qualifications, pauses), hôtel (chambres, arrivées, départs, réveils), radio (émissions, appels à l’antenne).
PATCH/api/apps/callcenter/callbacks/{id}Utilisateur#
Met à jour un rappel planifié (date, fait, annulé).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X PATCH "https://api.hcloud.fr/api/apps/callcenter/callbacks/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/apps/callcenter/campaignsUtilisateur#
Campagnes d’appels.
Exemple
curl -X GET "https://api.hcloud.fr/api/apps/callcenter/campaigns" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwjdjq3i0014q7rreaq9da4i",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"name": "Relance clients",
"status": "DRAFT",
"agents": [],
"maxAttempts": 3,
"retryMinutes": 60,
"script": "",
"createdAt": "2026-11-16T14:44:17.503Z",
"counts": {
"PENDING": 1
}
}
]
POST/api/apps/callcenter/campaignsAdministrateur#
Crée une campagne.
Corps (JSON)
| Champ | Type | Détails |
|---|
name requis | texte | 1 à 100 caractères |
agents | liste de texte | 500 éléments au plus · par défaut [] |
maxAttempts | entier | de 1 à 20 · par défaut 3 |
retryMinutes | entier | de 1 à 10080 · par défaut 60 |
script | texte | 10000 caractères au plus · par défaut "" |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/callcenter/campaigns" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin"}'
PUT/api/apps/callcenter/campaigns/{id}Administrateurpartiel#
Modifie une campagne.
Modification partielle : seuls les champs envoyés sont modifiés.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
name | texte | 1 à 100 caractères |
agents | liste de texte | 500 éléments au plus · par défaut [] |
maxAttempts | entier | de 1 à 20 · par défaut 3 |
retryMinutes | entier | de 1 à 10080 · par défaut 60 |
script | texte | 10000 caractères au plus · par défaut "" |
status | "DRAFT" | "RUNNING" | "PAUSED" | "DONE" | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/apps/callcenter/campaigns/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin","agents":[],"maxAttempts":3}'
DELETE/api/apps/callcenter/campaigns/{id}Administrateur#
Supprime une campagne.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/apps/callcenter/campaigns/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/apps/callcenter/campaigns/{id}/contactsUtilisateur#
Contacts d’une campagne et leur état (à appeler, joint, à rappeler…).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/apps/callcenter/campaigns/{id}/contacts" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwjdjq3u001aq7rr0qgmq34d",
"campaignId": "cmwjdjq3i0014q7rreaq9da4i",
"number": "+33612345678",
"name": "",
"data": {},
"status": "PENDING",
"attempts": 0,
"assignedTo": null,
"nextAttemptAt": "2026-11-16T14:44:17.514Z",
"dispositionId": null,
"notes": "",
"updatedAt": "2026-11-16T14:44:17.514Z"
}
]
POST/api/apps/callcenter/campaigns/{id}/contactsAdministrateur#
Import de contacts : CSV « numéro;nom;autres colonnes… » (première ligne d'en-têtes facultative).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
csv requis | texte | 3 à 5000000 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/callcenter/campaigns/{id}/contacts" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"csv":"…"}'
POST/api/apps/callcenter/campaigns/{id}/nextUtilisateur#
Contact suivant pour l'agent (verrouillé pour lui jusqu'à la qualification).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/callcenter/campaigns/{id}/next" \
-H "Authorization: Bearer vxk_…"
POST/api/apps/callcenter/contacts/{id}/releaseUtilisateur#
Libère un contact réservé par un agent (remis dans la campagne).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/callcenter/contacts/{id}/release" \
-H "Authorization: Bearer vxk_…"
GET/api/apps/callcenter/dispositionsUtilisateur#
Qualifications d’appel.
Exemple
curl -X GET "https://api.hcloud.fr/api/apps/callcenter/dispositions" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwjdjq3d0011q7rrhn90wqi8",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"label": "Vente conclue",
"color": "slate",
"success": false,
"callback": false,
"sortOrder": 0
}
]
POST/api/apps/callcenter/dispositionsAdministrateur#
Crée une qualification.
Corps (JSON)
| Champ | Type | Détails |
|---|
label requis | texte | 1 à 60 caractères |
color | texte | 20 caractères au plus · par défaut "slate" |
success | booléen | par défaut false |
callback | booléen | par défaut false |
sortOrder | entier | de -9007199254740991 à 9007199254740991 · par défaut 0 |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/callcenter/dispositions" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"label":"…"}'
PUT/api/apps/callcenter/dispositions/{id}Administrateurpartiel#
Modifie une qualification.
Modification partielle : seuls les champs envoyés sont modifiés.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
label | texte | 1 à 60 caractères |
color | texte | 20 caractères au plus · par défaut "slate" |
success | booléen | par défaut false |
callback | booléen | par défaut false |
sortOrder | entier | de -9007199254740991 à 9007199254740991 · par défaut 0 |
Exemple
curl -X PUT "https://api.hcloud.fr/api/apps/callcenter/dispositions/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"label":"…","color":"slate","success":false}'
DELETE/api/apps/callcenter/dispositions/{id}Administrateur#
Supprime une qualification.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/apps/callcenter/dispositions/{id}" \
-H "Authorization: Bearer vxk_…"
POST/api/apps/callcenter/logsUtilisateur#
Qualification de l'appel (après chaque appel) ; met à jour la campagne et programme un rappel.
Corps (JSON)
| Champ | Type | Détails |
|---|
number requis | texte | 2 à 30 caractères |
direction | "INBOUND" | "OUTBOUND" | par défaut "INBOUND" |
dispositionId | texte ou null | |
notes | texte | 4000 caractères au plus · par défaut "" |
durationSec | entier | de 0 à 9007199254740991 · par défaut 0 |
contactId | texte ou null | |
callback | objet ou null | |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/callcenter/logs" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"number":"+33612345678"}'
GET/api/apps/callcenter/lookupUtilisateur#
Fiche de l'appelant : contact, historique des échanges, rappels, données de campagne.
Paramètres de requête
| Champ | Type | Détails |
|---|
number requis | texte | 2 à 30 caractères |
Exemple
curl -X GET "https://api.hcloud.fr/api/apps/callcenter/lookup" \
-H "Authorization: Bearer vxk_…"
GET/api/apps/callcenter/meUtilisateur#
État de l’agent connecté : statut, pause, appel en cours, rappels à faire.
Exemple
curl -X GET "https://api.hcloud.fr/api/apps/callcenter/me" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"extensions": [
{
"id": "cmv8684sf0008q7abh4b8ftyw",
"number": "102"
}
],
"queues": [
{
"id": "cmv8684ta000gq7abhezk2dgn",
"name": "Service client",
"number": "600"
}
],
"status": "Logged Out",
"state": null,
"pauseReason": null,
"since": null,
"today": {
"calls": 0,
"talkSec": 0,
"byDisposition": []
},
"callbacks": [],
"campaigns": []
}
POST/api/apps/callcenter/me/statusUtilisateur#
Change le statut de l’agent : disponible, en pause (avec motif), déconnecté.
Corps (JSON)
| Champ | Type | Détails |
|---|
status requis | "Available" | "On Break" | "Logged Out" | |
reason | texte ou null | |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/callcenter/me/status" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"status":"Available"}'
GET/api/apps/callcenter/overviewAdministrateur#
Tableau de bord du centre d’appels : agents, campagnes, files, indicateurs du jour.
Exemple
curl -X GET "https://api.hcloud.fr/api/apps/callcenter/overview" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"queues": [
{
"id": "cmv8684ta000gq7abhezk2dgn",
"name": "Service client",
"number": "600",
"waiting": 0,
"longestWaitSec": 0,
"talking": 0
}
],
"agents": [
{
"extensionId": "cmv8684s40006q7abi97pyqu8",
"number": "101",
"name": "Julie Martin",
"status": "Logged Out",
"state": "",
"pauseReason": null,
"since": null,
"callsAnswered": 0,
"qualified": 0,
"success": 0
},
{
"extensionId": "cmv8684so000aq7ab7xldoinc",
"number": "103",
"name": "Sophie Laurent",
"status": "Logged Out",
"state": "",
"pauseReason": null,
"since": null,
"callsAnswered": 0,
"qualified": 0,
"success": 0
}
],
"dispositions": [
{
"id": "cmwjdjq3d0011q7rrhn90wqi8",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"label": "Vente conclue",
"color": "slate",
"success": false,
"callback": false,
"sortOrder": 0,
"count": 0
}
]
}
GET/api/apps/callcenter/pause-reasonsUtilisateur#
Motifs de pause.
Exemple
curl -X GET "https://api.hcloud.fr/api/apps/callcenter/pause-reasons" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwjdjq3g0012q7rrdjj79uru",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"label": "Déjeuner"
}
]
POST/api/apps/callcenter/pause-reasonsAdministrateur#
Crée un motif de pause.
Corps (JSON)
| Champ | Type | Détails |
|---|
label requis | texte | 1 à 60 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/callcenter/pause-reasons" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"label":"…"}'
DELETE/api/apps/callcenter/pause-reasons/{id}Administrateur#
Supprime un motif de pause.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/apps/callcenter/pause-reasons/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/apps/hotel/roomsUtilisateur#
Chambres.
Exemple
curl -X GET "https://api.hcloud.fr/api/apps/hotel/rooms" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwjdjq39000xq7rrj7toyz2x",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"number": "101",
"floor": "",
"extensionId": null,
"occupied": false,
"guestName": "",
"guestLanguage": "fr",
"checkInAt": null,
"housekeeping": "CLEAN",
"notes": "",
"updatedAt": "2026-11-16T14:44:17.493Z",
"wakeups": [],
"extension": null
}
]
POST/api/apps/hotel/roomsAdministrateur#
Crée une chambre.
Corps (JSON)
| Champ | Type | Détails |
|---|
number requis | texte | 1 à 10 caractères |
floor | texte | 20 caractères au plus · par défaut "" |
extensionId | texte ou null | |
createExtension | booléen | par défaut false |
notes | texte | 500 caractères au plus · par défaut "" |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/hotel/rooms" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"number":"+33612345678"}'
PATCH/api/apps/hotel/rooms/{id}Utilisateur#
Modifie une chambre.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
housekeeping | "CLEAN" | "DIRTY" | "INSPECTED" | "OUT_OF_ORDER" | |
notes | texte | 500 caractères au plus |
floor | texte | 20 caractères au plus |
dnd | booléen | |
guestName | texte | 80 caractères au plus |
Exemple
curl -X PATCH "https://api.hcloud.fr/api/apps/hotel/rooms/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"housekeeping":"CLEAN","notes":"…","floor":"…"}'
DELETE/api/apps/hotel/rooms/{id}Administrateur#
Supprime une chambre.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/apps/hotel/rooms/{id}" \
-H "Authorization: Bearer vxk_…"
POST/api/apps/hotel/rooms/{id}/checkinUtilisateur#
Arrivée d’un client : la chambre est ouverte aux appels (droits d’appel, nom affiché).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
guestName requis | texte | 1 à 80 caractères |
language | texte | 5 caractères au plus · par défaut "fr" |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/hotel/rooms/{id}/checkin" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"guestName":"…"}'
POST/api/apps/hotel/rooms/{id}/checkoutUtilisateur#
Départ : appels de la chambre bloqués, relevé des communications.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/hotel/rooms/{id}/checkout" \
-H "Authorization: Bearer vxk_…"
GET/api/apps/hotel/rooms/{id}/folioUtilisateur#
Relevé des appels facturables de la chambre pendant le séjour.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/apps/hotel/rooms/{id}/folio" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"room": "101",
"guestName": "",
"checkInAt": null,
"lines": [],
"totalCents": 0
}
POST/api/apps/hotel/rooms/{id}/wakeupsUtilisateur#
Programme un réveil téléphonique pour la chambre.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
at requis | | |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/hotel/rooms/{id}/wakeups" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"at":"…"}'
POST/api/apps/hotel/rooms/bulkAdministrateur#
Crée plusieurs chambres d’un coup (plage de numéros).
Corps (JSON)
| Champ | Type | Détails |
|---|
from requis | entier | de 1 à 9007199254740991 |
to requis | entier | de 1 à 9007199254740991 |
floor | texte | 20 caractères au plus · par défaut "" |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/hotel/rooms/bulk" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"from":1,"to":1}'
GET/api/apps/hotel/settingsUtilisateur#
Réglages de l’hôtel : tarifs des appels, numéros autorisés, réveils.
Exemple
curl -X GET "https://api.hcloud.fr/api/apps/hotel/settings" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"occupiedPermission": "NATIONAL",
"vacantPermission": "INTERNAL",
"markupPercent": 50,
"minChargeCents": 30,
"wakeupRetries": 3
}
PUT/api/apps/hotel/settingsAdministrateur#
Modifie les réglages de l’hôtel.
Corps (JSON)
| Champ | Type | Détails |
|---|
occupiedPermission requis | "INTERNAL" | "NATIONAL" | "INTERNATIONAL" | |
vacantPermission requis | "INTERNAL" | "NATIONAL" | "INTERNATIONAL" | |
markupPercent requis | nombre | de 0 à 1000 |
minChargeCents requis | entier | de 0 à 9007199254740991 |
wakeupRetries requis | entier | de 1 à 5 |
Exemple
curl -X PUT "https://api.hcloud.fr/api/apps/hotel/settings" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"occupiedPermission":"INTERNAL","vacantPermission":"INTERNAL","markupPercent":0,"minChargeCents":0,"wakeupRetries":1}'
GET/api/apps/hotel/staysUtilisateur#
Historique des séjours.
Exemple
curl -X GET "https://api.hcloud.fr/api/apps/hotel/stays" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
DELETE/api/apps/hotel/wakeups/{id}Utilisateur#
Supprime un réveil.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/apps/hotel/wakeups/{id}" \
-H "Authorization: Bearer vxk_…"
PATCH/api/apps/radio/calls/{id}Utilisateur#
Met à jour un auditeur en attente (nom, note, ordre de passage).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
name | texte | 80 caractères au plus |
city | texte | 80 caractères au plus |
topic | texte | 200 caractères au plus |
note | texte | 1000 caractères au plus |
priority | entier | de 0 à 9 |
Exemple
curl -X PATCH "https://api.hcloud.fr/api/apps/radio/calls/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin","city":"…","topic":"…"}'
POST/api/apps/radio/calls/{id}/actionUtilisateur#
Actions du standard et de l'antenne.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
action requis | "screen" | "wait" | "ready" | "air" | "hangup" | "mute" | "unmute" | |
extensionId | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/radio/calls/{id}/action" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"action":"screen"}'
GET/api/apps/radio/showsUtilisateur#
Émissions.
Exemple
curl -X GET "https://api.hcloud.fr/api/apps/radio/shows" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwjdjq3c000zq7rrdkbtrcem",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"name": "Matinale",
"studioExtensionId": null,
"screeners": [],
"welcomeAudioId": null,
"holdAudioId": null,
"maxWaiting": 20,
"autoAnswer": true,
"createdAt": "2026-11-16T14:44:17.496Z"
}
]
POST/api/apps/radio/showsAdministrateur#
Crée une émission.
Corps (JSON)
| Champ | Type | Détails |
|---|
name requis | texte | 1 à 100 caractères |
studioExtensionId | texte ou null | |
screeners | liste de texte | 50 éléments au plus · par défaut [] |
welcomeAudioId | texte ou null | |
holdAudioId | texte ou null | |
maxWaiting | entier | de 1 à 200 · par défaut 20 |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/radio/shows" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin"}'
PUT/api/apps/radio/shows/{id}Administrateurpartiel#
Modifie une émission.
Modification partielle : seuls les champs envoyés sont modifiés.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
name | texte | 1 à 100 caractères |
studioExtensionId | texte ou null | |
screeners | liste de texte | 50 éléments au plus · par défaut [] |
welcomeAudioId | texte ou null | |
holdAudioId | texte ou null | |
maxWaiting | entier | de 1 à 200 · par défaut 20 |
Exemple
curl -X PUT "https://api.hcloud.fr/api/apps/radio/shows/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin","studioExtensionId":"…","screeners":[]}'
DELETE/api/apps/radio/shows/{id}Administrateur#
Supprime une émission.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/apps/radio/shows/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/apps/radio/shows/{id}/liveUtilisateur#
État en direct : auditeurs, antenne, studio.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/apps/radio/shows/{id}/live" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"online": false,
"now": 1795214336043,
"show": {
"id": "cmwjdjq3c000zq7rrdkbtrcem",
"name": "Matinale",
"studioExtension": null
},
"studio": {
"connected": false,
"muted": false,
"talking": false
},
"calls": [
{
"id": "cmwjdjq3q0018q7rryubwbar3",
"showId": "cmwjdjq3c000zq7rrdkbtrcem",
"uuid": "00000000-0000-4000-8000-000000000002",
"caller": "+33612345678",
"callerName": null,
"state": "WAITING",
"name": "",
"city": "",
"topic": "",
"note": "",
"priority": 0,
"screenedBy": null,
"onAirAt": null,
"endedAt": null,
"createdAt": "2026-11-16T14:44:17.510Z",
"updatedAt": "2026-11-16T14:44:17.510Z",
"air": null
}
],
"ended": []
}
POST/api/apps/radio/shows/{id}/studioUtilisateur#
Ouvre ou ferme le studio de l’émission (prise d’appels).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
action requis | "connect" | "disconnect" | "mute" | "unmute" | "clear" | |
Exemple
curl -X POST "https://api.hcloud.fr/api/apps/radio/shows/{id}/studio" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"action":"connect"}'
Abonnement, factures et options
Offres, devis, souscription, moyens de paiement, factures, renouvellement, options (intégrations, enquête de satisfaction…).
GET/api/addonsAdministrateur#
Options disponibles et options souscrites (prix, état, réglages).
Exemple
curl -X GET "https://api.hcloud.fr/api/addons" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"code": "whmcs",
"label": "Intégration WHMCS",
"description": "Clic pour appeler, fiche client à l’appel, appels et résumés IA notés dans WHMCS",
"priceCents": 1000,
"active": false,
"offered": false,
"hasToken": false,
"startedAt": null,
"settings": {
"noteInbound": true,
"noteOutbound": true,
"noteMissed": true,
"aiSummary": true,
"minDurationSec": 0,
"popup": true
}
},
{
"code": "satisfaction",
"label": "Enquête de satisfaction",
"description": "L’appelant note l’appel au clavier après la conversation, sur vos critères ; tableau de bord par agent, file et critère",
"priceCents": 900,
"active": true,
"offered": true,
"hasToken": false,
"startedAt": "2026-10-14T17:28:39.572Z"
}
]
POST/api/addons/{code}/cancelAdministrateur#
Résilie une option.
Paramètres de chemin
| Champ | Type | Détails |
|---|
code requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/addons/{code}/cancel" \
-H "Authorization: Bearer vxk_…"
POST/api/addons/{code}/subscribeAdministrateur#
Souscrit une option (code : whmcs, satisfaction…).
Paramètres de chemin
| Champ | Type | Détails |
|---|
code requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/addons/{code}/subscribe" \
-H "Authorization: Bearer vxk_…"
POST/api/addons/{code}/tokenAdministrateur#
Crée (ou remplace) le jeton de connexion de l’option (module WHMCS) ; affiché une seule fois.
Paramètres de chemin
| Champ | Type | Détails |
|---|
code requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/addons/{code}/token" \
-H "Authorization: Bearer vxk_…"
GET/api/addons/whmcs/module.zipAdministrateur#
Télécharge le module WHMCS prêt à installer.
Exemple
curl -X GET "https://api.hcloud.fr/api/addons/whmcs/module.zip" \
-H "Authorization: Bearer vxk_…"
PUT/api/addons/whmcs/settingsAdministrateur#
Réglages du module WHMCS : notes d’appels dans la fiche client, résumé IA, fiche à l’appel.
Corps (JSON)
| Champ | Type | Détails |
|---|
noteInbound | booléen | |
noteOutbound | booléen | |
noteMissed | booléen | |
aiSummary | booléen | |
minDurationSec | entier | de 0 à 600 |
popup | booléen | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/addons/whmcs/settings" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"noteInbound":true,"noteOutbound":true,"noteMissed":true}'
GET/api/billingAdministrateur#
Abonnement, licences, moyens de paiement, factures, consommation et offres proposées.
Exemple
curl -X GET "https://api.hcloud.fr/api/billing" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"methods": [
"card"
],
"org": {
"id": "cmv8684q90000q7abs5rcqq3y",
"sandbox": false,
"sandboxOwnerId": null,
"name": "Boulangerie Martin",
"slug": "demo-documentation",
"sipDomain": "demo-documentation.demo.invalid",
"status": "ACTIVE",
"billingEmail": null,
"vatNumber": null,
"address": null,
"country": "FR",
"trialEndsAt": null,
"settings": {
"phonebookToken": "••••••••"
},
"centrexEnabled": true,
"timezone": "Europe/Paris",
"defaultCallerId": null,
"recordingRetentionDays": 90,
"maxChannels": null,
"pbxNodeId": null,
"pbxHomeNodeId": null,
"pbxPinned": false,
"lat": null,
"lon": null,
"telecomBilledMonth": "2026-10",
"apps": [
"radio",
"hotel"
],
"mohId": null,
"announceOverMusic": false,
"announceMode": "alone",
"announceMusicLevel": 25,
"simpleMode": false,
"product": "CENTREX",
"onboardingDone": true,
"aiGranted": false,
"postalCode": "69002",
"inseeCode": "69382",
"city": "Lyon",
"blockPremium": true,
"blockShortNumbers": true,
"specialCapCents": 3000,
"internationalCapCents": 3000
},
"current": null,
"licenses": [],
"paymentMethods": [],
"invoices": [],
"usage": {
"used": 2,
"seats": 0,
"available": 0
},
"plans": [],
"products": [
"CENTREX_HOSTED",
"RELAY"
],
"centrexHostedName": "Centrex by VoxNova",
"provider": "test",
"taxRatePercent": 20,
"pending": [],
"managedBy": null
}
POST/api/billing/auto-renewAdministrateur#
Active ou désactive le renouvellement automatique de l’abonnement.
Corps (JSON)
| Champ | Type | Détails |
|---|
autoRenew requis | booléen | |
Exemple
curl -X POST "https://api.hcloud.fr/api/billing/auto-renew" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"autoRenew":true}'
POST/api/billing/checkoutAdministrateur#
Souscription / changement d'offre.
Corps (JSON)
| Champ | Type | Détails |
|---|
planCode requis | texte | |
seats requis | entier | de 1 à 100000 |
channels | entier ou null | |
numbers | entier | de 0 à 500 |
unlimitedCalls | booléen | |
aiAnalysis | booléen | |
teams | booléen | |
card | objet | |
card.number requis | texte | 12 à 23 caractères |
card.expMonth requis | entier | de 1 à 12 |
card.expYear requis | entier | de 0 à 2100 |
card.cvc requis | texte | 3 à 4 caractères |
card.holderName | texte | 100 caractères au plus |
paymentMethodId | texte | |
method | "card" | "sepa" | "transfer" | |
Exemple
curl -X POST "https://api.hcloud.fr/api/billing/checkout" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"planCode":"…","seats":1}'
GET/api/billing/invoices/{id}Administrateur#
Facture en PDF (Factur-X si la plateforme agréée est configurée).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/billing/invoices/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/billing/license-keyAdministrateur#
Clé de licence de l’abonnement en cours (installation sur site).
Exemple
curl -X GET "https://api.hcloud.fr/api/billing/license-key" \
-H "Authorization: Bearer vxk_…"
POST/api/billing/orders/{id}/cancelAdministrateur#
Annulation d'une commande pas encore payée (paiement manuel).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/billing/orders/{id}/cancel" \
-H "Authorization: Bearer vxk_…"
POST/api/billing/payment-methodsAdministrateur#
Enregistre une carte bancaire (vérifiée par une autorisation de 0 €) ; elle devient le moyen de paiement par défaut.
Corps (JSON)
| Champ | Type | Détails |
|---|
number requis | texte | 12 à 23 caractères |
expMonth requis | entier | de 1 à 12 |
expYear requis | entier | de 0 à 2100 |
cvc requis | texte | 3 à 4 caractères |
holderName | texte | 100 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/billing/payment-methods" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"number":"+33612345678","expMonth":1,"expYear":0,"cvc":"…"}'
DELETE/api/billing/payment-methods/{id}Administrateur#
Supprime un moyen de paiement.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/billing/payment-methods/{id}" \
-H "Authorization: Bearer vxk_…"
POST/api/billing/quoteAdministrateur#
Calcule le prix d’une offre (postes, canaux, numéros, options) sans rien souscrire.
Corps (JSON)
| Champ | Type | Détails |
|---|
planCode requis | texte | |
seats requis | entier | de 1 à 9007199254740991 |
channels | entier ou null | |
numbers | entier | de 0 à 500 |
unlimitedCalls | booléen | |
aiAnalysis | booléen | |
teams | booléen | |
Exemple
curl -X POST "https://api.hcloud.fr/api/billing/quote" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"planCode":"…","seats":1}'
Intégrations
Fiche CRM à la prise d’appel (le softphone ouvre la fiche du client, requête signée vers votre CRM avec les variables du scénario), clés d’API, webhooks (appels terminés, messages vocaux…), Microsoft Teams (Direct Routing), module WHMCS.
GET/api/centrex/api-keysAdministrateur#
Clés d’API.
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/api-keys" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwjdjq3m0016q7rrcw12anod",
"name": "Intégration",
"prefix": "vxk_demo",
"lastUsedAt": null,
"createdAt": "2026-11-16T14:44:17.507Z"
}
]
POST/api/centrex/api-keysAdministrateur#
Crée une clé d’API.
Corps (JSON)
| Champ | Type | Détails |
|---|
name requis | texte | 1 à 100 caractères |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/api-keys" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":"Julie Martin"}'
DELETE/api/centrex/api-keys/{id}Administrateur#
Supprime une clé d’API.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/centrex/api-keys/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/centrex/webhooksAdministrateur#
Webhooks.
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/webhooks" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmwjdjq2m000fq7rr3nmw95pw",
"orgId": "cmv8684q90000q7abs5rcqq3y",
"url": "https://exemple.invalid/webhook",
"events": [
"call.completed"
],
"secret": "••••••••",
"enabled": true,
"lastStatus": null,
"createdAt": "2026-11-16T14:44:17.470Z"
}
]
POST/api/centrex/webhooksAdministrateur#
Crée un webhook.
Corps (JSON)
| Champ | Type | Détails |
|---|
url requis | texte | adresse web |
events | liste de "call.completed" | "voicemail.new" | "sms.status" | "porting.status" | "number.assigned" | "invoice.created" | "invoice.paid" | par défaut ["call.completed"] |
enabled | booléen | par défaut true |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/webhooks" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"url":"https://exemple.fr/webhook"}'
PUT/api/centrex/webhooks/{id}Administrateurpartiel#
Modifie un webhook.
Modification partielle : seuls les champs envoyés sont modifiés.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
url | texte | adresse web |
events | liste de "call.completed" | "voicemail.new" | "sms.status" | "porting.status" | "number.assigned" | "invoice.created" | "invoice.paid" | par défaut ["call.completed"] |
enabled | booléen | par défaut true |
Exemple
curl -X PUT "https://api.hcloud.fr/api/centrex/webhooks/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"url":"https://exemple.fr/webhook","events":["call.completed"],"enabled":true}'
DELETE/api/centrex/webhooks/{id}Administrateur#
Supprime un webhook.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/centrex/webhooks/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/centrex/webhooks/{id}/deliveriesAdministrateur#
Journal des envois du webhook (14 jours) : état, nombre d’essais, prochain essai, réponse reçue, contenu envoyé.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/centrex/webhooks/{id}/deliveries" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
POST/api/centrex/webhooks/{id}/deliveries/{delivery}/retryAdministrateur#
Renvoie tout de suite un envoi.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
delivery requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/webhooks/{id}/deliveries/{delivery}/retry" \
-H "Authorization: Bearer vxk_…"
POST/api/centrex/webhooks/{id}/testAdministrateur#
Envoie un événement de test au webhook.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/centrex/webhooks/{id}/test" \
-H "Authorization: Bearer vxk_…"
POST/api/integrations/whmcs/callAdministrateur#
Module WHMCS : lance un appel depuis la fiche client.
Exemple
curl -X POST "https://api.hcloud.fr/api/integrations/whmcs/call" \
-H "Authorization: Bearer vxk_…"
GET/api/integrations/whmcs/eventsAdministrateur#
Appels terminés et analyses IA depuis les curseurs donnés (synchronisation des notes).
Exemple
curl -X GET "https://api.hcloud.fr/api/integrations/whmcs/events" \
-H "Authorization: Bearer vxk_…"
GET/api/integrations/whmcs/liveAdministrateur#
Module WHMCS : appels en cours par poste (fiche client à l’appel).
Exemple
curl -X GET "https://api.hcloud.fr/api/integrations/whmcs/live" \
-H "Authorization: Bearer vxk_…"
PUT/api/integrations/whmcs/lookupAdministrateur#
Le module déclare l'adresse de son point d'interrogation (lookup.php) et un secret partagé (codes support).
Exemple
curl -X PUT "https://api.hcloud.fr/api/integrations/whmcs/lookup" \
-H "Authorization: Bearer vxk_…"
GET/api/integrations/whmcs/pingAdministrateur#
Module WHMCS : test de connexion.
Exemple
curl -X GET "https://api.hcloud.fr/api/integrations/whmcs/ping" \
-H "Authorization: Bearer vxk_…"
GET/api/integrations/whmcs/supervisionAdministrateur#
Supervision : files d'attente (appelants en attente, agents), appels en cours sur les postes.
Exemple
curl -X GET "https://api.hcloud.fr/api/integrations/whmcs/supervision" \
-H "Authorization: Bearer vxk_…"
GET/api/integrations/whmcs/updateAdministrateur#
Mise à jour automatique du module : version disponible, puis archive (vérifiée par son empreinte).
Exemple
curl -X GET "https://api.hcloud.fr/api/integrations/whmcs/update" \
-H "Authorization: Bearer vxk_…"
GET/api/integrations/whmcs/update.zipAdministrateur#
Module WHMCS : dernière version.
Exemple
curl -X GET "https://api.hcloud.fr/api/integrations/whmcs/update.zip" \
-H "Authorization: Bearer vxk_…"
GET/api/org/crmAdministrateur#
Réglages de la fiche CRM à la prise d’appel : mode (off, open : le softphone ouvre la fiche, request : requête de la plateforme, both), modèle de la fiche, adresse et méthode de la requête, secret de signature présent ou non.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/crm" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"mode": "off",
"url": "",
"requestUrl": "",
"requestMethod": "POST",
"hasSecret": false
}
PUT/api/org/crmAdministrateur#
Enregistre la fiche CRM. Modèles avec variables encodées automatiquement : {{caller}}, {{did}}, {{var.<nom>}} (variables du scénario : code tapé, client identifié, réponse d’une requête…). Adresses http(s) uniquement. Un secret de signature est créé au premier enregistrement.
Corps (JSON)
| Champ | Type | Détails |
|---|
mode requis | "off" | "open" | "request" | "both" | |
url requis | texte | 2000 caractères au plus |
requestUrl requis | texte | 2000 caractères au plus |
requestMethod requis | "POST" | "GET" | |
Exemple
curl -X PUT "https://api.hcloud.fr/api/org/crm" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"mode":"off","url":"https://exemple.fr/webhook","requestUrl":"https://exemple.fr/webhook","requestMethod":"POST"}'
POST/api/org/crm/secretAdministrateur#
Nouveau secret de signature des requêtes (vxc_…), affiché une seule fois. Vérifiez X-VoxNova-Signature: sha256=<HMAC-SHA256 du corps>.
Exemple
curl -X POST "https://api.hcloud.fr/api/org/crm/secret" \
-H "Authorization: Bearer vxk_…"
POST/api/org/crm/testAdministrateur#
Envoie une requête d’essai (variables d’exemple, champ test: true) et renvoie le statut obtenu.
Exemple
curl -X POST "https://api.hcloud.fr/api/org/crm/test" \
-H "Authorization: Bearer vxk_…"
GET/api/org/teamsAdministrateur#
Microsoft Teams : état du raccordement et numéros.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/teams" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"platform": {
"enabled": false,
"certReady": false,
"port": 5061,
"baseDomain": "teams.sip.localhost",
"dns": false
},
"enabled": false,
"fqdn": null,
"gateways": [],
"users": [
{
"id": "cmv8684rr0004q7abx95vduea",
"number": "100",
"name": "Accueil",
"email": null,
"teamsNumber": null
},
{
"id": "cmv8684s40006q7abi97pyqu8",
"number": "101",
"name": "Julie Martin",
"email": null,
"teamsNumber": null
}
],
"powershell": null
}
POST/api/org/teams/setupAdministrateur#
Mise en service : sous-domaine du SBC, enregistrement DNS, passerelles vers Microsoft.
Exemple
curl -X POST "https://api.hcloud.fr/api/org/teams/setup" \
-H "Authorization: Bearer vxk_…"
POST/api/org/teams/verificationAdministrateur#
Code de vérification du domaine donné par Microsoft 365 (« MS=ms12345678 ») : enregistrement TXT.
Corps (JSON)
| Champ | Type | Détails |
|---|
value requis | texte | format ^MS=ms\d{6,12}$ |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/teams/verification" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"value":"…"}'
GET/api/org/twilio-compatAdministrateur#
Compatibilité Twilio : Account SID de l’entreprise (null s’il n’est pas encore créé) et adresses à utiliser à la place de celles de Twilio.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/twilio-compat" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"accountSid": null,
"endpoints": {
"api": "http://localhost:5173/api/twilio",
"verify": "http://localhost:5173/api/twilio/verify",
"lookups": "http://localhost:5173/api/twilio/lookups"
}
}
POST/api/org/twilio-compat/tokenAdministrateur#
Crée les identifiants de compatibilité Twilio, ou un nouvel Auth Token (l’ancien cesse de fonctionner). Le jeton n’est affiché qu’une fois. Voir le guide « Compatibilité Twilio ».
Exemple
curl -X POST "https://api.hcloud.fr/api/org/twilio-compat/token" \
-H "Authorization: Bearer vxk_…"
GET/api/v1/webhooksAdministrateur#
Webhooks de l’entreprise
Exemple
curl -X GET "https://api.hcloud.fr/api/v1/webhooks" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "…",
"url": "https://exemple.fr/webhook",
"events": [
"call.completed"
]
}
]
Champs de la réponse
| Champ | Type | Détails |
|---|
id | texte | |
url | texte | adresse web |
events | liste de "call.completed" | "voicemail.new" | "sms.status" | "porting.status" | "number.assigned" | "invoice.created" | "invoice.paid" | |
enabled | booléen | |
lastStatus | texte ou null | |
secret | texte | Fourni une seule fois, à la création |
POST/api/v1/webhooksAdministrateur#
Créer un webhook (le secret de signature est renvoyé une fois)
Corps (JSON)
| Champ | Type | Détails |
|---|
url requis | texte | adresse web |
events | liste de "call.completed" | "voicemail.new" | "sms.status" | "porting.status" | "number.assigned" | "invoice.created" | "invoice.paid" | |
enabled | booléen | |
Exemple
curl -X POST "https://api.hcloud.fr/api/v1/webhooks" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"url":"https://exemple.fr/webhook"}'
Réponse
{
"id": "…",
"url": "https://exemple.fr/webhook",
"events": [
"call.completed"
]
}
Champs de la réponse
| Champ | Type | Détails |
|---|
id | texte | |
url | texte | adresse web |
events | liste de "call.completed" | "voicemail.new" | "sms.status" | "porting.status" | "number.assigned" | "invoice.created" | "invoice.paid" | |
enabled | booléen | |
lastStatus | texte ou null | |
secret | texte | Fourni une seule fois, à la création |
PATCH/api/v1/webhooks/{id}Administrateur#
Modifier
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | Identifiant |
Corps (JSON)
| Champ | Type | Détails |
|---|
url requis | texte | adresse web |
events | liste de "call.completed" | "voicemail.new" | "sms.status" | "porting.status" | "number.assigned" | "invoice.created" | "invoice.paid" | |
enabled | booléen | |
Exemple
curl -X PATCH "https://api.hcloud.fr/api/v1/webhooks/{id}" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"url":"https://exemple.fr/webhook"}'
Réponse
{
"id": "…",
"url": "https://exemple.fr/webhook",
"events": [
"call.completed"
]
}
Champs de la réponse
| Champ | Type | Détails |
|---|
id | texte | |
url | texte | adresse web |
events | liste de "call.completed" | "voicemail.new" | "sms.status" | "porting.status" | "number.assigned" | "invoice.created" | "invoice.paid" | |
enabled | booléen | |
lastStatus | texte ou null | |
secret | texte | Fourni une seule fois, à la création |
DELETE/api/v1/webhooks/{id}Administrateur#
Supprimer
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | Identifiant |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/v1/webhooks/{id}" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"ok": true
}
Champs de la réponse
| Champ | Type | Détails |
|---|
ok | booléen | |
Support et dépannage
Tickets de support, appel de test et diagnostic, sauvegardes et restauration de la configuration.
GET/api/config-backupsAdministrateur#
Sauvegardes de configuration.
Exemple
curl -X GET "https://api.hcloud.fr/api/config-backups" \
-H "Authorization: Bearer vxk_…"
Réponse
[
{
"id": "cmw3826bk2nkoq7dmrh54cyl4",
"name": "Sauvegarde automatique du 05/11/2026",
"kind": "auto",
"size": 1304,
"summary": {
"org": "Boulangerie Martin",
"audio": 1,
"queues": 1,
"numbers": 0,
"contacts": 0,
"ivrMenus": 1,
"callFlows": 0,
"createdAt": "2026-11-05T07:26:21.823Z",
"extensions": 5,
"ringGroups": 1,
"conferences": 0,
"timeConditions": 1
},
"createdBy": "plateforme",
"createdAt": "2026-11-05T07:26:21.825Z"
},
{
"id": "cmvsv48zh0v49q7dmy7s7qb78",
"name": "Sauvegarde automatique du 29/10/2026",
"kind": "auto",
"size": 1304,
"summary": {
"org": "Boulangerie Martin",
"audio": 1,
"queues": 1,
"numbers": 0,
"contacts": 0,
"ivrMenus": 1,
"callFlows": 0,
"createdAt": "2026-10-29T01:26:21.818Z",
"extensions": 5,
"ringGroups": 1,
"conferences": 0,
"timeConditions": 1
},
"createdBy": "plateforme",
"createdAt": "2026-10-29T01:26:21.822Z"
}
]
POST/api/config-backupsAdministrateur#
Crée une sauvegarde.
Corps (JSON)
| Champ | Type | Détails |
|---|
name | texte | 100 caractères au plus · par défaut "" |
Exemple
curl -X POST "https://api.hcloud.fr/api/config-backups" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"name":""}'
DELETE/api/config-backups/{id}Administrateur#
Supprime une sauvegarde.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X DELETE "https://api.hcloud.fr/api/config-backups/{id}" \
-H "Authorization: Bearer vxk_…"
GET/api/config-backups/{id}/downloadAdministrateur#
Télécharge une sauvegarde de configuration.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/config-backups/{id}/download" \
-H "Authorization: Bearer vxk_…"
POST/api/config-backups/{id}/restoreAdministrateur#
Restauration : une sauvegarde automatique de l'état actuel est faite juste avant.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Corps (JSON)
| Champ | Type | Détails |
|---|
sections | liste de "settings" | "audio" | "extensions" | "routing" | "numbers" | "contacts" | par défaut ["settings","audio","extensions","routing","numbers","contacts"] |
Exemple
curl -X POST "https://api.hcloud.fr/api/config-backups/{id}/restore" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"sections":["settings","audio","extensions","routing","numbers","contacts"]}'
POST/api/config-backups/uploadAdministrateur#
Fichier .hcfg déposé : vérifié, conservé dans l'espace, résumé renvoyé (l'import se fait ensuite).
Corps (multipart/form-data)
| Champ | Type | Détails |
|---|
file requis | fichier | Sauvegarde téléchargée auparavant |
Exemple
curl -X POST "https://api.hcloud.fr/api/config-backups/upload" \
-H "Authorization: Bearer vxk_…" \
-F "file=@fichier"
GET/api/org/troubleshootAdministrateur#
Diagnostic : postes, enregistrements, numéros, derniers appels en échec.
Paramètres de requête
| Champ | Type | Détails |
|---|
kind | "org" | "number" | "extension" | "user" | "flow" | par défaut "org" |
id | texte | 100 caractères au plus |
Exemple
curl -X GET "https://api.hcloud.fr/api/org/troubleshoot" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"kind": "org",
"target": "Boulangerie Martin",
"org": {
"id": "cmv8684q90000q7abs5rcqq3y",
"name": "Boulangerie Martin"
},
"generatedAt": "2026-11-20T22:38:57.357Z",
"level": "error",
"summary": "4 problèmes bloquants",
"path": [
"▸ +33199001234 (Accueil)",
"✖ aucune destination : appel rejeté"
],
"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 — Boulangerie Martin (Boulangerie Martin)\nLe 20/11/2026 23:38:57 — 4 problèmes bloquants\n\n✖ [Plateforme] Serveur téléphonique injoignable\n → Incid…"
}
POST/api/org/troubleshoot/callAdministrateur#
Lance un appel de test vers un poste ou un numéro.
Corps (JSON)
| Champ | Type | Détails |
|---|
kind requis | "ring" | "between" | "inbound" | |
extensionId | texte | 40 caractères au plus |
toExtensionId | texte | 40 caractères au plus |
number | texte | 30 caractères au plus |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/troubleshoot/call" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"kind":"ring"}'
GET/api/org/troubleshoot/targetsAdministrateur#
Cibles possibles pour l’appel de test.
Exemple
curl -X GET "https://api.hcloud.fr/api/org/troubleshoot/targets" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"numbers": [
{
"id": "+33199001234",
"label": "+33199001234 — Accueil"
}
],
"extensions": [
{
"id": "cmv8684rr0004q7abx95vduea",
"label": "100 — Accueil"
},
{
"id": "cmv8684s40006q7abi97pyqu8",
"label": "101 — Julie Martin"
}
],
"flows": [
{
"id": "cmwjdjq2o000hq7rrofua0gzt",
"label": "Accueil horaires"
}
]
}
POST/api/org/troubleshoot/ticketAdministrateur#
Ouvre un ticket de support avec le diagnostic joint.
Corps (JSON)
| Champ | Type | Détails |
|---|
kind | "org" | "number" | "extension" | "user" | "flow" | par défaut "org" |
id | texte | 100 caractères au plus |
message | texte | 5000 caractères au plus · par défaut "" |
Exemple
curl -X POST "https://api.hcloud.fr/api/org/troubleshoot/ticket" \
-H "Authorization: Bearer vxk_…" \
-H "Content-Type: application/json" \
-d '{"kind":"org","id":"…","message":""}'
GET/api/support/metaUtilisateur#
Support : disponible ou non (clients d’un revendeur : support assuré par le revendeur), catégories.
Exemple
curl -X GET "https://api.hcloud.fr/api/support/meta" \
-H "Authorization: Bearer vxk_…"
Réponse
{
"available": true,
"categories": {
"technique": "Appels et téléphones",
"facturation": "Facturation",
"portabilite": "Portabilité",
"internet": "Fibre et Internet",
"mobile": "Mobile",
"compte": "Compte et accès",
"commercial": "Commercial",
"autre": "Autre"
},
"statuses": {
"OPEN": "Nouveau",
"IN_PROGRESS": "En cours",
"WAITING_CUSTOMER": "En attente de votre réponse",
"RESOLVED": "Résolu",
"CLOSED": "Fermé"
}
}
GET/api/support/ticketsUtilisateur#
Tickets de support de l’entreprise.
Paramètres de requête
| Champ | Type | Détails |
|---|
status | "open" | "closed" | "all" | par défaut "all" |
Exemple
curl -X GET "https://api.hcloud.fr/api/support/tickets" \
-H "Authorization: Bearer vxk_…"
Réponse
[]
POST/api/support/ticketsUtilisateur#
Ouvre un ticket (multipart possible : pièce jointe dans file).
Corps (multipart/form-data)
| Champ | Type | Détails |
|---|
subject requis | texte | |
body requis | texte | |
category | texte | |
priority | "LOW" | "NORMAL" | "HIGH" | "URGENT" | |
file | fichier | Pièce jointe (facultative) |
Exemple
curl -X POST "https://api.hcloud.fr/api/support/tickets" \
-H "Authorization: Bearer vxk_…" \
-F "subject=…" \
-F "body=…" \
-F "category=…" \
-F "priority=…"
GET/api/support/tickets/{id}Utilisateur#
Détail d’un ticket et ses messages.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/support/tickets/{id}" \
-H "Authorization: Bearer vxk_…"
POST/api/support/tickets/{id}/closeUtilisateur#
Ferme un ticket résolu (note de satisfaction facultative).
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/support/tickets/{id}/close" \
-H "Authorization: Bearer vxk_…"
GET/api/support/tickets/{id}/files/{msg}/{file}Utilisateur#
Télécharge une pièce jointe.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
msg requis | texte | |
file requis | texte | |
Exemple
curl -X GET "https://api.hcloud.fr/api/support/tickets/{id}/files/{msg}/{file}" \
-H "Authorization: Bearer vxk_…"
POST/api/support/tickets/{id}/replyUtilisateur#
Répond dans un ticket.
Paramètres de chemin
| Champ | Type | Détails |
|---|
id requis | texte | |
Exemple
curl -X POST "https://api.hcloud.fr/api/support/tickets/{id}/reply" \
-H "Authorization: Bearer vxk_…"