@voxnova/webphone
v1.0.1
Published
Softphone navigateur en une balise : <voxnova-webphone> (appels entrants et sortants, mise en attente, muet, DTMF, transfert), ou API JavaScript. JsSIP embarqué, aucune dépendance.
Maintainers
Readme
@voxnova/webphone
Softphone navigateur en une balise pour la plateforme VoxNova : appels entrants et sortants, mise en attente, muet, touches DTMF, transfert direct, sonnerie, chronomètre. JsSIP est embarqué : aucune dépendance, aucun fichier audio à héberger.
Installation rapide
<script src="https://cdn.jsdelivr.net/npm/@voxnova/webphone"></script>
<voxnova-webphone
server="wss://voip.exemple.fr/sip"
uri="sip:[email protected]"
password="…"
display-name="Accueil"
floating></voxnova-webphone>Ou avec npm : npm i @voxnova/webphone, puis import '@voxnova/webphone'; (la balise est enregistrée automatiquement).
La page doit être servie en HTTPS (ou
localhost) : sinon le navigateur refuse l'accès au micro et le softphone l'indique.
Sans exposer de mot de passe dans la page
Faites renvoyer la configuration par votre serveur (champ webphone de GET /api/v1/endpoints/{id}, ou vx.endpoints.get(id) du SDK) et laissez la balise la charger :
<voxnova-webphone credentials-url="/api/mon-poste" credentials="include"></voxnova-webphone>// votre serveur (Node, SDK @voxnova/sdk)
app.get('/api/mon-poste', async (_req, res) => {
const endpoint = await vx.endpoints.get('1001');
res.json(endpoint.webphone); // { wsServers, uri, authorizationUser, password, realm, iceServers… }
});Attributs
| Attribut | Rôle |
|---|---|
| server, uri, password, auth-user, realm, display-name | Compte SIP (ou credentials-url) |
| credentials-url, credentials | Configuration JSON chargée au démarrage ; credentials="include" envoie les cookies |
| floating | Bulle en bas à droite, repliable |
| theme | light ou dark (automatique par défaut) |
| lang | fr ou en |
| ringtone="off" | Désactive la sonnerie |
| call-to="0612345678" | Appelle ce numéro dès l'enregistrement (bouton « cliquer pour appeler ») |
Couleur : variable CSS --vx-color (voxnova-webphone { --vx-color: #7c3aed }).
API JavaScript
const el = VoxNovaWebphone.mount('#telephone', { wsServers: ['wss://…/sip'], uri: 'sip:1001@…', password: '…', floating: true });
el.call('0612345678'); // appelle (ouvre la bulle)
el.phone.on('incoming', (call) => console.log('Appel de', call.remote));
el.phone.on('ended', (call) => console.log('Fin :', call.cause));
el.phone.hold(); el.phone.mute(); el.phone.transfer('102'); el.phone.hangup();Moteur seul (sans interface) :
import { Webphone } from '@voxnova/webphone';
const phone = new Webphone({ wsServers, uri, password, ringtone: true });
phone.on('state', (s) => console.log(s)); // connecting, registered, failed…
phone.on('incoming', () => phone.answer());
phone.dial('1002');| Méthode | |
|---|---|
| dial(numéro), answer(), hangup() (refuse un appel entrant) | |
| hold(on?), mute(on?), dtmf(touche) | |
| transfer(numéro) | Événement transfer : sent, accepted, failed |
| on(événement, fn) | state, incoming, call, ended, transfer, error |
| start(), stop() | Un seul appel à la fois : un 2e appel entrant reçoit « occupé » |
Événements DOM de la balise : incoming et ended (event.detail = l'appel).
Compilation
npm install && npm run build # dist/voxnova-webphone.min.js (script) et .esm.js (module)Test navigateur de bout en bout (dépôt VoxNova) : node infra/tests/webphone-e2e.mjs.
Licence MIT.
