Usage

Install / Add

Content Delivery Networks

UNPKG

<script src="https://unpkg.com/@wazo/sdk"></script>

jsDelivr

<script src="https://cdn.jsdelivr.net/npm/@wazo/sdk"></script>

Require / Import

Init

constclient=newWazoApiClient({server:'demo.wazo.community',// required stringagent:null// http(s).Agent instance, allows custom proxy, unsecured https, certificate etc.});

Log In

client.auth.logIn({  expiration,// optional integer. Session life in number of seconds. If omitted, defaults to 3600 (an hour).  username,// required string  password,// required string  backend,// optional string. If omitted, defaults to wazo_user}).then(/* undefined if login failed, or : */{metadata:{    username,    uuid_tenant_uuid,    xivo_user_uuid,    groups,    xivo_uuid,tenants:[{ uuid}],    auth_id},  token,// should be used for other request  acls,  utc_expires_at,  xivo_uuid,  issued_at,  utc_issued_at,  auth_id,  expires_at,  xivo_user_uuid});// orconstresult=awaitclient.auth.login(/* ... */);

Log Out

client.auth.logOut(token).then(/* ... */);// orawaitclient.auth.logOut(token);

Check token

client.auth.checkToken(token).then(valid);// orconst valid = await client.auth.checkToken(token);

Other auth methods

client.auth.listTenants(token);client.auth.createTenant(token,name);client.auth.deleteTenant(token,uuid);client.auth.listUsers(token);client.auth.listGroups(token);client.auth.listPolicies(token);

Application

client.application.calls(token,applicationUuid);// list callsclient.application.hangupCall(token,applicationUuid,callId);// hangup a callclient.application.answerCall(token,applicationUuid,callId,context,exten,autoanswer);// answer a callclient.application.listNodes(token,applicationUuid);// list nodesclient.application.listCallsNodes(token,applicationUuid,nodeUuid);// list calls in a nodeclient.application.removeCallNodes(token,applicationUuid,nodeUuid,callId);// remove call from node (no hangup)client.application.addCallNodes(token,applicationUuid,nodeUuid,callId);// add call in a nodeclient.application.playCall(token,applicationUuid,callId,language,uri);// play a sound into a call

Confd

client.confd.listUsers(token);client.confd.getUser(token,userUuid);client.confd.getUserLineSip(token,userUuid,lineId);client.confd.listApplications(token);

Accessd

client.accessd.listSubscriptions(token);client.accessd.createSubscription(token,{ productSku, name, startDate, contractDate, autoRenew, term});client.accessd.getSubscription(token,uuid);client.accessd.listAuthorizations(token);client.accessd.getAuthorization(token,uuid);

WebRTCPhone

import{WazoWebRTCClient}from'@wazo/sdk';constconfig={wsServer:'wss://path.to/asterisk/ws',displayName:'My Display Name',authorizationUser:'line username',password:'line password',uri:'user@server.com',media:{audio:document.getElementById('audio'),// Pointing to a `<audio />` elementvideo:document.getElementById('video'),// optional, pointing to a `<video />` elementlocalVideo:document.getElementById('local-video')// optional, pointing to a `<video />` element}};constphone=newWazoWebRTCClient({displayName:'From WEB',host:'quintana.wazo.community',authorizationUser:lineData.username,password:lineData.secret,media:{audio:boolean|document.getElementById('audio'),// Pointing to a `<audio />` elementvideo:boolean|document.getElementById('video'),// pointing to a `<video />` elementlocalVideo:boolean|document.getElementById('video'),// pointing to a `<video />` element}});// eventName can be on the of events : `connected`, `disconnected`, `registered`, `unregistered`, `registrationFailed`, `invite`, `inviteSent`, `transportCreated`, `newTransaction`, `transactionDestroyed`, `notify`, `outOfDialogReferRequested`, `message`.phone.on('invite',(session:SIP.sessionDescriptionHandler)=>{this.currentSession=session;// ...});// or a wildcard : `*`phone.on('*',(data:mixed,eventName:string)=>{});phone.call('1234');

Calling a number

phone.call(number:string);

Be notified to a phone call

phone.on('invite',(session:SIP.sessionDescriptionHandler)=>{this.currentSession=session;});

Answering a call

phone.answer(session:SIP.sessionDescriptionHandler);

Hangup a call

phone.hangup(session:SIP.sessionDescriptionHandler);

Rejecting a call

phone.reject(session:SIP.sessionDescriptionHandler);

Muting a call

phone.mute(session:SIP.sessionDescriptionHandler);

Umuting a call

phone.unmute(session:SIP.sessionDescriptionHandler);

Holding a call

phone.hold(session:SIP.sessionDescriptionHandler);

Unholding a call

phone.unhold(session:SIP.sessionDescriptionHandler);

Transferring a call

phone.transfert(session:SIP.sessionDescriptionHandler,target:string);

Sending a DTMF tone

phone.sendDTMF(session:SIP.sessionDescriptionHandler,tone:string);

Sending a message

phone.sendDTMF(message:string,destination:string);

Closing the RTC connection

phone.close();

Wazo Websocket

import{WazoWebSocketClient}from'@wazo/sdk';constws=newWazoWebSocket({  host,// wazo websocket host  token,// valid Wazo token});// eventName can be on the of events here: http://documentation.wazo.community/en/stable/api_sdk/websocket.htmlws.on('eventName',(data:mixed)=>{});// You can also use a wildcard to catch all eventsws.on('*',(data:mixed,eventName:string)=>{});ws.connect();

Closing the socket

ws.close();