Wazo's JavaScript Software Development Kit.
npm install @wazo/sdk
Wazo JavaScript SDK makes it easy for you to build Programmable Conversation applications.
Use this dev kit in any JS application to leverage communication possibilities.
- Voice : Voice
- Video : Video
- Chat : Chat
- Fax : Fax
- Log : Log
- Users status : Status
- Users configurations : Config
- Directories, Logs : Misc
* Install
+ Install / Add
+ Content Delivery Networks
- UNPKG
- jsDelivr
* Simple API
+ Importing the Simple API
+ Authentication with the simple API
- Initializing
- Setting the engine host
- Authenticating a user
- Authenticating a user with SAML
- Validating a token
- Setting a callback when a new token is refreshed
- Logging out
+ Conference
- Joining a room
- Sending a chat message in the room
- Sending a custom message to all participants
- Sharing the user screen
- Stopping the screen share
- Disabling the camera
- Enabling the camera
- Disabling the microphone
- Enabling the microphone
- Accessing room participants
- Disconnect from the room
+ Conference events
+ Conference features
- Merging sessions in one conference
- Add a session to a conference
- Remove a session from a conference
- Terminating a conference
+ Accessing the current WebRtc phone
+ Domains
- Participant
- Participant events
- Stream
* Advanced API
+ Libraries
- Require / Import
- API Client Library
- WebRTC Library
- WebSocket Library
+ Authentication
- Initialization
- When using API Client
- When using WebRTC
- Log In
- Set token (and refresh token)
- Add an event when the token is refreshed
- Log Out
- Check token
- Other auth methods
+ Sending logs to fluentd via a http endpoint
+ Interact with the engine
- Applicationd
- Calld
- Confd
- Dird
- Agentd
- callLogd
- Chatd
- Calling an API endpoint without WazoApiClient
+ WebRTCClient
- WebRTCClient Configuration
- Basic client features
- Calling a number
- Be notified of a phone call
- Answering a call
- Hangup a call
- Rejecting a call
- Muting a call
- Unmuting a call
- Holding a call
- Unholding a call
- Transferring a call
- Sending a DTMF tone
- Sending a message
- Closing the RTC connection
+ WebRTCPhone
- Basic phone features
- Calling a number
- Hangup a call
- Accepting a call
- Rejecting a call
- Holding a call
- Resuming a call
- Muting a call
- Unmuting a call
- Muting camera in a call
- Unmuting camera in a call
- Sending DTMF
- Make a blind transfer
- Make an attended transfer
- Start screen sharing
- Stop screen sharing
- Conference phone features
- Starting a conference
- Adding a participant to the conference
- Holding a conference
- Resuming a conference
- Muting a conference
- Unmuting a conference
- Removing participants from a conference
- Stopping a conference
- Advanced phone features
- Registering the phone
- Check if the phone is registered
- Un-registering the phone
- Updating audio output device
- Updating audio ring device
- Updating audio input device
- Updating video input device
- Checking if it has an active call
- Retrieve the number of active calls
- Sending a SIP message
- Closing the phone
- Starting heartbeat
- Stopping heartbeat
+ WebSocketClient
- Web Socket features
- Opening the socket
- Listening for event
- Updating the user token
- Closing the socket
Voice Video Chat Fax Status Config MiscYou may install the Wazo JavaScript Software Development Kit to your project one of the following ways:
* npm install @wazo/sdk
* pnpm add @wazo/sdk
Voice Video Chat Fax Status Config MiscAlternatively, you may load the Wazo SDK from a CDN. Use one of the following Content Delivery Networks:
#### UNPKG
``
#### jsDelivr
`
js
// For Node / packaged app
import Wazo from '@wazo/sdk';// Browser
// You can access the
Wazo object directly on the browser, simply include it in the html :
or
`$3
#### Initializing
js
Wazo.Auth.init(clientId, tokenExpiration, minSubscriptionType, authorizationName);
`-
: string (optional)
- An identifier of your application that will be used to refresh users token-
tokenExpiration: number (optional, default 3600 seconds)
- Duration before token expiration (in seconds)-
minSubscriptionType: number (optional)
- Defines the minimum user subscription type that allows access to your application.-
authorizationName: string (optional)
- Defines the name of the authorization the user should have to ba able to login.#### Setting the engine host
`js
Wazo.Auth.setHost(host);
`-
: string
- URL to your host (include port if needed).#### Customizing all the
fetch options`js
Wazo.Auth.fetchOptions({
referrer: '',
});
`-
: Object
- Options passed to all the fetch requests of the SDK.#### Authenticating a user
`js
const session = await Wazo.Auth.logIn(username, password, backend, tenantId);
`-
: string
- User's username-
password: string
- User's password-
backend: string
- Optional string. If omitted, defaults to wazo_user-
tenantId: string
- Optional string. The tenant identifier (uuid or slug). Needed when backend is external (not wazo_user)Returns as
Wazo.domain.Session. This object contains, among other information, the user's token.Note: you need to set
clientId in your WazoAPIClient in order to get a refresh token in the returned Session.#### Authenticating a user with SAML
`js
const response = await Wazo.Auth.initiateIdpAuthentication(domain, redirectUrl);
`-
: string
- The domain name of the tenant-
redirectUrl: string
- Where to redirect the browser once the login succeedsReturns an object that contains a
location and a saml_session_id is the URL to open for the user to log in through an identity provider.saml_session_id needs to be used to create a wazo-auth token once the SAML authentication has been completed successfully.
`js
const session = await Wazo.Auth.samlLogIn(samlSessionId);
`-
: string
- samlSessionId generated by wazo-auth, returned by initiateIdpAuthenticationReturns as
. This object contains, among other information, the user's token.
`js
const logoutResponse = await Wazo.Auth.samlLogOut();
`Returns an object that contains a
is the URL to open for the user to log out from their identity provider.#### Validating a token
`js
const session = await Wazo.Auth.validateToken(token, refreshToken);
`-
: string
- User's token to validate (eg: makes sure the token is valid and not expired).-
refreshToken: string (optional)
- User's refresh token, used to generate a new token if expired.Returns as
Wazo.domain.Session.#### Setting a callback when a new token is refreshed
When the user's token is about to expire, Wazo's SDK triggers a callback so you can update it in your application.
Like updating the new token in your localstorage / cookies.
Note: you need to set
clientId in your WazoAPIClient in order to refresh tokens.`js
Wazo.Auth.setOnRefreshToken(token => { / Do something with the new token / });
`-
: Function(token: string)
- A function that is triggered when the user's token will soon expire.#### Logging out
Destroys user's token and refreshToken.
`js
await Wazo.Auth.logout();
`$3
#### Joining a room
js
Wazo.Room.connect(options);
`-
: Object
- extension: string
The room extension (number) you want to join
- audio: boolean|Object
A boolean, if you want to send the user audio or not; or an Object, if you want to specify the audio input, etc...
See getUserMedia arguments for more information.
- video: boolean|Object
A boolean, if you want to send the user video or not; or an Object, if you want to specify the audio input, etc...
See getUserMedia arguments for more information.
- extra: Object
A map of values that will be added to the information of the current participant.Returns a
Wazo.Room instance.#### Sending a chat message in the room
`js
room.sendChat(content);
`-
: string
The chat message content you want to send to all participants in the room.#### Sending a custom message to all participants
`js
room.sendSignal(content);
`-
: string
The message content you want to send to all participants in the room.#### Sharing the user screen
`js
room.startScreenSharing(constraints);
`-
: Object
See getUserMedia arguments for more information.#### Stopping the screen share
`js
room.stopScreenSharing();
`#### Disabling the camera
js
room.turnCameraOff();
`#### Enabling the camera
js
room.turnCameraOn();
`#### Disabling the microphone
js
room.mute();
`#### Enabling the microphone
js
room.unmute();
`#### Accessing room participants
js
room.participants;
`: An array of Wazo.LocalParticipant and Wazo.RemoteParticipant.#### Disconnect from the room
`js
Wazo.room.disconnect();
`$3
js
room.on(room.ON_CHAT, (message) => {});
`Triggered when receiving a chat message.
-
: string`js
room.on(room.ON_MESSAGE, (message) => {});
`Triggered when receiving a custom message.
-
: string`js
room.on(room.ON_JOINED, (participant) => {});
`Triggered when joining the room.
-
: Wazo.LocalParticipant.`js
room.on(room.CONFERENCE_USER_PARTICIPANT_JOINED, (participant) => {});
`Triggered when a participant joins the room.
-
: Wazo.RemoteParticipant.`js
room.on(room.CONFERENCE_USER_PARTICIPANT_LEFT, (participant) => {});
`Triggered when a participant leaves the room.
-
: Wazo.RemoteParticipant.`js
room.on(room.ON_SCREEN_SHARE_ENDED, () => {});
`Triggered when screensharing is stopped.
-
: Wazo.RemoteParticipant.`js
room.on(room.ON_TALKING, (channel, participant) => {});
`Triggered when a participant is talking or stops talking.
-
: Object containing information about the event.
- participant: Wazo.RemoteParticipant or Wazo.LocalParticipant.
The participant instance, you can access the participant.isTalking attribute to know the status.$3
Voice Video#### Merging sessions in one conference
Use this method to merge multiple calls in a new ad hoc conference.
js
const adHocConference = Wazo.Phone.startConference(host: CallSession, otherCalls: CallSession[]): Promise;
`#### Add a call to a conference
Use this method to add a single call to an existing conference room.
js
adHocConference.addParticipant(participant: CallSession);
`#### Remove a call from a conference
Use this method to remove a participant from a conference.
js
adHocConference.removeParticipant(callSession: CallSession);
// shouldHold indicate if the session should be held after removed from session
`#### Terminating a conference
Use this method to terminate a conference.
js
adHocConference.hangup();
`$3
You can access the current webRtcPhone instance via
.$3
You can access all Wazo's domain objects in
Wazo.domain.*, like Wazo.domain.Session;#### Participant
Wazo.LocalParticipant and Wazo.RemoteParticipant shares the same properties :-
uuid: string
The participant uuid.-
name: string
The participant name, retrieved from the sip configuration.-
isTalking: boolean
Indicates if the participant is currently talking.-
streams: Array of Wazo.Stream
List all streams that the participant is sending.-
: Array of Wazo.Stream
List all video streams that the participant is sending.-
: boolean
Indicates if the participant has muted his microphone.-
videoMuted: boolean
Indicates if the participant has muted his camera.-
screensharing: boolean
Indicates if the participant is currently sharing his screen.-
extra: Object
extra information related to a participant.
#### Participant events
`js
participant.on(participant.ON_UPDATED, () => {});
`Triggered when the participant is updated.
js
participant.on(participant.ON_START_TALKING, () => {});
`Triggered when the participant is talking.
js
participant.on(participant.ON_STOP_TALKING, () => {});
`Triggered when the participant stops talking.
js
participant.on(participant.ON_DISCONNECT, () => {});
`Triggered when the participant leaves the room.
js
participant.on(participant.ON_STREAM_SUBSCRIBED, (stream) => {});
`Triggered when the participant sends a stream.
-
: Wazo.Stream
A Wazo stream that is sent by the participant.js
participant.on(participant.ON_STREAM_UNSUBSCRIBED, (stream) => {});
`Triggered when the participant stops sending a stream.
-
: Wazo.Stream
A Wazo stream that is no longer sent by the participant.js
participant.on(participant.ON_AUDIO_MUTED, () => {});
`Triggered when the participant has disabled his microphone.
js
participant.on(participant.ON_AUDIO_UNMUTED, () => {});
`Triggered when the participant has enabled his microphone.
js
participant.on(participant.ON_VIDEO_MUTED, () => {});
`Triggered when the participant has disabled his camera.
js
participant.on(participant.ON_VIDEO_UNMUTED, () => {});
`Triggered when the participant has enabled his camera.
js
participant.on(participant.ON_SCREENSHARING, () => {});
`Triggered when the participant is sharing his screen.
js
participant.on(participant.ON_STOP_SCREENSHARING, () => {});
`Triggered when the participant stops sharing his screen.
#### Stream
helps attach or detach streams to HTML elements:stream.attach(htmlEmelent)Attaches a stream to an existing htmlElement or creates and returns a new one.
-
: htmlElement (optional).Returns a
htmlElement (audio or video) attached to the stream.stream.detach(htmlEmelent)Detaches a stream from an existing htmlElement.
-
: htmlElement.Advanced API
$3
#### Require / Import
Voice Video Chat Fax Status Config MiscDepending on your preference, you may require or add the Wazo SDK to your own client application one of the following ways using:
##### API Client Library
*
* Depending on your environment you can import:
*
: compatible with (most) browsers only.
* @wazo/sdk/lib: runnable on node env.##### WebRTC Library
`js
import { WebRTCClient } from '@wazo/sdk';
`##### WebSocket Library
js
import { WazoWebSocketClient } from '@wazo/sdk';
`$3
#### Initialization
Video Chat Fax Status Config Misc##### When using API Client
js
const client = new WazoApiClient({
server: 'stack.example.com', // required string
agent: null, // http(s).Agent instance, allows custom proxy, unsecured https, certificate etc.
clientId: null, // Set an identifier for your app when using refreshToken
isMobile: false,
});
`##### When using WebRTC
js
const session = await client.auth.logIn({ ... });
`#### Log In
Video Chat Fax Status Config Miscjs
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
mobile, // optional boolean. If omitted, defaults to false: tells if the current user uses a mobile application
tenantId, // optional string. The tenant identifier (uuid or slug). Needed when backend is external (not wazo_user)
}).then(/ undefined if login failed, or : /{
metadata: {
username,
uuid_tenant_uuid,
xivo_user_uuid,
groups,
xivo_uuid,
tenants: [{ uuid }],
auth_id
},
// should be used for other request
acl,
utc_expires_at,
xivo_uuid,
issued_at,
utc_issued_at,
auth_id,
expires_at,
xivo_user_uuid
});
// or
const { refreshToken, ...result } = await client.auth.logIn(/ ... /);
`Note: you need to set
in your WazoAPIClient in order to get a refresh token.#### Set token (and refresh token)
Voice Video Chat Fax Status Config Miscjs
client.setToken(token);
client.setRefreshToken(refreshToken);
client.setRefreshTokenExpiration(tokenExpirationInSeconds);
`Note: you need to set
in your WazoAPIClient in order to get a refresh token.#### Add an event when the token is refreshed
Voice Video Chat Fax Status Config Miscjs
client.setOnRefreshToken((newToken, newSession) => {
// Do something with the new token and the new session (like storing them in the localstorage...).
});
`Note: you need to set
in your WazoAPIClient to refresh a token.#### Log Out
Voice Video Chat Fax Status Config Miscjs
client.auth.logOut(token).then(/ ... /);
// or
await client.auth.logOut(token);
`#### Check token
Video Chat Fax Status Config Misc
client.auth.checkToken(token).then(valid);
// or
const valid = await client.auth.checkToken(token);
#### Other auth methods
js
client.auth.listTenants();
client.auth.createTenant(name);
client.auth.deleteTenant(uuid);
client.auth.createUser(username, password, firstname, lastname);
client.auth.addUserEmail(userUuid, email, main);
client.auth.addUserPolicy(userUuid, policyUuid);
client.auth.deleteUser();
client.auth.listUsers();
client.auth.listGroups();
client.auth.createPolicy(name, description, acl);
client.auth.listPolicies();
`$3
#### Logger
import Wazo from '@wazo/sdk';Wazo.IssueReporter.enable();
Wazo.IssueReporter.configureRemoteClient({
host: 'localhost', // fluentd http host
port: 9880, // fluentd http port
tag: 'name of your application,
level: 'trace', // Min log level to be sent
extra: {
// Extra info sent for every logs
user_uuid: '...',
},
});
Using the logger :
// Log with for category, this will send a attribute in every logs for this logger.
const logger = Wazo.IssueReporter.loggerFor('my_category');
logger(logger.TRACE, 'my log');// or simply
Wazo.IssueReporter.log(Wazo.IssueReporter.INFO, 'my log');
`$3
#### Applicationd
Video Chat Fax Status ConfigUse Applicationd to construct your own communication features.
js
client.application.calls(applicationUuid); // list calls
client.application.hangupCall(applicationUuid, callId); // hangup a call
client.application.answerCall(applicationUuid, callId, context, exten, autoanswer); // answer a call
client.application.listNodes(applicationUuid); // list nodes
client.application.listCallsNodes(applicationUuid, nodeUuid); // list calls in a node
client.application.removeCallNodes(applicationUuid, nodeUuid, callId); // remove call from node (no hangup)
client.application.addCallNodes(applicationUuid, nodeUuid, callId); // add call in a node
client.application.playCall(applicationUuid, callId, language, uri); // play a sound into a call
`#### Calld
Video Chat Fax StatusUse Calld to directly control interactions.
(Please note, ctidNg endpoint is deprecated but continues to work with old versions. Please update your code.)
js
client.calld.getConferenceParticipantsAsUser(conferenceId); // List participants of a conference the user is part of
client.calld.answerSwitchboardQueuedCall(switchboardUuid, callId);
client.calld.answerSwitchboardHeldCall(switchboardUuid, callId);
client.calld.cancelCall(callId);
client.calld.deleteVoicemail(voicemailId);
client.calld.fetchSwitchboardHeldCalls(switchboardUuid);
client.calld.fetchSwitchboardQueuedCalls(switchboardUuid);
client.calld.getConferenceParticipantsAsUser(conferenceId);
client.calld.getPresence(contactUuid); //deprecated use chatd in ctidNg, don't work with calld
client.calld.getStatus(lineUuid); //deprecated use chatd in ctidNg, don't work with calld
client.calld.holdSwitchboardCall(switchboardUuid, callId);
client.calld.listCalls();
client.calld.listMessages(participantUuid, limit);
client.calld.listVoicemails();
client.calld.makeCall(extension, fromMobile, lineId, allLines);
client.calld.sendFax(extension, fax, callerId);
client.calld.sendMessage(alias, msg, toUserId);
client.calld.relocateCall(callId, destination, lineId);
client.calld.updatePresence(presence);
`#### Confd
Use Confd to interact with configurations.
js
client.confd.listUsers();
client.confd.getUser(userUuid);
client.confd.getUserLineSip(userUuid, lineId);
client.confd.listApplications();
`#### Dird
Use Dird to interact with directories.
js
client.dird.search(context: string, term: string, offset: number, limit: number);
client.dird.listPersonalContacts();
client.dird.addContact(newContact: NewContact);
client.dird.editContact(contact: Contact);
client.dird.deleteContact(contactUuid: UUID);
client.dird.listFavorites(context: string);
client.dird.markAsFavorite(source: string, sourceId: string);
client.dird.removeFavorite(source: string, sourceId: string);
`#### Agentd
Use Agentd to handle agent states
Legacy (all versions)
js
client.agentd.getAgent(agentNumber);
client.agentd.login(agentNumber, context, extension);
client.agentd.logout(agentNumber);
client.agentd.pause(agentNumber);
client.agentd.resume(agentNumber);
`
Log in with line ID only (engine version > 20.11 -- recommended)
js
client.agentd.loginWithLineId(lineId);
`
No-args methods (engine version >= 20.17 -- recommended)
js
client.agentd.getStatus();
client.agentd.staticLogout();
client.agentd.staticPause();
client.agentd.staticResume();
`#### callLogd
MiscUse callLogd to interact with call logs.
js
client.callLogd.search(search, limit);
client.callLogd.listCallLogs(offset, limit);
client.callLogd.listCallLogsFromDate(from, number);
`#### Chatd
StatusUse chatd to send and retrieve chat messages and user statuses.
js
client.chatd.getContactStatusInfo(contactUuid: UUID);
client.chatd.getState(contactUuid: UUID);
client.chatd.getLineState(contactUuid: UUID);
client.chatd.getMultipleLineState(contactUuids: ?Array);
client.chatd.getUserRooms();
client.chatd.updateState(contactUuid: UUID, state: string);
client.chatd.updateStatus(contactUuid: UUID, state: string, status: string);
client.chatd.createRoom(name: string, users: Array);
client.chatd.getRoomMessages(roomUuid: string);
client.chatd.sendRoomMessage(roomUuid: string, message: ChatMessage);
client.chatd.getMessages(options: GetMessagesOptions);
`#### Calling an API endpoint without WazoApiClient
MiscUse this generic method to request endpoints directly.
js
const requester = new ApiRequester({
server: 'stack.example.com', // Engine server
refreshTokenCallback: () => {}, // Called when the token is refreshed
clientId: 'my-id', // ClientId used for refreshToken
agent: null, // http(s).Agent instance, allows custom proxy, unsecured https, certificate etc.
token: null, // User token (can be defined later with requester.setToken()
});// Retrieve personal contacts
const results = await requester.call('dird/0.1/personal');
`#### Extending BaseApiClient with you own methods
MiscWazoApiClient is an extended version of BaseApiClient with needed APIs for softphone users. If you want to add new endpoints and methods it is also possible.
js
const myEndpointMethods = (client: ApiRequester, baseUrl: string) => ({
getFoo: () => client.get(${baseUrl}/foo),
postFoo: () => client.post(${baseUrl}/foo, { / body / }),
putFoo: (uuid: string) => client.post(${baseUrl}/foo/${uuid}, { / body / }),
deleteFoo: (uuid: string) => client.delete(${baseUrl}/foo/${uuid}),
});class CustomApiClient extends BaseApiClient {
public myEndpoint;
constructor(args: ConstructorParams) {
super(args);
this.initializeEndpoints(); // Reinitialize sdk endpoints
}
initializeEndpoints() {
super.initializeEndpoints(); // Include default
auth methods for token and refresh token mecanism
this.myEndpoint = myEndpointMethods(this.client, confd/1.1);
}
}
`$3
This sample describes the very first steps to place a call using WebRTC.js
import { WebRTCClient } from '@wazo/sdk'; // import the libraryconst session = await client.auth.logIn({ ... }); // log in
const client = new WebRTCClient({
displayName: 'From WEB',
host: 'stack.example.com',
websocketSip: 'other.url.com', // Allows to connect throught another URL than host (default to
host is not set).
media: {
audio: boolean,
video: boolean | document.getElementById('video'), // pointing to a element
localVideo: boolean | document.getElementById('video'), // pointing to a element
}
}, session);// eventName can be on the of events :
// - transport:
connected, disconnected, transportError, message, closed, keepAliveDebounceTimeout
// - webrtc: , unregistered, registrationFailed, invite, inviteSent, transportCreated, newTransaction, transactionDestroyed, notify, outOfDialogReferRequested, message.
client.on('invite', (sipSession: SipSession, hasVideo: boolean, shouldAutoAnswer: boolean) => {
this.currentSipSession = sipSession;
// ...
});// We have to wait to be registered to be able to make a call
await client.waitForRegister();
client.call('1234');
`#### WebRTCClient Configuration
js
const config = {
displayName: '', // Display name sent in SIP payload
host: '', // Host where to connect
port: '', // Port of the host (default to 443)
media: {
audio: boolean, // If we want to send audio
video: boolean | document.getElementById('video'), // pointing to a element
localVideo: boolean | document.getElementById('video'), // pointing to a element
},
iceCheckingTimeout: 1000, // Time allowed to retrieve ice candidates
log: {}, // @see https://sipjs.com/api/0.5.0/ua_configuration_parameters/#log
audioOutputDeviceId: null, // The audio output device id (when we want to send audio in another destination).
userAgentString: null, // Customize the User-Agent SIP header
heartbeatDelay: 1000, // Duration in ms between 2 heartbeat (default to 2000)
heartbeatTimeout: 5000, // Duration in ms when to consider that the Asterisk server is not responding (default to 5000)
maxHeartbeats: 4, // Number of heatbeat send each time we want to check connection (default to 3) // When not passing session as second argument:
authorizationUser: '', // The SIP username
password: '', // The SIP user password
uri: '', // The SIP user identity
}
const uaConfigOverrides = {
peerConnectionOptions: {
iceServers = [
{urls: "stun:stun.example.com:443"}, // STUN server
{urls: "turn:turn.example.com:443", username: "login", credential: "secret" }, // TURN server
...
]
}
}
const client = new WebRTCClient(config, session, / optional / uaConfigOverrides);
`#### Basic client features
Video Chat##### Calling a number
Use this method to dial a number.
js
client.call(number: string);
`##### Be notified of a phone call
Use this method to be notified of an incoming call.
js
client.on('invite', (sipSession: SipSession) => {
this.currentSipSession = sipSession;
});
`##### Answering a call
Use this method to pick up an incoming call.
js
client.answer(sipSession: SipSession);
`##### Hangup a call
Use this method to hangup a call (the call must have been already picked up)
js
client.hangup(sipSession: SipSession);
`##### Rejecting a call
Use this method to deny an incoming call (Must not have been picked up already)
js
client.reject(sipSession: SipSession);
`##### Muting a call
Use this method to mute yourself in a running call.
js
client.mute(sipSession: SipSession);
`##### Unmuting a call
Use this method to unmute yourself in a running call.
js
client.unmute(sipSession: SipSession);
`##### Holding a call
Use this method to put a running call on hold.
js
client.hold(sipSession: SipSession);
`##### Unholding a call
Use this method to resume a running call.
js
client.unhold(sipSession: SipSession);
`##### Make a blind transfer
Use this method to transfer a call to another target, without introduction
js
client.transfer(sipSession: SipSession, target: string);
`##### Make an attended transfer
Use this method to transfer a call to another target, but first introduce the caller to the transfer target. The transfer may be cancelled (hangup the transfer target) or completed (hangup the transfer initiator).
js
transfer = client.atxfer(sipSession: SipSession);// Start the transfer to a phone number, starts a new SIP session in the process
transfer.init(target: string)
// Get the new SIP session to the target of the transfer
targetSession = transfer.newSession
// Complete the transfer.
// transfer.init(...) must be called first.
transfer.complete()
// Cancel the transfer.
// transfer.init(...) must be called first.
transfer.cancel()
`##### Sending a DTMF tone
Use this method to send the dual-tone multi-frequency from the phone keypad.
js
client.sendDTMF(sipSession: SipSession, tone: string);
`##### Sending a message
js
client.message(destination: string, message: string);
`#### Set the audio output volume
Stores a value between 0 and 1, which can be used to on your audio element
js
phone.changeAudioOutputVolume(volume: number);
`#### Set the audio ring volume
Stores a value between 0 and 1, which can be used to on your audio element
js
phone.changeAudioRingVolume(volume: number);
`#### Closing the RTC connection
Use this method to put an end to an RTC connection.
js
client.close();
`$3
Higher level of abstraction to use the .`js
import { WebRTCClient, WebRTCPhone } from '@wazo/sdk';const webRtcClient = new WebRTCClient({/ See above for parameters /});
const phone = new WebRTCPhone(
webRtcClient: WebRTCClient, // Instance of WebRTCClient
audioDeviceOutput: string, // The output device used to play audio
allowVideo: boolean, // Allow to send and receive video
audioDeviceRing, // The output device used to play ringtones
);
`#### Basic phone features
Video Chat##### Calling a number
Use this method to dial a number.
js
const callSession = await phone.makeCall(
number: string, // The number to dial
line: // Not used
enableVideo: boolean // Optional (default to false) when we want to make a video call
);
`##### Hangup a call
Use this method to stop a call
js
phone.hangup(
callSession: CallSession, // The callSession to stop
);`
##### Accepting a call
Use this method to accept (answer) an incoming calljs
phone.accept(
callSession: CallSession, // The callSession to accept
cameraEnabled?: boolean // Should we accept the call with video
);
`##### Rejecting a call
Use this method to reject an incoming call
js
phone.reject(
callSession: CallSession // The callSession to reject
);
`##### Holding a call
Use this method to put a running call on hold.
js
phone.hold(
callSession: CallSession, // The call session to put on hold
withEvent: boolean = true // Should the phone triggers event
);
`##### Resuming a call
Use this method to resume a running call.
js
phone.resume(callSession: CallSession);
`
Please note that is the preferred method
`js
phone.unhold(callSession: CallSession); // deprecated
`##### Muting a call
Use this method to mute yourself in a running call.
js
phone.mute(
callSession: CallSession, // The call session to mute
withEvent: boolean = true // Should the phone triggers event
);
`##### Unmuting a call
Use this method to unmute yourself in a running call.
js
phone.unmute(callSession: CallSession);
`##### Muting camera in a call
Use this method to mute your camera in a running call.
js
phone.turnCameraOff(callSession: CallSession);
`##### Unmuting camera in a call
Use this method to unmute your camera in a running call.
js
phone.turnCameraOn(callSession: CallSession);
`##### Sending DTMF
Use this method to unmute yourself in a running call.
js
phone.sendKey(callSession: CallSession, tone: string);
`##### Transferring a call
###### Blind transfer
Use this method to transfer a call directly to another extension, without introduction
js
phone.transfer(
callSession: CallSession, // The call session to transfer
target: string // The extension where to transfer to call
);
`###### Attended transfer
Use this method to transfer a call to another extension by allowing to speak with the other participant first and validate the transfer after that.
You have to run
first on the target to be able to confirm the transfer with this method.`js
phone.indirectTransfer(
callSession: CallSession, // The call session to transfer
target: string // The extension where to transfer to call
);
`##### Start screen sharing
js
const screenShareStream: MediaStream = await phone.startScreenSharing({
audio: true,
video: true,
/ See webRtc media constraints /
});
`##### Stop screen sharing
js
phone.stopScreenSharing();
`#### Conference phone features
Video Chat##### Starting a conference
Use this method to start an ad-hoc conference.
js
phone.startConference(participants: CallSession[]);
`##### Adding a participant to the conference
js
phone.addToConference(participant: CallSession);
`##### Holding a conference
js
phone.holdConference(participants: CallSession[]);
`##### Resuming a conference
js
phone.resumeConference(participants: CallSession[]);
`##### Muting a conference
js
phone.muteConference(participants: CallSession[]);
`##### Unmuting a conference
js
phone.unmuteConference(participants: CallSession[]);
`##### Removing participants from a conference
js
phone.removeFromConference(participants: CallSession[]);
`##### Stopping a conference
js
phone.hangupConference(participants: CallSession[]);
`#### Advanced phone features
Video Chat##### Registering the phone
Sends a SIP
payload
`js
phone.register();
`##### Check if the phone is registered
js
phone.isRegistered();
`##### Un-registering the phone
Sends a SIP
payload
`js
phone.unregister();
`##### Updating audio output device
js
phone.changeAudioDevice(someDevice: string);
`##### Updating audio ring device
js
phone.changeRingDevice(someDevice: string);
`##### Updating audio input device
js
phone.changeAudioInputDevice(someDevice: string, session: ?Inviter, force: ?boolean);
`##### Updating video input device
js
phone.changeVideoInputDevice(someDevice: string);
`##### Checking if it has an active call
js
phone.hasAnActiveCall(): boolean;
`##### Retrieve the number of active calls
js
phone.callCount(): number;
`##### Sending a SIP message
Sends a SIP MESSAGE in a session.
Use
to retrieve the current sipSession.`js
phone.sendMessage(
sipSession: SipSession = null, The sip session where to send to message
body: string, // The message to SEND
);
`##### Closing the phone
Disconnect the SIP webSocket transport.
js
phone.stop();
`##### Starting heartbeat
Sends a SIP
every X seconds, Y times and timeout after Z seconds.
See webrtcClient's heartbeatDelay, heartbeatTimeout, maxHeartbeats, configuration.`js
phone.startHeartbeat();
`##### Stopping heartbeat
js
phone.stopHeartbeat();
`$3
You can use the Wazo WebSocket to listen for real-time events (eg: receiving a chat message, a presential update...)#### Web Socket features
Video Chat Fax Status##### Opening the socket
js
import { WebSocketClient } from '@wazo/sdk';const ws = new WebSocketClient({
host: '', // wazo websocket host
token: '', // valid Wazo token
events: [''], // List of events you want to receive (use
['*'] as wildcard).
version: 2, // Use version 2 of the Wazo WebSocket protocol to be informed when the token will expire.
}, {
// see https://github.com/pladaria/reconnecting-websocket#available-options
});ws.connect();
`##### Listening for event
js
import { USERS_SERVICES_DND_UPDATED, AUTH_SESSION_EXPIRE_SOON } from '@wazo/sdk/lib/websocket-client';// eventName can be on the of events here: http://documentation.wazo.community/en/stable/api_sdk/websocket.html
ws.on('eventName', (data: mixed) => {
});
ws.on(USERS_SERVICES_DND_UPDATED, ({ enabled }) => {
// Do something with the new do not disturb value.
});
ws.on(AUTH_SESSION_EXPIRE_SOON, (data) => {
// Called when the user's token will expire soon.
// You should refresh it at this point (eg: by using a refreshToken).
});
`##### Updating the user token
You can update a new token to avoid being disconnected when the old one will expire.
js
ws.updateToken(newToken: string);
`#### Closing the socket
js
ws.close();
`
Usage with Webpack 5
As Webpack 5 dropped some polyfills, you have to add them manually:
sh
pnpm add -D assert buffer https-browserify url stream-http stream-browserify browserify-zlib process
`If you have used
to create your app, you can customize the Webpack configuration with react-app-rewired :`sh
pnpm add -D react-app-rewired
`Create a
file :
`js
const webpack = require('webpack');
module.exports = function override(config, env) {
config.resolve.fallback = {
...config.resolve.fallback,
assert: require.resolve("assert"),
buffer: require.resolve('buffer'),
https: require.resolve('https-browserify'),
url: require.resolve('url'),
http: require.resolve('stream-http'),
stream: require.resolve('stream-browserify'),
zlib: require.resolve('browserify-zlib'),
}; config.plugins.push(
new webpack.ProvidePlugin({
process: 'process/browser',
Buffer: ['buffer', 'Buffer'],
}),
);
config.module.rules.push({
test: /\.m?js/,
resolve: {
fullySpecified: false
}
})
return config;
}
`Then edit in
:
`json
"scripts": {
// ...
"start": "react-app-rewired start",
"build": "react-app-rewired build",
"test": "react-app-rewired test",
"eject": "react-app-rewired eject"
// ...
},
``Please refer to https://github.com/facebook/create-react-app/issues/11756 for more details.