aircall-everywhere
v1.8.0
Published
Library to embed and communicate with aircall-phone in any webpage
Downloads
11,169
Keywords
Readme
How to use the Aircall Everywhere in any CRM ?
Include this project in your dependency
npm install -s aircall-everywhere
Constructor
You need to create an instance to use the library. The constructor has a settings argument:
onLogin
: Callback function after the phone is fully loaded, logged in, and the connexion between the phone and the CRM is established. This callback will triggers everytime the user logs again. User details and integration settings if any are passed as parameters.onLogout
: Callback function after the user logs out of the phone. It will triggers everytime the user logs out.integrationToLoad
: You can specify a CRM from which specific settings can be retrieved. Onlyzendesk
orhubspot
available for now. You can ignore this if you have your own CRM.domToLoadPhone
: You must specify in which element you want to load the phone. Query selector string.size
: You can specify a preset for the size of the phone loaded. 3 possibilities:big
: 666px by 376px. Recommanded and default valuesmall
: 600px by 376pxauto
: 100% width and height. Not recommanded
debug
: Enables or disables logging. Defaults totrue
.
Example:
import AircallPhone from 'aircall-everywhere';
const aircallPhone = new AircallPhone({
onLogin: (settings) => {
console.log('phone loaded');
doStuff();
},
onLogout: () => {},
domToLoadPhone: '#phone',
integrationToLoad: 'zendesk',
size: 'big',
});
Settings passed in the onLogin
callback contains info about the user and integration and looks like this:
{
user: {
email: '[email protected]',
first_name: 'John',
last_name: 'Smith',
company_name: 'Super Company Inc'
},
settings: {
<specific_integration_settings>
}
}
isLoggedIn method
In addition to the onLogin
and onLogout
callbacks, a isLoggedIn
method is provided that will directly asks the phone about its status. The result is a boolean.
Example:
aircallPhone.isLoggedIn((res) => {
console.log('login status:', res);
});
on & send
You can send messages to the phone and listen messages coming from it.
events from the phone:
All events from the phone with the payload associated:
incoming_call
: there is an incoming call, ringing.{ from: '+15557543010', to: '+15551234567', call_id: 12345 }
call_end_ringtone
: the ringtone has ended. This event is only triggered for incoming calls.{ answer_status: 'answered | disconnected | refused', call_id: 12345 }
outgoing_call
: an outgoing call has started{ from: '+15557543010', to: '+15551234567', call_id: 12345 }
outgoing_answered
: an outgoing call has been answered{ call_id: 12345; }
call_ended
: a call has been ended{ duration: 20, call_id: 12345 }
comment_saved
: a comment has been saved about a call{ comment: 'This is a comment', call_id: 12345 }
external_dial
: a dial has been made from outside of the phone (api/extension){ phone_number: '+15557543010'; }
powerdialer_updated
: a powerdialer campaign has been updated (via extension). There is no payload.redirect_event
: event coming from specific CRM settings if it has been enabled in the Aircall Dashboard. Onlyzendesk
andhubspot
is supported for now. This event data has this schema:{ type: 'Zendesk::User' | 'Zendesk::Ticket' id: <userId> | <ticketId> }
call_id
parameter is a number per call.
duration
is in seconds.
All numbers are sent in the e.164
format.
Example:
aircallPhone.on('incoming_call', (callInfos) => {
console.log(`Call from ${callInfos.from} to ${callInfos.to}`);
doStuff();
});
events the phone listens to:
Example:
aircallPhone.send('dial_number', { phone_number: number }, (success, data) => {
console.log('success of dial:', success);
});
The callback of the send
method has two arguments:
- success of the request
- if the request is successful, data from the response sent by the phone
- if the request is not successful, an error object with an error code and error message:
All generic errors from send
:
no_event_name
: the event name sent is not validnot_ready
: Phone is not loaded or logged in yetno_answer
: Phone didn't answer, most likely not logged indoes_not_exists
: The event sent does not existsinvalid_response
: Phone sent an malformed answer, should not happenunknown_error
: Should not happen
List of events:
dial_number
: with{phone_number: <number>}
argument, you can ask the phone to dial the number. Specific errors for this event:in_call
: Phone is on a call, retry after the call is ended
exit_keyboard
: with no argument, you can ask the phone to exit the keyboard view if it is on. Specific errors for this event:in_call
: Phone is on a call, retry after the call is endednot_in_keyboard
: Phone is not on keyboard screen, so it can't exit the keyboard :D
more events to come...
removeListener method
You can remove a listener added by on
with this method.
<iframe>
authorizations
Please be aware that aircall-everywhere
will generate an iframe with following allow
attributes.
<iframe
allow="microphone; autoplay; clipboard-read; clipboard-write; hid"
src="https://phone.aircall.io?integration=generic"
style="height:100%; width:100%;"
>
</iframe>
If you need to embed aircall-everywhere
in an <iframe>
you own, please be sure to propagate the allow
attributes like so
<!-- your iframe -->
<iframe src="your src here" allow="camera; microphone; clipboard-read; clipboard-write; hid">
<!-- iframe generated by aircall-everywhere -->
<iframe
allow="microphone; autoplay; clipboard-read; clipboard-write; hid"
src="https://phone.aircall.io?integration=generic"
style="height:100%; width:100%;"
>
</iframe>
</iframe>
The clipboard API is not accessible through <iframe>
since Chrome v81 and a policy has been added since Chrome v85. That's why aircall-everywhere
needs these attributes. More info here.
Development
You can run the demo webpage with:
yarn start
tests are available:
yarn test
yarn test-watch
yarn coverage
to create a new version:
yarn version --patch|--minor|--major
and create a PR. The CI will publish the new version after manual approval.
Code coverage
A code coverage report is available here.